Icon Gallery
This page can be used as a reference for finding icons and their filenames to use them in the documentation.
See here for how to add icons to pages.
General icons
General icons used in Stroom.
Example: {{< stroom-icon "edit.svg" >}}
Pipeline element icons
Icons used for the different pipeline elements.
Base path: pipeline
Example: {{< stroom-icon "pipeline/stream.svg" >}}
Document type icons
Icons used for the different document entity types, i.e. those seen in the explorer tree.
Base path: document
Example: {{< stroom-icon "document/Index.svg" >}}
Table column icons
Icons used on the Dashboard and Query table columns.
Base path: fields.
Menu items
Menu items with icons that are available for use with the stroom-menu shortcode.
Pipeline elements
Pipeline elements that are available for use with the pipe-elm and pipe shortcodes.
Updating this gallery
Icons
This gallery of icons can be updated by running the following script which will copy all the icons from the stroom repository. You should ensure your local stroom repository is up to date and on the correct branch before running this.
e.g.
Menu Items
To update the available menu items edit the shortcode file layouts/shortcodes/stroom-menu.html and modify the icon_map variable.
Pipeline elements
To update the available pipeline elements edit the shortcode file layouts/shortcodes/pipe-elm.html and modify the element_map variable.