Skip to content
Open
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ repos:
- --ignore-directives=toctree,include,only,ifconfig,literalinclude,index,glossary,substitution-definitions,highlight,todo,todolist,deprecated,versionadded,versionchanged,seealso,productionlist,centered,testcleanup,testcode,testoutput,testsetup,tabs,tab,code-block,toggle
- --ignore-roles=menuselection,guilabel,file,kbd,ref,doc,term,command,program,option,envvar,index,abbr,dfn,numref,eq,download,py:mod,py:obj,py:class,py:meth,py:attr,py:func,py:exc,pyqgis,api,source,sup,sub,raw,math,green,purple,blue,turquoise,kaki,slate,darkgray,midgray
- --ignore-languages=python,bash,sql,json,xml,yaml
- --ignore-substitutions=version,rarr,srtmFileName
- --ignore-substitutions=version,srtmFileName
exclude: ^(locale/|_dummy/|build/)
additional_dependencies:
- sphinx
Expand Down
4 changes: 2 additions & 2 deletions docs/about/contributors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ The current translations are made possible thanks to:
Statistics of translation
=========================

Efforts of translation for QGIS |CURRENT| Long Term Release are provided below.
Efforts of translation for QGIS |ltr| Long Term Release are provided below.
Official documentation is published in only the languages that reached 5% of translation.

.. include:: translation_stats.rst
Expand All @@ -138,4 +138,4 @@ The current translations are made possible thanks to:
please add it also to the substitutions.txt file in the
source folder.

.. |CURRENT| replace:: 3.44
.. |ltr| replace:: 3.44
1 change: 1 addition & 0 deletions docs/about/conventions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ that, and that and that and that, and that and that.
Screenshots that appear throughout the user guide have been created on
different platforms.


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
12 changes: 9 additions & 3 deletions docs/about/preamble.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,19 @@ What is new in QGIS |version|
-----------------------------

This release of QGIS includes hundreds of bug fixes and many new
features and enhancements, compared to |QGIS_CURRENT|_.
features and enhancements, compared to QGIS |previous_docs|.
For a list of new features, visit the `visual changelogs
<https://qgis.org/project/visual-changelogs/>`_.

.. only:: not testing and not outdated

We recommend that you use this version over previous releases.

.. |QGIS_CURRENT| replace:: QGIS 3.40
.. _QGIS_CURRENT: https://docs.qgis.org/3.40/en/docs/

.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
please add it also to the substitutions.txt file in the
source folder.

.. |previous_docs| replace:: 3.44
11 changes: 6 additions & 5 deletions docs/developers_guide/qtcreator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -217,16 +217,17 @@ Now launch QGIS under the debugger by clicking the |runDebug| :sup:`Start
Debugging` in the bottom left of the window.


.. |build| image:: img/build.png
.. |runDebug| image:: img/runDebug.png
.. |runInstall| image:: img/runInstall.png


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
please add it also to the substitutions.txt file in the
source folder.

.. |build| image:: /static/common/build.png
:width: 1.5em
.. |checkbox| image:: /static/common/checkbox.png
:width: 1.3em
.. |runDebug| image:: /static/common/runDebug.png
:width: 1.5em
.. |runInstall| image:: /static/common/runInstall.png
:width: 1.5em
8 changes: 6 additions & 2 deletions docs/documentation_guidelines/do_translations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -413,8 +413,8 @@ part of it!!
Summary Rules for translation
-----------------------------

#. Do not change text between two ``|`` characters like ``|bronze|``, ``|checkbox|``,
``|labels|``, ``|selectString|``, ``|addLayer|`` ... These are special tags
#. Do not change text between two ``|`` characters like ``|logo|``, ``|checkbox|``,
``|label|``, ``|selectString|``, ``|addLayer|``,... These are special tags
used to replace images
#. Do not change references that start with roles like ``:ref:``, ``:file:``,
``:numref:`` unless they include a title. In that case, you can translate the title
Expand Down Expand Up @@ -462,6 +462,8 @@ For any question, please contact the `QGIS Community Team
:width: 1.3em
.. |heatmap| image:: /static/common/heatmap.png
:width: 1.5em
.. |label| image:: /static/common/mActionLabel.png
:width: 1.5em
.. |linguist_done_next| image:: /static/common/linguist_done_next.png
:width: 2em
.. |linguist_next| image:: /static/common/linguist_next.png
Expand All @@ -472,5 +474,7 @@ For any question, please contact the `QGIS Community Team
:width: 2em
.. |linguist_previous_todo| image:: /static/common/linguist_previous_todo.png
:width: 2em
.. |logo| image:: /static/common/logo.png
:width: 1.5em
.. |selectString| image:: /static/common/selectstring.png
:width: 2.5em
2 changes: 1 addition & 1 deletion docs/documentation_guidelines/substitutions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ Print Layout
|addChart| ``|addChart|``
|label| ``|label|`` |scaleBar| ``|scaleBar|``
|select| ``|select|`` |moveItemContent| ``|moveItemContent|``
|layers| ``|Layers|``
|layers| ``|layers|``
|setToCanvasScale| ``|setToCanvasScale|`` |setToCanvasExtent| ``|setToCanvasExtent|``
|viewScaleInCanvas| ``|viewScaleInCanvas|`` |viewExtentInCanvas| ``|viewExtentInCanvas|``
|raiseItems| ``|raiseItems|`` |lowerItems| ``|lowerItems|``
Expand Down
4 changes: 3 additions & 1 deletion docs/documentation_guidelines/writing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ You can use tags to emphasize items.

