projectdoc Toolbox

Display Document Property As List Macro

Renders the list value of a document property.

Audience

Author, Template Author

Categories

Display / Property

Tags

Type

Content Reuse

Since

4.11

Renders a list value in a selected target format. This macro allows to render a list value independent of its original representation.

Properties

Document

The document the property is part of.

If not specified, the current document is used.

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!

Property Name

The name of the property to fetch.

The property control value-separator is considered when parsing the property value.

Representation

Select the target representation for the list.

Identifier	Description
`bullet`	Renders the property value as a bullet list.
`ordered`	Renders the property value as an ordered list.
`separator`	Renders the property value as a list of text strings, separated by the specified separator. E.g. `one, two, three`.
`text-and`	Renders the list as text. The last element is separated by an 'and' connector. E.g. `one, two, and three` or `one and two`
`text-or`	Renders the list as text. The last element is separated by an 'or' connector. E.g. `one, two, or three` or `one or two`

Separator

Specify the separator for the list elements.

Only applies for text modes.

Identifier

The unique identifier to render with the list.

Does not apply if the list is rendered as text.

CSS Classes

Add CSS classes to the rendered list element.

Does not apply if the list is rendered as text.

Details

Information on using this marco.

Merging Lists

A common use case is to merge list values from different sources. The Table Merger Macro allows to merge lists rendered by this macro.

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

More information on this topic is available by the following resources.

Table Merger Macro: Merges tables (and lists) into one table (or list).

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