[All Adaptavist Apps]
Excerpt |
---|
This page provides a quick-reference guide to the parameters and features of the menulink macro and compound-menuitem macro (click for more information when/where to use each macro). |
This page is still under construction - some parameters and destinations are not yet listed
The Ver column denotes the minimum version of Theme Builder that is required.
The following parameters are available in both the menulink macro and compound-menuitem macro:
Parameter | Required | Default | Description | menulink | compound-menuitem | Ver | |||
---|---|---|---|---|---|---|---|---|---|
default |
| Defines the type of link to output (see #Destinations and #Aliases below). | 2.0.0 | ||||||
accesskey |
| Assign a access key (alpha or numeric keyboard shortcut) | 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 |
|
| ||||||
|
| ||||||||
checkexists |
| Determines how the "userspace" destination will work:
|
| ||||||
class |
| Adds one or more classes to the link, for use with CSS Selectors. |
| ||||||
force |
| Determines how the "comments" or "children" destinations function:
| force | force the comments or children link to be displayed when
|
| ||||
forceicon |
| ||||||||
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) |
|
| ||||||
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 |
|
| ||||||
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 to (used with "newpage" destination) |
|
| ||||||
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 |
|
| ||||||
location | the webui location to use with webui links |
|
| key | the webui key to use with webui links |
| |||
| Defines the scenarios in which icons, if specified by the "icon" parameter, will be displayed:
|
| |||||||
hideanon |
| Determines if the link is hidden from anonymous (not logged in) users:
| 3.0.0 | ||||||
icon |
| Specifies an icon to display to the left of the link. See menuicon macro for examples and a directory of icons. | 3.0.2 | ||||||
imginside |
| Determines where an icon is displayed:
|
| ||||||
key |
| When used with the "webui" destination, this defines the link key.
| 2.0.8 | ||||||
latch |
| Determines the effect of the "use-layout" destination:
| 3.0 | ||||||
layout |
| When using the "use-layout" destination, defines the ID of the layout to use.
| 3.0 | ||||||
link |
| When using the "custom" destination, defines the URL to use for the link.
|
| ||||||
location |
| When used with the "webui" destination, this defines the link location.
| 2.0.8 | ||||||
page | current page | For #Destinations that would normally apply to the current page, you can use this parameter to specify a different page by it's page title. |
| ||||||
parent | space home page | Defines the parent that the "exportMail" destination will use when exporting mail archive messages to wiki pages. |
| ||||||
size |
| The size of the icon (if applicable) in pixels. |
| ||||||
space | current space | For #Destinations that would normally apply to the current space, or a page in that space, you can use this parameter to specify a different space by it's space key. |
| ||||||
target |
| Defines the link target, eg. | 2.0.9 | ||||||
title |
| Allows you to pre-define the title of new pages created with the "newpage" destination - if the title already exists, an incrementing number will be appended to the end to ensure a unique title. |
| ||||||
toggle |
| Defines the ID of the HTML element to toggle when using the "toggleVisibility" destination. | 3.0 | ||||||
tooltip |
| Defines the tooltip that will be displayed when hovering over the link.
|
|
Footnotes Display |
---|
The following parameters are only available in the compound-menuitem macro:
Parameter | Required | Default | Description | Ver | ||
---|---|---|---|---|---|---|
autohide |
| Determines how inactive links
|
| |||
flat |
| Determines whether the link will be wrapped in a list item:
|
| |||
id |
| Defines the HTML ID to associate with the list item that wraps the link (not applicable if |
|
Footnotes Display |
---|
Destination | Description |
---|---|
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 This feature requires Theme Builder 3.3 and above. For more information on editing aliases and defining your own, please see Menulink Aliases Tab.or above.
You can create any number of custom destinations via the Menulink Aliases Tab. Once defined, the alias can be used in the default parameter of the menulink macro and compound-menuitem macro just like any of the #Destinations listed above.
A number of pre-defined aliases are available for linking to features in popular third-party plugins:
Alias | Destination | Plugin |
---|---|---|
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 |
When you first use any of the aliases listed above, an entry will automatically be added to the list of aliases on the Menulink Aliases Tab.