Versions Compared

Key

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

...

Document Properties Marker
doctypemacro
overridefalse


Doctypemacrohide
NameDisplay Document Property Macro
Short DescriptionRenders the value of a property of a document.
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Template Author
empty-as-nonefalse

Categories
Name List
doctypecategory
namesDisplay / Property
propertyCategories

Tags

Tag List
namesDisplay, Property Value Transclusion, Autocomplete


Type

Name List
doctypemacro-type
render-list-as-comma-separated-valuestrue
namesContent Reuse, Properties Management


Iteration
Iteration
valueproduction
hide
Sort Keyhide


...

Section
titleProperties


Section
level2
titleDocument

The document the property is 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
titleProperty Name

 The name of the property to fetch the property value.


Section
level2
titleAdd Link

If checked, a link to the referenced document is rendered.


Section
titleCSS Classes

Provide a list of classes to be set for the rendered value.

The value will be rendered in a HTML-span element with this CSS class names added.

This parameter is available since version 2.0.


Section
titleMatch Pattern

Provide a regular expression to match with the property value. Define groups in the pattern to apply to placeholders in the Render Template.

The regular expression is passed to the Jave Regular Expression parser. For more information please refer to Class Pattern.

If the match pattern does not match, the property value is returned unaltered.

Example Box

The following pattern matches with one group.

Code Block
^\d\d\d ([^#]+) #\d+$

Use the parameter Render Template and refer to the group with ${1}.


Version Box
since4.5

This parameter is supported since version 4.5.



Section
titleRender Template

Specify a template with placeholders of the form ${integer}, to reference the groups matched with the Match Pattern.

Example Box

The follwing render template refers to the first group matched with the matcher.

Code Block
Reference ${1}



Version Box
since4.5

This parameter is supported since version 4.5.


Version Box
since5.0

Since version 5.0.6 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 select parameter is specified by the space property my-select, then the value of the select parameter is §my-select.


Transclusion
documentDisplay Document Properties Macro
idssupported-html-elements




Section
level2
titleAppend

Check if the Append Text is actually to be appended. If unchecked, the Append Text is prepended.


Section
level2
titleAdditional Text

The text to be appended to the referenced property value.


Section
level2
titleDefault Value

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


Section
level2
titlePrepend Newline

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


Section
titleRender Mode

Specify how values from multiple documents are merged.

In case the values are drawn from multiple documents, typically by the use of 

Static Document Link
documentDeep Links
, then this parameter allows to control how the list of names is rendered.

Render ModeDescription
noneThe content is rendered as is (default).
textThe names are rendered in a comma-separated list.
bulletThe names are rendered in a bullet list (the ul HTML element).
numberedThe names are rendered in a bullet list (the ol HTML element).


Version Box
since5.0.8

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



Section
titleIdentifier

Unique identifier of the macro for the rendered context.

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

Version Box
since4.0

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


Tip Box
titleRemote Control

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



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

Version Box
since4.0

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


Tip Box
titleRemote Control

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



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

Version Box
since4.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.


Transclusion
document@self
idsautocomplete-constraints-explained




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

Version Box
since4.0

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


Content Marker
idautocomplete-constraints-explained

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



Section
hidetrue
titleAutocomplete Sort

Control the sort order for the autocomplete feature of this macro.

This parameter has only effect on the autocomplete feature of this macro. If empty, the default sort order is defined by the Sort Key property of the documents.

Version Box
since4.0

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




Section
titleDetails


Content Marker
consider-as-emptytrue

Information on using this macro.


Transclusion
taget-heading-level*
documentDisplay Document Properties Macro
render-error-on-no-contentfalse
idsTiling




Section
indextrue
titleRelated macros
Display Table
doctypemacro
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
sort-bySort Key, Name
whereCategories = "Display / Property"
exclude-selftrue

Display Table
selectName, Short Description, Doctype
whereTags = "query"


Section
indextrue
titleSub-Macros
Display Table
doctypemacro
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...

Section
titleReferences


Tags = "query"
Section
titleResources


projectdoc-
display-table
selectName, Short Description, Doctype
where
tour-macro
render-as-definition-listtrue
replace-title-with-nametrue





Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categoryprojectdoc-macro
Typemodular


...