Update documentation

GeoCat · Oct 5, 2024 · 308356d · 308356d
1 parent 7a08d92
commit 308356d
Show file tree

Hide file tree

Showing 61 changed files with 378 additions and 184 deletions.
diff --git 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
diff --git a/latest/.doctrees/bridge_dialog.doctree b/latest/.doctrees/bridge_dialog.doctree
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/latest/.doctrees/metadata_editing.doctree b/latest/.doctrees/metadata_editing.doctree
diff --git a/latest/.doctrees/publish.doctree b/latest/.doctrees/publish.doctree
diff --git a/latest/.doctrees/quickstart.doctree b/latest/.doctrees/quickstart.doctree
diff --git a/latest/.doctrees/server_configuration.doctree b/latest/.doctrees/server_configuration.doctree
diff --git a/latest/.doctrees/styleviewer.doctree b/latest/.doctrees/styleviewer.doctree
diff --git a/latest/_images/add.svg b/latest/_images/add.svg
diff --git a/latest/_images/attention.svg b/latest/_images/attention.svg
diff --git a/latest/_images/duplicate.svg b/latest/_images/duplicate.svg
diff --git a/latest/_images/export.svg b/latest/_images/export.svg
diff --git a/latest/_images/first_time.png b/latest/_images/first_time.png
diff --git a/latest/_images/import.svg b/latest/_images/import.svg
diff --git a/latest/_images/manually_load_metadata.png b/latest/_images/manually_load_metadata.png
diff --git a/latest/_images/preview.svg b/latest/_images/preview.svg
diff --git a/latest/_images/publish_layers_context_menu.png b/latest/_images/publish_layers_context_menu.png
diff --git a/latest/_images/publish_layers_list.png b/latest/_images/publish_layers_list.png
diff --git a/latest/_images/publish_layers_progress.png b/latest/_images/publish_layers_progress.png
diff --git a/latest/_images/publish_layers_report.png b/latest/_images/publish_layers_report.png
diff --git a/latest/_images/publish_metadata.png b/latest/_images/publish_metadata.png
diff --git a/latest/_images/publish_section.png b/latest/_images/publish_section.png
diff --git a/latest/_images/publish_workspace_warning.png b/latest/_images/publish_workspace_warning.png
diff --git a/latest/_images/quickstart_authentication.png b/latest/_images/quickstart_authentication.png
diff --git a/latest/_images/quickstart_newgeoserver.png b/latest/_images/quickstart_newgeoserver.png
diff --git a/latest/_images/quickstart_newserver.png b/latest/_images/quickstart_newserver.png
diff --git a/latest/_images/quickstart_publishexample.png b/latest/_images/quickstart_publishexample.png
diff --git a/latest/_images/quickstart_servers.png b/latest/_images/quickstart_servers.png
diff --git a/latest/_images/quickstart_titleabstract.png b/latest/_images/quickstart_titleabstract.png
diff --git a/latest/_images/remove.svg b/latest/_images/remove.svg
diff --git a/latest/_images/servers_geonetwork.png b/latest/_images/servers_geonetwork.png
diff --git a/latest/_images/servers_geoserver.png b/latest/_images/servers_geoserver.png
diff --git a/latest/_images/servers_geoserver2.png b/latest/_images/servers_geoserver2.png
diff --git a/latest/_images/servers_mapserver.png b/latest/_images/servers_mapserver.png
diff --git a/latest/_images/servers_mapserver2.png b/latest/_images/servers_mapserver2.png
diff --git a/latest/_images/servers_postgis.png b/latest/_images/servers_postgis.png
diff --git a/latest/_images/validate.svg b/latest/_images/validate.svg
diff --git 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 <https://www.mapserver.org/mapfile/>`_,
-which can be generated by |short_name|.
+which can be generated by |short_name|, but support for it is limited.
 
 `GeoNetwork <https://geonetwork-opensource.org>`_ 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 <https://geostyler.org/>`_ is a JS library used in the `Shogun framework <https://github.com/terrestris/shogun-core>`_
-to create generic styles. GeoServer also has a `plugin <https://docs.geoserver.org/latest/en/user/community/geostyler/index.html>`_
-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 <https://geostyler.org/>`_ is a NodeJS tool by Terrestris to create map styles.
+GeoServer also has a `plugin <https://docs.geoserver.org/latest/en/user/community/geostyler/index.html>`_
+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 <https://github.com/GeoCat/bridge-style>`_ library, that utilizes
+GeoStyler JSON as an intermediate format before it converts it to various other formats (SLD, Mapfile, etc.).
 
 `Mapbox Style <https://docs.mapbox.com/mapbox-gl-js/style-spec/>`_ is a style format that defines the visual
 appearance of vector tiles in the `Mapbox JavaScript API <https://docs.mapbox.com/mapbox-gl-js/api/>`_.
-|short_name| is able to generate a Mapbox style document.
+|short_name| is able to generate a Mapbox or `MapLibre <https://maplibre.org/>`_ style document, but newer versions
+of both specifications may not be fully compatible anymore.
 
 `PostGIS <https://postgis.net/>`_ 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
@@ -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,18 +25,21 @@ 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)
 - Spanish (Español)
 
 | 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 <https://explore.transifex.com/geocat/bridge-common>`_.
diff --git 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
@@ -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