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
	`\|logo\|`
	`\|kde\|`		`\|nix\|`
	`\|osx\|`		`\|win\|`

5.2.2. Menu Items ¶

Substitution	Icon	Substitution
`\|checkbox\|`		`\|unchecked\|`
`\|radioButtonOn\|`		`\|radioButtonOff\|`
`\|selectNumber\|`		`\|selectString\|`
`\|selectColor\|`		`\|selectColorRamp\|`
`\|tab\|`	°	`\|degrees\|`
`\|inputText\|`		`\|slider\|`

5.3. Toolbar Button Icons ¶

5.3.1. Manage Layers and overview ¶

Icon	Substitution	Icon	Substitution
	`\|dataSourceManager\|`
	`\|addOgrLayer\|`		`\|addDb2Layer\|`
	`\|addRasterLayer\|`		`\|addMssqlLayer\|`
	`\|addDelimitedTextLayer\|`		`\|addSpatiaLiteLayer\|`
	`\|addPostgisLayer\|`		`\|addOracleLayer\|`
	`\|addAfsLayer\|`		`\|addAmsLayer\|`
	`\|addMeshLayer\|`
	`\|addVectorTileLayer\|`		`\|addXyzLayer\|`
	`\|addVirtualLayer\|`		`\|addWmsLayer\|`
	`\|addWcsLayer\|`		`\|addWfsLayer\|`
	`\|newVectorLayer\|`		`\|newSpatiaLiteLayer\|`
	`\|newGeoPackageLayer\|`		`\|createMemory\|`
	`\|newVirtualLayer\|`
	`\|dbManager\|`		`\|gdal\|`
	`\|geoPackage\|`		`\|spatialite\|`
	`\|virtualLayer\|`		`\|wms\|`
	`\|wcs\|`		`\|wfs\|`
	`\|dbSchema\|`
	`\|inOverview\|`		`\|addAllToOverview\|`
	`\|removeAllOVerview\|`		`\|removeLayer\|`
	`\|showAllLayers\|`		`\|hideAllLayers\|`
	`\|showMapTheme\|`		`\|showSelectedLayers\|`
	`\|hideSelectedLayers\|`		`\|hideDeselectedLayers\|`
	`\|toggleAllLayers\|`		`\|toggleSelectedLayers\|`
	`\|addLayer\|`
	`\|indicatorTemporal\|`		`\|indicatorNonRemovable\|`
	`\|indicatorEmbedded\|`		`\|indicatorFilter\|`
	`\|indicatorMemory\|`		`\|indicatorNoCRS\|`
	`\|indicatorBadLayer\|`		`\|favourites\|`

5.3.2. File ¶

Icon	Substitution	Icon	Substitution
	`\|fileNew\|`		`\|fileOpen\|`
	`\|fileSave\|`		`\|fileSaveAs\|`
	`\|fileExit\|`

5.3.3. Edit ¶

Icon	Substitution	Icon	Substitution
	`\|undo\|`		`\|redo\|`
	`\|editCopy\|`		`\|editPaste\|`
	`\|editCut\|`		`\|saveEdits\|`
	`\|editableEdits\|`
	`\|circle2Points\|`		`\|circle2TangentsPoint\|`
	`\|circle3Points\|`		`\|circle3Tangents\|`
	`\|circleCenterPoint\|`		`\|ellipseCenter2Points\|`
	`\|ellipseCenterPoint\|`		`\|ellipseExtent\|`
	`\|ellipseFoci\|`		`\|rectangle3PointsDistance\|`
	`\|rectangle3PointsProjected\|`		`\|rectangleCenter\|`
	`\|rectangleExtent\|`		`\|regularPolygon2Points\|`
	`\|regularPolygonCenterCorner\|`		`\|regularPolygonCenterPoint\|`

5.3.4. Identity result ¶

Icon	Substitution	Icon	Substitution
	`\|expandTree\|`		`\|collapseTree\|`
	`\|expandNewTree\|`		`\|formView\|`
	`\|deselectAll\|`		`\|editCopy\|`
	`\|filePrint\|`
	`\|identifyByRectangle\|`		`\|identifyByPolygon\|`
	`\|identifyByFreehand\|`		`\|identifyByRadius\|`

5.3.5. Digitizing and Advanced Digitizing ¶

Icon	Substitution	Icon	Substitution
	`\|cad\|`		`\|cadConstruction\|`
	`\|cadParallel\|`		`\|cadPerpendicular\|`
	`\|toggleEditing\|`		`\|allEdits\|`
	`\|tracing\|`		`\|snapping\|`
	`\|capturePoint\|`		`\|capturePolygon\|`
	`\|captureLine\|`		`\|deleteSelectedFeatures\|`
	`\|circularStringCurvePoint\|`		`\|circularStringRadius\|`
	`\|vertexTool\|`		`\|vertexToolActiveLayer\|`
	`\|moveFeature\|`		`\|moveFeatureCopy\|`
	`\|moveFeatureLine\|`		`\|moveFeatureCopyLine\|`
	`\|moveFeaturePoint\|`		`\|moveFeatureCopyPoint\|`
	`\|rotateFeature\|`		`\|rotatePointSymbols\|`
	`\|offsetCurve\|`		`\|offsetPointSymbols\|`
	`\|simplifyFeatures\|`		`\|reshape\|`
	`\|addRing\|`		`\|addPart\|`
	`\|fillRing\|`
	`\|deleteRing\|`		`\|deletePart\|`
	`\|mergeFeatures\|`		`\|mergeFeatAttributes\|`
	`\|splitFeatures\|`		`\|splitParts\|`
	`\|reverseLine\|`

5.3.6. Map Navigation and attributes ¶

Icon	Substitution	Icon	Substitution
	`\|pan\|`		`\|panToSelected\|`
	`\|zoomIn\|`		`\|zoomOut\|`
	`\|zoomActual\|`		`\|zoomFullExtent\|`
	`\|zoomToLayer\|`		`\|zoomToSelected\|`
	`\|zoomLast\|`		`\|zoomNext\|`
	`\|refresh\|`
	`\|identify\|`		`\|mapTips\|`
	`\|showBookmarks\|`		`\|newBookmark\|`
	`\|measure\|`		`\|measureArea\|`
	`\|measureAngle\|`
	`\|newMap\|`		`\|new3DMap\|`
	`\|tiltUp\|`		`\|tiltDown\|`
	`\|3dNavigation\|`		`\|play\|`

5.3.7. Selection and Expressions ¶

Icon	Substitution	Icon	Substitution
	`\|selectRectangle\|`		`\|selectPolygon\|`
	`\|selectFreehand\|`		`\|selectRadius\|`
	`\|selectAll\|`		`\|deselectAll\|`
	`\|invertSelection\|`		`\|expressionSelect\|`
	`\|deselectActiveLayer\|`		`\|algorithmSelectLocation\|`
	`\|selectAllTree\|`		`\|select\|`
	`\|formSelect\|`		`\|dataDefined\|`
	`\|expression\|`		`\|dataDefineOn\|`
	`\|dataDefineExpressionOn\|`		`\|dataDefineError\|`
	`\|dataDefineExpressionError\|`
	`\|addExpression\|`
	`\|expressionFilter\|`		`\|filterMap\|`

5.3.8. Labels and Diagrams ¶

Icon	Substitution	Icon	Substitution
	`\|labeling\|`		`\|labelingNone\|`
	`\|labelingRuleBased\|`		`\|labelingObstacle\|`
	`\|piechart\|`		`\|diagramNone\|`
	`\|text\|`		`\|histogram\|`
	`\|stackedBar\|`
	`\|annotation\|`		`\|textAnnotation\|`
	`\|formAnnotation\|`		`\|htmlAnnotation\|`
	`\|svgAnnotation\|`		`\|autoPlacement\|`
	`\|labelbackground\|`		`\|labelbuffer\|`
	`\|labelformatting\|`		`\|labelplacement\|`
	`\|labelshadow\|`		`\|render\|`
	`\|labelcallout\|`
	`\|labelAnchorCenter\|`		`\|labelAnchorCustom\|`
	`\|labelAnchorEnd\|`		`\|labelAnchorStart\|`
	`\|pinLabels\|`		`\|showHideLabels\|`
	`\|moveLabel\|`		`\|rotateLabel\|`
	`\|showPinnedLabels\|`		`\|showUnplacedLabel\|`
	`\|changeLabelProperties\|`

