Simple Placeholders

A simple placeholder has a name and is delimited by a starting ${ and ends with a curly brace ('}').

${A simple placeholder}

Without transclusion simple placeholders are not replaced.

Simple placeholders are used by

• Transclusion Macro - Transcludes content from a document marked with the content marker macro.
• Transclude Documents Macro - Renders transcluded content fetched from documents of a result set.
• Code Block Placeholder Macro - Passes a text containing placeholders to the Code Block Macro. The placeholders are replaced by the properties of a document and/or the space properties.

Property References

A property reference is a macro that displays the value of a page or space property.

Properties are defined by the Document Properties Marker Macro and the Document Properties Supplier Macro.

Property placeholders simply render the value of a property. If a property is not defined an alternative value may be rendered which is specified with the macro.

Macros used to display the property values are

Explicit Replacement

An explicit replacements defines the replacement values with the transclusion macro.

This is an example for placeholder replacements in the body of the Transclusion Macro or the Transclude Documents Macro:

product-name=projectdoc Toolbox
product-version=2.0

And this is an example of a fragment that defines the placeholders:

There current version of ${product-name} is ${product-version}.

Here is another example with the Transclusion Macro where a letter is created using placeholders.

Context Replacement

The context replacement uses the properties defined on the page, the space the page is part of, and to spaces and pages the space or page delegates to. All properties accessible from a given point are part of the replacement context.

The Code Block Placeholder Macro uses the properties information form the page and space.

Impersonator

The impersonator feature, available since version 1.13 of the projectdoc Toolbox, allows to use property references in transclusion by replacing the owning document. Usually a page is rendered in its own context. With an impersonator the page will rendered in the context of the transcluding page.

The Transclusion Macro provides a property to define the impersonating page.