Hi,
I would definitely go with Soy templates. They are used by Stash internally as well and provide - beside having quite a nice syntax - the possibility to be used on the server as well as on the client side, as they are transformed to JavaScript on the client side.
For plug-in settings, I would go with a template similar to this (note the usage of the decorator and the active tab):
/**
* @param config
* @param? errors
**/
{template .adminConfigurationPanel}
<html>
<head>
<meta name="decorator" content="atl.admin">
<meta name="admin.active.tab" content="your-webitem-key-from-atlassian-plugin.xml"/>
<title>{{stash_i18n('adminconfig.title', 'Plug-in Admin Config')}}</title>
</head>
<body>
// YOUR SETTINGS PAGE CONTENT HERE
</body>
{/template}Inside your SOY template, you want to use AUI to have a consistent look with the Atlassian products. There is not so much documentation about how to use the SOY templates provided by AUI, but the source code is of great help here:
https://bitbucket.org/atlassian/aui/src/883995019420e253fcc22346a38b8624e838e908/src/soy/?at=master
As form elements are probably necessary when building a settings page, you should have a look at the aui-forms.soy file as well:
https://bitbucket.org/atlassian/aui/src/883995019420e253fcc22346a38b8624e838e908/src/soy/form.soy?at=master
Here's an example of how such a form could look like:
{call aui.form.form}
{param action: '' /}
{param id: 'adminConfig' /}
{param content}
{call aui.form.textField}
{param id: 'server_url' /}
{param labelContent: stash_i18n('serverurl.label', 'Server URL') /}
{param value: $config.serverUrl /}
{param descriptionText: stash_i18n('serverurl.description', 'This is the base URL of your Server server instance') /}
{param errorTexts: $errors ? $errors['serverUrl'] : null /}
{/call}
{/call}
The config and the optional errors variable you would pass from your servlet when rendering the SOY template:
// build Map with pageContext including the config object and optional errors hre
String soyTemplateName = "plugin.page.adminConfigurationPanel";
String pluginModuleKey = "your-plugin-id:your-resources-key";
soyTemplateRenderer.render(res.getWriter(), pluginModuleKey, soyTemplateName, pageContext);
Hope this helps.
Cheers,
Michael
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.