- Created by Robert Reiner, last modified on 10. Jan 2022
projectdoc Toolbox
Renders a static link to a projectdoc document in the wiki. A static link is a link to a Confluence page that is identified by its space key and document title.
Renders a static link to a projectdoc document in the wiki. It is a specialized form of the Wiki Link Macro.
The macro uses the Confluence link to reference the document. Therefore this link is changed in case the title of the referenced document is changed. It is static in the sense that the link is not dependent on the space closure to determine the document to link to.
Parameters
Document
The title of the document to link to.
Anchor
The Anchor allows to define a document fragment to reference on the target document.
The anchor value may have one of two forms:
- If the first character is a hashmark (
#), then the anchor is used verbatim as fragment part of the generated URL - 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.
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.
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.
Abbreviation Mode
Renders the abbreviation or short name with the name as tooltip.
The following options are available:
| Option | Description |
|---|---|
none | Does not activate the abbreviation mode. The link uses the name to render the label and the document's short description as tooltip. |
name | Renders the abbreviation or short name as label and the document's name as tooltip. |
short-name | Renders the abbreviation or short name as label and the document's short name as tooltip. |
Since 4.6
The parameter is supported since version 4.6.
Blueprint
The complete key of the page blueprint.
A page blueprint key looks like this:
de.smartics.atlassian.confluence.smartics-projectdoc-confluence:projectdoc-blueprint-doctype-blank
This example refers to the Blank Document.
If omitted, the new page will be based on the empty page template.
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.
Related Macros
- Ancestor Property Macro
- Render the property value of an ancestor of this document, for the first ancestor that matches the specified document type.
- Attachment Link Macro
- Renders a link to an attached file for download.
- Breadcrumb Macro
- Renders a breadcrumb for the current page.
- Child Documents Macro
- Renders the list of child documents, matching the given filter criteria.
- Dynamic Document Link Macro
- Renders a dynamic link to a projectdoc document in the wiki. A dynamic link is a link to a Confluence page that is identified by the page title and the delegate space closure. The target of the link is calculated at render time. In case the delegate space closure changes, a different document may be the target of the link.
- External Link Macro
- Renders a locale dependent link to an external resource. The body of the macro contains the link label.
- In-Document Link Macro
- Renders a static link to a location within the same document. This is a static document link macro with a specialized interface.
- Name Body List Macro
- Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name hat is added to the body.
- Name List Macro
- Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name.
- Parent Property Macro
- Renders the property of the parent document, if it has the same doctype.
- Role List Macro
- Renders a name list while taking care of special role semantics. Confluence names of groups with view permissions are added to the list of values.
- Tag Body List Macro
- Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name hat is added to the body.
- Tag List Macro
- Renders a name list while taking care of special tag semantics. Confluence labels are added virtually to this list and displayed in the tags table row of the document properties table.
- Template Document Link Macro
- Allows to render a link constructed with a template to a document dependent on the space closure.
- Term Link Macro
- Renders a dynamic link to a Glossary Item in the wiki.
- Wiki Link Macro
- Allows to render a link to a wiki page.
