This documentation is deprecated. Adaptavist's documentation has moved to a new location where it is maintained and updated. Please visit Adaptavist's new Documentation area.
Each link destination abides by all applicable permissions - should the user not have sufficient permission to use the link, or simply be in a location where the link is not applicable, the body of the macro is returned un-linked (which is then usually hidden by the menuitem macro).
Optionally set the space to which the link relates.
3.0
page
current page
Optionally set the page to which the link relates, eg. when using the "newpage" destination you can define the parent page with this parameter.
3.0
parent
space homepage
When using the "exportMail" destination, this defines the page that will be the parent of the new page containing the exported mail message.
3.0
link
When using the "custom" destination (see examples) this is the URL to link to.
3.0
toggle
When using the "toggleVisibility" destination (see examples) this is the HTML id of the tag to show/hide.
3.0
tooltip
The tooltip to display when the mouse hovers over the link (max: 77 chars for cross-platform compatibility)1
3.0
accesskey
An optional shortcut key for the link which can be any alphanumeric character2
3.0
target
current browser window
An optional target window or frame in which to load the link destination.
3.0
class
Optional HTML classes to associated with the hyperlink.
3.0
hideanon
false
Whether to hide the link from anonymous users:
false - don't hide from anonymous users (default)
true - always hide from anonymous users, even if they have privileges to use the link
3.0
rel
automatic
The "rel" attribute to assign to the link. Many links get an automatic rel attribute (eg. rel="index" for the index link) and also "nofollow" rels to prevent search engines following links that alter content, etc.
3.0
icon
none
the icon to use as one of SPACEKEY:pagename^filename.ext/custom url/inbuilt icon (use 'noicon' to prevent an icon being displayed)
3.0
imginside
false
Defines whether the icon (if present) should be within the link tag or outside it. This is useful when displaying just an icon link on the main menu bar.
false - icon is outside the link tag (default)
true - icon is inside the link tag
3.0
size
16
When used with the compound-menuitem macro, defines the pixel size (same for width and height) of the icon if shown.
3.0
layout
When using the use-layout location, defines the layout ID to use.
3.0
latch
false
When using the use-layout location, determines whether the layout should be used temporarily for the resulting page view or latched for all subsequent page views.
false - don't latch the layout (default)
true - latch the layout so it's used for subsequent page views
3.0
item
3.0
flag
The macro is rendered only if one or more of the specified flags are set. See Working with Flags for more details.
3.3.6
notflag
The macro is rendered only if none of the specified flags are set. See Working with Flags for more details.
When using the link in a menu, tooltips will only be shown if enabled in theme configuration. In all other formats, the tooltip will always be shown when the mouse hovers over the link.
When using links inside menus, you can also prefix a letter in the link text with an "_" to define the access key - this letter will then be underlined when displayed in the menu. Access keys only work when the associated item is visible on screen.
Caption Fields
Some link locations provide fields for captions which get automatically replaced when the links are displayed based on the state of the link location.
For example, the %page% field will be replaced with either "page" or "news" depending on whether you're looking at a page or a blog post.
In Theme Builder 2.x this link will return you to the actual page if viewing attachments or information screens for a page. In Theme Builder 3.0 and above, this will display the normal view of whatever you are currently looking at (useful for returning from printable view).
In Theme Builder 2.x the printable view simply removes the menu and navigation bars. In Theme Builder 3.0 and above the printable layout (which can be fully customised in Layout Manager will be displayed.
Shows or hides a HTML tag (and it's contents) based on it's HTML id (see examples).
3.0
toggleSidebar
General Navigation
Destination
Default Location
Notes
Builder Ver
Feature Of
dashboard
View > Other Pages > Dashbaord
Site dashboard
3.0
Confluence
mail
View > Mail
If a Space has mail in it's mail archive, this will display the mail archive
3.0
Confluence
news
View > Other Pages > News
Displays the recent news within a Space
3.0
Confluence
recent
View > Other Pages > Recent Updates
Displays the list of recent updates within a Space
3.0
Confluence
history
View > Account > History
Displays the history of visited pages, for the current user, in a new window
3.0
Confluence
search
Links to the search screen (defaulting to searching the current space where applicable).
3.0
Confluence
index
View > Other Pages > Index
Displays the alphabetical index of content in a Space
3.0
Confluence
spaceattachments
View > Other Pages > Attachments
Displays the attachments index within a Space
3.0
Confluence
people
View > Other Pages > People Directory
Displays the people directory.
Confluence
Hierarchical Navigation
Destination
Default Location
Notes
Builder Ver
Feature Of
home
View > Other Pages > Home Page
If used within a Space, this takes the user to the space home page. If used anywhere else, the site home page is shown. The site home page is either the user's homepage (if set in their profile), the site homepage (if set in General Configuration) or the Dashboard (default)
3.0
Confluence
next
Links to the next sibling page.
3.0
Theme Builder
prev
Links to the previous sibling page.
3.0
Theme Builder
parent
Links to the parent of the current page.
3.0
Theme Builder
first
Links to the first sibling page.
3.0
Theme Builder
last
Links to the last sibling page.
3.0
Theme Builder
firstchild
Links to the first child page.
3.0
Theme Builder
lastchild
Links to the last child page.
3.0
Theme Builder
map
View > Other Pages > Site Map
Displays the tree view of hierarchical pages (with current page selected if applicable) within a Space.
3.0
Confluence
Custom Links
Destination
Default Location
Notes
Builder Ver
Feature Of
custom
Allows you to specify a custom URL. This is often useful if you want an external web page to launch in a new window because you can combine it with the "target" parameter.
3.0
Theme Builder
webui
Displays a "Web UI" link (some plugins use these to add additional navigation, etc). See Examples for more details. The next section (third-party) lists some inbuilt webui aliases for popular plugins.
3.0
Confluence
wikipage
Links to a wiki page, the page being defined using the page parameter (and optionally the space parameter if the page is in a different space.
3.0
Confluence
Theme Configuration
Destination
Default Location
Notes
Builder Ver
Feature Of
configuretheme
Edit > Administration > Configure Theme
Displays the theme configuration page (Builder 2.x) or Layout Chooser (Builder 3.0 and above).
3.0
Theme Builder
colourscheme
Edit > Administration > Colour Scheme
Displays the space or global (as applicable to current location) colour scheme editor.
You can create a link to the dashboard as follows:
{compound-menuitem:dashboard|caption=Go to the dashboard}
Linking to a Space
You can link to a space by using a combination of the home location and the space parameter:
{compound-menuitem:home|space=foo|caption=Go to the home page of the foo space}
That will link to the home page of a Space with a key of "foo".
This is really useful because if someone renames the home page this link will still work!
Links to features in other spaces
You can link to a feature in another space as follows:
{compound-menuitem:map|space=wibble|caption=Wibble Site Map}
This would show the site map in the Space with a key of "wibble", regardless of where you are in your site.
Tooltips and Access Keys
To add tooltips and access keys, use the following notation:
{compound-menuitem:newcomment|accesskey=c|tooltip=Add comment|caption=Add a comment...}
Hiding Inactive Links
this does not appear to be working at the momment
If a compound-menuitem is not applicable (eg. user doesn't have privilages or the link does not relate to the current location within your site, etc) then the body text of the link will be output unlinked.
For example, if a user does not have comment privileges, then they would see the link shown in the previous example as:
Add a comment...
Obviously, that's not very useful so you want to hide inactive menu links. To do this, use the menuitem macro which will hide it's body content if there are no links in it:
{compound-menuitem:newcomment|flat=true|caption=Add a comment...}
If the body of the menuitem macro doesn't contain a link, it will not be shown.
Link Target
You can open the link destination in a specific frame or window using the target parameter:
{compound-menuitem:map|target=_blank|caption=Open site map in new window}
There is a bug in Builder 2.0.1 - please don't use this link destination until further notice as it doesn't work.
You can toggle the visibility of any HTML tag with a unique id using the code below:
{div:id=visdemo}*This is a div tag with id of "visdemo" that you can show or hide using the link below.*{div}
{menulink:toggleVisibility|target=visdemo}Toggle the text above{menulink}
As you can see, the div tag has been given a HTML id - the raw HTML looks like this:
<div id="visdemo"> ... <div>
And the "target" parameter in the menulink macro states what id will be toggled.
The result:
This is a div tag with id of "visdemo" that you can show or hide using the link below.
Toggle the text above
If you want the tag to initially be hidden, use the "display:none" CSS style:
{div:id=visdemo1|style=display:none;}*This is a div tag with id of "visdemo1" that you can show or hide using the link below.*{div}
{menulink:toggleVisibility|target=visdemo1}Show/hide the text above{menulink}
The div tag will now be output with a style attribute like this:
Note that we've changed the id from "visdemo" to "visdemo1" - that's because a HTML id must be unique to the entire web page. If there are two or more occurrences of the same id, the results can be very unpredictable so make sure to use unique id's.
The result (it starts hidden so click the link to see it):
This is a div tag with id of "visdemo1" that you can show or hide using the link below.
Show/hide the text above
Linking to other sites
To add tooltips and access keys, use the following notation:
Web UI links are a feature of Confluence plugins that allow them to add additional navigation to the default themes.
However, because Theme Builder displays navigation in a significantly different format, we can't display those links by default otherwise we'd end up with duplicate and confusing navigation in the default menus.
Web UI link support was added in Theme Builder 2.0.8 and above.
Before adding Web UI links as shown below, please check the table above the Examples section on this page which lists a number of aliases for popular third party plugins.
To add Web UI links to Theme Builder meuns, use the following syntax:
Note: There are aliases for these links in the table further up the page, the links shown above are just to illustrate how to manually construct those links.
If you don't specify any link text (eg. "Edit Podcast") then the default text supplied by the plugins' Web UI link will be used.
Important
Many third party plugins don't do strict checking of the mode and context to determine whether a Web UI link should be displayed. Because Theme Builder can display Web UI links in any area of Confluence, you might need to use the builder-show macro or builder-hide macro to show/hide Web UI links that start appearing in too many places.
If you need a technical explanation as to why this is the case, or any help with working with Web UI links in third party plugins, please contact our support desk.
When using the menulink inside a menu, it needs to be wrapped in the menuitem macro, eg:
You can create keyboard shortcuts by adding empty menulinks to a panel in builder (eg. title or footnotes panel, etc), for example:
{compound-menuitem:edit|tooltip=Edit this content|accesskey=e|caption=Edit this %page%}
This would add the keyboard shortcut "Alt+E" to all screens that can be edited (eg. blogposts, pages, etc). The shortcut would only be available if the current user has sufficient privileges to edit the page, etc.
Share Menu
To include the Share menu, you can make a Link Alias called, say, sharepage for Share Page - Share then reference that in the macro e.g. {compound-menuitem:sharepage...}
this does not appear to be working at the momment
Web UI link support was added in Theme Builder 2.0.8 and above.
