Skip to content

Commit 3e78ee0

Browse files
committed
Updated documentation for 4.3 release
1 parent e949d71 commit 3e78ee0

12 files changed

+47
-33
lines changed

docs/source/bridge_dialog.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,18 @@ Logging and error handling
3030
| This panel can be opened by clicking the "balloon" button in the lower-right corner of QGIS
3131
or by checking the :guilabel:`View` > :guilabel:`Panels` > :guilabel:`Log Messages` item from the QGIS menu bar.
3232
33-
| In some (rare) occassions, |short_name| might raise an exception. When this happens, a dialog pops up with a Python strack trace.
33+
| In some (rare) occasions, |short_name| might raise an exception. When this happens, a dialog pops up with a Python stack trace.
3434
| 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.
3535
3636
Internationalization (i18n)
3737
---------------------------
3838

3939
|app_name| is primarily targeted towards an international audience, which means that it has an English user interface.
40-
| However, some rudimentary translations are available for the following languages:
40+
| However, some basic translations are available for the following languages:
4141
4242
- Dutch (Nederlands)
4343
- German (Deutsch)
4444
- Spanish (Español)
4545

4646
| The translations will be applied automatically based on the language settings of the user.
47-
If no translation can be found for a certain text, the original text (English) will be displayed instead.
47+
If no translation can be found for a certain text, the original text (English) will be displayed instead.
6.74 KB
Loading

docs/source/img/first_time.png

-26.5 KB
Loading
-54.8 KB
Binary file not shown.
13.9 KB
Loading
-31.2 KB
Binary file not shown.
5.44 KB
Loading

docs/source/index.rst

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
=============
33

44
|plugin_name| enables you to publish your map metadata to a spatial catalogue (CSW)
5-
like GeoNetwork opensource, or to publish the map itself as an OGC data service (WMS/WMTS/WFS/WCS)
5+
like GeoNetwork, or to publish the map itself as an OGC data service (WMS/WMTS/WFS/WCS)
66
to GeoServer or MapServer. |short_name| also offers the option to export metadata, symbology
77
and/or data as local files.
88

@@ -11,21 +11,16 @@ a Dutch-Canadian company focusing on the development, customization
1111
and support of cutting-edge geospatial catalog software on both server and desktop platforms.
1212
GeoCat provides all-in-one Spatial Data Infrastructure (SDI) solutions
1313
that offer a geospatial catalog, map server and map client.
14-
The software is based on established Free and Open Source Software (FOSS)
15-
projects, uses open standard protocols, and can be customized to the needs of
16-
different clients.
14+
The software is based on established Free and Open Source Software (FOSS4G)
15+
projects, and uses open standard protocols.
1716

18-
The founder of GeoCat worked for many years with the United Nations Food and Agriculture Organization (FAO)
19-
where he founded the `GeoNetwork opensource <https://geonetwork-opensource.org>`_ project.
20-
Today, GeoNetwork opensource can be considered the leading open source geospatial catalog
21-
application with numerous international and national geo-portal implementations.
2217

2318
Contents
2419
--------
2520

2621
.. toctree::
2722
:glob:
28-
:maxdepth: 1
23+
:maxdepth: 2
2924

3025
background
3126
installation

docs/source/installation.rst

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ Client-side
1010
|app_name| requires QGIS |min_qgis_ver| or newer.
1111
Both the standalone QGIS installation or the OSGeo distribution should work.
1212

13+
QGIS users who use a QGIS version *beyond* 3.16 should verify that the ``lxml`` :ref:`Python dependency <lxml-dependency>` is available.
14+
However, this only applies if you wish to import or publish metadata using |short_name|.
15+
1316
.. note:: If you access the internet through a proxy server,
1417
you might experience some issues while publishing data or connecting to a server.
1518

@@ -19,8 +22,8 @@ Server-side
1922
GeoNetwork
2023
^^^^^^^^^^
2124

22-
|app_name| currently supports GeoNetwork 3 starting at version 3.4 and higher.
23-
GeoNetwork 2 support has been deprecated and version 4 is not supported yet.
25+
|app_name| currently supports GeoNetwork version 3.4 and higher.
26+
GeoNetwork 2.x support has been deprecated and version 4.x is not supported yet.
2427

2528
GeoServer
2629
^^^^^^^^^
@@ -35,6 +38,8 @@ GeoServer
3538
the REST API instead of direct access), you need to make sure that the
3639
`Importer extension <https://docs.geoserver.org/latest/en/user/extensions/importer/index.html>`_
3740
is available on GeoServer.
41+
If you do not know if this extension is installed, simply try to publish
42+
something and |short_name| will warn you if it isn't.
3843

3944
MapServer
4045
^^^^^^^^^
@@ -49,33 +54,31 @@ How to install
4954

5055
To install the |plugin_name|, please follow these steps:
5156

52-
1. Open the :guilabel:`QGIS Plugin Manager`. The Plugin Manager can be opened using the :menuselection:`Plugins --> Manage and Install plugins` menu entry.
57+
1. Open the :guilabel:`QGIS Plugin Manager` by clicking on the :menuselection:`Plugins --> Manage and Install Plugins...` menu entry.
5358

5459
.. image:: ./img/pluginmanagermenu.png
5560

56-
You will see the following dialog:
61+
You will now see a dialog similar to the one below, listing all your (pre-)installed plugins:
5762

5863
.. image:: ./img/pluginmanager.png
5964

60-
2. Select the :guilabel:`all` section to show all available plugins.
61-
62-
.. image:: ./img/pluginmanagerall.png
63-
64-
3. In the search box, type `bridge` to filter the list of available plugins.
65-
66-
.. image:: ./img/pluginmanagerfiltered.png
67-
68-
4. Click on the |gui_name| plugin entry to display the information about the plugin:
65+
2. Click the :guilabel:`All` section on the sidebar to list all available plugins. Scroll down to find "|gui_name|"
66+
or use the search box at the top to filter the list (e.g. by typing "|short_name|"). Clicking on the "|gui_name|" plugin entry
67+
will display detailed information about the plugin:
6968

7069
.. image:: ./img/pluginmanagerbridge.png
7170

72-
5. Click on :guilabel:`Install` to install the plugin.
71+
4. Click :guilabel:`Install Plugin` and wait until |short_name| has been downloaded and installed.
7372

74-
6. Once the plugin is installed, close the Plugin Manager and you will find a new menu entry under the :menuselection:`Web` menu,
75-
which contains the menu items for the |short_name| plugin.
73+
5. Close the Plugin Manager when done. You should now have a new menu entry under the :menuselection:`Web` menu,
74+
which contains a couple of menu items related the |short_name| plugin:
7675

7776
.. image:: ./img/bridgemenuentry.png
7877

79-
7. You'll also notice a new toolbar button, that will open the |short_name| Publish dialog.
78+
6. You should also see a new toolbar button, that will open the |short_name| Publish dialog.
8079

8180
.. image:: ./img/bridgetoolbarbutton.png
81+
82+
83+
In the Plugin Manager settings, note that you can configure QGIS to automatically check for plugin updates.
84+
Alternatively, you can update plugins manually using the :guilabel:`Upgrade All` button.

docs/source/metadata_editing.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ complete a minimal subset of required metadata elements:
1818
- Metadata language
1919

2020
When publishing metadata to GeoNetwork, |short_name| will convert the QGIS metadata (QMD) into the ISO19139 format.
21+
Note that in order to do that, |short_name| uses the ``lxml`` library, which :ref:`may not be installed <lxml-dependency>`.
2122

2223
| You can edit the |short_name| metadata fields directly, or use the QGIS metadata editor by clicking the :guilabel:`Open QGIS metadata editor` button.
2324
| Note that you can also click the :guilabel:`...` buttons next to each |short_name| metadata field to open the QGIS metadata editor a specific page:
@@ -70,6 +71,8 @@ If you click :guilabel:`Yes`, a file dialog will open so you can select the meta
7071

7172
.. note:: - Some (non-supported) elements of the original metadata may get lost in the transformation.
7273
- Changes in the metadata editor will not be saved to the original imported metadata file.
74+
- Because of a :ref:`dependency <lxml-dependency>`, |short_name| may not be able to import metadata.
75+
If this is the case, a warning will be displayed.
7376

7477
.. warning:: | **If you wish to persist the imported/edited metadata for another time, it is important that you
7578
save the QGIS project before your close the application.**

0 commit comments

Comments
 (0)