.. code-block:: rst

|icon| :sup:`popup_text`
|iconView| :sup:`popup_text`

(see `image`_ below).

Expand Down Expand Up @@ -861,6 +861,8 @@ to help you with the layout and the description:
:width: 1.5em
.. |fieldText| image:: /static/common/mIconFieldText.png
:width: 1.5em
.. |iconView| image:: /static/common/mActionIconView.png
:width: 1.5em
.. |inputText| image:: /static/common/inputtext.png
.. |lineLayer| image:: /static/common/mIconLineLayer.png
:width: 1.5em
Expand Down
10 changes: 5 additions & 5 deletions docs/pyqgis_developer_cookbook/server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ There are a few different ways you can alter the behavior of QGIS Server or exte
capabilities to offer new custom services or APIs, these are the main scenarios you
may face:

* EMBEDDING |rarr| Use QGIS Server API from another Python application
* STANDALONE |rarr| Run QGIS Server as a standalone WSGI/HTTP service
* FILTERS |rarr| Enhance/Customize QGIS Server with filter plugins
* SERVICES |rarr| Add a new *SERVICE*
* OGC APIs |rarr| Add a new *OGC API*
* ``EMBEDDING`` :menuselection:`-->` Use QGIS Server API from another Python application
* ``STANDALONE`` :menuselection:`-->` Run QGIS Server as a standalone WSGI/HTTP service
* ``FILTERS`` :menuselection:`-->` Enhance/Customize QGIS Server with filter plugins
* ``SERVICES`` :menuselection:`-->` Add a new *SERVICE*
* ``OGC APIs`` :menuselection:`-->` Add a new *OGC API*

Embedding and standalone applications require using the QGIS Server Python API directly from
another Python script or application. The remaining options are better suited for when
Expand Down
1 change: 1 addition & 0 deletions docs/training_manual/basic_map/mapviewnavigation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ Knowing how to navigate the Map Canvas is important, as it allows one to explore
and visually inspect the layers. This could be done for initial data exploration,
or to validate output of a spatial analysis.


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -862,6 +862,7 @@ highlighted.
Follow all the best practices for cartography in creating your output
map.


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
1 change: 1 addition & 0 deletions docs/user_manual/expressions/expression.rst
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,7 @@ Further information about creating Python code can be found in the

.. _Qt: https://doc.qt.io/qt-6.8/


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
3 changes: 1 addition & 2 deletions docs/user_manual/grass_integration/grass_integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -592,7 +592,7 @@ The GRASS plugin provides a user-friendly toolbox with about 200 of the availabl
GRASS modules and functionalities.

A complete list of GRASS modules available in the graphical Toolbox in QGIS
version |CURRENT| is available in the GRASS wiki at
is available in the GRASS wiki at
https://grasswiki.osgeo.org/wiki/GRASS-QGIS_relevant_module_list.

It is also possible to customize the GRASS Toolbox content. This procedure is
Expand Down Expand Up @@ -843,7 +843,6 @@ you select the module.
please add it also to the substitutions.txt file in the
source folder.

.. |CURRENT| replace:: 3.44
.. |captureBoundary| image:: /static/common/mActionCaptureBoundary.png
:width: 1.5em
.. |captureCentroid| image:: /static/common/mActionCaptureCentroid.png
Expand Down
6 changes: 3 additions & 3 deletions docs/user_manual/introduction/general_tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -691,7 +691,7 @@ The :guilabel:`Debugging/Development Tools` panel (:kbd:`F12`) provides
a unified place for handling and debugging actions within QGIS.
Available tools are organized under following tabs:

* |HelpContents| :guilabel:`API Documentation`: embeds developer oriented documentation
* |helpContents| :guilabel:`API Documentation`: embeds developer oriented documentation
* |networkAndProxy| :guilabel:`Network Logger`: records and displays network requests
and interactions
* |dbManager| :guilabel:`Query Logger`: logs SQL commands issued by data providers
Expand All @@ -708,12 +708,12 @@ Available tools are organized under following tabs:
API Documentation
.................

The |HelpContents| :guilabel:`API Documentation` tab can display either
The |helpContents| :guilabel:`API Documentation` tab can display either
the |logo| :sup:`PyQGIS API documentation` or the |qt| :sup:`Qt API documentation`.
These are embedded in the widget, allowing you to browse and search the docs without leaving QGIS.
It is also the place you can display specific help page for objects or classes in your code sample;
from the Python interactive console or text editor dialog, select or hover a text
and press :kbd:`F1` or right-click and select |HelpContents| :sup:`Contextual help` to get its API help.
and press :kbd:`F1` or right-click and select |helpContents| :sup:`Contextual help` to get its API help.
If you wish to read the active page in the system web browser, then press |wms| :sup:`Open in web browser`.

