Substitutions

Usage

To easier 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 /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 /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.

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 Icon Substitution
logo |logo|    
kde |kde| nix |nix|
osx |osx| win |win|

Toolbar Button Icons

Manage Layers and overview

Icon Substitution Icon Substitution
dataSourceManager |dataSourceManager|
addOgrLayer |addOgrLayer| addDb2Layer |addDb2Layer|
addRasterLayer |addRasterLayer| addMssqlLayer |addMssqlLayer|
addDelimitedTextLayer |addDelimitedTextLayer| addSpatiaLiteLayer |addSpatiaLiteLayer|
addPostgisLayer |addPostgisLayer| addOracleLayer |addOracleLayer|
addAfsLayer |addAfsLayer| addAmsLayer |addAmsLayer|
virtualLayer |virtualLayer| wms |wms|
wcs |wcs| wfs |wfs|
newVectorLayer |newVectorLayer| newSpatiaLiteLayer |newSpatiaLiteLayer|
newGeoPackageLayer |newGeoPackageLayer| createMemory |createMemory|
dbManager |dbManager| gdal |gdal|
inOverview |inOverview| addAllToOverview |addAllToOverview|
removeAllOVerview |removeAllOVerview| removeLayer |removeLayer|
showAllLayers |showAllLayers| hideAllLayers |hideAllLayers|
showMapTheme |showMapTheme| showSelectedLayers |showSelectedLayers|
hideSelectedLayers |hideSelectedLayers| hideDeselectedLayers |hideDeselectedLayers|
addLayer |addLayer|    
indicatorEmbedded |indicatorEmbedded| indicatorFilter |indicatorFilter|
indicatorMemory |indicatorMemory| favourites |favourites|

File

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

Edit

Icon Substitution Icon Substitution
undo |undo| redo |redo|
editCopy |editCopy| editPaste |editPaste|
editCut |editCut| saveEdits |saveEdits|
editableEdits |editableEdits|    

Identity result

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

Digitizing and Advanced Digitizing

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

Map Navigation and attributes

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

Selection and Expressions

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

Labels and Diagrams

Icon Substitution Icon Substitution
labeling |labeling| labelingNone |labelingNone|
labelingRuleBased |labelingRuleBased| labelingObstacle |labelingObstacle|
piechart |piechart| diagramNone |diagramNone|
text |text| histogram |histogram|
annotation |annotation| textAnnotation |textAnnotation|
formAnnotation |formAnnotation| htmlAnnotation |htmlAnnotation|
svgAnnotation |svgAnnotation| autoPlacement |autoPlacement|
labelbackground |labelbackground| labelbuffer |labelbuffer|
labelformatting |labelformatting| labelplacement |labelplacement|
labelshadow |labelshadow| render |render|

Help

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

Colors

Icon Substitution Icon Substitution
colorBox |colorBox| colorPicker |colorPicker|
colorSwatches |colorSwatches| colorWheel |colorWheel|

Other basic icons

Icon Substitution Icon Substitution
arrowDown |arrowDown| arrowUp |arrowUp|
signPlus |signPlus| signMinus |signMinus|
projectProperties |projectProperties| options |options|
interfaceCustomization |interfaceCustomization| keyboardShortcuts |keyboardShortcuts|
copyrightLabel |copyrightLabel| northArrow |northArrow|
scaleBar |scaleBar| tracking |tracking|
gpsImporter |gpsImporter| gpsTrackBarChart |gpsTrackBarChart|
folder |folder| extents |extents|
settings |settings| start |start|

Attribute Table

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

Projections and Georeferencer

Icon Substitution Icon Substitution
geographic |geographic| crs |crs|
customProjection |customProjection| setProjection |setProjection|
projectionDisabled |projectionDisabled| projectionEnabled |projectionEnabled|
georefRun |georefRun| pencil |pencil|
linkQGisToGeoref |linkQGisToGeoref| linkGeorefToQGis |linkGeorefToQGis|
coordinateCapture |coordinateCapture| fullHistogramStretch |fullHistogramStretch|

Layer Properties

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

Plugins

Processing

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

Various Core Plugins

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

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

Grass integration

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

eVis plugin

Icon Substitution Icon Substitution
eventBrowser |eventBrowser| eventId |eventId|
evisConnect |evisConnect| evisFile |evisFile|