|
You can use a {openremote-list} macro to achieve a consistent brand look for bulleted lists.
{openremote-list:title=OpenRemote Links|link1=Home:|link2=Community:|link3=orb:}
The above renders as shown below:
|
|
Parameters
| Name | Mandatory | Default | Description |
| title | Yes | N/A |
The value of title parameter is used as the header for the list. |
| link[1..20] | No | N/A |
The links for the bullet list. Link parameters are named from link1 to link20. Maximum of 20 links are supported at the moment.
The link value is a slash '/' separated string of 'alias/space:page name^attachment/tooltip'. This will be converted to Confluence link notation, e.g. '[alias|space:page name^attachment|tooltip]'. Alias and tooltip are optional. Space is optional in case linking to a document within the same space. Attachment is only necessary to link to page attachments. |
Examples
The sample markup below creates a bulleted list with one link. The link has an alias 'Link to this page' and a tooltip 'You will end up right back to this page'.
{openremote-list:title=Example List|link1=Link to this page/How to create OpenRemote branded bullet lists/You will end up right back to this page}
Above markup renders as shown below:
Caveats
The format of links in the macro is different from regular Confluence markup. This is partly due to not being able to escape characters (such as the pipe '|' character) inside macro parameters (see CONF-4009 in Confluence issue tracker). This also means that the usual search and WYSIWYG tools provided by Confluence to search and create links easily are not as useful. Creating the links for this macro becomes a more involved process requiring a detailed understanding of how the linking notation in Confluence works (and the exceptions to that notation required by this macro).
Bugs
Links don't update gracefully (CRITICAL)
Links in macro parameters don't update gracefully when pages are renamed, and do not count for as incoming references in other pages.
Missing Features
- Allow control over margin sizes
- Bake an option for {panel} background into the macro so additional markup is not required (also control the color and style of the panel according to brand guidelines this way)
