Versions Compared

Key

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

...

Section
titleProperties


Section
level2
titleDocument

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.

Transclusion
documentDisplay Property Usage Warning
idsContent




Section
level2
titleTemplate

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

The template defaults to 

Code Block
languagetext
$[Name] - ${Short Description}


Version Box
since4.13

Since version 4.13 the parameter supports to reference a

Static Document Link
documentSpace Properties
labelspace property
. The name of the space property has to be prefixed with the paragraph sign ('§').

For instance, if the value for the template parameter is specified by the space property my-select, then the value of the template parameter is §my-select.


projectdoc-content-marker
idsupported-html-elements


Version Box
since5.0

Since version 5.0.6 the parameter supports a selection of HTML tags to structure the template.

Section


Column

Supported inline elements

Section


Column
  • b
  • br
  • cite
  • code
  • dd
  • dt
  • em
  • i
  • li


Column
  • q
  • small
  • span
  • strike
  • strong
  • sub
  • sup
  • u




Column

Supported block elements

  • blockquote
  • dl
  • ol
  • p
  • pre
  • ul






projectdoc-section
level2
titleAdd Link

If checked, a link to the referenced document is rendered for the complete template text.


Section
level2
titleLowercase Properties

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

Usually used for short descriptions.


Section
titleApply Space Properties

If checked the properties defined by the space of the document this macro is part of are applied as defaults.

Since these values are defaults they will only apply, if no document properties match.

Version Box
since4.13

This parameter is available since version 4.13.



Section
level2
titleCalculate Expression

The content is an expression to be evaluated.

Note Box

This property is available since version 1.7.0.

Use the Format Pattern to define the output format.

Example Box

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:

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

The result: 32.5



Section
level2
titleFormat Pattern

A format pattern to render an evaluated expression.

Version Box
since1.7.0

This property is available since version 1.7.0.


Transclusion
documentNumber Format
idsContent




Section
titleBlank 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).

Version Box
since2.0

This property is available since version 2.0.



Section
level2
titleDefault Value

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


Section
level2
titlePrepend Newline

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


Section
titleIdentifier


Transclusion
documentDisplay Document Property Macro
idsIdentifier




Section
titleIdentifier Classes


Transclusion
documentDisplay Document Property Macro
idsIdentifier Classes




Section
titleAutocomplete Space Closure


Transclusion
documentDisplay Document Property Macro
idsAutocomplete Space Closure




Section
titleAutocomplete Constraints


Transclusion
documentDisplay Document Property Macro
idsAutocomplete Constraints




Section
hidetrue
titleAutocomplete Sort


Transclusion
documentDisplay Document Property Macro
idsAutocomplete Sort




...