Skip to content

Commit 60a4de9

Browse files
Lorinphilipbaileynar
authored andcommitted
several updates to qviewer documentation and screenshots. add last update time globally.
1 parent 280e54a commit 60a4de9

10 files changed

Lines changed: 41 additions & 27 deletions

docs/Docs.code-workspace

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
},
1313
],
1414
"settings": {
15-
"window.title": "Riverscapes Viewer Docs${separator}${activeEditorShort}${separator}${rootName}",
15+
"window.title": "Riverscapes Viewer Docs${separator}${activeEditorShort}${separator}${rootName}",
1616
"[mdx]": {
1717
"editor.wordWrap": "bounded",
1818
"editor.wordWrapColumn": 80
@@ -44,6 +44,7 @@
4444
"**/node_modules/**": true
4545
},
4646
"terminal.integrated.defaultProfile.linux": "zsh",
47+
"terminal.integrated.cwd": "./",
4748
// Riverscapes documentation standards
4849
// treat mdx as markdown
4950
"files.associations": {

docs/docs/Deploy/install-qgis.mdx

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ sidebar_position: 2
66
---
77

88
## Plugin Installation
9-
To install the Riverscapes Viewer for [QGIS](https://qgis.org/) 3.16 or later:
109

11-
1. From the main QGIS menu choose `Plugins → Manage and Install Plugins`.
12-
2. Search Plugins for `Riverscapes`.
13-
3. Pick the `Riverscapes Viewer` plugin and click install. The installation should take less than 30 seconds.
10+
To install the Riverscapes Viewer for [QGIS](https://qgis.org/) 3.16 or later:
11+
12+
1. From the main QGIS menu choose `Plugins → Manage and Install Plugins...`.
13+
2. Search Plugins for "Riverscapes".
14+
3. Pick the `Riverscapes Viewer` plugin and click `Install Plugin`. The installation should take less than 30 seconds.
1415

1516
At any time after it is installed, you can return to the QGIS plugins manager and update the plugin by clicking the `Update` button next to the `Riverscapes Viewer` plugin.
1617

@@ -22,9 +23,11 @@ The Riverscapes Viewer for QGIS requires QGIS 3.16 or newer.
2223

2324
## Updating Resources
2425

25-
You will want to update resources just about every time you use the Viewer (including on a new install) to make sure you have the latest [symbology](/technical-reference/symbology) and [business logic](/technical-reference/business-logic). To do this, you simply go to the Viewer toolbar and choose `Help → Update Resources`. This then downloads the latest files from the [RiverscapesXML repo](https://github.com/Riverscapes/RiverscapesXML) and places them in a local resource folder. You can browse to that resource folder from the toolbar by choosing `Help → Find Resources Folder`.
26+
By default, the Riverscapes Viewer automatically synchronizes (downloads) the latest [symbology](/technical-reference/symbology) and [business logic](/technical-reference/business-logic) from [RiverscapesXML repo](https://github.com/Riverscapes/RiverscapesXML) to your local resource folder. You can also force an update at any time. To do this, from the Riverscapes Viewer toolbar choose `Tools → Update resources`.
27+
28+
You can browse to that resource folder from the toolbar by choosing `Tools → Open Resources folder`.
2629

27-
![Update Resources](/images/qviewer/qris_help_menu.png)
30+
![Tools menu](/images/qviewer/qviewer_tools_menu_v1.0.5.windows.png)
2831

2932
## QGIS - Need to get GIS?
3033

@@ -38,4 +41,4 @@ If you do not have [QGIS](https://qgis.org/) already, or even if you have never
3841

3942
See the [release notes](https://github.com/Riverscapes/QRAVEPlugin/releases) provided in the code repository.
4043

41-
Note: the Riverscapes Viewer for QGIS was previously known as the QRAVE plugin.
44+
Note: the Riverscapes Viewer for QGIS was previously known as the QRAVE plugin.

docs/docs/software-help/help-qgis.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ sidebar_position: 2
77

88
The QGIS Version of the Riverscapes Viewer is a free plugin for QGIS that helps display riverscapes projects with consistent symbology and labeling. This help guide will help you get started with the Riverscapes Viewer.
99

10-
# Getting Started
10+
## Getting Started
1111

1212
If you have not already installed the Riverscapes Viewer, you can do so by following the instructions on the [installation page](/Deploy/install-qgis).
1313

1414
The Viewer consists of a toolbar and a project explorer panel. The toolbar contains buttons for opening projects and updating resources. The project explorer panel contains a tree view of the project layers. This is the main way for adding layers to the map.
1515

1616
![Riverscapes Viewer](/images/qviewer/qris_toolbar_map_project.png)
1717

18-
After you have installed the plugin, locate the toolbar in QGIS. If it is not visible then enable it from the **View > Toolbars** menu. Check the box next to the Riverscapes Viewer to make it visible.
18+
After you have installed the plugin, locate the toolbar in QGIS. If it is not visible then enable it from the **View > Toolbars** menu. Check the box next to the Riverscapes Viewer to make it visible.
1919

2020
The four buttons on the toolbar are (left to right):
2121

@@ -24,49 +24,49 @@ The four buttons on the toolbar are (left to right):
2424
1. Close all currently open projects within the project explorer dockable panel.
2525
1. Get information and help about the Riverscapes Viewer as well as [update resources](/software-help/help-qgis/#updating-resources) that come with the software.
2626

27-
# Open a Project
27+
## Open a Project
2828

2929
Click on the second button on the toolbar to open a riverscapes project. This will open a file dialog where you can select a project file. The project file is a `*.rs.xml` file that defines the project layers.
3030

3131
After the selecting file, the project will be loaded into the Riverscapes Viewer Project Explorer panel. If the project type possesses a default project view it will be loaded into the map.
3232

33-
## Adding Layers to the Map
33+
### Adding Layers to the Map
3434

3535
To add layers to the map, simply double click them in the project explorer panel. They will be added to the map in a structure that reflects the project explorer panel (and is defined in the [business logic](/technical-reference/business-logic) for this project type).
3636

3737
Right click on any layer in the tree and choose "View Layer Metadata" to show information stored in the project about the chosen layer in the metadata panel.
3838

39-
## Metadata Panel
39+
### Metadata Panel
4040

4141
The metadata panel displays information about the project, including the Model Version, Date Created, and id, or about individual layers
4242

4343
![layer metadata in metadata panel](/images/qviewer/qris_layer_metadata.png).
4444

45-
## Adding Base Layers to the Map
45+
### Adding Base Layers to the Map
4646

4747
The Riverscapes Viewer comes with a set of base layers that can be added to the map. Expand the basemap node in the project explorer panel and double click the layer you want to add to the map.
4848

49-
# Project Views
49+
## Project Views
5050

5151
Project views are predefined, curated views that can be added to the map with a single click. They allow for quickly adding the more popular ways of viewing a specific project type. Project views are defined in the [business logic](/technical-reference/business-logic) for the project type.
5252

53-
# Options
53+
## Settings
5454

55-
The Riverscapes Viewer has a few options that can be set in the options dialog. To open the options dialog, click on the options button in the toolbar.
55+
The Riverscapes Viewer has a few options that can be set in the Settings dialog. To open the options dialog, from the Riverscapes toolbar choose `Tools → Settings`.
5656

57-
![options](/images/qviewer/qris_options.png)
57+
![Settings menu](/images/qviewer/qviewer_settings_menu_v1.0.5.windows.png)
5858

5959
- You can choose to include or exclude basemaps from the project explorer panel.
60-
- You can choose a region for certain basemaps. Currently the region options are "United States" and "New Zealand".
60+
- You can choose a region for certain basemaps. Currently the region options are "United States" and "New Zealand".
6161
- You can choose to automatically update resources when the Riverscapes Viewer is first loaded.
6262
- You can choose to enable or disable opening of the default project view when a project is opened.
6363

64-
# Updating resources
64+
## Updating resources
6565

66-
You can update the [business logic](/technical-reference/business-logic) and [symbology](/technical-reference/symbology/) for the Riverscapes Viewer by clicking on the update resources button in the toolbar. This will download the latest versions of these resources and place them on your computer in the correct location.
66+
You can update the [business logic](/technical-reference/business-logic) and [symbology](/technical-reference/symbology/) for the Riverscapes Viewer by choosing `Tools → Update resources` from the toolbar. This will download the latest versions of these resources and place them on your computer in the correct location.
6767

68-
Simply click on the Riverscapes Viewer Help menu and choose "Updates Resources". This operation will report the number of successfully updated files in the QGIS message panel.
68+
This operation will report the number of successfully updated files in the QGIS message panel.
6969

70-
# Uploading Projects
70+
## Uploading Projects
7171

7272
You can upload projects to the [Riverscapes Data Exchange](https://data.riverscapes.net) by following the instructions on the [Uploading Projects](/software-help/help-qgis-uploader) page.

docs/docs/tutorials/riverscapes-project-data-exchnage.mdx renamed to docs/docs/tutorials/riverscapes-project-data-exchange.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: A guide to uploading riverscapes projects to Data Exchanges
44
sidebar_position: 2
55
---
66

7-
As of version [0.9.2](https://github.com/Riverscapes/QRAVEPlugin/releases/tag/untagged-e750a6a0ddd07492d89d) of [Q-Viewer](https://viewer.riverscapes.net/software-help/help-qgis/), you can upload projects to the Data Exchange. Check out the [Uploading Projects documentation here](https://viewer.riverscapes.net/software-help/help-qgis-uploader/).
7+
Since version [0.9.2](https://github.com/Riverscapes/QRAVEPlugin/releases/tag/version_0.9.2) of [Q-Viewer](https://viewer.riverscapes.net/software-help/help-qgis/), you can upload projects to the Data Exchange. Check out the [Uploading Projects documentation here](https://viewer.riverscapes.net/software-help/help-qgis-uploader/).
88

99
In short, you right click on a project once you have it completed from the Viewer and access the Uploader:
1010

@@ -18,12 +18,12 @@ Here is a short video on its use:
1818

1919
<YouTubeEmbed videoId="Rs6RnAHAsNY" />
2020

21-
This [feature](https://viewer.riverscapes.net/software-help/help-qgis-uploader/) provides a simple user interface to augment the command line `rscli` interface that also allows upload (as well as download).
21+
This [feature](https://viewer.riverscapes.net/software-help/help-qgis-uploader/) provides a simple user interface to augment the command line `rscli` interface that also allows upload (as well as download).
2222

2323
### Why are layers not showing up in WebViewer - Tiling
2424

2525
As soon as a Riverscapes Project is successfully uploaded to the Data Exchange, we make it available for download. However, it takes time for the exchange to generate web tiles of all the layer views of that project and make them visible in Web Viewer. Depending on how many new projects have been uploaded recently, this can take hours, days or even a week or more.
2626

27-
Don't be alarmed, the project is there and you can download it and view the project in the ArcViewer or QViewer locally on your machine. The web view just takes some time.
27+
Don't be alarmed, the project is there and you can download it and view the project in the ArcViewer or QViewer locally on your machine. The web view just takes some time.
2828

29-
![queued tiling](/images/tutorials-how-to/Queued-Tiling.png)
29+
![queued tiling](/images/tutorials-how-to/Queued-Tiling.png)

docs/docusaurus.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ const config: Config = {
3838
sidebarPath: './sidebars.ts', // Path to sidebar config
3939
routeBasePath: '/', // Serve docs at site root
4040
editUrl: 'https://github.com/Riverscapes/RaveAddIn/tree/master/docs/', // "Edit this page" link
41+
showLastUpdateTime: true,
4142
},
4243
} satisfies Preset.Options,
4344
],
-3.86 KB
Binary file not shown.
-5.28 KB
Binary file not shown.
18.6 KB
Loading
22.5 KB
Loading

readme.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ This repository hosts the documentation for viewer.riverscapes.net.
66

77
Read about [Contributing to Riverscapes Documentation, on docs.riverscapes.net](docs.riverscapes.net/get-involved/documentation).
88

9+
### Development server
10+
11+
To run the server locally, open the Docs code-workspace, and then execute these terminal commands:
12+
13+
```sh
14+
yarn install
15+
yarn start
16+
```
17+
918
## Riverscapes Analysis and Explorer AddIn
1019

1120
This repository contains the source code for the Riverscapes Viewer Addin for ArcGIS, formerly known as Riverscapes Analysis Viewer and Explorer (RAVE). The code is written in C# using Visual Studio 2015 and consists of several code projects within a single solution:

0 commit comments

Comments
 (0)