Substitutions

Usage ¶

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:

check the documentation repository whether the icon is available in /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.
create the reference to the substitution in the /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

(optional) add the reference to the icon and its substitution to the list below.

Common Substitutions ¶

Below are given some icons and their substitution to use when writing documentation. Can be used/found in many places in manuals.

Platform Icons ¶

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

Icon	Substitution	Icon	Substitution
	`\|checkbox\|`		`\|unchecked\|`
	`\|radioButtonOn\|`		`\|radioButtonOff\|`
	`\|selectNumber\|`		`\|selectString\|`
	`\|browseButton\|`		`\|slider\|`

Icon	Substitution
	`\|selectColor\|`
	`\|inputText\|`
	`\|tab\|`
°	`\|degrees\|`

Toolbar Button Icons ¶

Manage Layers and overview ¶

Icon	Substitution	Icon	Substitution
	`\|addOgrLayer\|`		`\|addDb2Layer\|`
	`\|addRasterLayer\|`		`\|addMssqlLayer\|`
	`\|addDelimitedTextLayer\|`		`\|addSpatiaLiteLayer\|`
	`\|addPostgisLayer\|`		`\|addOracleLayer\|`
	`\|addAfsLayer\|`		`\|addAmsLayer\|`
	`\|virtualLayer\|`		`\|wms\|`
	`\|wcs\|`		`\|wfs\|`
	`\|newVectorLayer\|`		`\|newSpatiaLiteLayer\|`
	`\|newGeoPackageLayer\|`		`\|createMemory\|`
	`\|dbManager\|`		`\|gdal\|`
	`\|inOverview\|`		`\|addAllToOverview\|`
	`\|removeAllOVerview\|`		`\|removeLayer\|`
	`\|showAllLayers\|`		`\|hideAllLayers\|`
	`\|showPresets\|`		`\|zip\|`
	`\|addLayer\|`

File ¶

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

Edit ¶

Icon	Substitution	Icon	Substitution
	`\|saveEdits\|`
	`\|undo\|`		`\|redo\|`
	`\|editCopy\|`		`\|editPaste\|`
	`\|editCut\|`

Identity result ¶

Icon	Substitution	Icon	Substitution
	`\|expandTree\|`		`\|collapseTree\|`
	`\|expandNewTree\|`		`\|propertyItem\|`
	`\|deselectAll\|`		`\|editCopy\|`
	`\|filePrint\|`		`\|propertiesWidget\|`

Digitizing and Advanced Digitizing ¶

Icon	Substitution	Icon	Substitution
	`\|cad\|`		`\|cadConstruction\|`
	`\|cadParallel\|`		`\|cadPerpendicular\|`
	`\|toggleEditing\|`		`\|allEdits\|`
	`\|tracing\|`		`\|capturePoint\|`
	`\|captureLine\|`		`\|capturePolygon\|`
	`\|circularStringCurvePoint\|`		`\|circularStringRadius\|`
	`\|nodeTool\|`		`\|deleteSelected\|`
	`\|moveFeature\|`		`\|rotateFeature\|`
	`\|simplifyFeatures\|`		`\|reshape\|`
	`\|addRing\|`		`\|addPart\|`
	`\|fillRing\|`
	`\|deleteRing\|`		`\|deletePart\|`
	`\|mergeFeatures\|`		`\|mergeFeatAttributes\|`
	`\|splitFeatures\|`		`\|splitParts\|`
	`\|offsetPointSymbols\|`		`\|rotatePointSymbols\|`
	`\|offsetCurve\|`

Map Navigation and attributes ¶

Icon	Substitution	Icon	Substitution
	`\|pan\|`		`\|panToSelected\|`
	`\|zoomIn\|`		`\|zoomOut\|`
	`\|zoomActual\|`		`\|zoomFullExtent\|`
	`\|zoomToLayer\|`		`\|zoomToSelected\|`
	`\|zoomLast\|`		`\|zoomNext\|`
	`\|touch\|`		`\|draw\|`
	`\|identify\|`		`\|mapTips\|`
	`\|showBookmarks\|`		`\|newBookmark\|`
	`\|measure\|`		`\|measureArea\|`
	`\|measureAngle\|`

Selection and Expressions ¶

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

Labels and Diagrams ¶

Icon	Substitution	Icon	Substitution
	`\|labeling\|`		`\|labelingNone\|`
	`\|labelingRuleBased\|`		`\|labelingObstacle\|`
	`\|diagramProperties\|`		`\|diagramNone\|`
	`\|text\|`		`\|histogram\|`
	`\|annotation\|`		`\|textAnnotation\|`
	`\|formAnnotation\|`		`\|htmlAnnotation\|`
	`\|svgAnnotation\|`

