Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
doctypeapp-macro
overridefalse


Short DescriptionRender 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.
NameTerm Dynamic Document Link Macro
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
namesAuthor
property-restrict-value-rangetrue
propertyAudience
empty-as-nonetrue


Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
property-restrict-value-rangetrue
propertyCategories

Tags

Tag List
namesLink
propertyTags


Flagshide
Iteration

Iteration
valueproduction

hide
IDprojectdoc-dynamic-document-link-macro
Type
Name List
doctypeapp-macro-type
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyType

Suite
Name List
doctypeapp, app-extension
property-restrict-value-rangetrue
defaults-toancestor
propertySuite

App-Tool
Name List
doctypeapp-tool
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyApp-Tool

Since4.6
Deprecated
Removed
Sort Keyhide


...

Section
show-titlefalse
titleDescription

Renders a dynamic link to a

projectdoc-static-document-link-macro
documentprojectdoc Document
labelprojectdoc document
 in the wiki. It is a specialized form of the 
Static Document Link
documentWiki Link Macro
.

It is dynamic in the sense that the document to link to is determined by the provided document title and

projectdoc-static-document-link-macro
documentPDAC:Delegate Space
labeldelegate space
. The first matching document is linked to.


projectdoc-section
titleParameters


Section
titleDocument Title

The title of the document to reference.

Since version 4.10 of the projectdoc Toolbox this value is added to the artificial property 

projectdoc-static-document-link-macro
documentprojectdoc Dynamic Link Titles
.


-section
projectdoc-section
titleSpace 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. Also see

projectdoc

titleDocument

The title of the document to link to.

Overrides the document title parameter.

-in-document-link-macro
anchorSpace Closure
to control the space closure to use.


Section
titleAnchor

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.

Example Box
titleValid values: Section Titles and Identifiers
  • My Section Title
  • #my-element-id
  • #myAnchorName



Section
titleLabel

The label to render instead of the document name.

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


projectdoc-transclusion-macro
taget-heading-level*
documentWiki Link Macro
idsLower Case



projectdoc-section
titleTooltip

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.


Section
titleCSS Classes

The optional CSS classes to add to the link.

Version Box
since4.10

The default class 

Static Document Link
documentprojectdoc-intra-site-link
is added per default.



Section
titleSpace 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. 


projectdoc-transclusion-macro
taget-heading-level*
documentWiki Link Macro
idsDoctype Constraints



projectdoc-section
titleLink Render Control

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

Valid values are:

Definition List


create-linkRender a link to create a document (default)
emptyRender nothing
plain-textRender the link label.




Transclusion
taget-heading-level*
documentWiki Link Macro
idsAbbreviation Mode, Blueprint



Section
titleRequest 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

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


Note Box
titleRemote Controller

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



Section
titleRequest 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.


Section
titleRequest Toggle Tooltip

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

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


...

Section
titleResources


Tour
render-no-hits-as-blanktrue
render-as-definition-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue


TitleShort Description
projectdoc Dynamic Link Titles