Access Keys:
Skip to content (Access Key - 0)

Adaptavist Documentation Move

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.

menulink macro

This macro creates a link to a specific Confluence feature or page relative to the current location in the wiki.

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).

Requirements

This macro requires Theme Builder 2.0 or above.

If you are using Theme Builder 3.0 or above, please consider using the compound-menuitem macro instead - it combines all the features of the menuitem macro, menuicon macro and this menulink macro in to a single macro which results in more concise wiki markup and significantly faster performance.

Usage

To display a text link use the following syntax:

{menulink:destination}Link Text{menulink}

To display link inside a menu (see menubar macro), use the following syntax:

{menubar:id=example}
 {menuitem}{menulink:destination}Link Text{menulink}{menuitem}
{menubar}

Parameters

Please see Links - Quick Reference.

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.

Click for example

Field Link Destinations Notes
%page% information, edit, remove, favourite, favouritespace, watch, watchspace, watchpage Displays either "page", "news" or "space" as applicable to the content you are currently viewing.
%count% spaceattachments, children, comments, pageattachments, viewattachments Displays the number of attachments, children or comments as applicable to the link location.
%user% profile, userspace Displays the users full name.
%space%, %Space% activity Displays "space" or "site" - the %Space% field capitalises the first letter, eg. "Space" or "Site".
%add% favourite, favouritespace, watch, watchspace, watchpage Displays "Add" or "Remove" depending on whether the content is in your favourites or watched.
%watching%, %watch% watch, watchspace, watchpage Displays "Watching" or "Watch" (%watching%), "Watch" or "Unwatch" (%watch) depending on whether you are watching the content.

Link Destinations

The following link destinations can be used in the menulink macro and also the compound-menuitem macro.

The Ver column denotes which version of Theme Builder is required.

Account management

Destination Default Location Notes Builder Ver Feature Of
login View > Account > Login If the user is logged out, this will take them to the login screen 2.0.0 Confluence
logout View > Account > Logout If the user is logged in, this will take them to the logout screen 2.0.0 Confluence
profile View > Account > Preferences: <name> If the user is logged in, this will take them to their personal profile screen 2.0.0 Confluence
userspace View > Account > Personal Space Displays the users' personal space if they have one, otherwise it displays their personal profile 2.0.0 Confluence
signup View > Account > Sign-up Displays the user sign-up screen (if public sign-up is enabled in General Configuration) 2.0.2 Confluence

Community Features

Destination Default Location Notes Builder Ver Feature Of
inviteothers     3.0 Invite Plugin
invitelist     3.0 Invite Plugin
invite View > Invite Friends   3.0 Invite Plugin
customusermanagement Edit > Administration > User Management... Displays screen for editing the user group associated with current space. 2.0.8 Custom Space User Management
space-socialbookmarks View > Other Pages > Bookmarks Displays a list of bookmarks for the current space. 3.0 Social Bookmarking Plugin
review Edit > New > Review... Adds a new review for the current page. 2.0.8 Mark for Review Plugin

Web Feeds

Destination Default Location Notes Builder Ver Feature Of
podcastpage Edit > Podcast Settings... Configures Podcast settings for a page. 2.0.8 Podcast Plugin
podcastnews Edit > Podcast Settings... Configures Podcast settings for a blog post (news). 2.0.8 Podcast Plugin
podcastchannels View > Other Pages > Podcasts Displays Podcast channels screen for a space (which also allows channels to be edited). 2.0.8 Podcast Plugin
RSS View > Other Pages > RSS Feed Builder Displays the RSS Feed Builder 2.0.0 Confluence

Folksonomy (Labels/Tags)

Destination Default Location Notes Builder Ver Feature Of
labels View > Other Pages > Labels Displays the labels within a space or global labels if used outside a Space 2.0.0 Confluence

label
globalLabel

Interest Management