Help ¶

Icon	Substitution	Icon	Substitution
	`\|helpContents\|`		`\|qgisHomePage\|`
	`\|checkQgisVersion\|`		`\|helpAbout\|`
	`\|helpSponsors\|`		`\|contextHelp\|`

Colors ¶

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

Other basic icons ¶

Icon	Substitution	Icon	Substitution
	`\|arrowDown\|`		`\|arrowUp\|`
	`\|arrowLeft\|`		`\|arrowRight\|`
	`\|signPlus\|`		`\|signMinus\|`
	`\|projectProperties\|`		`\|options\|`
	`\|copyrightLabel\|`		`\|northArrow\|`
	`\|scaleBar\|`		`\|locale\|`
	`\|gpsImporter\|`		`\|gpsTrackBarChart\|`
	`\|gpsTrackPolarChart\|`		`\|tracking\|`
	`\|folder\|`		`\|extents\|`
	`\|settings\|`

Attribute Table ¶

Icon	Substitution	Icon	Substitution
	`\|openTable\|`		`\|selectedToTop\|`
	`\|selectAll\|`		`\|invertSelection\|`
	`\|panToSelected\|`		`\|zoomToSelected\|`
	`\|copySelected\|`		`\|editPaste\|`
	`\|expressionSelect\|`		`\|deleteSelected\|`
	`\|newAttribute\|`		`\|deleteAttribute\|`
	`\|newTableRow\|`		`\|calculateField\|`
	`\|draw\|`		`\|formView\|`
	`\|conditionalFormatting\|`		`\|multiEdit\|`

Projections and Georeferencer ¶

Icon	Substitution	Icon	Substitution
	`\|geographic\|`		`\|crs\|`
	`\|customProjection\|`		`\|setProjection\|`
	`\|projectionDisabled\|`		`\|projectionEnabled\|`
	`\|georeferencer\|`		`\|pencil\|`
	`\|linkQGisToGeoref\|`		`\|linkGeorefToQGis\|`
	`\|coordinateCapture\|`		`\|startGeoref\|`

Composer Icons ¶

Icons used in Composer:

Icon	Substitution	Icon	Substitution
	`\|newComposer\|`		`\|composerManager\|`
	`\|duplicateComposer\|`
	`\|atlasSettings\|`		`\|atlas\|`
	`\|filePrint\|`		`\|saveMapAsImage\|`
	`\|saveAsSVG\|`		`\|saveAsPDF\|`
	`\|addArrow\|`		`\|addBasicShape\|`
	`\|addNodesShape\|`		`\|editNodesShape\|`
	`\|addMap\|`		`\|addLegend\|`
	`\|addHtml\|`		`\|addTable\|`
	`\|label\|`		`\|scaleBar\|`
	`\|select\|`		`\|moveItemContent\|`
	`\|raiseItems\|`		`\|lowerItems\|`
	`\|moveItemsToTop\|`		`\|moveItemsToBottom\|`
	`\|alignLeft\|`		`\|alignRight\|`
	`\|alignHCenter\|`		`\|alignVCenter\|`
	`\|alignTop\|`		`\|alignBottom\|`
	`\|locked\|`		`\|unlocked\|`
	`\|lockedRepeat\|`		`\|groupItems\|`

Properties ¶

Icons used in Layer Properties dialog:

Icon	Substitution	Icon	Substitution
	`\|symbology\|`		`\|labeling\|`
	`\|attributes\|`		`\|general\|`
	`\|metadata\|`		`\|action\|`
	`\|mapTips\|`		`\|rendering\|`
	`\|join\|`		`\|diagram\|`
	`\|legend\|`
	`\|history\|`		`\|stylePreset\|`
	`\|singleSymbol\|`		`\|nullSymbol\|`
	`\|graduatedSymbol\|`		`\|categorizedSymbol\|`
	`\|25dSymbol\|`		`\|ruleBasedSymbol\|`
	`\|invertedSymbol\|`		`\|heatmapSymbol\|`
	`\|pointDisplacementSymbol\|`		`\|pointClusterSymbol\|`
	`\|sum\|`		`\|sort\|`
	`\|paintEffects\|`		`\|mapIdentification\|`

Vector Menu Icons ¶

