Skip to content

Commit d4143e5

Browse files
committed
Drop the 2 from QWC2
1 parent b631e42 commit d4143e5

19 files changed

+120
-120
lines changed

Diff for: src/QuickStart.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Quick start
22

3-
## Running QWC2 as part of qwc-services
3+
## Running QWC as part of qwc-services
44

5-
`qwc-services` is a collection of loosely coupled micro-services for extending QWC2. The services communicate with each other via HTTP/Rest, and are mostly written in Python.
5+
`qwc-services` is a collection of loosely coupled micro-services for extending QWC. The services communicate with each other via HTTP/Rest, and are mostly written in Python.
66

77
The easiest way to run `qwc-services` is to use the readily available docker images, using the sample setup at [qwc-docker](https://github.com/qwc-services/qwc-docker).
88

@@ -57,11 +57,11 @@ Next steps:
5757
- [Configuring the services](configuration/../configuration/ServiceConfiguration.md)
5858
- [Set resource permissions](configuration/ResourcesPermissions.md)
5959

60-
## Running QWC2 as a standalone viewer
60+
## Running QWC as a standalone viewer
6161

62-
If you don't need the advanced functionalities provided by `qwc-services` or want to integrate QWC2 in another environment, you can run QWC2 as a standalone viewer.
62+
If you don't need the advanced functionalities provided by `qwc-services` or want to integrate QWC in another environment, you can run QWC as a standalone viewer.
6363

64-
To work with QWC2, you will need a minimal development environment consisting of [git](https://git-scm.com/), [node](https://nodejs.org/) and [yarn](https://yarnpkg.com). You will also need a running QGIS Server instance which serves your projects.
64+
To work with QWC, you will need a minimal development environment consisting of [git](https://git-scm.com/), [node](https://nodejs.org/) and [yarn](https://yarnpkg.com). You will also need a running QGIS Server instance which serves your projects.
6565

6666
The fastest way to get started is by cloning the stock application:
6767
```bash

Diff for: src/UserGuide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# User guide
22

3-
This section contains user documentation of the QWC2 application and QWC services. It describes **some** of the available features.
3+
This section contains user documentation of the QWC application and QWC services. It describes **some** of the available features.
44

55
*Note*: Depending on the specific viewer configuration, some functionalities might be missing or different than described in this section.
66

Diff for: src/configuration/ResourcesPermissions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ For more detailed [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_
4040

4141
The `viewer_task` resource defines viewer functionalities (e.g. printing or raster export) that can be restricted or permitted.
4242
Their `name` (e.g. `RasterExport`) will be matched against:
43-
- The `key` in `menuItems` and `toolbarItems` in the QWC2 `config.json`.
43+
- The `key` in `menuItems` and `toolbarItems` in the QWC `config.json`.
4444
- The `name` of a plugin entry in `config.json`.
4545
- The `task` configuration property of a `TaskButton` plugin entry in `config.json`
4646

@@ -50,7 +50,7 @@ The `FeatureInfo service`, `FeatureInfo layer` and subordinate `Attribute` resou
5050

5151
Restricted viewer task items are then removed from the menu and toolbar in the map viewer. Viewer tasks not explicitly added as resources are kept unchanged from the `config.json`.
5252

53-
*Note*: The resource types, i.e. for custom QWC2 plugins, can be extended by inserting new types into the `qwc_config.resource_types` table.
53+
*Note*: The resource types, i.e. for custom QWC plugins, can be extended by inserting new types into the `qwc_config.resource_types` table.
5454
These can be queried, e.g. in a custom service, by using `PermissionClient::resource_permissions()` or
5555
`PermissionClient::resource_restrictions()` from [QWC Services Core](https://github.com/qwc-services/qwc-services-core).
5656

Diff for: src/configuration/ServiceConfiguration.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The architecture of `qwc-services` is as follows:
66

77
- API-Gateway: API Gateway, forwards requests to individual services <http://localhost:8088>
88
- Auth-Service: Authentication service with local user database (default users: admin:admin, demo:demo) <http://localhost:8088/auth/login>
9-
- Map viewer: QWC2 map viewer <http://localhost:8088>
9+
- Map viewer: QWC map viewer <http://localhost:8088>
1010
- OGC Service: Proxy for WMS/WFS requests filtered by permissions, calls QGIS Server <http://localhost:8088/ows/api>
1111
- Admin GUI: Admin GUI <http://localhost:8088/qwc_admin/>
1212

@@ -18,24 +18,24 @@ Following is an overview of existing `qwc-services`:
1818

1919
**Applications**:
2020

21-
* [QWC2 Map Viewer](https://github.com/qwc-services/qwc-map-viewer): The map viewer application
21+
* [QWC Map Viewer](https://github.com/qwc-services/qwc-map-viewer): The map viewer application
2222
* [QWC Admin GUI](https://github.com/qwc-services/qwc-admin-gui): Configuration backend for managing users and permissions
2323
* [Registration GUI](https://github.com/qwc-services/qwc-registration-gui): GUI for registration of new users
2424

2525
**REST services**:
2626

2727
* [DB auth service](https://github.com/qwc-services/qwc-db-auth): Authentication service with local user database
2828
* [LDAP auth service](https://github.com/qwc-services/qwc-ldap-auth): LDAP Authentication service
29-
* [Data service](https://github.com/qwc-services/qwc-data-service): Data edit service, required for QWC2 editing functionality
29+
* [Data service](https://github.com/qwc-services/qwc-data-service): Data edit service, required for QWC editing functionality
3030
* [Document service](https://github.com/qwc-services/qwc-document-service): Service for generating Jasper reports
31-
* [Elevation service](https://github.com/qwc-services/qwc-elevation-service): Service for providing elevation data, required for QWC2 elevation profile
32-
* [Feature info service](https://github.com/qwc-services/qwc-feature-info-service): Service for providing enhanced GetFeatureInfo responses to QWC2
33-
* [Fulltext search service](https://github.com/qwc-services/qwc-fulltext-search-service): Fulltext search service for the QWC2 search functionality
34-
* [Legend service](https://github.com/qwc-services/qwc-legend-service): Service for providing enhanced legend graphics to QWC2
35-
* [Mapinfo service](https://github.com/qwc-services/qwc-mapinfo-service): Service for providing additional information to the QWC2 right-click map context popup
31+
* [Elevation service](https://github.com/qwc-services/qwc-elevation-service): Service for providing elevation data, required for QWC elevation profile
32+
* [Feature info service](https://github.com/qwc-services/qwc-feature-info-service): Service for providing enhanced GetFeatureInfo responses to QWC
33+
* [Fulltext search service](https://github.com/qwc-services/qwc-fulltext-search-service): Fulltext search service for the QWC search functionality
34+
* [Legend service](https://github.com/qwc-services/qwc-legend-service): Service for providing enhanced legend graphics to QWC
35+
* [Mapinfo service](https://github.com/qwc-services/qwc-mapinfo-service): Service for providing additional information to the QWC right-click map context popup
3636
* [OGC service](https://github.com/qwc-services/qwc-ogc-service): Proxy for WMS/WFS requests filtered by permissions, calls QGIS Server
37-
* [Permalink service](https://github.com/qwc-services/qwc-permalink-service): Service for storing compat permalinks and bookmarks generated by QWC2
38-
* [Print service](https://github.com/qwc-services/qwc-print-service): Service for enhancing the QWC2 GetPrint requests
37+
* [Permalink service](https://github.com/qwc-services/qwc-permalink-service): Service for storing compat permalinks and bookmarks generated by QWC
38+
* [Print service](https://github.com/qwc-services/qwc-print-service): Service for enhancing the QWC GetPrint requests
3939

4040
**Configuration database**:
4141

@@ -53,10 +53,10 @@ The layout of the `qwc-docker` tree is as follows:
5353
|-------------------------------|---------------------------------------------------------------------|
5454
|`├─ api-gateway/nginx.conf` | API gateway configuration. |
5555
|`├─ volumes/` | Contains folders which are mounted into the various containers. |
56-
|`│ ├─ attachments` | Storage of files uploaded through the QWC2 editing functionality. |
56+
|`│ ├─ attachments` | Storage of files uploaded through the QWC editing functionality. |
5757
|`│ ├─ config/<tenant>/` | Service configuration files, generated by `qwc-config-generator`. |
5858
|`│ ├─ config-in/<tenant>/` | Input configuration files, processed by the `qwc-config-generator`. |
59-
|`│ │ ├─ config.json` | Master configuration for the QWC2 viewer. |
59+
|`│ │ ├─ config.json` | Master configuration for the QWC viewer. |
6060
|`│ │ ├─ index.html` | Viewer entry point. |
6161
|`│ │ ├─ themesConfig.json` | Themes configuration. |
6262
|`│ │ └─ tenantConfig.json` | Master configuration file for qwc services. |
@@ -65,7 +65,7 @@ The layout of the `qwc-docker` tree is as follows:
6565
|`│ ├─ jasper-reports/` | Jasper reports (see `qwc-document-service`). |
6666
|`│ ├─ legends/` | Custom legend images (see `qwc-legend-service`). |
6767
|`│ ├─ qgs-resources/` | QGIS projects and data referenced by the projects. |
68-
|`│ ├─ qwc2/` | QWC2 Viewer. |
68+
|`│ ├─ qwc2/` | QWC Viewer. |
6969
|`│ └─ solr/` | Fulltext search index. |
7070
|`├─ docker-compose.yml` | Container configuration file. |
7171
|`├─ pg_service.conf` | Database service definitions. |

Diff for: src/configuration/ThemesConfiguration.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ A theme corresponds to a QGIS project, published as WMS and served by QGIS Serve
55
The basic steps for configuring a theme are:
66

77
- [Create a QGIS project and deploy it to QGIS Server](#create-qgis-project)
8-
- [Writing the QWC2 theme configuration](#writing-themes-configuration)
8+
- [Writing the QWC theme configuration](#writing-themes-configuration)
99
- [Generating the themes configuration](#generating-themes-configuration)
1010

1111
## Creating and publishing a QGIS project<a name="create-qgis-project"></a>
1212

13-
The first step is to prepare a QGIS project for publishing. Besides the common tasks of adding and styling layers, the following table gives an overview of settings which influence how the theme is displayed in QWC2:
13+
The first step is to prepare a QGIS project for publishing. Besides the common tasks of adding and styling layers, the following table gives an overview of settings which influence how the theme is displayed in QWC:
1414

1515
| What | Where | Description |
1616
|----------------------|-------------------------------------------|--------------------------------------------------|
@@ -27,7 +27,7 @@ The first step is to prepare a QGIS project for publishing. Besides the common t
2727
| Rendering order | Layer Order Panel or Layers Panel | Rendering order of the layers. If layer re-ordering is enabled in `config.json`, the order from the Layer Order Panel is ignored. |
2828
| Print layouts | Layout manager | The print layouts offered in the Print plugin. |
2929
| Print layout labels | Layout manager | Print layout labels with an ID will be exposed in the Print plugin. Note: a label ID starting with `__` will not be exposed. |
30-
| Attribute form | Vector Layer Properties &rarr; Attributes Form | The configured attribute form will be displayed when editing in QWC2. |
30+
| Attribute form | Vector Layer Properties &rarr; Attributes Form | The configured attribute form will be displayed when editing in QWC. |
3131
| External layers | Layer Properties &rarr; QGIS Server &rarr; Data URL | Mark the layer as an external layer to avoid cascaded requests. See [Configuring external layers](#external-layers). |
3232

3333
Then, store the project in the publishing directory of your QGIS Server instance. When using `qwc-docker`, store the project as `*.qgs` below `qwc-docker/volumes/qgs-resources`.
@@ -52,7 +52,7 @@ sslmode=disable
5252

5353
## Configuring the themes in `themesConfig.json` <a name="writing-themes-configuration"></a>
5454

55-
The next step is to configure the theme for QWC2. There are two approaches:
55+
The next step is to configure the theme for QWC. There are two approaches:
5656

5757
- [Automatic theme configuration](#automatic-theme-configuration) (only when using `qwc-docker`): Just copy the project file to the designated location and the `qwc-config-generator` will automatically generate a theme configuration using default parameters.
5858
- [Manual theme configuration](#manual-theme-configuration): Manually configure a theme with the full set of configuration options.
@@ -75,7 +75,7 @@ To use a custom thumbnail for an automatically configured theme, place a an imag
7575

7676
The theme configuration file is located as follows:
7777

78-
- Standalone viewer: `qwc2-app/static/themesConfig.json`
78+
- Standalone viewer: `qwc-app/static/themesConfig.json`
7979
- `qwc-docker`: `qwc-docker/volumes/config-in/<tentant>/themesConfig.json`
8080

8181
*Note*: when using `qwc-docker`, the themes configuration may also be embedded as `themesConfig` directly in `qwc-docker/volumes/config-in/<tentant>/tenantConfig.json`.
@@ -198,7 +198,7 @@ The format of the theme definitions is as follows:
198198
| `"extraLegendParameters": "<&KEY=VALUE>",` | Optional, [additional query parameters](https://docs.qgis.org/latest/en/docs/server_manual/services/wms.html#getlegendgraphics) to append to GetLegendGraphic request. |
199199
| `"extraDxfParameters": "<&KEY=VALUE>",` | Optional, [additional query parameters](https://docs.qgis.org/latest/en/docs/server_manual/services/wms.html?highlight=dxf#format-options) to append to DXF export request. |
200200
| `"extraPrintParameters": "<&KEY=VALUE>",` | Optional, additional query parameters to append to GetPrint request (requires QGIS Server >= 3.32.0). |
201-
| `"extraPrintLayers": ["<layername>", ...],` | Optional, extra list of layers to mark as internal print layers, i.e. which are omitted from the QWC2 LayerTree. |
201+
| `"extraPrintLayers": ["<layername>", ...],` | Optional, extra list of layers to mark as internal print layers, i.e. which are omitted from the QWC LayerTree. |
202202
| `"printLabelBlacklist": ["<LabelId>", ...]` | Optional, list of composer label ids to not expose in the print dialog. |
203203
| `"editConfig": {<editConfig>} ` | Optional, object containing the editing configuration for the theme, see [Editing](../topics/Editing.md#edit-config). |
204204
| `"snapping": {...},` | Optional, snapping configuration, see [Snapping](../topics/Snapping.md). |
@@ -239,7 +239,7 @@ A bare minimum theme entry might look as follows:
239239

240240
### External layers <a name="external-layers"></a>
241241

242-
External layers can be used to selectively replace layers in a QGIS project with a layer from an external source, for instance in the case of a WMS layer embedded in a QGIS project, to avoid cascading WMS requests. They are handled transparently by QWC2 (they are positioned in the layer tree identically to the internal layer they replace), but the `GetMap` and `GetFeatureInfo` requests are sent directly to the specified WMS Service.
242+
External layers can be used to selectively replace layers in a QGIS project with a layer from an external source, for instance in the case of a WMS layer embedded in a QGIS project, to avoid cascading WMS requests. They are handled transparently by QWC (they are positioned in the layer tree identically to the internal layer they replace), but the `GetMap` and `GetFeatureInfo` requests are sent directly to the specified WMS Service.
243243

244244
**Configuring external layers via Data Url**
245245

@@ -465,11 +465,11 @@ Instead of specifiying a full background layer definition in a group, you can al
465465

466466
## Generating the themes configuration <a name="generating-theme-configuration"></a>
467467

468-
The file ultimately read by the QWC2 viewer is the `themes.json` configuration, which includes the contents of `themesConfig.json` completed with additional data obtained from the QGIS Project.
468+
The file ultimately read by the QWC viewer is the `themes.json` configuration, which includes the contents of `themesConfig.json` completed with additional data obtained from the QGIS Project.
469469

470470
* When using `qwc-docker`, you can generate the themes from the `qwc-admin-gui` administration backend, running on <http://localhost:8088/qwc_admin> by default. Log in as `admin` user, then press the green `Generate service configuration` button. This will invoce the`qwc-config-generator`, which will generate `mapViewerConfig.json` located below `qwc-docker/volumes/config/<tentant>`. You can then inspect the generated `themes.json` at <http://localhost:8088/themes.json>.
471471

472-
* When using QWC2 as a standalone viewer, the `themes.json` can be generated by invoking
472+
* When using QWC as a standalone viewer, the `themes.json` can be generated by invoking
473473
```bash
474474
yarn run themesconfig
475475
```
@@ -499,7 +499,7 @@ You can configure `qwc-docker` to look for `qgz` project files instead of `qgs`
499499

500500
## Split categorized layers
501501

502-
By default, symbol categories of a [classified](https://docs.qgis.org/latest/en/docs/training_manual/vector_classification/classification.html) layer won't be exposed via WMS and hence in QWC2.
502+
By default, symbol categories of a [classified](https://docs.qgis.org/latest/en/docs/training_manual/vector_classification/classification.html) layer won't be exposed via WMS and hence in QWC.
503503

504504
To expose symbol categories as separate layers via WMS, you can use the [split_categorized](https://github.com/qwc-services/qwc-qgis-server-plugins/tree/main/split_categorized) QGIS Server plugin.
505505

0 commit comments

Comments
 (0)