You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/QuickStart.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -63,13 +63,13 @@ If you don't need the advanced functionalities provided by `qwc-services` or wan
63
63
64
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.
65
65
66
-
The fastest way to get started is by cloning the demo application:
66
+
The fastest way to get started is by cloning the stock application:
*Note*: when using `qwc-docker`, the themes configuration may also be embedded as `themesConfig` directly in `qwc-docker/volumes/config-in/<tentant>/tenantConfig.json`.
@@ -126,7 +126,7 @@ The `themesConfig.json` file contains a list of themes, optionally organized in
126
126
127
127
Refer to [External layers](#external-layers), [Theme info links](#theme-info-links), [Plugin data](#plugin-data) and [Background layers](#background-layers) for the format of the respective definitions.
128
128
129
-
Refer to the [sample `themesConfig.json`](https://github.com/qgis/qwc2-demo-app/blob/master/themesConfig.json) for a complete example.
129
+
Refer to the [sample `themesConfig.json`](https://github.com/qwc-services/qwc-docker/blob/master/volumes/config-in/default/themesConfig.json) for a complete example.
130
130
131
131
The format of the theme definitions is as follows:
132
132
<!-- Important: Use U+00A0 non-breaking spaces ( ) in code blocks -->
Copy file name to clipboardExpand all lines: src/configuration/ViewerConfiguration.md
+23-26Lines changed: 23 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ First of all, it is important to keep in mind that the QWC2 Viewer is designed t
8
8
-[Customizing the assets](#viewer-asset): specify additional search providers, customize the color schemes, etc...
9
9
-[Compiling a custom viewer](#custom-viewer): configure which components which are built into the application, add own plugins, etc...
10
10
11
-
The `qwc2-demo-app`(and the `qwc-map-viewer-demo` docker image) serve as a good starting point, and for simple viewers the load-time configuration options are often sufficient to avoid the need of building a customized application.
11
+
The `qwc2` stock application (and the `qwc-map-viewer` docker image) serve as a good starting point, and for simple viewers the load-time configuration options are often sufficient to avoid the need of building a customized application.
Refer to the [sample `config.json`](https://github.com/qgis/qwc2-demo-app/blob/master/static/config.json) for a concrete example.
20
+
Refer to the [sample `config.json`](https://github.com/qgis/qwc2/blob/master/static/config.json) for a concrete example.
21
21
22
22
### Global settings
23
23
@@ -245,11 +245,11 @@ Furthermore, the application entry point `index.html` is located as follows:
245
245
This file noteably specifies the application title, and references many of the assets located below the `assets` folder.
246
246
247
247
### Customizing the color scheme
248
-
The QWC2 color scheme is fully customizeable via CSS. A default color-scheme is built-in (see [DefaultColorScheme.css](https://github.com/qgis/qwc2/blob/master/components/style/DefaultColorScheme.css)). To define a custom color scheme, copy the default color scheme to `assets/css/colorschemes.css`, add an appropriate class name to the `:root` selector, and modify the colors as desided. Two additional examples (`highcontrast` and `dark`) are provided by default in[`assets/css/colorschemes.css`](https://github.com/qgis/qwc2-demo-app/blob/master/static/assets/css/colorschemes.css).
248
+
The QWC2 color scheme is fully customizeable via CSS. A default color-scheme is built-in (see [DefaultColorScheme.css](https://github.com/qgis/qwc2/blob/master/components/style/DefaultColorScheme.css)). To define a custom color scheme, copy the default color scheme to `assets/css/colorschemes.css`, add an appropriate class name to the `:root` selector, and modify the colors as desided. Two additional examples (`highcontrast` and `dark`) are provided by default in[`assets/css/colorschemes.css`](https://github.com/qgis/qwc2/blob/master/static/assets/css/colorschemes.css).
249
249
250
250
You can then modify the color scheme which is applied by default by setting `defaultColorScheme` in `config.json` to an appropriate class name (i.e. `highcontrast` or `dark`).
251
251
252
-
To change the color scheme at runtime in QWC2, make sure the `Settings` plugin is enabled, and in the `Settings` plugin configuration block in `config.json` list the color schemes below `colorSchemes`. Refer to the [sample `config.json`](https://github.com/qgis/qwc2-demo-app/blob/master/static/config.json).
252
+
To change the color scheme at runtime in QWC2, make sure the `Settings` plugin is enabled, and in the `Settings` plugin configuration block in `config.json` list the color schemes below `colorSchemes`. Refer to the [sample `config.json`](https://github.com/qgis/qwc2/blob/master/static/config.json).
253
253
254
254
*Note*: When changing the color scheme via Settings dialog in QWC2, the picked color scheme is stored in the browser local storage, and this setting will override the `defaultColorScheme` setting from `config.json`. Specifying the `style` URL-parameter (see [URL parameters](../topics/Interfacing.md#url-parameters)) will take precedence over all other settings.
255
255
@@ -288,10 +288,7 @@ The legend print template `assets/templates/legendprint.html` is used when print
288
288
289
289
## Building a custom viewer <aname="custom-viewer"></a>
290
290
291
-
QWC2 is divided into two repositories:
292
-
293
-
- The QWC2 components, hosted at [https://github.com/qgis/qwc2/](https://github.com/qgis/qwc2/). This repository contains the core building blocks common to all QWC2 applications.
294
-
- The QWC2 application, the demo application is hosted at [https://github.com/qgis/qwc2-demo-app](https://github.com/qgis/qwc2-demo-app).
291
+
The QWC2 stock application, hosted at [https://github.com/qgis/qwc2/](https://github.com/qgis/qwc2/), can serve as a base for building a custom application. An example of a custom application is hosted at [https://github.com/qgis/qwc2-demo-app](https://github.com/qgis/qwc2-demo-app).
295
292
296
293
To build a custom viewer, the first step is cloning the demo application:
@@ -401,7 +398,7 @@ When adding or modifying translations at QWC2 components level, please contribut
401
398
402
399
### Selectively overriding translation strings
403
400
404
-
Occasionally, it is desireable to selectively override specific translation strings. While one can modify the full translation file as described above, especially when using the `qwc-map-viewer-demo` docker image, it is easier to just selectively override the desired translation strings and leave the original file unchanged and avoid having to compile a custom viewer (or overwriting the entire file with a docker volume mount).
401
+
Occasionally, it is desireable to selectively override specific translation strings. While one can modify the full translation file as described above, especially when using the `qwc-map-viewer` docker image, it is easier to just selectively override the desired translation strings and leave the original file unchanged and avoid having to compile a custom viewer (or overwriting the entire file with a docker volume mount).
405
402
406
403
To do this:
407
404
@@ -421,11 +418,11 @@ To do this:
421
418
* Place this file inside the `translations` folder of your production build. When using `qwc-docker`, you can place this file in `qwc-docker/volumes/qwc2/translations/` and mount this file inside the container, i.e. :
When no translation exists for the requested language (i.e. the current browser language), QWC2 will fall back to the default translation specified as `defaultLocaleData` in `qwc2-app/js/appConfig.js`. For the demo viewer, the default fallback translation is `en-US`.
428
+
When no translation exists for the requested language (i.e. the current browser language), QWC2 will fall back to the default translation specified as `defaultLocaleData` in `qwc2-app/js/appConfig.js`. For the stock application, the default fallback translation is `en-US`.
Copy file name to clipboardExpand all lines: src/release_notes/QwcDockerUpgradeNotes.md
+10Lines changed: 10 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,13 @@
1
+
# Updating to qwc-map-viewer-demo-v2025.03.06
2
+
3
+
The `qwc-map-viewer-demo` images have been replaced by the `qwc-map-viewer` images (without the `-demo` suffix). Reference this image instead in your `docker-compose.yml`:
# Updating to qwc-permalink-service-v2024.12.14 \[2024-lts → 2025-lts\]
2
12
3
13
When updating to `qwc-permalink-service-v2024.12.14`, make sure to also update to `qwc-config-db-migrate-v2024.12.14` to update the schema of the `user_bookmarks` table. The bookmarks are now stored by user id instead of username.
Copy file name to clipboardExpand all lines: src/topics/Search.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -172,11 +172,11 @@ searchProviders: [
172
172
]
173
173
...
174
174
```
175
-
Note: The `qwc2-demo-app`(also used by the `qwc-map-viewer-demo` docker image) includes four providers by default: `coordinates`, `nominatim` (OpenStreetMap location search), `qgis` (see <ahref="#qgis-search">below</a>) and `fulltext` (see <ahref="#fulltext-search">below</a>).
175
+
Note: The `qwc2` stock application (also used by the `qwc-map-viewer` docker image) includes four providers by default: `coordinates`, `nominatim` (OpenStreetMap location search), `qgis` (see <ahref="#qgis-search">below</a>) and `fulltext` (see <ahref="#fulltext-search">below</a>).
176
176
177
177
## Configuring the QGIS feature search <aname="qgis-search"></a>
178
178
179
-
The QGIS feature search relies on WMS GetFeatureInfo with the [`FILTER`](https://docs.qgis.org/latest/en/docs/server_manual/services/wms.html#wms-filter) parameter to search features of layers which are part of the theme WMS. It is enabled via the `qgis` search provider, which is part of the `qwc2-demo-app`.
179
+
The QGIS feature search relies on WMS GetFeatureInfo with the [`FILTER`](https://docs.qgis.org/latest/en/docs/server_manual/services/wms.html#wms-filter) parameter to search features of layers which are part of the theme WMS. It is enabled via the `qgis` search provider, which is part of the `qwc2` stock application.
180
180
181
181
*Note*: Make sure the QGIS Project is configured to return geometries with the feature info responses (`Project`→`Properties`→`QGIS Server`→`Add geometry to feature response`).
Copy file name to clipboardExpand all lines: src/topics/Snapping.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Snapping
2
2
3
-
QWC2 ships a plugin for snapping support while drawing (redlining / measuring / editing). To enable it, make sure the `SnappingSupport` plugin is enabled in `appConfig.js` (see the sample [sample `js/appConfig.js`](https://github.com/qgis/qwc2-demo-app/blob/master/js/appConfig.js)). Then, for each theme for which you want snapping to be available, you can add a `snapping` block to your theme item in `themesConfig.json` as follows:
3
+
QWC2 ships a plugin for snapping support while drawing (redlining / measuring / editing). The plugin is enabled in the stock application. To enable it in a custom application, make sure the `SnappingSupport` plugin is enabled in `appConfig.js` (see the sample [sample `js/appConfig.js`](https://github.com/qgis/qwc2-demo-app/blob/master/js/appConfig.js)). Then, for each theme for which you want snapping to be available, you can add a `snapping` block to your theme item in `themesConfig.json` as follows:
0 commit comments