diff --git a/latest/.buildinfo b/latest/.buildinfo
index 8dfd631..2920557 100644
--- a/latest/.buildinfo
+++ b/latest/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f852d7ad4e9259dc5e03cbede53702b6
+config: 43fcd1518eb079fca107f5eea01413d0
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/latest/.doctrees/background.doctree b/latest/.doctrees/background.doctree
index cab8bf8..4c69545 100644
Binary files a/latest/.doctrees/background.doctree and b/latest/.doctrees/background.doctree differ
diff --git a/latest/.doctrees/bridge_dialog.doctree b/latest/.doctrees/bridge_dialog.doctree
index 4eab128..fa498fb 100644
Binary files a/latest/.doctrees/bridge_dialog.doctree and b/latest/.doctrees/bridge_dialog.doctree differ
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
index 55a9d9d..2e0c8bf 100644
Binary files a/latest/.doctrees/environment.pickle and b/latest/.doctrees/environment.pickle differ
diff --git a/latest/.doctrees/metadata_editing.doctree b/latest/.doctrees/metadata_editing.doctree
index 2530497..94b33ec 100644
Binary files a/latest/.doctrees/metadata_editing.doctree and b/latest/.doctrees/metadata_editing.doctree differ
diff --git a/latest/.doctrees/publish.doctree b/latest/.doctrees/publish.doctree
index 8ff839f..3d9c4c7 100644
Binary files a/latest/.doctrees/publish.doctree and b/latest/.doctrees/publish.doctree differ
diff --git a/latest/.doctrees/quickstart.doctree b/latest/.doctrees/quickstart.doctree
index 4770789..19dbedb 100644
Binary files a/latest/.doctrees/quickstart.doctree and b/latest/.doctrees/quickstart.doctree differ
diff --git a/latest/.doctrees/server_configuration.doctree b/latest/.doctrees/server_configuration.doctree
index 077d240..5609904 100644
Binary files a/latest/.doctrees/server_configuration.doctree and b/latest/.doctrees/server_configuration.doctree differ
diff --git a/latest/.doctrees/styleviewer.doctree b/latest/.doctrees/styleviewer.doctree
index d2f42bb..49d2066 100644
Binary files a/latest/.doctrees/styleviewer.doctree and b/latest/.doctrees/styleviewer.doctree differ
diff --git a/latest/_images/add.svg b/latest/_images/add.svg
new file mode 100644
index 0000000..cb54c49
--- /dev/null
+++ b/latest/_images/add.svg
@@ -0,0 +1,5 @@
+
+
\ No newline at end of file
diff --git a/latest/_images/attention.svg b/latest/_images/attention.svg
new file mode 100644
index 0000000..eabb104
--- /dev/null
+++ b/latest/_images/attention.svg
@@ -0,0 +1,4 @@
+
+
\ No newline at end of file
diff --git a/latest/_images/duplicate.svg b/latest/_images/duplicate.svg
new file mode 100644
index 0000000..3473545
--- /dev/null
+++ b/latest/_images/duplicate.svg
@@ -0,0 +1,5 @@
+
+
\ No newline at end of file
diff --git a/latest/_images/export.svg b/latest/_images/export.svg
new file mode 100644
index 0000000..1a1b028
--- /dev/null
+++ b/latest/_images/export.svg
@@ -0,0 +1,5 @@
+
+
diff --git a/latest/_images/first_time.png b/latest/_images/first_time.png
index b5ea921..43f332d 100644
Binary files a/latest/_images/first_time.png and b/latest/_images/first_time.png differ
diff --git a/latest/_images/import.svg b/latest/_images/import.svg
new file mode 100644
index 0000000..561fabb
--- /dev/null
+++ b/latest/_images/import.svg
@@ -0,0 +1,5 @@
+
+
diff --git a/latest/_images/manually_load_metadata.png b/latest/_images/manually_load_metadata.png
index a81fa89..bb02967 100644
Binary files a/latest/_images/manually_load_metadata.png and b/latest/_images/manually_load_metadata.png differ
diff --git a/latest/_images/preview.svg b/latest/_images/preview.svg
new file mode 100644
index 0000000..1dbe08c
--- /dev/null
+++ b/latest/_images/preview.svg
@@ -0,0 +1,4 @@
+
+
\ No newline at end of file
diff --git a/latest/_images/publish_layers_context_menu.png b/latest/_images/publish_layers_context_menu.png
index d362675..33f29e8 100644
Binary files a/latest/_images/publish_layers_context_menu.png and b/latest/_images/publish_layers_context_menu.png differ
diff --git a/latest/_images/publish_layers_list.png b/latest/_images/publish_layers_list.png
index a1ef2ac..a5d359f 100644
Binary files a/latest/_images/publish_layers_list.png and b/latest/_images/publish_layers_list.png differ
diff --git a/latest/_images/publish_layers_progress.png b/latest/_images/publish_layers_progress.png
index 884b888..3252a9f 100644
Binary files a/latest/_images/publish_layers_progress.png and b/latest/_images/publish_layers_progress.png differ
diff --git a/latest/_images/publish_layers_report.png b/latest/_images/publish_layers_report.png
index 6f39578..4bb8220 100644
Binary files a/latest/_images/publish_layers_report.png and b/latest/_images/publish_layers_report.png differ
diff --git a/latest/_images/publish_metadata.png b/latest/_images/publish_metadata.png
index 459994e..c04f692 100644
Binary files a/latest/_images/publish_metadata.png and b/latest/_images/publish_metadata.png differ
diff --git a/latest/_images/publish_section.png b/latest/_images/publish_section.png
index a51abb4..b52a7d0 100644
Binary files a/latest/_images/publish_section.png and b/latest/_images/publish_section.png differ
diff --git a/latest/_images/publish_workspace_warning.png b/latest/_images/publish_workspace_warning.png
index 4d69c26..036d7e8 100644
Binary files a/latest/_images/publish_workspace_warning.png and b/latest/_images/publish_workspace_warning.png differ
diff --git a/latest/_images/quickstart_authentication.png b/latest/_images/quickstart_authentication.png
index a8fe766..e653c89 100644
Binary files a/latest/_images/quickstart_authentication.png and b/latest/_images/quickstart_authentication.png differ
diff --git a/latest/_images/quickstart_newgeoserver.png b/latest/_images/quickstart_newgeoserver.png
index ab8857e..3bf421b 100644
Binary files a/latest/_images/quickstart_newgeoserver.png and b/latest/_images/quickstart_newgeoserver.png differ
diff --git a/latest/_images/quickstart_newserver.png b/latest/_images/quickstart_newserver.png
index d4c695f..644ce8d 100644
Binary files a/latest/_images/quickstart_newserver.png and b/latest/_images/quickstart_newserver.png differ
diff --git a/latest/_images/quickstart_publishexample.png b/latest/_images/quickstart_publishexample.png
index 9185ae1..a405df4 100644
Binary files a/latest/_images/quickstart_publishexample.png and b/latest/_images/quickstart_publishexample.png differ
diff --git a/latest/_images/quickstart_servers.png b/latest/_images/quickstart_servers.png
index 4af1f69..febd289 100644
Binary files a/latest/_images/quickstart_servers.png and b/latest/_images/quickstart_servers.png differ
diff --git a/latest/_images/quickstart_titleabstract.png b/latest/_images/quickstart_titleabstract.png
index f986234..5180d63 100644
Binary files a/latest/_images/quickstart_titleabstract.png and b/latest/_images/quickstart_titleabstract.png differ
diff --git a/latest/_images/remove.svg b/latest/_images/remove.svg
new file mode 100644
index 0000000..badefd6
--- /dev/null
+++ b/latest/_images/remove.svg
@@ -0,0 +1,5 @@
+
+
\ No newline at end of file
diff --git a/latest/_images/servers_geonetwork.png b/latest/_images/servers_geonetwork.png
index a2d2885..252ea70 100644
Binary files a/latest/_images/servers_geonetwork.png and b/latest/_images/servers_geonetwork.png differ
diff --git a/latest/_images/servers_geoserver.png b/latest/_images/servers_geoserver.png
index 69d3504..43e69a8 100644
Binary files a/latest/_images/servers_geoserver.png and b/latest/_images/servers_geoserver.png differ
diff --git a/latest/_images/servers_geoserver2.png b/latest/_images/servers_geoserver2.png
index bc407ee..c0d33eb 100644
Binary files a/latest/_images/servers_geoserver2.png and b/latest/_images/servers_geoserver2.png differ
diff --git a/latest/_images/servers_mapserver.png b/latest/_images/servers_mapserver.png
index 5d4d253..4d86d97 100644
Binary files a/latest/_images/servers_mapserver.png and b/latest/_images/servers_mapserver.png differ
diff --git a/latest/_images/servers_mapserver2.png b/latest/_images/servers_mapserver2.png
index 70dadcb..8482ef6 100644
Binary files a/latest/_images/servers_mapserver2.png and b/latest/_images/servers_mapserver2.png differ
diff --git a/latest/_images/servers_postgis.png b/latest/_images/servers_postgis.png
index bcb39eb..5e78bc0 100644
Binary files a/latest/_images/servers_postgis.png and b/latest/_images/servers_postgis.png differ
diff --git a/latest/_images/validate.svg b/latest/_images/validate.svg
new file mode 100644
index 0000000..124f5cf
--- /dev/null
+++ b/latest/_images/validate.svg
@@ -0,0 +1,4 @@
+
+
\ No newline at end of file
diff --git a/latest/_sources/background.rst.txt b/latest/_sources/background.rst.txt
index 7841f29..2aec81a 100644
--- a/latest/_sources/background.rst.txt
+++ b/latest/_sources/background.rst.txt
@@ -39,22 +39,24 @@ Originally developed in the mid-1990's at the University of Minnesota,
MapServer is released under an MIT-style license, and runs on all major
platforms (Windows, Linux, Mac OS X).
Mapserver services are defined by `Mapfiles `_,
-which can be generated by |short_name|.
+which can be generated by |short_name|, but support for it is limited.
`GeoNetwork `_ is a catalog for registering
-assets, such as spatial datasets. It contains a CatalogService for the Web (CSW)
+assets, such as spatial datasets. It contains a Catalog Service for the Web (CSW)
endpoint. GeoNetwork can operate on various metadata models via a plugin mechanism. It
supports ISO19115-3, ISO19139, ISO19110 and DCAT metadata standards. GeoNetwork
opensource software complies with the requirements of INSPIRE discovery services and metadata.
-`GeoStyler `_ is a JS library used in the `Shogun framework `_
-to create generic styles. GeoServer also has a `plugin `_
-that allows to style layers using GeoStyler. |short_name| does not make use of the GeoStyler library, but it does use the GeoStyler format
-internally as an intermediate format, which can be exported as a GeoStyler style file (JSON).
+`GeoStyler `_ is a NodeJS tool by Terrestris to create map styles.
+GeoServer also has a `plugin `_
+that allows users to style layers using GeoStyler. Although |short_name| does not make use of GeoStyler directly,
+it does use the Python-based `bridge-style `_ library, that utilizes
+GeoStyler JSON as an intermediate format before it converts it to various other formats (SLD, Mapfile, etc.).
`Mapbox Style `_ is a style format that defines the visual
appearance of vector tiles in the `Mapbox JavaScript API `_.
-|short_name| is able to generate a Mapbox style document.
+|short_name| is able to generate a Mapbox or `MapLibre `_ style document, but newer versions
+of both specifications may not be fully compatible anymore.
`PostGIS `_ is a spatial extension to the popular open source Postgres database.
|short_name| is able to export any local data to a remote (or local) PostGIS database, allowing it
diff --git a/latest/_sources/bridge_dialog.rst.txt b/latest/_sources/bridge_dialog.rst.txt
index ef2fb2c..696e0fe 100644
--- a/latest/_sources/bridge_dialog.rst.txt
+++ b/latest/_sources/bridge_dialog.rst.txt
@@ -2,24 +2,19 @@ The |short_name| Dialog
=======================
Most of the interaction with |app_name| is done through the |short_name| dialog.
-To open it, select the `Publish` button on the `Web toolbar` or look for it under the |menu_name| menu.
+To open it, select the `Bridge Publisher` button on the `Web toolbar` or look for it under the |menu_name| menu.
.. image:: ./img/bridgemenuentry.png
-The first time you open the |short_name| dialog, you will see a landing page with information about
-|short_name| and other |publisher| products. Follow the corresponding links to find out more about these
-products and how they can be used with |short_name|.
+The first time you open the |short_name| dialog, it should display the `About` panel that shows some information
+about your current |short_name| version, and contains some useful links.
.. image:: ./img/first_time.png
-
-.. tip:: At the bottom of the `About` panel, it should display the |app_name| version that you are currently running.
-
-
As you can see, there are 2 more panels besides the `About` panel mentioned above:
- Publish
-- Servers
+- Connections
We will have closer look at these panels on the following pages.
@@ -30,14 +25,15 @@ Logging and error handling
| This panel can be opened by clicking the "balloon" button in the lower-right corner of QGIS
or by checking the :guilabel:`View` > :guilabel:`Panels` > :guilabel:`Log Messages` item from the QGIS menu bar.
-| In some (rare) occasions, |short_name| might raise an exception. When this happens, a dialog pops up with a Python stack trace.
-| If the error re-occurs, please press the :guilabel:`Send Report` button, so that we're aware of the issue and can try fixing it.
+In some (rare) occasions, |short_name| might raise an exception. When this happens, a dialog pops up with a Python stack trace.
+If you keep experiencing the same error, please press the :guilabel:`Send Report` button. This will open your browser with a web form,
+where you can (optionally) describe the problem and send the error report to the |short_name| developers, so they are aware and can fix it.
Internationalization (i18n)
---------------------------
|app_name| is primarily targeted towards an international audience, which means that it has an English user interface.
-| However, some basic translations are available for the following languages:
+However, some basic translations are available for the following languages:
- Dutch (Nederlands)
- German (Deutsch)
@@ -45,3 +41,5 @@ Internationalization (i18n)
| The translations will be applied automatically based on the language settings of the user.
If no translation can be found for a certain text, the original text (English) will be displayed instead.
+
+If you would like to contribute to the translations, please join the |short_name| `Transifex project `_.
diff --git a/latest/_sources/metadata_editing.rst.txt b/latest/_sources/metadata_editing.rst.txt
index a166e3c..34f0be7 100644
--- a/latest/_sources/metadata_editing.rst.txt
+++ b/latest/_sources/metadata_editing.rst.txt
@@ -31,7 +31,9 @@ Preview metadata
To see a preview of the metadata of the selected layer, click the |previewmetadata| button.
-.. |previewmetadata| image:: ./img/preview_metadata_button.png
+.. |previewmetadata| image:: ../../geocatbridge/images/preview.svg
+ :height: 16 px
+ :width: 16 px
This will open a new dialog and render the metadata as a simple HTML webpage:
@@ -44,7 +46,9 @@ Metadata validation
|short_name| can use built-in QGIS validation tools and display the result of the metadata validation.
Click the |validatemetadata| button to validate your metadata.
-.. |validatemetadata| image:: ./img/validation.png
+.. |validatemetadata| image:: ../../geocatbridge/images/validate.svg
+ :height: 16 px
+ :width: 16 px
After validation a dialog with the results is displayed:
@@ -58,7 +62,9 @@ If your layer has metadata in ISO19139 or ESRI-ISO (ISO19115 or FGDC) format, an
| QGIS only has native support for its own `qmd` format. However, |short_name| is able to import the metadata.
| Select the layer in the |short_name| dialog and click the |loadmetadata| button.
-.. |loadmetadata| image:: ./img/loadmetadata.png
+.. |loadmetadata| image:: ../../geocatbridge/images/import.svg
+ :height: 16 px
+ :width: 16 px
| |short_name| will look in the folder where the layer file is stored and try to find a metadata file named either `[layer_filename].[extension].xml` or `[layer_filename].xml`.
| For example, for a layer data source named `countries.shp`, it will search for both `countries.shp.xml` and `countries.xml`.
diff --git a/latest/_sources/publish.rst.txt b/latest/_sources/publish.rst.txt
index cd59132..5206c1d 100644
--- a/latest/_sources/publish.rst.txt
+++ b/latest/_sources/publish.rst.txt
@@ -62,7 +62,7 @@ or specify the things you wish to export to a local file on the :guilabel:`Offli
When publishing online, you can publish your layers to a geodata server, their metadata to a metadata server, or both in one go.
Those servers must be selected from the two available drop-down lists in the :guilabel:`Online` tab.
-As mentioned before, these servers should be added beforehand in the :guilabel:`Servers` section of the |short_name| dialog,
+As mentioned before, these servers should be added beforehand in the :guilabel:`Connections` section of the |short_name| dialog,
as described in :ref:`ServerConnections`.
.. note:: If you are publishing layers to GeoServer, the destination workspace name will be taken from the
diff --git a/latest/_sources/quickstart.rst.txt b/latest/_sources/quickstart.rst.txt
index 8876b21..87c245c 100644
--- a/latest/_sources/quickstart.rst.txt
+++ b/latest/_sources/quickstart.rst.txt
@@ -1,6 +1,8 @@
Quickstart Tutorial
###################
+ .. |nbsp| unicode:: 0xA0
+
Once |app_name| has been :ref:`installed `, the first thing you might want to do is publish some layers!
This quickstart tutorial will walk you through the process of publishing a QGIS map layers to GeoServer.
@@ -24,18 +26,22 @@ Find and click the |short_name| button in the QGIS Web Toolbar:
The |short_name| dialog should now appear. First-time users may see the :guilabel:`About` panel, while others will
probably see the :guilabel:`Publish` panel instead.
-Step 2: go to servers panel
----------------------------
+Step 2: go to Connections panel
+-------------------------------
-Click on :guilabel:`Servers` in the left sidebar. If no servers have been configured so far, this should show the
+Click on :guilabel:`Connections` in the left sidebar. If no servers have been configured so far, this should show the
following panel:
.. image:: ./img/quickstart_servers.png
-Step 3: add new server
-----------------------
+Step 3: add new connection
+--------------------------
-Click the :guilabel:`New Server` button on the lower left corner of the :guilabel:`Servers` panel and select :guilabel:`GeoServer`:
+.. |addbutton| image:: ../../geocatbridge/images/add.svg
+ :height: 16 px
+ :width: 16 px
+
+Click the |addbutton| **Add...** button on the lower left corner of the :guilabel:`Connections` panel and select :guilabel:`GeoServer`:
.. image:: ./img/quickstart_newserver.png
@@ -71,7 +77,7 @@ Step 6: add new credentials
---------------------------
In order to actually establish a connection, we need to authenticate ourselves with GeoServer.
-To do that, add new :guilabel:`Credentials` by clicking the :guilabel:`+` button:
+To do that, add new :guilabel:`Credentials` by clicking the |addbutton| button:
.. image:: ./img/quickstart_addauth.png
@@ -80,7 +86,7 @@ If you have already set GeoServer credentials before, you may select the right o
Step 7: authentication details
------------------------------
-After you clicked the :guilabel:`+` button in the previous step, the *Authentication* dialog will pop up.
+After you clicked the |addbutton| button in the previous step, the *Authentication* dialog will pop up.
For the authentication mechanism, we will use *Basic authentication*. This is the default and works
well with GeoServer. It also is the only mechanism that |short_name| currently supports.
@@ -106,7 +112,7 @@ Step 9: save configuration
--------------------------
Save your GeoServer configuration by clicking the :guilabel:`Save` button in the lower right corner of the
-:guilabel:`Servers` panel.
+:guilabel:`Connections` panel.
You are now ready to publish some layers!
@@ -144,7 +150,7 @@ In the :guilabel:`Online` tab at the bottom of the :guilabel:`Publish` panel, se
.. image:: ./img/quickstart_setdataserver.png
-The :guilabel:`Data server` list should display all the names of the configurations that you created in the :guilabel:`Servers` panel.
+The :guilabel:`Data server` list should display all the names of the configurations that you created in the :guilabel:`Connections` panel.
If you just got started, then there will likely only be 1 item in this list.
Step 3: select layers
@@ -160,6 +166,8 @@ the layer name as shown in the QGIS Table of Contents is used.
.. image:: ./img/quickstart_titleabstract.png
+|nbsp|
+
.. tip:: If you have vector layers with lots of attributes, but you only need to publish a couple of these
fields, you can select the applicable layer and click on the :guilabel:`Attributes` tab.
Here you can uncheck all attributes that do *not* need to be published, which will save some storage
@@ -173,7 +181,9 @@ For this tutorial, we will simply go ahead and publish **all layers**. As noted
Click the :guilabel:`Publish` button in the lower right corner of the |short_name| dialog to start the publication process.
During this process, a progress dialog should appear:
- .. image:: ./img/quickstart_publishprogress.png
+ .. image:: ./img/publish_layers_progress.png
+
+|nbsp|
.. note:: For you (the user) it may seem that |short_name| does not treat *raster* layers differently from *vector* layers.
Under the hood however, |short_name| will **always** publish *raster* data to a file-based GeoServer datastore
@@ -185,10 +195,14 @@ Step 5: review results
Once the publish process has completed, a result dialog should appear:
- .. image:: ./img/quickstart_publishresult.png
+ .. image:: ./img/publish_layers_report.png
+
+.. |attnbutton| image:: ../../geocatbridge/images/attention.svg
+ :height: 16 px
+ :width: 16 px
If there are any errors or warnings, these are shown in the :guilabel:`Status` column of the published layer list.
-Click on the tiny :guilabel:`!` buttons to get more details about the issue(s).
+Click on the tiny |attnbutton| buttons to get more details about the issue(s).
If there are no issues, it should say *OK* next to each layer.
Close the result dialog once you finished reviewing.
@@ -209,7 +223,7 @@ If you wish to view a browser-based preview of the GeoServer WMS, you can right-
icon and choose either :guilabel:`View all WMS layers` to preview all layers (i.e. the entire map) in your
GeoServer workspace, or choose :guilabel:`View this WMS layer` to only preview the selected layer:
- .. image:: ./img/quickstart_wmspreview.png
+ .. image:: ./img/publish_layers_context_menu.png
The OpenLayers preview for all layers could for example look like this:
diff --git a/latest/_sources/server_configuration.rst.txt b/latest/_sources/server_configuration.rst.txt
index 1eab7bd..d925a30 100644
--- a/latest/_sources/server_configuration.rst.txt
+++ b/latest/_sources/server_configuration.rst.txt
@@ -4,15 +4,19 @@ Server Connections
==================
Before you can publish data with |app_name|, you will have to configure one or more server connections.
-This can be achieved in the *Servers* section of the |short_name| dialog:
+This can be achieved in the :guilabel:`Connections` section of the |short_name| dialog:
-.. image:: ./img/servers.png
+.. image:: ./img/quickstart_servers.png
Adding connections
##################
-Click :guilabel:`New Server` and choose one of the supported server types to create a new server connection:
+.. |addbutton| image:: ../../geocatbridge/images/add.svg
+ :height: 16 px
+ :width: 16 px
+
+Click |addbutton| **Add...** and choose one of the supported server types to create a new server connection:
- GeoServer
- MapServer
@@ -22,14 +26,30 @@ Click :guilabel:`New Server` and choose one of the supported server types to cre
| Fill in the required parameters and click the :guilabel:`Save` button to store the connection details.
| You can edit the parameters of a server at any given time. Just select the server connection in the left panel, and edit the fields you wish to change in the right panel.
-If you wish to remove a server connection, select it from the left panel and click the :guilabel:`Remove` button.
-The :guilabel:`Duplicate` button may come in handy if you wish to try out an alternative configuration based on an existing
+.. |removebutton| image:: ../../geocatbridge/images/remove.svg
+ :height: 16 px
+ :width: 16 px
+
+.. |duplicatebutton| image:: ../../geocatbridge/images/duplicate.svg
+ :height: 16 px
+ :width: 16 px
+
+If you wish to remove a server connection, select it from the left panel and click the |removebutton| **Remove** button.
+The |duplicatebutton| **Duplicate** button may come in handy if you wish to try out an alternative configuration based on an existing
server connection.
+.. |exportbutton| image:: ../../geocatbridge/images/export.svg
+ :height: 16 px
+ :width: 16 px
+
+.. |importbutton| image:: ../../geocatbridge/images/import.svg
+ :height: 16 px
+ :width: 16 px
+
| |short_name| will automatically store all server connections in the QGIS settings for later use.
-| However, sometimes you might want to backup or share all the configured server connections. The :guilabel:`Export` button will
+| However, sometimes you might want to backup or share all the configured server connections. The |exportbutton| **Export** button will
allow you to *save* a JSON file of the current configuration.
-| The :guilabel:`Import` button will do the opposite and *load* server connections from a JSON file. Note that the imported connections will be
+| The |importbutton| **Import** button will do the opposite and *load* server connections from a JSON file. Note that the imported connections will be
*added* to the list (i.e. no existing connections will be removed). |short_name| will append a numeric suffix to server connections
with a name that already exists.
@@ -77,42 +97,74 @@ after all layers were successfully published to GeoServer.
Click :guilabel:`Test Connection` to verify that the connection can be established.
-You should also specify how layer data will be stored on the server. Three different methods are available:
+You also need to specify how the layer data should be stored. Three different storage methods are available:
+
+1. `File-based storage`_
+2. `Import into PostGIS database (direct connect)`_ (vector layers only)
+3. `Import into PostGIS database (managed by GeoServer)`_ (vector layers only)
+
File-based storage
^^^^^^^^^^^^^^^^^^
-| The layer data is uploaded and stored as files in the GeoServer target workspace on the server.
+| The layer data is uploaded and stored as files in the GeoServer target workspace datastore.
| |short_name| prefers to upload vector data as GeoPackages and raster data as GeoTIFF files.
+This method is the most straight-forward and should always work, as there are no dependencies.
+However, depending on the size of the data, this method may be slower and could potentially fail due to network timeouts
+or server-side file upload size limitations.
+
.. _PostGISDirectOption:
Import into PostGIS database (direct connect)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-| The layer data is uploaded to tables in a PostGIS database directly (i.e. by |short_name|, see `PostGIS`_).
-| GeoServer will *not* handle the database upload, but merely establish a link to the database table in the created layer(s). This will require a direct PostGIS connection, which you can set up in the *Servers* section of |short_name| as well (see below).
-| Note that GeoServer should also have read access to that PostGIS connection.
+| The layer data is imported by |short_name| into a PostGIS database directly.
+| GeoServer will merely establish a link to the imported database table for the created layer(s). This will require a direct `PostGIS`_ connection, which you can set up in the *Connections* section of |short_name| as well (see below).
+| Note that GeoServer should also have read access to that same PostGIS connection.
+
+.. note:: | This method is only available for vector layers.
+ | For raster layers, |short_name| will resort to `file-based storage`_ instead.
-Import into PostGIS database (handled by GeoServer)
+Import into PostGIS database (managed by GeoServer)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-| The layer data is uploaded to tables in a PostGIS database by GeoServer. This method requires the GeoServer Importer extension, which only handles Shapefile imports for vector data.
-| This means that if the data is stored in a GeoPackage originally, attribute names may be renamed due to the 10 character limit of the Shapefile `.dbf` file upon export. Bridge handles this automatically and also makes sure that field names referenced in styles are renamed accordingly.
-| You must select a suitable PostGIS datastore on the GeoServer instance. Selecting this option will trigger a process that lists all the available datastores in each GeoServer workspace (which might take some time):
+The layer data is packaged and uploaded to GeoServer, and a job is scheduled on the server to import the data into a PostGIS database.
-.. image:: ./img/servers_geoserver2.png
+This is a good approach if you do not have direct access to the PostGIS database from your machine, but GeoServer does.
+
+.. note:: | This method is only available for vector layers.
+ | For raster layers, |short_name| will resort to `file-based storage`_ instead.
+Please note that some limitations apply:
+
+1. This method requires the GeoServer `Importer extension `_ to be installed and enabled.
+2. Because Importer can only import vector data from Shapefiles, attribute names may be shortened on export to 10 characters (`.dbf` limitation). Those names will also be applied to the PostGIS table attributes. However, |short_name| will try to make sure that attribute names referenced in styles are renamed accordingly, so the styles won't break.
+3. Created PostGIS tables must be deleted manually. Please read :ref:`this warning ` for more information.
+
+Datastore selection
++++++++++++++++++++
+
+In the *Import into PostGIS database (managed by GeoServer)* mode, you must either:
+
+- select an existing PostGIS datastore connection on GeoServer that can act as a template;
+- or define a new PostGIS connection to use on the GeoServer side.
+
+|short_name| will automatically try to list all available PostGIS datastores on GeoServer.
+You can select any datastore as the template that |short_name| should use to create a new datastore with the same connection details as the selected one.
+
+.. image:: ./img/servers_geoserver2.png
.. note:: | The listed datastores will be prefixed by the workspace name to which they belong.
- | This does **not** mean that the layers will be published to that workspace as well.
- | |short_name| always publishes layers to a (new) workspace named after the QGIS project name
- (see :ref:`HowToPublish`), but it will use the same datastore *connection details* as
- the datastore that you have selected.
+ | This does **not** mean that the layers will be published to that workspace.
+
+Alternatively, you can click the |addbutton| button to create a new datastore yourself, if you know the connection details.
+Note that this is the connection that **GeoServer** should use, and that the connection might not work locally on your machine.
-| If you wish to add a new PostGIS-backed datastore, click the :guilabel:`Add datastore` button.
-| This will open a dialog that allows you to specify the connection details. Make sure that GeoServer has full access to the specified PostGIS instance.
-| For more options (or if you wish to specify a JNDI connection pool) please create the datastore using the GeoServer admin page instead.
+For more fine-grained control, or if you wish to specify a JNDI connection pool instead, please create the datastore in the GeoServer Web UI instead.
+|short_name| should then pick up the new datastore automatically, so you can select that as a template.
+
+.. _ImporterWarning:
.. warning:: | Neither the GeoServer REST API nor the Importer extension is authorized to delete underlying PostGIS layer data tables.
| This means that Bridge also won't be able to clean up these data tables and that each publication will create new tables in the database,
@@ -134,7 +186,6 @@ Setting up this connection is required when using the :ref:`PostGISDirectOption`
.. image:: ./img/servers_postgis.png
-
.. note:: JNDI connection pool support is currently unavailable.
diff --git a/latest/_sources/styleviewer.rst.txt b/latest/_sources/styleviewer.rst.txt
index 83c8d63..3048c8f 100644
--- a/latest/_sources/styleviewer.rst.txt
+++ b/latest/_sources/styleviewer.rst.txt
@@ -1,31 +1,31 @@
.. _StyleViewer:
-StyleViewer Panel
-=================
+Style Viewer Panel
+==================
-|app_name| offers a way to preview a layer style (symbology) in several different formats using the *StyleViewer*.
+|app_name| offers a way to preview a layer style (symbology) in several different formats using the *Style Viewer*.
-You can open the *StyleViewer* panel by clicking :guilabel:`StyleViewer` from the |app_name| menu:
+You can open the *Style Viewer* panel by clicking :guilabel:`Bridge Style Viewer` from the |app_name| menu:
.. image:: ./img/styleviewer_menu.png
-Alternatively, you can open the panel using :guilabel:`View` > :guilabel:`Panels` > :guilabel:`StyleViewer` in the QGIS menu bar.
+Alternatively, you can open the panel using :guilabel:`View` > :guilabel:`Panels` > :guilabel:`Bridge Style Viewer` in the QGIS menu bar.
A dockable panel will now be displayed (initially on the right side of the screen) that looks similar to this:
.. image:: ./img/styleviewer.png
-If you wish to close the *StyleViewer*, click the close button (:guilabel:`x`) in the upper-right corner of the panel
-or uncheck the :guilabel:`View` > :guilabel:`Panels` > :guilabel:`StyleViewer` item in the QGIS menu bar.
+If you wish to close the *Style Viewer*, click the close button (:guilabel:`x`) in the upper-right corner of the panel
+or uncheck the :guilabel:`View` > :guilabel:`Panels` > :guilabel:`Bridge Style Viewer` item in the QGIS menu bar.
-Currently, *StyleViewer* supports the following style formats:
+Currently, *Style Viewer* supports the following style formats:
- SLD (XML): used by GeoServer
- MapServer style (plain text): also known as Mapfile
- Mapbox style (JSON): used for vector tiles
- GeoStyler (JSON)
-The *StyleViewer* is context-aware, meaning that it will show style previews for the currently selected layer in the QGIS *Layers* panel:
+The *Style Viewer* is context-aware, meaning that it will show style previews for the currently selected layer in the QGIS *Layers* panel:
For more information about how |short_name| handles symbology and which style elements are supported, please read the :ref:`Symbology` section.
diff --git a/latest/_static/bridge_logo.svg b/latest/_static/bridge_logo.svg
new file mode 100644
index 0000000..fb20ae7
--- /dev/null
+++ b/latest/_static/bridge_logo.svg
@@ -0,0 +1,26 @@
+
diff --git a/latest/_static/favicon.ico b/latest/_static/favicon.ico
index b397114..26302c1 100644
Binary files a/latest/_static/favicon.ico and b/latest/_static/favicon.ico differ
diff --git a/latest/background.html b/latest/background.html
index cad2382..27309fb 100644
--- a/latest/background.html
+++ b/latest/background.html
@@ -9,6 +9,7 @@
+
@@ -35,6 +36,7 @@
+
Supported server types and formatsMapfiles,
-which can be generated by Bridge.
+which can be generated by Bridge, but support for it is limited.
GeoNetwork is a catalog for registering
-assets, such as spatial datasets. It contains a CatalogService for the Web (CSW)
+assets, such as spatial datasets. It contains a Catalog Service for the Web (CSW)
endpoint. GeoNetwork can operate on various metadata models via a plugin mechanism. It
supports ISO19115-3, ISO19139, ISO19110 and DCAT metadata standards. GeoNetwork
opensource software complies with the requirements of INSPIRE discovery services and metadata.
-
GeoStyler is a JS library used in the Shogun framework
-to create generic styles. GeoServer also has a plugin
-that allows to style layers using GeoStyler. Bridge does not make use of the GeoStyler library, but it does use the GeoStyler format
-internally as an intermediate format, which can be exported as a GeoStyler style file (JSON).
+
GeoStyler is a NodeJS tool by Terrestris to create map styles.
+GeoServer also has a plugin
+that allows users to style layers using GeoStyler. Although Bridge does not make use of GeoStyler directly,
+it does use the Python-based bridge-style library, that utilizes
+GeoStyler JSON as an intermediate format before it converts it to various other formats (SLD, Mapfile, etc.).
Mapbox Style is a style format that defines the visual
appearance of vector tiles in the Mapbox JavaScript API.
-Bridge is able to generate a Mapbox style document.
+Bridge is able to generate a Mapbox or MapLibre style document, but newer versions
+of both specifications may not be fully compatible anymore.
PostGIS is a spatial extension to the popular open source Postgres database.
Bridge is able to export any local data to a remote (or local) PostGIS database, allowing it
to be consumed by data services.
Most of the interaction with GeoCat Bridge is done through the Bridge dialog.
-To open it, select the Publish button on the Web toolbar or look for it under the Web/GeoCat Bridge menu.
+To open it, select the Bridge Publisher button on the Web toolbar or look for it under the Web/GeoCat Bridge menu.
-
The first time you open the Bridge dialog, you will see a landing page with information about
-Bridge and other GeoCat products. Follow the corresponding links to find out more about these
-products and how they can be used with Bridge.
+
The first time you open the Bridge dialog, it should display the About panel that shows some information
+about your current Bridge version, and contains some useful links.
-
-
Tip
-
At the bottom of the About panel, it should display the GeoCat Bridge version that you are currently running.
-
As you can see, there are 2 more panels besides the About panel mentioned above:
Publish
-
Servers
+
Connections
We will have closer look at these panels on the following pages.
In some (rare) occasions, Bridge might raise an exception. When this happens, a dialog pops up with a Python stack trace.
-
If the error re-occurs, please press the Send Report button, so that we’re aware of the issue and can try fixing it.
-
+
In some (rare) occasions, Bridge might raise an exception. When this happens, a dialog pops up with a Python stack trace.
+If you keep experiencing the same error, please press the Send Report button. This will open your browser with a web form,
+where you can (optionally) describe the problem and send the error report to the Bridge developers, so they are aware and can fix it.
GeoCat Bridge is primarily targeted towards an international audience, which means that it has an English user interface.
-| However, some basic translations are available for the following languages:
+However, some basic translations are available for the following languages:
Bridge will look in the folder where the layer file is stored and try to find a metadata file named either [layer_filename].[extension].xml or [layer_filename].xml.
In order to actually establish a connection, we need to authenticate ourselves with GeoServer.
-To do that, add new Credentials by clicking the + button:
+To do that, add new Credentials by clicking the button:
After you clicked the + button in the previous step, the Authentication dialog will pop up.
+
After you clicked the button in the previous step, the Authentication dialog will pop up.
For the authentication mechanism, we will use Basic authentication. This is the default and works
well with GeoServer. It also is the only mechanism that Bridge currently supports.
Now specify any Name (to identify your credential settings) and set the Username
@@ -195,7 +199,7 @@
Save your GeoServer configuration by clicking the Save button in the lower right corner of the
-Servers panel.
+Connections panel.
You are now ready to publish some layers!
@@ -227,7 +231,7 @@
Step 2: select target server
-
The Data server list should display all the names of the configurations that you created in the Servers panel.
+
The Data server list should display all the names of the configurations that you created in the Connections panel.
If you just got started, then there will likely only be 1 item in this list.
Once the publish process has completed, a result dialog should appear:
-
+
If there are any errors or warnings, these are shown in the Status column of the published layer list.
-Click on the tiny ! buttons to get more details about the issue(s).
+Click on the tiny buttons to get more details about the issue(s).
If there are no issues, it should say OK next to each layer.
Close the result dialog once you finished reviewing.
Before you can publish data with GeoCat Bridge, you will have to configure one or more server connections.
-This can be achieved in the Servers section of the Bridge dialog:
-
+This can be achieved in the Connections section of the Bridge dialog:
+
You can edit the parameters of a server at any given time. Just select the server connection in the left panel, and edit the fields you wish to change in the right panel.
-
If you wish to remove a server connection, select it from the left panel and click the Remove button.
-The Duplicate button may come in handy if you wish to try out an alternative configuration based on an existing
+
If you wish to remove a server connection, select it from the left panel and click the Remove button.
+The Duplicate button may come in handy if you wish to try out an alternative configuration based on an existing
server connection.
Bridge will automatically store all server connections in the QGIS settings for later use.
-
However, sometimes you might want to backup or share all the configured server connections. The Export button will
+
However, sometimes you might want to backup or share all the configured server connections. The Export button will
allow you to save a JSON file of the current configuration.
-
The Import button will do the opposite and load server connections from a JSON file. Note that the imported connections will be
+
The Import button will do the opposite and load server connections from a JSON file. Note that the imported connections will be
added to the list (i.e. no existing connections will be removed). Bridge will append a numeric suffix to server connections
with a name that already exists.
The layer data is uploaded and stored as files in the GeoServer target workspace on the server.
+
The layer data is uploaded and stored as files in the GeoServer target workspace datastore.
Bridge prefers to upload vector data as GeoPackages and raster data as GeoTIFF files.
+
This method is the most straight-forward and should always work, as there are no dependencies.
+However, depending on the size of the data, this method may be slower and could potentially fail due to network timeouts
+or server-side file upload size limitations.
The layer data is uploaded to tables in a PostGIS database directly (i.e. by Bridge, see PostGIS).
-
GeoServer will not handle the database upload, but merely establish a link to the database table in the created layer(s). This will require a direct PostGIS connection, which you can set up in the Servers section of Bridge as well (see below).
-
Note that GeoServer should also have read access to that PostGIS connection.
+
The layer data is imported by Bridge into a PostGIS database directly.
+
GeoServer will merely establish a link to the imported database table for the created layer(s). This will require a direct PostGIS connection, which you can set up in the Connections section of Bridge as well (see below).
+
Note that GeoServer should also have read access to that same PostGIS connection.
Import into PostGIS database (handled by GeoServer)
+
+
Import into PostGIS database (managed by GeoServer)
+
The layer data is packaged and uploaded to GeoServer, and a job is scheduled on the server to import the data into a PostGIS database.
+
This is a good approach if you do not have direct access to the PostGIS database from your machine, but GeoServer does.
+
+
Note
-
The layer data is uploaded to tables in a PostGIS database by GeoServer. This method requires the GeoServer Importer extension, which only handles Shapefile imports for vector data.
-
This means that if the data is stored in a GeoPackage originally, attribute names may be renamed due to the 10 character limit of the Shapefile .dbf file upon export. Bridge handles this automatically and also makes sure that field names referenced in styles are renamed accordingly.
-
You must select a suitable PostGIS datastore on the GeoServer instance. Selecting this option will trigger a process that lists all the available datastores in each GeoServer workspace (which might take some time):
This method requires the GeoServer Importer extension to be installed and enabled.
+
Because Importer can only import vector data from Shapefiles, attribute names may be shortened on export to 10 characters (.dbf limitation). Those names will also be applied to the PostGIS table attributes. However, Bridge will try to make sure that attribute names referenced in styles are renamed accordingly, so the styles won’t break.
+
Created PostGIS tables must be deleted manually. Please read this warning for more information.
In the Import into PostGIS database (managed by GeoServer) mode, you must either:
+
+
select an existing PostGIS datastore connection on GeoServer that can act as a template;
+
or define a new PostGIS connection to use on the GeoServer side.
+
+
Bridge will automatically try to list all available PostGIS datastores on GeoServer.
+You can select any datastore as the template that Bridge should use to create a new datastore with the same connection details as the selected one.
Note
The listed datastores will be prefixed by the workspace name to which they belong.
-
This does not mean that the layers will be published to that workspace as well.
-
Bridge always publishes layers to a (new) workspace named after the QGIS project name
-(see How to publish), but it will use the same datastore connection details as
-the datastore that you have selected.
+
This does not mean that the layers will be published to that workspace.
-
-
If you wish to add a new PostGIS-backed datastore, click the Add datastore button.
-
This will open a dialog that allows you to specify the connection details. Make sure that GeoServer has full access to the specified PostGIS instance.
-
For more options (or if you wish to specify a JNDI connection pool) please create the datastore using the GeoServer admin page instead.
-
-
+
Alternatively, you can click the button to create a new datastore yourself, if you know the connection details.
+Note that this is the connection that GeoServer should use, and that the connection might not work locally on your machine.
+
For more fine-grained control, or if you wish to specify a JNDI connection pool instead, please create the datastore in the GeoServer Web UI instead.
+Bridge should then pick up the new datastore automatically, so you can select that as a template.
+
Warning
Neither the GeoServer REST API nor the Importer extension is authorized to delete underlying PostGIS layer data tables.
@@ -218,6 +250,7 @@
Import into PostGIS database (handled by GeoServer)
+
GeoCat Bridge offers a way to preview a layer style (symbology) in several different formats using the Style Viewer.
+
You can open the Style Viewer panel by clicking Bridge Style Viewer from the GeoCat Bridge menu:
-
Alternatively, you can open the panel using View > Panels > StyleViewer in the QGIS menu bar.
+
Alternatively, you can open the panel using View > Panels > Bridge Style Viewer in the QGIS menu bar.
A dockable panel will now be displayed (initially on the right side of the screen) that looks similar to this:
-
If you wish to close the StyleViewer, click the close button (x) in the upper-right corner of the panel
-or uncheck the View > Panels > StyleViewer item in the QGIS menu bar.
-
Currently, StyleViewer supports the following style formats:
+
If you wish to close the Style Viewer, click the close button (x) in the upper-right corner of the panel
+or uncheck the View > Panels > Bridge Style Viewer item in the QGIS menu bar.
+
Currently, Style Viewer supports the following style formats:
SLD (XML): used by GeoServer
MapServer style (plain text): also known as Mapfile
Mapbox style (JSON): used for vector tiles
GeoStyler (JSON)
-
The StyleViewer is context-aware, meaning that it will show style previews for the currently selected layer in the QGIS Layers panel:
+
The Style Viewer is context-aware, meaning that it will show style previews for the currently selected layer in the QGIS Layers panel:
For more information about how Bridge handles symbology and which style elements are supported, please read the Supported Symbology section.