Renders a static link to a location within the same document. This is a static document link macro with a specialized interface.

Audience
Tags
ID
Since
4.10

Renders an intra-document link to a Content Marker Macro or a Section Macro. This macro is a specialized form of the Static Document Link Macro with proper defaults for the special use case of linking to content within the same document.

The macro currently does not check if the link is actually valid, but it provides the autocomplete feature for the anchor parameter. This makes it easier for users to select the correct location, but it does not prevent losing the target in case the anchor name is changed later. To prevent this teams may choose to define identifiers in the referenced content and explicitly set a label and link to this identifier. In case the section title is rephrased later, the link would still be valid.

Parameters

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. In case the content is part of a Confluence page then the generated anchor typically includes the title of the page as a prefix (separated by a single dash '-').

Valid values: Section Titles and Identifiers

 
  • My Section Title
  • #Pagetitle-my-element-id
  • #myAnchorName

There is an artificial property named projectdoc Anchor IDs in Document Part References that lists all anchor identifiers used in a document.

Limitations on Drafts

 

The macro checks the page contents on the server. If users need to reference to a new section on a document and the draft has not already been saved automatically, the macro does not yet have access to the new section. The workaround here is to save the page and open it again. Sometimes it works to change to the preview of the page.

Required Parameter

 

Currently the required anchor is not enforced to be set. This is a known limitation in our autocomplete feature.

See  PDAC-1388 - Getting issue details... STATUS .

Label

The label to render instead of the document name.

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

Lower Case

When checked the label of the link is rendered in lower case.

This is especially useful for text in the English locale to appear in the body of a section.

Tooltip

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

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

CSS Classes

The optional CSS classes to add to the link.

The default class projectdoc-intra-document-link is added per default.

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]

Remote Controller

 

This macro passes the Remote Controls via HTTP request parameters. Other Remote Controllers do this via macro parameters set in the rendering context.

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 Request Toggle Label.

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