Display Document Properties Macro

...

Document Properties Marker

doctype	macro
override	false

Doctype

macro

hide

Name

Display Document Properties Macro

Short Description

Renders a template with property references.

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

Tags

Tag List


css	projectdoc-compact
names	Display, Property Value Transclusion, Development, Deep Link, 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

index	true
show-title	false
title	Description

This macro transcludes the values of properties of another document. The properties of the values to fetch are specified in a template.

...

Section

title	Properties

Section

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

Transclusion

document	Display Property Usage Warning
ids	Content

Section

level	2
title	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.. With $<...> the property is rendered as is (as HTML).

The Since version 1.9.0 the template defaults to

Code Block

language	text

$[Name] - ${Short Description}

Version Box

since	4.13

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

projectdoc-content-marker

id	supported-html-elements

Version Box

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

Section

level	2
title	Add Link

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

Section

level	2
title	Lowercase Properties

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

Usually used for short descriptions.

Section

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

since	4.13

This parameter is available since version 4.13.

Section

level	2
title	Calculate 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

level	2
title	Format Pattern

A format pattern to render an evaluated expression.

projectdoc-box-noteversion

since	1.7.0

This property is available since version 1.7.0.

Transclusion

document	Number Format
ids	Content

Section

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

projectdoc-box-version

since	2.0

This property is available since version 2.0.

projectdoc-section

level	2
title	Default Value

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

Section

level	2
title	Prepend Newline

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

Section

title	Render Mode

Transclusion

document	Display Document Property Macro
ids	Render Mode

Section

title	Identifier

Transclusion

document	Display Document Property Macro
ids	Identifier

Section

title	Identifier Classes

Transclusion

document	Display Document Property Macro
ids	Identifier Classes

Section

title	Autocomplete Space Closure

Transclusion

document	Display Document Property Macro
ids	Autocomplete Space Closure

Section

title	Autocomplete Constraints

Transclusion

document	Display Document Property Macro
ids	Autocomplete Constraints

Section

hide	true
title	Autocomplete Sort

Transclusion

document	Display Document Property Macro
ids	Autocomplete Sort

Section

title	Details

Information on using this macro.

Section

title	Tiling

Since version 5.0.6 this macro supports rendering block elements, also known as tiling.

Prior to that version block elements could be rendered, but will add additional spacing on top and bottom of the rendered content.

The macro cannot prevent to put empty paragraphs on top and bottom of the element. The following CSS may remove these empty elements and reduce spaces.

Code Block

language	css
title	Remove empty paragraphs

div.content-wrapper > p:empty {  
  display: none;  
}

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

...

Section

title	References

Section

title	Resources

Tour

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

Title	Short Description
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 6

New Version Current

Key

About

Keep up-to-date!

Powered by