5. Substitutions
5.1. Usage
To ease the use of icons in QGIS manuals, replacements are defined
for each icon in /source/substitutions.txt
file at QGIS-Documentation repository and some of these substitutions
are listed below.
Thus, when you want to use an icon from QGIS application in the documentation
there is a big chance that there is already a substitution that can/should be used.
If no replacement exists:
check the documentation repository whether the icon is available in
/static/common
folder. If no image, then you need to find and copy the icon image file from QGIS repository (often under https://github.com/qgis/QGIS/blob/release-3_16/images/themes/default folder) and paste (in.png
format) under/static/common
folder. For convenience and update, it's advised to keep filename when possible.create the reference to the substitution in the
/source/substitutions.txt
file following the example below. The replacement text should be in camelCase:.. |splitLayer| image:: /static/common/split_layer.png :width: 1.5em
run the
scripts/find_set_subst.py
script to update the substitution definitions in the rst files and include the new substitution(s).(optional) add the reference to the icon and its substitution to the list below.
5.2. Common Substitutions
Below are given some icons and their substitution to use when writing documentation. Can be used/found in many places in manuals.
5.2.1. Platform Icons
Icon |
Substitution |
Icon |
Substitution |
---|---|---|---|
|
|||
|
|
||
|
|
5.4. Other basic icons
Icon |
Substitution |
Icon |
Substitution |
---|---|---|---|
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
5.5. Attribute Table
Icon |
Substitution |
Icon |
Substitution |
---|---|---|---|
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|||
|
|
5.6. Projections and Georeferencer
Icon |
Substitution |
Icon |
Substitution |
---|---|---|---|
|
|
||
|
|
||
|
|
||
|
|||
|
|
||
|
|
||
|
5.7. Print Layout
Icon |
Substitution |
Icon |
Substitution |
---|---|---|---|
|
|
||
|
|||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|||
|
|
||
|
|
||
|
|
||
|
5.8. Layer Properties
Icon |
Substitution |
Icon |
Substitution |
---|---|---|---|
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|||
|
|
5.9. Plugin
5.9.1. Pengolahan
Icon |
Substitution |
Icon |
Substitution |
---|---|---|---|
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
5.9.2. Various Core Plugins
Standard provided with basic install, but not loaded with initial install
Icon |
Substitution |
Icon |
Substitution |
---|---|---|---|
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
5.9.3. Grass integration
Icon |
Substitution |
Icon |
Substitution |
---|---|---|---|
|
|
||
|
|
||
|
|