Logo Help Center

Elvis 6 action plug-ins setting - icons

Elvis 6 action plug-ins setting - icons

The icons setting is one of the settings of an Action plug-in that can be configured in its configuration file. For more information, see Elvis 6 Action plug-ins - configuration settings.

Required Yes
Description

There are two png icon images defined for a plug-in, one is 16x16 pixels and the other 24x24 pixels. These icons are used in the Pro client, the 24x24 variant is used as icon for the button in the main button toolbar, the 16x16 variant is currently not used, but defined for future reference.

Internally hosted plug-ins can have icons URL's relative to the server domain. This allows you to create a plug-in which can run directly in any Elvis server installation without having to change the icon URL settings. There are variables that can be used to create these relative URL's.

Basic setting
<action>
    <icon16Url>...</icon16Url>
    <icon24Url>...</icon24Url>
</action>

Examples

Icons in the plug-in folder

Assume we have a plug-in called my_plugin containing the two icon images: active/my_plugin/....

<icon16Url>${pluginUrl}/icon16.png</icon16Url>
<icon24Url>${pluginUrl}/icon24.png</icon24Url>

Icons in the base plug-in folder

Assume we have a plug-in that uses the icons from the plug-in base, for example the debug plug-in, which has the following plug-in path on disk: plugin_base/action.base/debug.base/....

<icon16Url>${pluginsBaseUrl}/icon16.png</icon16Url>
<icon24Url>${pluginsBaseUrl}/icon24.png</icon24Url>

Externally hosted icons

Assume that we have the plug-in icons hosted on a different machine, different domain, etc.

<icon16Url>http://www.myserver.com/specialplugin/icon16.png</icon16Url>
<icon24Url>http://www.myserver.com/specialplugin/icon24.png</icon24Url>
Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.