5.3.9. Decorations ¶

Icon	Substitution	Icon	Substitution
	`\|copyrightLabel\|`		`\|addGrid\|`
	`\|titleLabel\|`		`\|northArrow\|`
	`\|scaleBar\|`		`\|addMap\|`
	`\|addImage\|`

5.3.10. Help ¶

Icon	Substitution	Icon	Substitution
	`\|helpContents\|`		`\|qgisHomePage\|`
	`\|success\|`
	`\|helpSponsors\|`		`\|contextHelp\|`

5.3.11. Colors ¶

Icon	Substitution	Icon	Substitution
	`\|colorBox\|`		`\|colorPicker\|`
	`\|colorSwatches\|`		`\|colorWheel\|`

5.4. Other basic icons ¶

Icon	Substitution	Icon	Substitution
	`\|arrowDown\|`		`\|arrowUp\|`
	`\|signPlus\|`		`\|signMinus\|`
	`\|projectProperties\|`		`\|options\|`
	`\|interfaceCustomization\|`		`\|keyboardShortcuts\|`
	`\|copyrightLabel\|`		`\|northArrow\|`
	`\|scaleBar\|`		`\|tracking\|`
	`\|gpsImporter\|`		`\|gpsTrackBarChart\|`
	`\|folder\|`		`\|extents\|`
	`\|settings\|`		`\|start\|`
	`\|3dconfigure\|`		`\|deleteSelected\|`
	`\|browserExpand\|`		`\|browserCollapse\|`
	`\|codeEditor\|`

5.5. Attribute Table ¶

Icon	Substitution	Icon	Substitution
	`\|openTable\|`		`\|selectedToTop\|`
	`\|selectAll\|`		`\|invertSelection\|`
	`\|panToSelected\|`		`\|zoomToSelected\|`
	`\|copySelected\|`		`\|editPaste\|`
	`\|expressionSelect\|`		`\|deleteSelectedFeatures\|`
	`\|newAttribute\|`		`\|deleteAttribute\|`
	`\|newTableRow\|`		`\|calculateField\|`
	`\|refresh\|`		`\|formView\|`
	`\|conditionalFormatting\|`		`\|multiEdit\|`
	`\|dock\|`		`\|actionRun\|`
	`\|duplicateFeature\|`
	`\|panTo\|`		`\|highlightFeature\|`

5.6. Projections and Georeferencer ¶

Icon	Substitution	Icon	Substitution
	`\|geographic\|`		`\|crs\|`
	`\|customProjection\|`		`\|setProjection\|`
	`\|projectionDisabled\|`		`\|projectionEnabled\|`
	`\|transformation\|`
	`\|georefRun\|`		`\|pencil\|`
	`\|linkQGisToGeoref\|`		`\|linkGeorefToQGis\|`
	`\|fullHistogramStretch\|`

5.7. Print Layout ¶

Icon	Substitution	Icon	Substitution
	`\|newLayout\|`		`\|layoutManager\|`
	`\|duplicateLayout\|`
	`\|newReport\|`		`\|newPage\|`
	`\|atlasSettings\|`		`\|atlas\|`
	`\|filePrint\|`		`\|saveMapAsImage\|`
	`\|saveAsSVG\|`		`\|saveAsPDF\|`
	`\|addBasicShape\|`		`\|addBasicCircle\|`
	`\|addBasicTriangle\|`		`\|addBasicRectangle\|`
	`\|addNodesShape\|`		`\|editNodesShape\|`
	`\|addPolygon\|`		`\|addPolyline\|`
	`\|addArrow\|`		`\|northArrow\|`
	`\|add3DMap\|`		`\|addMap\|`
	`\|addLegend\|`		`\|addHtml\|`
	`\|addManualTable\|`		`\|addTable\|`
	`\|addImage\|`		`\|addMarker\|`
	`\|label\|`		`\|scaleBar\|`
	`\|select\|`		`\|moveItemContent\|`
	`\|setToCanvasScale\|`		`\|setToCanvasExtent\|`
	`\|viewScaleInCanvas\|`		`\|viewExtentInCanvas\|`
	`\|raiseItems\|`		`\|lowerItems\|`
	`\|moveItemsToTop\|`		`\|moveItemsToBottom\|`
	`\|alignLeft\|`		`\|alignRight\|`
	`\|alignHCenter\|`		`\|alignVCenter\|`
	`\|alignTop\|`		`\|alignBottom\|`
	`\|resizeShortest\|`		`\|resizeTallest\|`
	`\|resizeNarrowest\|`		`\|resizeWidest\|`
	`\|resizeSquare\|`
	`\|lockItems\|`		`\|unlockAll\|`
	`\|locked\|`		`\|unlocked\|`
	`\|lockedRepeat\|`		`\|lockedGray\|`
	`\|groupItems\|`

5.8. Layer Properties ¶

Icon	Substitution	Icon	Substitution
	`\|symbology\|`		`\|labeling\|`
	`\|sourceFields\|`		`\|general\|`
	`\|metadata\|`		`\|action\|`
	`\|display\|`		`\|rendering\|`
	`\|join\|`		`\|diagram\|`
	`\|labelmask\|`		`\|temporal\|`
	`\|legend\|`		`\|dependencies\|`
	`\|3d\|`		`\|system\|`
	`\|editMetadata\|`		`\|overlay\|`
	`\|digitizing\|`		`\|auxiliaryStorage\|`
	`\|history\|`		`\|stylePreset\|`
	`\|search\|`		`\|pyramids\|`
	`\|transparency\|`		`\|rasterHistogram\|`
	`\|singleSymbol\|`		`\|nullSymbol\|`
	`\|graduatedSymbol\|`		`\|categorizedSymbol\|`
	`\|25dSymbol\|`		`\|ruleBasedSymbol\|`
	`\|invertedSymbol\|`		`\|heatmapSymbol\|`
	`\|pointDisplacementSymbol\|`		`\|pointClusterSymbol\|`
	`\|meshcontours\|`		`\|meshcontoursoff\|`
	`\|meshvectors\|`		`\|meshvectorsoff\|`
	`\|meshframe\|`
	`\|sum\|`		`\|sort\|`
	`\|paintEffects\|`		`\|mapIdentification\|`
	`\|styleManager\|`		`\|iconView\|`
	`\|joinNotEditable\|`		`\|joinedLayerNotEditable\|`
	`\|joinHasNotUpsertOnEdit\|`		`\|filterTableFields\|`
	`\|symbologyEdit\|`
	`\|sharingImport\|`		`\|sharingExport\|`

5.9. Plugins ¶

5.9.1. Processing ¶

Icon	Substitution	Icon	Substitution
	`\|processing\|`		`\|processingModel\|`
	`\|processingHistory\|`		`\|processingResult\|`
	`\|processSelected\|`		`\|processingHelp\|`
	`\|saveAsPython\|`		`\|processingOutput\|`
	`\|qgsProjectFile\|`		`\|addToProject\|`
	`\|integer\|`
	`\|mean\|`		`\|layerExtent\|`
	`\|randomSelection\|`		`\|vectorGrid\|`
	`\|convexHull\|`		`\|buffer\|`
	`\|intersect\|`		`\|union\|`
	`\|symDifference\|`		`\|clip\|`
	`\|difference\|`		`\|dissolve\|`
	`\|checkGeometry\|`		`\|exportGeometry\|`
	`\|delaunay\|`		`\|centroids\|`
	`\|toLines\|`		`\|extractNodes\|`
	`\|splitLayer\|`		`\|heatmap\|`
	`\|showRasterCalculator\|`		`\|showMeshCalculator\|`

5.9.2. Various Core Plugins ¶

Standard provided with basic install, but not loaded with initial install

Icon	Substitution	Icon	Substitution
	`\|showPluginManager\|`		`\|installPluginFromZip\|`
	`\|pythonFile\|`		`\|runConsole\|`
	`\|showEditorConsole\|`		`\|clearConsole\|`
	`\|offlineEditingCopy\|`		`\|offlineEditingSync\|`
	`\|plugin\|`		`\|interpolation\|`
	`\|gdalScript\|`		`\|metasearch\|`
	`\|geometryChecker\|`		`\|topologyChecker\|`
	`\|fromSelectedFeature\|`		`\|sqlQueryBuilder\|`

