Display Document Property Macro

...

Document Properties Marker

doctype	macro
override	false

Doctype

macro

hide

Name

Display Document Property Macro

Short Description

Renders the value of a property of a document.

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
render-list-as-comma-separated-values	true
names	Author, Template Author
empty-as-none	false

Tags

Tag List


names	Display, Property Value Transclusion, Autocomplete

Type

Name List

doctype	macro-type
render-list-as-comma-separated-values	true
names	Content Reuse, Properties Management

Iteration


value	production

hide

Sort Key

hide

...

Section

title	Properties

Section

level	2
title	Document

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

document	Display Property Usage Warning
ids	Content

Section

level	2
title	Property Name

The name of the property to fetch the property value.

Section

level	2
title	Add Link

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

Section

title	CSS 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

title	Match 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

since	4.5

This parameter is supported since version 4.5.

Section

title	Render 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

since	4.5

This parameter is supported since version 4.5.

Version Box

since	5.0

Since version 5.0.6 the parameter supports to reference a

Static Document Link

document	Space Properties
label	space 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

document	Display Document Properties Macro
ids	supported-html-elements

Section

level	2
title	Append

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

Section

level	2
title	Additional Text

The text to be appended to the referenced property value.

Section

level	2
title	Default Value

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

Section

level	2
title	Prepend Newline

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

Section

title	Render 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

document	Deep Links

, then this parameter allows to control how the list of names is rendered.

Render Mode	Description
none	The content is rendered as is (default).
text	The names are rendered in a comma-separated list.
bullet	The names are rendered in a bullet list (the `ul` HTML element).
numbered	The names are rendered in a bullet list (the `ol` HTML element).

Version Box

since	5.0.8

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

Section

title	Identifier

Unique identifier of the macro for the rendered context.

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

Version Box

since	4.0

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

Tip Box

title	Remote Control

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

Section

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

Version Box

since	4.0

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

Tip Box

title	Remote Control

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

Section

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

Version Box

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.

Transclusion

document	@self
ids	autocomplete-constraints-explained

Section

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

Version Box

since	4.0

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

Content Marker

id	autocomplete-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

hide	true
title	Autocomplete 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

since	4.0

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

Section

title	Details

Content Marker

consider-as-empty	true

Information on using this macro.

Transclusion

taget-heading-level	*
document	Display Document Properties Macro
render-error-on-no-content	false
ids	Tiling

Section

index	true
title	Related macros

Display Table

doctype	macro
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
sort-by	Sort Key, Name
where	Categories = "Display / Property"
exclude-self	true

Display Table

select	Name, Short Description, Doctype
where	Tags = "query"

Section

index	true
title	Sub-Macros

Display Table

doctype	macro
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

...

Section

title	References

Tags = "query"

Section

title	Resources

projectdoc-

display-table

select

Name, Short Description, Doctype

where

tour-macro

render-as-definition-list	true
replace-title-with-name	true

Title	Short Description
Referencing Property Values
Linking to Glossary Terms

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-macro
Type	modular

...

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 5

New Version Current

Key

About

Keep up-to-date!

Powered by