Destination Default Location Notes Builder Ver Feature Of
favourite View > This Page > Add/remove favourite Adds or removes the current page/news/space to or from personal favourites. See also: builder-favicon macro 2.0.0 Confluence
watch View > This Page > Watch this page/news/space Toggles email notifications when current page/news/space is changed 2.0.0 Confluence
pagewatcher View > This Page > Watchers Displays a list of people watching the current page, editable by admins. 3.0 Community Bubbles
newswatcher View > This Page > Watchers Displays a list of people watching the current blogpost, editable by admins. 3.0 Community Bubbles
pagefavourites View > This Page > Favourites Displays a list of people who have marked the page as their favourite, editable by admins. 3.0 Community Bubbles
newsfavourites View > This Page > Favourites Displays a list of people who have marked the blogpost as their favourite. 3.0 Community Bubbles
favouritespace   Adds or removes the current space from the logged in users' favourites. 3.0 Confluence
watchspace   Toggles email notifications for the space for the logged in user. 3.0 Confluence
watchpage   Toggles email notifications for the current page or blogpost for the logged in user. See also: builder-watchicon macro   Confluence
activity View > Other Pages > Usage Statistics Links to the activity graphs for the current space or entire site (depending on current location in wiki).   Activity Plugin

Content Creation

Destination Default Location Notes Builder Ver Feature Of
newcomment Edit > New > Comment... Creates a new comment on a page or news item (blog post) within a Space 2.0.0 Confluence
newnews Edit > New > News... Creates a new news item (blog post) within a Space 2.0.0 Confluence
newpage Edit > New > Page... Creates a new page within a Space 2.0.0 Confluence
newspace Edit > New > Space... Creates a new Space 2.0.0 Confluence
addbookmark Edit > New > Bookmark... Links to the "Add Bookmark" screen. 3.0 Social Bookmarking Plugin
editgridaddbook Edit > New > Spreadsheet... Adds a new editable spreadsheet to the page. 2.0.8 Edit Grid
notationguide   Links to the notation guide. You can use other parameters, such as target, to launch it in a new window. 3.0 Confluence

Content Management

Destination Default Location Notes Builder Ver Feature Of
copy Edit > Copy this Page... Creates an editable copy of a page 2.0.0 Confluence
edit Edit > Edit this Page/News... Edits the current page or news item 2.0.0 Confluence
remove Edit > Remove this Page/News... Deletes (after confirmation) the current page or news item 2.0.0 Confluence
editinword Edit > Edit in Word Edits the current page in MS Word. 3.0 WordDAV Plugin
addgliffydiagram Edit > New > Diagram... Adds a new Gliffy diagram to a wiki page. 2.0.8 Gliffy Plugin
pageattachments Edit > Attachments Displays the attachments for a page or news item if you have add-attachment permission 2.0.0 Confluence
viewattachments   Displays the attachments for a page or news item 3.0 Confluence

Content Exporting

These options allow you to export content in different formats.

Destination Default Location Notes Builder Ver Feature Of
emailpage View > This Page > Email to a friend... Allows the user to email the page to a friend. 2.0.7 Mail Page Plugin
exportMail View > This Page > Export to Wiki Page When viewing a mail message in the space mail archive, this will export that message (including attachments) to a new, editable wiki page 2.0.7 Theme Builder
exportPDF View > This Page > Export to Adobe Acrobat (PDF) Exports the page (and in some versions of Confluence, a blog post) to a PDF file 2.0.0 Confluence
exportWord View > This Page > Export to Microsoft Word Exports the page (and in some versions of Confluence, a blog post) to a Word document 2.0.0 Confluence

Display Mode

Destination Default Location Notes Builder Ver Feature Of
information View > This Page > Page Information Displays information for a page or blog post 2.0.0 Confluence
normalView View > This Page > Normal view The normal view of a page.1 2.0.0 Confluence
printableView View > This Page > Printable view The print preview of any page. If a sidebar is set to be "collapsed by default" it will not appear in the print preview.2 2.0.0 Confluence
pageView View > This Page > View Page When viewing attachments or page information, this will return you to the normal view of the page. 3.0 Confluence
information View > This Page > Page Information Displays page information such as recent changes, author, incoming links, etc. 2.0.0 Confluence
Footnotes
Ref Notes
1 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).
2 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.

