PortalToolsPlugins
A plugin should add/group administrative functions for one special concern (e.g. user management).
Components
Each plugin must contain at least the following components:
- Tool.xml
- Sitemap.xmap
- i18n-Files
and - Flow/Forms/JX-Templates/Stylesheets/Images etc. required by the plugin
tool.xml
The tool.xml file is a 'description' of the plugin. It contains a name, an id and a list of functions which are available for use. Furthermore, it holds information about the i18n-catalogues bundled with the plugin. As further development of the RightsManagement takes place, the tool.xml file will include authentication id’s and defaults.
A sample tool.xml looks like:
<tool name="copletManagement.title" id="copletManagement">
<functions>
<function name="copletManagement.editLayout"
id="copletMangementEditLayout" pipeline="showTab"/>
</functions>
<i18n>
<catalogue id="copletManagement" name="copletManagement"/>
</i18n>
</tool>
<tool>-tag
name |
The name of the plugin, will be displayed in the menu. Should be an i18n-key |
id |
a unique id for the plugin. every other id or key should start with this id |
<functions>-tag
name |
name of the function, i18n-key |
id |
unique id for the function |
pipeline | a pipeline in the sitemap which contains displays the gui |
<catalogue>-tag
id |
id for the catalogue |
name |
name of the catalogue (the beginning of the i18n-filenames) |
The location is generated automatically.
sitemap.xmap
The sitemap must contain at least the pipelines for the functions declared in tool.xml. Please have a look at the sitemaps provided with the samples for further detail (especially for how the portal-skins are applied).
i18n-Files
The i18n-File are standard Cocoon-i18n-Files. Add one file for each language required. If you want to give your tool back to Cocoon you should add an english file as default (youPluginName.xml) 