[All Adaptavist Apps]
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).
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.
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}
Please see Links - Quick Reference.
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.
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. |
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.
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 |
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 | |
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 |
Destination | Default Location | Notes | Builder Ver | Feature Of |
---|---|---|---|---|
podcastpage | Edit > Podcast Settings... | Configures Podcast settings for a page. | 2.0.8 | |
podcastnews | Edit > Podcast Settings... | Configures Podcast settings for a blog post (news). | 2.0.8 | |
podcastchannels | View > Other Pages > Podcasts | Displays Podcast channels screen for a space (which also allows channels to be edited). | 2.0.8 | |
RSS | View > Other Pages > RSS Feed Builder | Displays the RSS Feed Builder | 2.0.0 | Confluence |
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
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 |
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 | |
notationguide |
| Links to the notation guide. You can use other parameters, such as target, to launch it in a new window. | 3.0 | Confluence |
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 | |
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 |
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 |
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 |
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
Destination | Default Location | Notes | Builder Ver | Feature Of |
---|---|---|---|---|
dashboard | View > Other Pages > dashboard | Site dashboard | 2.0.0 | Confluence |
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 |
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 |
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 | 3.0 | Confluence |
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 |
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 | |
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 |
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.
34 Comments
Unknown User (jamie.zabel)
Can I use this macro to link to a page in a different space. For example, I want to link to an FAQ page I created inside a space called IT. Below is the code I attempted to write, however it does not work.
If you have a solution, I'd appreciate it! ~Jamie
Unknown User (amoran)
Assuming Builder 3.3.3 you can use a URL alias with the page name specified in SPACEKEY:pagename syntax.
Unknown User (dannyzen)
What is the menulink macro for "page move" (editpage.action?pageId=123456&locationShowing=true#locationSection)
Unknown User (lutz)
Hey danny,
i used
to get to the edit modus.
Unknown User (davidchapmanattpt)
Is there a target for page restrictions? I can't seem to find a way to indicate a page has restrictions much like confluence does without theme builder.
Unknown User (fenliu@stanford.edu)
I am trying to link to Wiki page call Team in the same space, I used "wikipage" Destination in Custom Links, but it does not working, here is code I used:
I'd appreciate it!
Unknown User (gfraser)
You need to add 'page=' before the page title (otherwise the macro has no way to know what 'Team' is):
Also, I'd recommend using the compound-menuitem macro as it's much faster and easier to read, eg:
If you don't specify the caption, Builder will guess what caption to use (in this case based on the page title) so you could shorten that even more to:
Unknown User (fenliu@stanford.edu)
thank you so much, they all works great! I also tried used URL alias with the page name specified as SPACEKEY:pagename in Builder Administration, this worked good too.
Unknown User (amoran)
cat.skinning.ways++
Unknown User (fenliu@stanford.edu)
I want to add the "logout" and "printableView" two links at Header Panel in Layout Editor, they exactly look like this Adaptavist page header at above. Can you please let me know how do I add divider or space between these two links? The "menuseparator macro" looks like only works with in menu bar but not links. Here is my code in Header Panel:
I'd appreciate it!
Unknown User (amoran)
http://www.w3schools.com/css/css_reference.asp
In particular: http://www.w3schools.com/css/pr_border-right.asp
Unknown User (fenliu@stanford.edu)
Alain, thank you so much to point out the css border-right, it works great!
Unknown User (lutz)
hey everyone,
im a big fan of using the control + mouseclick combination to open links in a new window. unfortunately this doesn work with the menulink or menuitem macro. have you got any idea how i can still get this functionality?
regards, jerome
Unknown User (scayla)
I guess you could bind the 'ctrl+click" event on each element in the menu in order to open the link in a new tab via jquery. Have a look at this library http://code.google.com/p/js-hotkeys/.
Alain or Mark (or any of the Adaptavist team) may have a better solution, I don't know.
Also, you should always ask for help in the forum, not in the documentation page because this page would become really huge if everyone discussed here.
Regards
Unknown User (gfraser)
We're working on a new menu system but it won't be available until next year.
With the current Dynarch hMenu system it's not possible to do what you require.
Unknown User (davidchapmanattpt)
Is there a viewpreviousversions destination or way to access it? I tried the obvious without luck.
Unknown User (sumeet.malik@db.com)
Hey
I need help here !! please help !
I am trying to make the upper navigation panel for the page i am developing.
In that i am trying to link the drop down (pop-up) with a page link name Team ( as Title)
But once i write following code, the pop-up got missing.
About us is missing.
IN Menu link- If i write other than Dashboard ( which go to link on Dashbard ) , i don't know how to define a page like that so that link works.
== Linking About us with page Team
!About US - Gets missing if i like it as shown in code|thumbnail,width=32,height=32!
Now if u don't link the "Team Structure" pop-up then it appears in the page. Please see the code and screenshot
!No linking of Team Structure, it appears|thumbnail,width=32,height=32!
Unknown User (sumeet.malik@db.com)
Sorry image didn't got attached last time
Following code is used to link the "Team Structure"
Unknown User (amoran)
When pasting code, please use the {code} macro, I have updated your posts to include this macro so we can see what you are talking about.
By the looks of things you really need a support contract
Unknown User (sumeet.malik@db.com)
Thanks Alain.
I'll keep it in mind while posting next mail.
Unknown User (bama4535)
How would you create a menulink to page restrictions? Would this be done w/ the builder aliasing or is there a more direct way?
Unknown User (kichap)
In the above, I have created five links pointing to five websites. When I click on the link, it displays the URL contents in a new window. Instead of that, I want to have only one confluence page assigned for all the external links and whenever I click on these links, it should take me to that confluence page and display the contents onto that confluence page. I don't want to have five different pages for these five different links. I want to have contents change on a single confluence page whenever i click on the different menu items. Is this feasible?
Currently I am using iframe in five different pages to display the result on cliking the menuitems.
Any suggestions?
Unknown User (kichap)
Will the confluence macros work across Jira or Bamboo ? ie. Can the menuitem macro work on Jira or Bamboo or Crucible?
Unknown User (chrisroush)
For some reason I get a syntax error when using the menulink:history macro. I am running Confluence 3.1.2 with Builder 4.0.1. Is anyone else having this issue? I click the link and it throws the error in the browser's console.
Unknown User (james.pun@printsoft.com)
Requirements:
1. Currently, I am using the "recent" parameter with the menulink macro and it only shows Recently Updated List for the space. I was wondering how I could use the menulink macro with something similar to the "recent" parameter to point to Recently Updated List for ALL Spaces rather than just the space itself.
2. Also I would like the "What's New" link to appear on the Menu on the DASHBOARD too rather than just the individual space. At the moment, when I click on About Us link, I get to the space and I can see the "What's New" link on the menu. But when I click Dashboard, What's New link is missing from the menu.
Refer to image below
The code I have is a as follows in the Layout:
Unknown User (macandron)
With Builder 4.1.3/4.0.4 and the new Admin panel, the old "themeadmin" destination no longer works. Can you provide the new destinations to the different tabs in Theme Administration?
Mark Gibson
Hi Jonas, you can add the destination back:
The 'themeadmin' destination will then take you to the first tab (ie. 'Backup') of the Theme Builder admin pages.
You could setup destinations to other tabs in a similar manner.
Mark Gibson
The 'themeadmin' will be added back (as a default link alias) in the next builder release. Use the manual method given above in the meantime, it won't conflict when you upgrade later.
Unknown User (macandron)
Ok did that and it works. Thanks!
Unknown User (ville.valtasaari@thl.fi)
Hi,
Does anyoame manage to make the toggleVisibility action work? I'd like to add the option to turn a sidebar off or on into a menu. As it is, I have to resort to an html-macro to make a link:
Impossible to put that in a menuitem.
Conf 3.5.1 Builder 4.2.1
Didn't work for Conf 3.4.2 Builder 4.2.0 either.
Regards, Ville
Unknown User (alison r)
Just discovered something strange... not sure if it's a bug or a documentation issue or what exactly...
We created a custom page Tools menu using compound-menuitem. We used "pageattachments", expecting "Attachments (%count%)" to appear in the menu for all page viewers.
However, it seems like there is permission logic associated with "pageattachments". Users who do not have attachment-add permission on the page were not able to see this menu item at all. This didn't seem appropriate. They should be able to see the list of attachments, just not be offered the ability to add files.
By chance, we replaced "pageattachments" with "viewattachments", and it worked how we wanted. But I don't see documentation for "viewattachments". That was an important distinction for us: the visibility of the "pageattachments" item is connected to attachment permissions, while the "viewattachments" is not.
We're not on the very latest versions (we have Confluence 3.4.9 & Builder 4.2.2), but just wanted to let others know. Happy to log an issue, if that's helpful.
Unknown User (amoran)
Looks like the HTML documentation has drifted out of date, you are correct viewattachments is the link you want.
The permissions checks were setup in this way to make it easier for developers of more 'web' type layouts to hide the attachments link from those who 'shouldnt' need access. The viewattachments link was added to help people developing more 'wiki' type layouts.
Unknown User (amoran)
The documentation has now been updated ... thanks for highlighting the discrepancy
Unknown User (alison r)
The web vs. wiki explanation makes sense. Thanks very much!