menulink macro

Description

This macro creates a link to a specific Confluence feature in relation to the current location within 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).

Usage

{menulink:linktype|tootlip=tooltip text|accesskey=key}Link Text{menulink}

Parameters

Property	Default	Notes
default		The destination to link to (see list below)
space	current space	Optionally set the space to which the link relates.
tooltip		The tooltip to display when the mouse hovers over the link (max: 77 chars for cross-platform compatibility) Unknown macro: {footnote} 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.
accesskey		An optional shortcut key for the link which can be any alphanumeric character Unknown macro: {footnote} 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.
target	current browser window	An optional target window or frame in which to load the link destination.
class		Optional HTML classes to associated with the hyperlink.

Unknown macro: {display-footnotes}

Link Destinations

The following destinations are currently supported by this macro:

Destination	Default Location	Notes
dashboard	View > Other Pages > Dashbaord	Site dashboard
normalView	View > This Page > Normal view	The normal view of a page. When viewing attachments, info, etc., on pages and blogs, this will take you to the actual page view
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. The menu and navigation bars are never shown in print preview.
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
exportWord	View > This Page > Export to Microsoft Word	Exports the page (and in some versions of Confluence, a blog post) to a Word document
exportMail	View > This Page > Export to Wiki Page	When viewing a mail message in the archive, this will export that message to a new, editable wiki page
information	View > This Page > Page Information	Displays information for a page or blog post
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)
news	View > Other Pages > News	Displays the recent news within a Space
recent	View > Other Pages > Recent Updates	Displays the list of recent updates within a Space
RSS	View > Other Pages > RSS Feed Builder	Displays the RSS Feed Builder
index	View > Other Pages > Index	Displays the alphabetical index of content in a Space
map	View > Other Pages > Site Map	Displays the tree view of hierarchical pages (with current page selected if applicable) within a Space
labels	View > Other Pages > Labels	Displays the labels within a space or global labels if used outside a Space
spaceattchments	View > Other Pages > Attachments	Displays the attachments index within a Space
signup	View > Account > Sign-up	Displays the user sign-up screen (if public sign-up is enabled in General Configuration)
history	View > Account > History	Displays the history of visited pages, for the current user, in a new window
logout	View > Account > Logout	If the user is logged in, this will take them to the logout screen
login	View > Account > Login	If the user is logged out, this will take them to the login screen
profile	View > Account > Preferences: <name>	If the user is logged in, this will take them to their personal profile screen
mail	View > Mail	If a Space has mail in it's mail archive, this will display the mail archive
children	View > Show Children	If a page has child pages, this option allows the user to toggle their display
comments	View > Show Comments	If a page has comments, this option allows the user to toggle their display
newpage	Edit > New > Page...	Creates a new page within a Space
newnews	Edit > New > News...	Creates a new news item (blog post) within a Space
newspace	Edit > New > Space...	Creates a new Space
newcomment	Edit > New > Comment...	Creates a new comment on a page or news item (blog post) within a Space
edit	Edit > Edit this Page/News...	Edits the current page or news item
remove	Edit > Remove this Page/News...	Deletes (after confirmation) the current page or news item
copy	Edit > Copy this Page...	Creates an editable copy of a page (and optionally copies over it's children)
pageattachments	Edit > Attachments	Displays the attachments for a page or news item
spacetemplates	Edit > Administration > Space Templates	Displays the templates within a Space
globaltemplates	Edit > Administration > Global Templates	Displays the global templates
configuretheme	Edit > Administration > Configure Theme	Displays the theme configuration page
advanced	Edit > Administration > Advanced	Displays the "advanced" screen
spaceadmin	Edit > Administration > Space Administration	Displays teh Space administration screen
siteadmin	Edit > Administration > Site Administration	Displays the Administration Console
favourite	View > This Page > Add/remove favourite	Adds or removes the current page/news/space to or from personal favourites
watch	View > This Page > Watch this page/news/space	Toggles email notifications when current page/news/space is changed
search		Links to the search screen (defaulting to searching the current space where applicable).
userspace		Links to the current users' personal space

Examples

Basic use

You can create a link to the dashboard as follows:
{menulink:dashbaord}Go to the dashbaord{menulink}

Links in menus

When you are adding links in menus, wrap them in the menuitem macro:
{menuitem}{menulink:dashbaord}Go to the dashbaord{menulink}{menuitem}

Links to other spaces

You can link to a feature in another space as follows:
{menulink:map|space=wibble}Wibble Site Map{menulink}
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:
{menulink:newcomment|accesskey=c|tooltip=Add comment}Add a comment...{menulink}

Hiding Inactive Links

If a menulink 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:
{menuitem:flat=true}{menulink:newcomment}Add a comment...{menulink}{menuitem}
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:
{menulink:map|target=_blank}Open site map in new window{menulink}
Which results in:

Unknown macro: {menulink}
Open site map in new window

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.

Page tree