GUI Icons

The Serna GUI global icons common to all documents are compiled-in. The plugin-specific icons coming with the distribution are stored in the icons subdirectory within the plugin directory (e.g. DITA-specific icons reside in sernaInstallationPath\plugins\dita\icons).

It is possible to add your own new icons as well as override the compiled-in icons or overwrite the icons coming with the distribution. The possible graphical formats for the icons are: JPG, GIF, BMP, PNG, XBM, XPM, PNM.

In the dialogs wherever the icons are used (e.g. Custom Content Dialog), the list of registered icons is available in a combo-box.

The following rules apply to overriding and adding new icons:

1. Global icon files must reside in sernaInstallationPath/icons directory. Plugin-specific icon files must reside in the icons subdirectory within the plugin directory (e.g. sernaInstallationPath\plugins\dita\icons).

   Important:

   Icon size must not exceed 20x20 pixels, otherwise the icon will not be shown in the drop-down lists in the dialogs such as the Custom Content Dialog and Interface Customizer Dialog.

2. The icon file must be named icon-name.ext, where icon-name must be the same as in the icon's value, and ext should be the extension for the icon graphic type (e.g. new_document.png, dita_topic.png)

   Note:

   You can find an icon's value in the Interface Customizer Dialog. Note that global icons common to all documents have <icon-name> values (e.g. new_document, publish_ah), while plugin-specific icons have <plugin-name>:<icon-name> values (e.g. DITA_Py:dita_topic).

3. If you want to provide the "disabled" type of the icon you must also provide icon-name_disabled.ext icon file.

To learn how to override/overwrite a GUI icon, see How to Override Icon or proceed to the quick start example: