You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

projectdoc Toolbox

Renders a template with property references.

Description

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.

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

 

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

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.

Related macros

Display Document Properties Macro
Renders a template with property references.
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 As List Macro
Renders the list value of a document property.
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.

  • No labels