Icon	Substitution	Icon	Substitution
	`\|matrix\|`		`\|unique\|`
	`\|sumLines\|`		`\|sumPoints\|`
	`\|basicStatistics\|`		`\|neighbor\|`
	`\|mean\|`		`\|intersections\|`
	`\|randomSelection\|`		`\|subSelection\|`
	`\|randomPoints\|`
	`\|regularPoints\|`		`\|vectorGrid\|`
	`\|selectLocation\|`		`\|layerExtent\|`
	`\|convexHull\|`		`\|buffer\|`
	`\|intersect\|`		`\|union\|`
	`\|symDifference\|`		`\|clip\|`
	`\|difference\|`		`\|dissolve\|`
	`\|checkGeometry\|`		`\|exportGeometry\|`
	`\|delaunay\|`		`\|centroids\|`
	`\|simplify\|`		`\|joinLocation\|`
	`\|multiToSingle\|`		`\|singleToMulti\|`
	`\|toLines\|`		`\|extractNodes\|`
	`\|exportProjection\|`		`\|defineProjection\|`
	`\|splitLayer\|`		`\|mergeShapes\|`

Plugin Icons ¶

Core Plugin Icons ¶

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

Icon	Substitution	Icon	Substitution
	`\|showPluginManager\|`		`\|pluginInstaller\|`
	`\|offlineEditingCopy\|`		`\|offlineEditingSync\|`
	`\|plugin\|`		`\|interpolation\|`
	`\|mapserverExport\|`		`\|exportMapServer\|`
	`\|delimitedText\|`
	`\|gdalScript\|`		`\|dxf2shpConverter\|`
	`\|spatialQuery\|`		`\|selectSubsetLayer\|`
	`\|selectCreateLayer\|`		`\|metasearch\|`
	`\|geometryChecker\|`		`\|geometrySnapper\|`
	`\|topologychecker\|`		`\|oracleRaster\|`

Grass integration ¶

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

OpenStreetMap ¶

Icon	Substitution	Icon	Substitution
	`\|osmLoad\|`		`\|osmDownload\|`
	`\|osmFeatureManager\|`		`\|osmIdentify\|`
	`\|osmImport\|`		`\|osmSave\|`
	`\|osmCreatePoint\|`		`\|osmCreateLine\|`
	`\|osmCreatePolygon\|`
	`\|osmMove\|`		`\|osmRemoveFeat\|`
	`\|osmCreateRelation\|`		`\|osmAddRelation\|`
	`\|osmEditRelation\|`		`\|osmGenerateTags\|`
	`\|osmQuestionMark\|`

Raster related ¶

Icon	Substitution	Icon	Substitution
	`\|fullCumulativeStretch\|`		`\|fullHistogramStretch\|`
	`\|showRasterCalculator\|`		`\|rasterStats\|`
	`\|rasterInterpolate\|`		`\|rasterInfo\|`
	`\|rasterTerrain\|`		`\|heatmap\|`

eVis plugin ¶

Icon	Substitution	Icon	Substitution
	`\|eventBrowser\|`		`\|eventId\|`
	`\|evisConnect\|`		`\|evisFile\|`

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

Icon	Substitution	Icon	Substitution
	`\|checkbox\|`		`\|unchecked\|`
	`\|radioButtonOn\|`		`\|radioButtonOff\|`
	`\|selectNumber\|`		`\|selectString\|`
	`\|browseButton\|`		`\|slider\|`

Icon	Substitution
	`\|selectColor\|`
	`\|inputText\|`
	`\|tab\|`
°	`\|degrees\|`

Icon	Substitution	Icon	Substitution
	`\|addOgrLayer\|`		`\|addDb2Layer\|`
	`\|addRasterLayer\|`		`\|addMssqlLayer\|`
	`\|addDelimitedTextLayer\|`		`\|addSpatiaLiteLayer\|`
	`\|addPostgisLayer\|`		`\|addOracleLayer\|`
	`\|addAfsLayer\|`		`\|addAmsLayer\|`
	`\|virtualLayer\|`		`\|wms\|`
	`\|wcs\|`		`\|wfs\|`
	`\|newVectorLayer\|`		`\|newSpatiaLiteLayer\|`
	`\|newGeoPackageLayer\|`		`\|createMemory\|`
	`\|dbManager\|`		`\|gdal\|`
	`\|inOverview\|`		`\|addAllToOverview\|`
	`\|removeAllOVerview\|`		`\|removeLayer\|`
	`\|showAllLayers\|`		`\|hideAllLayers\|`
	`\|showPresets\|`		`\|zip\|`
	`\|addLayer\|`

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

Outdated version of the documentation. Find the latest one here.

Table Of Contents

Substitutions¶