projectdoc Toolbox

Renders a template with property references.

This macro transcludes the values of properties of another document. The properties of the values to fetch are specified in a template.

Properties

Document

The document the properties are part of.

If not specified, the current document is used. This allows to render the value of a property of the same document at several places of this document, without duplicating the value.

 

Within the Document Properties Marker Macro

  • you must not reference a property of the same document before it is defined. If you use this macro as the value of a document property, the macro must only reference properties that haven been specified prior.
  • do not reference properties of pages with different page access restrictions!

Template

The template to add property references.

The placeholder ${...} references a property value. The placeholder $[...] references a property value and also generates a link to the referenced document. With $<...> the property is rendered as is (as HTML).

Since version 1.9.0 the template defaults to 

$[Name] - ${Short Description}

Lowercase Properties

List of property names whose values first letter should be lowercased.

Usually used for short descriptions.

Calculate Expression

The content is an expression to be evaluated.

 

This property is available since version 1.7.0.

Use the Display Document Properties Macro#Format Pattern to define the output format.

 

If the document has the properties X with a value of 23 and Y with a value of 42.

If you want to calculate the average of these two values, use this pattern:

(${X} + ${Y}) / 2

The result: 32.5

Format Pattern

A format pattern to render an evaluated expression.

Since 1.7.0

 

This property is available since version 1.7.0.

Use the following symbols to define the pattern:

SymbolDescription
.Decimal Separator
0Digit
#Optional Digit
,Grouping Separator

¤

Currency Sign
%Multiply by 100 and show as percentage
Multiply by 1000 and show as per mille value
'Quote strings (to escape symbols)
 

Here are two examples for Locale US.

If the content is 2342.738, the pattern give these results:

PatternResult
<Default>2342.738
0.002342.74
###,##0.002,342.74
¤ ##,##0.00
$ 2,342.74

Assume the following value for the next example: 0.7832

PatternResult
<Default>0.7832
%%78
%0.00%78.32
‰783

Blank Placeholders

Controls the rendering of unresolved placeholders. Since unresolved placeholders may be further processed by transclusion macros (e.g. the Transclusion Macro), per default unresolved placeholders are rendered.

If this flag is checked, unresolved placeholders will not be rendered (blanked out).

Since 2.0

 

This property is available since version 2.0.

Default Value

A default value to render, if the document has no value for the template.

Prepend Newline

If checked, signals that a newline is to be rendered before the property template.

Identifier

Unique identifier of the macro for the rendered context.

Features may supply default configurations dependent on the value of this property.

Since 4.0

 

This parameter is available since version 4.0 of the projectdoc Toolbox.

Remote Control

 

This parameter is used in the context of Remote Controlled Documents.

Identifier Classes

Identifiers to address this macro as part a group for the rendered context.

Features may supply default configurations dependent on the value of this property.

Since 4.0

 

This parameter is available since version 4.0 of the projectdoc Toolbox.

Remote Control

 

This parameter is used in the context of Remote Controlled Documents.

Autocomplete Space Closure

Define the scope to search for documents in the Autocomplete context.

Only documents within this scope will be accepted by the Autocomplete for the Documents parameter.

Further constraints on the space can be declared by the use of the Autocomplete Constraints parameter.

Default space is the delegate space of the current space.

Since 4.3

 

This parameter is available since version 4.3 of the projectdoc Toolbox.

Before this the space closure could not be changed from its default delegate space.

This property is only used in the context of the Autocomplete function. It is only enforced on Autocomplete in the browser.

Changes to the parameter value will only take effect on the next Autocomplete selections. But there is also no guarantee that the list of selected documents will not be filtered later. The not enforced constraint is that the selected documents should match the constraints.content

Autocomplete Constraints

Provide a Where clause to select on documents for the autocomplete feature of this macro.

This parameter is only to control the autocomplete feature of this macro. If empty, no constraints are put on the list documents presented.

Since 4.0

 

This parameter is available since version 4.0 of the projectdoc Toolbox.

This property is only used in the context of the Autocomplete function. It is only enforced on Autocomplete in the browser.

Changes to the parameter value will only take effect on the next Autocomplete selections. But there is also no guarantee that the list of selected documents will not be filtered later. The not enforced constraint is that the selected documents should match the constraints.content

Related macros

Display Document Property As Image Macro
Renders the value of a document property as an image. The property value is required to an URL that points to an image.
Display Document Property As Link Macro
Renders the value of a document property as a link with an alternative label.
Display Document Property Macro
Renders the value of a property of a document.
Display Document Property Ref Concat Macro
Displays a single property of a document that is referred by a property of another document and concatenates it with the value of a local property.
Display Document Property Ref Macro
Displays a document property from a referenced document.
Display Space Attribute Macro
Renders a space attribute value.
Display Space Property Macro
Renders a space property value.
Tour Macro
Renders a predefined list of documents in a table.

Resources

Linking to Glossary Terms
Show how to use the Name List Macro to render links to glossary terms.