projectdoc Toolbox

Primary Page Display Document Property Macro

Renders the value of a document property from the primary page.

Categories: Visual
ID: projectdoc-primary-page-property-display-macro
Since: 2.5

The Display Primary Page Property is used to render a property from the currently rendered projectdoc Document in a page fragments, such as the header or footer.

Parameters

Property Name

The name of the property to fetch the property value. Defaults to 'Name'.

When used in Wiki Markup the name of the parameter is property-name. The value is a string.

Default Property Value

The default value, if the property is not set.

When used in Wiki Markup the name of the parameter is default-not-set. The value is a string.

Add Link

Signals to render a link to the referenced document (if the property value is an URL the target of the link is that URL).

When used in Wiki Markup the name of the parameter is add-link. The value is a boolean (true or false).

CSS Classes

Set the CSS style classes.

Separate class names by comma or space.

When used in Wiki Markup the name of the parameter is css. The value is a string with the name of the class.

Additional Text

The text to be add to the referenced property value (see append for controlling the location).

When used in Wiki Markup the name of the parameter is append-text. The value is a string.

Append

If checked the additional text is appended, otherwise it is prepended (set in front of the property value).

When used in Wiki Markup the name of the parameter is append. The value is a boolean (true or false).

Prepend Newline

If checked a newline is rendered before the property.

This feature is typically used by Template Authors.

When used in Wiki Markup the name of the parameter is prepend-newline. The value is a boolean (true or false).

Details

If you want to show a property of the primary page in the footer of a specific space then add the following in the Space Tools under Sidebar, header and footer in one of the sections.

Show the Name of the Document

{projectdoc-primary-page-property-display-macro}

Show the Short Description of the Document

{projectdoc-primary-page-property-display-macro:property-name=Short Description}

We need to use the 'curly syntax' of the macro known as Wiki Markup. For more information on this syntax, please refer to Working with Macros on confluence.atlassian.com.

References

https://confluence.atlassian.com/display/CONF35/Working+with+Macros: In the section 'Including Macros with the Confluence Editor' the basic syntax for specifying macros in Wiki Markup is explained.

Resources

Page Include Macro: Supports page inclusion dependent on the space of the primary page.
Layout Element Macro: Renders an block or inline element of a page.

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools