To easier the use of icons in QGIS manuals, replacements are defined
for each icon in /source/conf.py
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:
/resources/en/docs/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/tree/master/images/themes/default folder)
and paste (in .png
format) under /resources/en/docs/common
folder.
For convenience and update, it’s advised to keep filename when possible./source/conf.py
file following the example below. The replacement text should be in camelCase:.. |splitLayer| image:: /static/common/split_layer.png
:width: 1.5em
Below are given some icons and their substitution to use when writing documentation. Can be used/found in many places in manuals.
Icon | Substitution |
---|---|
|kde| |
|
|nix| |
|
|osx| |
|
|win| |
Icon | Substitution | Icon | Substitution |
---|---|---|---|
|saveEdits| |
|||
|undo| |
|redo| |
||
|editCopy| |
|editPaste| |
||
|editCut| |
Icon | Substitution | Icon | Substitution |
---|---|---|---|
|expandTree| |
|collapseTree| |
||
|expandNewTree| |
|propertyItem| |
||
|deselectAll| |
|editCopy| |
||
|filePrint| |
|propertiesWidget| |
Icons used in Composer:
Icons used in Layer Properties dialog:
Standard provided with basic install, but not loaded with initial install
Icon | Substitution | Icon | Substitution |
---|---|---|---|
|grass| |
|||
|grassTools| |
|grassNewMapset| |
||
|grassOpenMapset| |
|grassCloseMapset| |
||
|grassRegion| |
|grassSetRegion| |
Icon | Substitution | Icon | Substitution |
---|---|---|---|
|eventBrowser| |
|eventId| |
||
|evisConnect| |
|evisFile| |