5.9.3. Grass integration ¶

Icon	Substitution	Icon	Substitution
	`\|grass\|`		`\|grassRegion\|`
	`\|grassTools\|`		`\|grassNewMapset\|`
	`\|grassOpenMapset\|`		`\|grassCloseMapset\|`

Icon	Substitution	Icon	Substitution
	`\|logo\|`
	`\|kde\|`		`\|nix\|`
	`\|osx\|`		`\|win\|`

Substitution	Icon	Substitution
`\|checkbox\|`		`\|unchecked\|`
`\|radioButtonOn\|`		`\|radioButtonOff\|`
`\|selectNumber\|`		`\|selectString\|`
`\|selectColor\|`		`\|selectColorRamp\|`
`\|tab\|`	°	`\|degrees\|`
`\|inputText\|`		`\|slider\|`

Icon	Substitution	Icon	Substitution
	`\|dataSourceManager\|`
	`\|addOgrLayer\|`		`\|addDb2Layer\|`
	`\|addRasterLayer\|`		`\|addMssqlLayer\|`
	`\|addDelimitedTextLayer\|`		`\|addSpatiaLiteLayer\|`
	`\|addPostgisLayer\|`		`\|addOracleLayer\|`
	`\|addAfsLayer\|`		`\|addAmsLayer\|`
	`\|addMeshLayer\|`
	`\|addVectorTileLayer\|`		`\|addXyzLayer\|`
	`\|addVirtualLayer\|`		`\|addWmsLayer\|`
	`\|addWcsLayer\|`		`\|addWfsLayer\|`
	`\|newVectorLayer\|`		`\|newSpatiaLiteLayer\|`
	`\|newGeoPackageLayer\|`		`\|createMemory\|`
	`\|newVirtualLayer\|`
	`\|dbManager\|`		`\|gdal\|`
	`\|geoPackage\|`		`\|spatialite\|`
	`\|virtualLayer\|`		`\|wms\|`
	`\|wcs\|`		`\|wfs\|`
	`\|dbSchema\|`
	`\|inOverview\|`		`\|addAllToOverview\|`
	`\|removeAllOVerview\|`		`\|removeLayer\|`
	`\|showAllLayers\|`		`\|hideAllLayers\|`
	`\|showMapTheme\|`		`\|showSelectedLayers\|`
	`\|hideSelectedLayers\|`		`\|hideDeselectedLayers\|`
	`\|toggleAllLayers\|`		`\|toggleSelectedLayers\|`
	`\|addLayer\|`
	`\|indicatorTemporal\|`		`\|indicatorNonRemovable\|`
	`\|indicatorEmbedded\|`		`\|indicatorFilter\|`
	`\|indicatorMemory\|`		`\|indicatorNoCRS\|`
	`\|indicatorBadLayer\|`		`\|favourites\|`

Icon	Substitution	Icon	Substitution
	`\|fileNew\|`		`\|fileOpen\|`
	`\|fileSave\|`		`\|fileSaveAs\|`
	`\|fileExit\|`

Icon	Substitution	Icon	Substitution
	`\|undo\|`		`\|redo\|`
	`\|editCopy\|`		`\|editPaste\|`
	`\|editCut\|`		`\|saveEdits\|`
	`\|editableEdits\|`
	`\|circle2Points\|`		`\|circle2TangentsPoint\|`
	`\|circle3Points\|`		`\|circle3Tangents\|`
	`\|circleCenterPoint\|`		`\|ellipseCenter2Points\|`
	`\|ellipseCenterPoint\|`		`\|ellipseExtent\|`
	`\|ellipseFoci\|`		`\|rectangle3PointsDistance\|`
	`\|rectangle3PointsProjected\|`		`\|rectangleCenter\|`
	`\|rectangleExtent\|`		`\|regularPolygon2Points\|`
	`\|regularPolygonCenterCorner\|`		`\|regularPolygonCenterPoint\|`