[All Adaptavist Apps]

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Property

Required

Default

Notes

Ver

default

(tick)

 

The destination to link to (see list below)

3.0

caption

(error)

 

The link text to be displayed to the user.

3.0

space

(error)

current space

Optionally set the space to which the link relates.

3.0

page

(error)

current page

Optionally set the page to which the link relates, eg. when using the "newpage" destination you can define the parent page with this parameter.

3.0

parent

(error)

space homepage

When using the "exportMail" destination, this defines the page that will be the parent of the new page containing the exported mail message.

3.0

link

(error)

 

When using the "custom" destination (see examples) this is the URL to link to.

3.0

toggle

(error)

 

When using the "toggleVisibility" destination (see examples) this is the HTML id of the tag to show/hide.

3.0

tooltip

(error)

 

The tooltip to display when the mouse hovers over the link (max: 77 chars for cross-platform compatibility)

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.

3.0

accesskey

(error)

 

An optional shortcut key for the link which can be any alphanumeric character

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.

3.0

target

(error)

current browser window

An optional target window or frame in which to load the link destination.

3.0

class

(error)

 

Optional HTML classes to associated with the hyperlink.

3.0

hideanon

(error)

false

Whether to hide the link from anonymous users:

  • false - don't hide from anonymous users (default)
  • true - always hide from anonymous users, even if they have privileges to use the link

3.0

rel

(error)

automatic

The "rel" attribute to assign to the link. Many links get an automatic rel attribute (eg. rel="index" for the index link) and also "nofollow" rels to prevent search engines following links that alter content, etc.

3.0

icon

(error)

none

the icon to use as one of SPACEKEY:pagename^filename.ext/custom url/inbuilt icon (use 'noicon' to prevent an icon being displayed)

3.0

imginside

(error)

false

Defines whether the icon (if present) should be within the link tag or outside it. This is useful when displaying just an icon link on the main menu bar.

  • false - icon is outside the link tag (default)
  • true - icon is inside the link tag

3.0

size

(error)

16

When used with the compound-menuitem macro, defines the pixel size (same for width and height) of the icon if shown.

3.0

layout

(error)

 

When using the use-layout location, defines the layout ID to use.

3.0

latch

(error)

false

When using the use-layout location, determines whether the layout should be used temporarily for the resulting page view or latched for all subsequent page views.

  • false - don't latch the layout (default)
  • true - latch the layout so it's used for subsequent page views

3.0

item

(error)

 

 

3.0

flag

(error)

 

The macro is rendered only if one or more of the specified flags are set. See Working with Flags for more details.

3.3.6

notflag

(error)

 

The macro is rendered only if none of the specified flags are set. See Working with Flags for more details.

3.3.6

...

Expand
Display Mode
Display Mode

Destination

Default Location

Notes

Builder Ver

Feature Of

information

View > This Page > Page Information

Displays information for a page or blog post

3.0

Confluence

normalView

View > This Page > Normal view

The normal view of a page.

Footnote

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

View > This Page > Normal view

The normal view of a page.

Footnote

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

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

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

3.0

Confluence

Footnotes Display

...