[All Adaptavist Apps]
Excerpt |
---|
This page provides a quick-reference guide to the parameters and features of the menulink |
macro (click for more information when/where to use each macro). |
Parameter | Description | menulink | compound-menuitem |
---|---|---|---|
accesskey | Assign a shortcut key to the link. |
|
|
checkexists | whether userspace menulink should check to see if the user has a personal space (default false) |
|
|
class | the css class to be applied to the link |
|
|
force | force the comments or children link to be displayed when there are no comments or children to the page (default false) |
|
|
forceicon | force the icon to be displayed irrespective of the layout (default false) |
|
|
icon | the icon to use |
|
|
imginside | should the icon appear inside the link (default=false) |
|
|
latch | whether use-layout should latch the layout (used with use-layout menulink) |
|
|
layout | the layoutId to (used with use-layout menulink) |
|
|
link | the custom link (used by 'custom' menulink - deprecated, use URL aliases instead) |
|
|
parameter | usage | ||
tooltip | the tooltip that should be displayed by the link | ||
accesskey | the keypress that should be associated with this link | ||
target | the target for the link (eg _blank) | ||
space | the spacekey whose context the link generation should be calculated against | ||
page | the title of the page whose context the link generation should be calculated against |
|
|
parent | used by the exportMail link type to define the parent where the page generated from the mail shuld be created | ||
class | the css class to be applied to the link | ||
toggle | the html ID of the element whose visibility is to be toggled (used by toggleVisibility) | ||
link | the custom link (used by 'custom' menulink - deprecated, use URL aliases instead) | ||
icon | the icon to use | ||
size | the size of the icon to use | ||
imginside | should the icon appear inside the link (default=false) | ||
|
| ||
size | the size of the icon to use |
|
|
space | the spacekey whose context the link generation should be calculated against |
|
|
target | the target for the link (eg _blank) |
|
|
title | Page | title | page title to (used with "newpage menulink" destination) |
layoutId | the layoutId to (used with use-layout menulink) | ||
latch | whether use-layout should latch the layout (used with use-layout menulink) | ||
checkexists | whether userspace menulink should check to see if the user has a personal space (default false) | ||
force | force the comments or children link to be displayed when there are no comments or children to the page (default false) | ||
forceicon | force the icon to be displayed irrespective of the layout (default false) |
|
| ||
toggle | the html ID of the element whose visibility is to be toggled (used by toggleVisibility) |
|
|
---|---|---|---|
tooltip | the tooltip that should be displayed by the link |
|
|
Destination | Description | menulink | destination |
---|---|---|---|
advanced | go to advanced config page | ||
children | show/hide children toggle | ||
comments | show/hide comments toggle | ||
configuretheme | configure the theme | ||
copy | copy the current page | ||
dashboard | go to dashboard | ||
edit | edit the current page | ||
exportMail | export email to page | ||
exportPDF | export page to pdf | ||
exportWord | export page to word doc | ||
favourite | add page to favourites | ||
favouritespace | add space to favourites | ||
globaltemplates | display list of global templates | ||
history | show account history | ||
home | go to space home page | ||
index | go to space index | ||
information | show page information | ||
labels | show labels heatmap | ||
login | go to login screen | ||
logout | log out | ||
show space email | |||
map | go to space map | ||
newcomment | add a comment | ||
newnews | create a new blogpost | ||
newpage | create a new page | ||
newspace | create a new space | ||
news | view space news | ||
normalView | view page as normal | ||
pageattachments | show page attachments | ||
viewattachments | show page attachments without checking attachment permission | ||
printableView | view page as printable | ||
profile | show user profile | ||
recent | view recently updated in space | ||
remove | delete the current page | ||
RSS | go to rss feed editor | ||
search | links to the search screen | ||
signup | create a new account | ||
siteadmin | go to site administration | ||
spaceadmin | go to space administration | ||
colourscheme | go to colour scheme selector | ||
spaceattachments | display space attachments | ||
spacetemplates | display list of space templates | ||
userspace | show user's space | ||
watch | watch current page/space | ||
watchspace | watch current space | ||
custom | define a custom link | ||
toggleVisibility | toggle the visibility of an html element | ||
people | show the people directory | ||
activity | show site/space activity | ||
webui | show a webui link, requires location & key parameters | ||
use-layout | change the layout | ||
wikipage | link to the page specified by the page & space parameters | ||
next | the next sibling page | ||
prev | the previous sibling page | ||
first | the first sibling page | ||
last | the last sibling page | ||
parent | the current page's parent | ||
firstchild | the first child page | ||
lastchild | the last child page | ||
notationguide | link to the macro notation guide | ||
managelayouts | link to manage layouts | ||
pageView | view the current page in normal mode | ||
viewSource | view the wiki markup source of the current page | ||
editinword | edit the current page using MS-Word (requires the office connector plugin) |
...
The following aliases are automatically defined in Theme Builder 3.3 and above. For more information on editing aliases and defining your own, please see Menulink Aliases Tab.
Alias | Destination | Plugin | alias | destination |
---|---|---|---|---|
pagewatcher | system.page:pagewatcher | |||
newswatcher | system.news:newswatcher | |||
pagefavourites | system.page:pagefavourites | |||
newsfavourites | system.news:newsfavourites | |||
emailpage | system.page.operations:mail-page | |||
addgliffydiagram | system.space.actions:gliffy_system_space_add_diagram_action | |||
admingliffy | system.admin/administration:gliffyshowadminwebitem | |||
podcastpage | system.page:podcast-episode-page-webui | |||
podcastnews | system.news:podcast-episode-blogpost-webui | |||
podcastchannels | system.space:space-podcast-channel-webui | |||
customusermanagement | system.space:space-custom-usermanagement | |||
editgridaddbook | system.space.action:editgrid-space-add-book | |||
inviteothersadmin | system.space.admin/security:admin.invitelink | |||
invitelistadmin | system.space.admin/security:admin.invitelistlink | |||
inviteothers | system.space.advanced/advanced:advanced.invitelink | |||
invitelist | system.space.advanced/advanced:advanced.invitelink | |||
invite | system.space.actions:space.invitelink | |||
review | system.page:review | |||
reviewreport | system.space:space-markforreview-report | |||
reviewspaceconfig | system.space.admin/security:configure-markforreview-space | |||
reviewglobalconfig | system.space.admin/security:configure-markforreview-global | |||
space-socialbookmarks | system.space:space-socialbookmarks | |||
addbookmark | system.space.actions:addbookmark | |||
config-approvals | system.admin:approvalsWorkflowConfig | |||
manage-approvals | system.space.admin:editspaceapprovals | |||
space-approvals | system.space:space-approvals | |||
page-approvals | system.page:page-approvals | |||
released-approvals | system.page:released |