Confluence Docs 3.0 : Adding a Configuration UI for your Plugin
This page last changed on Sep 07, 2009 by ggaskell.
On this page: Purpose of the Configuration UIA plugin for an Atlassian application can specify internal links within the application, to allow the user to configure options for the plugin. This is useful where your plugin requires configuration or user-specific settings to work. Here are some examples of plugins which provide a configuration UI:
In Creating your Plugin Descriptor, we tell you how to create the XML descriptor file for your plugin. In Plugin Module Types, we tell you how to define the modules within your plugin. Below is information on defining the links to the configuration UI for your plugin. Adding a Configuration Link for the Entire PluginTo add a configuration link for your plugin as a whole, place a single param element with the name configure.url within the plugin-info element at the top of the plugin descriptor: <plugin-info> <description>A macro which displays Google maps within a Confluence page.</description> <vendor name="Atlassian Software Systems Pty Ltd" url="http://www.atlassian.com/"/> <version>0.1</version> <param name="configure.url">/admin/plugins/gmaps/configurePlugin.action</param> </plugin-info> Adding a Configuration Link for a ModuleTo add a configuration link for a single module within your plugin, place a single param element with the name configure.url within the descriptor element for that module: <macro name="gmap" class="com.atlassian.confluence.ext.gmaps.GmapsMacro" key="gmap"> <description>The individual map macro.</description> <param name="configure.url">/admin/plugins/gmaps/configureMacro.action</param> </macro> Example of a Plugin Configuration UIHere is an image showing where the configuration links appear for both a plugin and an individual module within Confluence: Notes
RELATED TOPICS
Information sourced from Plugin Framework documentation |
![]() |
Document generated by Confluence on Nov 05, 2009 23:34 |