Read :ref:`contextual help <python_contextual_help>` for details on the widget configuration.
Expand Down
1 change: 1 addition & 0 deletions docs/user_manual/introduction/qgis_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2924,6 +2924,7 @@ in the QGIS user profile.
.. _`ProxyType-enum`: https://doc.qt.io/qt-6/qnetworkproxy.html#ProxyType-enum
.. _Qt: https://doc.qt.io/qt-6.8/


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
1 change: 1 addition & 0 deletions docs/user_manual/managing_data_source/opening_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1740,6 +1740,7 @@ or :guilabel:`Load Connection` from an XML file.
.. _GeoCSV specification: https://giswiki.ch/GeoCSV#CSVT_file_format_specification
.. _`ArcGIS REST Server`: https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-types-of-services-can-you-publish.htm


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
1 change: 1 addition & 0 deletions docs/user_manual/plugins/core_plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Icon Plugin Description
To use the Core Plugins |grassTools| GRASS 7, |grassLogo| GRASS GIS provider,
they have to be configured. Information can be found :ref:`here <processing.results>`.


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
1 change: 1 addition & 0 deletions docs/user_manual/plugins/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ directly from their repository. Encrypted files are supported.

The |installPluginFromZip| :guilabel:`Install from zip` tab


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ In this section, select and configure the layer and fields you want to display i

Chart Data Source group


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ can also:

The marker item custom properties


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ Camera pose
The :guilabel:`Set from a 3D View...` pull-down menu lets you
populate the items with the parameters of a 3D View.


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
1 change: 1 addition & 0 deletions docs/user_manual/processing_algs/qgis/vectorgeometry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8056,6 +8056,7 @@ Python code
.. _GEOS: https://libgeos.org/
.. _SFCGAL: https://sfcgal.gitlab.io/SFCGAL/


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -899,6 +899,7 @@ After setting the attribute, value, and optional filter, digitize a selection us
Only points in front of the camera’s near plane (i.e. currently rendered)
are considered; points behind the camera are ignored.


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down
4 changes: 3 additions & 1 deletion release_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@ This usually happens from the October release.
Following changes have to be done in `master` branch before you create the new release branch.
Otherwise, you will have to do the changes twice: in master and in the new branch.

- [ ] In [substitutions.txt](substitutions.txt) file, replace |CURRENT| value with the new version number
- [ ] In [docs_conf.yml](docs_conf.yml) file: add the new release number to the `version_list` parameter
- [ ] In [dependabot.yml](.github/dependabot.yml) file: Add label for backporting dependencies update to the new branch

You can now create the `release_x.y` branch in the [repository](https://github.com/qgis/QGIS-Documentation/branches), based on `master`.

#### After the new branch is created

- [ ] In [substitutions.txt](substitutions.txt) file, replace |previous_docs| value with the new version number
- [ ] In [substitutions.txt](substitutions.txt) file:
- [ ] Remove intermediate versions substitutions and their occurrences in the rst files
- [ ] Add substitutions for the versions of the next LTR cycle that starts
Expand Down Expand Up @@ -127,6 +127,7 @@ In February, the new version is labeled as LTR, and replaces the previous one in
<details>

- [ ] In [conf.py](conf.py) file: set the html_context `isLtr` to `True`
- [ ] In [substitutions.txt](substitutions.txt) file, replace |ltr| value with the new LTR version number
- [ ] In [docs_conf.yml](docs_conf.yml) file: add target languages to the `supported_languages` parameter.
These are the languages that will be published in the documentation.
A threshold of 5% is currently applied to candidates.
Expand Down Expand Up @@ -158,6 +159,7 @@ is being translated. So when a new LTR is published, we disconnect the old one a

<details>

- [ ] In [substitutions.txt](substitutions.txt) file, replace |ltr| value with the new LTR version number
- [ ] In [fix_versions.sh](scripts/fix_versions.sh) file:
- [ ] add the old LTR number to the `DEPRECATED` parameter
- [ ] add the new LTR number to the `DOCVERSIONS` parameter
Expand Down
4 changes: 2 additions & 2 deletions scripts/find_set_subst.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ def get_subst_from_file(file):
"""

# defines a pattern for a substitution
# anything inside || except is preceded by ..
s_pattern = re.compile(r"(?<!\.\. )\|([\w\d-]+)\|")
# i.e., anything inside || except is preceded by .. and/or not surrounded by a character
s_pattern = re.compile(r"(?<!\.\. )(?<!\w)\|([\w\d-]+)\|(?![\w-])")
s_title = re.compile(r"\.\. Substitutions definitions - AVOID EDITING "
r"PAST THIS LINE\n")
subs = []
Expand Down
File renamed without changes
File renamed without changes
Loading
Loading