Document Title

The title of the document to reference.

Space Key

The key to the space the document is part of. If empty, the macro tries to find a term with the given page title on the delegate space.

Document

The title of the document to link to.

Overrides the document title parameter.

Anchor

The Anchor allows to define a document fragment to reference on the target document.

The anchor value may have one of two forms:

1. If the first character is a hashmark (#), then the anchor is used verbatim as fragment part of the generated URL
2. If the first character is not a hashmark (#), then the anchor is a section title and a proper anchor is derived

So if the reference is to a section using the Section Macro, simply add the title of the section. If the user knows the identifier or anchor in the HTML code, use that identifier an put a hashmark (#) in front.

Label

The label to render instead of the document name.

It may contain property placeholders (like ${Title})  of the referenced document.

Tooltip

Allows to override the tooltip which defaults to the short description provided by the referenced termdocument

It may contain property placeholders (like ${Name} ${Short Name})  of the referenced document.

CSS Classes

The optional CSS classes to add to the link.

Space Closure

The space closure defines which spaces are to be considered for searching.

Valid values are

• space-default
• delegate-space
• search-space
• self-space (since 4.5)

Per default the delegate spaces are used. This is what the is most often needed: the location where new documents are stored per default is the location this macro will link to.

If you have a space that references the latest version of a product space, you may want to link to information to be found in any space. In this case the space contains the latest version of a space in its search space. Using this link will ensure that the latest version is linked.

The value self-space restricts the search to the local space, that is the space the the page with the macro is part of. This supports the use case where the template authors want to limit the search. 

Link Render Control

Control how the link is rendered if the target document does not exist.

Valid values are:

create-link

Render a link to create a document (default)

empty

Render nothing

plain-text

Render the link label.

Request Parameters

Request parameters allow to call a Remote Controlled Document (e.g. using the Display Table Macro).

The left side (value) of the parameter assignments will be URL encoded. The expected pattern is

id-x:name1=value A, value B&id-y:$<name2>=[some value]

Request Toggle Label

In case the macro adds request parameters it is able to react to a request that contains these request parameters with matching values. In case the macro is called on a page with its request parameters it will render the provided label and will not add its request parameter. This effectively allows the macro to toggle between two states: one in which the macro applies the request parameters and uses its standard label and one in which the request parameters are not applied and the toggle label is used.

Request Toggle Tooltip

Set the tooltip for the link when in the toggled state. This tooltip is only shown withe the Document Link Macro.

If the toggle state for Remote Control is not in use, this parameter has no effect. To enforce this feature the Document Link Macro and the Document Link Macro must be specified. Whenever the macro recognizes that its request parameters are set, it enters the toggle state.