Visibility Settings

Destination Default Location Notes Builder Ver Feature Of
children View > Show Children Toggle the display of the builder-children macro 2.0.0 Theme Builder
comments View > Show Comments Toggle the display of the builder-comments macro 2.0.0 Theme Builder
toggleVisibility   Shows or hides a HTML tag (and it's contents) based on it's HTML id (see examples). 2.0.7

toggleSidebar

General Navigation

Destination Default Location Notes Builder Ver Feature Of
dashboard View > Other Pages > Dashbaord Site dashboard 2.0.0 Confluence
mail View > Mail If a Space has mail in it's mail archive, this will display the mail archive 2.0.0 Confluence
news View > Other Pages > News Displays the recent news within a Space 2.0.0 Confluence
recent View > Other Pages > Recent Updates Displays the list of recent updates within a Space 2.0.0 Confluence
history View > Account > History Displays the history of visited pages, for the current user, in a new window 2.0.0 Confluence
search   Links to the search screen (defaulting to searching the current space where applicable). 2.0.0 Confluence
index View > Other Pages > Index Displays the alphabetical index of content in a Space 2.0.0 Confluence
spaceattachments View > Other Pages > Attachments Displays the attachments index within a Space 2.0.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) 2.0.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. 2.0.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.   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. 2.0.8 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). 2.0.0 Theme Builder
colourscheme Edit > Administration > Colour Scheme Displays the space or global (as applicable to current location) colour scheme editor. 3.0 Confluence
chooselayout Edit > Administration > Choose Layout Displays the Layout Chooser. 3.0 Theme Builder
managelayouts Edit > Administration > Manage Layouts Displays the Layout Manager. 3.0 Theme Builder
themeadmin Edit > Administration > Theme Administration Displays the Theme Administration screen. 3.0 Theme Builder
use-layout   Allows selection of a different layout. See examples and also use-layout macro. 3.0 Theme Builder

Administration

Destination Default Location Notes Builder Ver Feature Of
advanced Edit > Administration > Advanced Displays the "advanced" screen 2.0.0 Confluence
siteadmin Edit > Administration > Site Administration Displays the Administration Console 2.0.0 Confluence
spaceadmin Edit > Administration > Space Administration Displays teh Space administration screen 2.0.0 Confluence
admingliffy Edit > Admiinstration > Gliffy... Links to the Gliffy administration screen. 2.0.8 Gliffy
reviewreport Edit > Administration > Reviews Displays review report for the space. 2.0.8 Mark for Review Plugin
reviewspaceconfig Edit > Administration > Review - Space Config Space-level configuration for Reviews. 2.0.8 Mark for Review Plugin
reviewglobalconfig Edit > Administration > Review - Admin Config Global configuration for Reviews. 2.0.8 Mark for Review Plugin
inviteothersadmin Edit > Administration > Invite Others   3.0 Invite Plugin
invitelistadmin Edit > Administration > Invite List   3.0 Invite Plugin
globaltemplates Edit > Administration > Global Templates Displays the global templates 2.0.0 Confluence
spacetemplates Edit > Administration > Space Templates Displays the templates within a Space 2.0.0 Confluence

Examples

Basic use

Links in menus

Linking to a Space

Links to features in other spaces

Tooltips and Access Keys

Hiding Inactive Links

Link Target

Toggle the Visibility of an on-screen element

Linking to other sites

How do I show Web UI links?

Hints and Tips

You can create keyboard shortcuts by adding empty menulinks to a panel in builder (eg. title or footnotes panel, etc), for example:

{menulink:edit|tooltip=Edit this content|accesskey=e}{menulink}

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.



View old comments


Adaptavist Theme Builder Powered by Atlassian Confluence