Versions Compared

Key

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

...

Document Properties Marker
doctypemacro
overridefalse


Short DescriptionA table containing document properties. Three columns: name, value and meta data (aka controls) to a property.
Doctypemacrohide

NameDocument Properties Marker Macro
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesTemplate Author

Subject
Name List
doctypesubject
render-no-hits-as-blanktrue
propertySubject

Categories
Name List
doctypecategory
render-no-hits-as-blanktrue
namesTransclusion / Marker
propertyCategories

Tags

Tag List
namesDocument Structure, Marker, Property Value Transclusion, Define Properties
propertyTags


Type

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


Iteration
Iteration
valueproduction
hide
Since1.0
Sort Keyhide



Section
indextrue
show-titlefalse
titleDescription

This macro contains the document properties in a table. The first column contains the name of the property, the second column contains the value. The value may be a macro to be evaluated. The macro should return a static value. The third column contains controls.

Caution Box

It is very important to note that the property values are used in the Lucene index.

Therefore property values must not contain sensitive (secret) information!

If a page is accessible for a user, all properties of that page will also be accessible for that user.

Here is an example of the macro in edit mode:

Example Box
titleMacro Body with a valid Document Properties Table

The following screenshot shows the macro with a valid document properties table:

Document Properties provides information about the standard properties of projectdoc.

The following controls are valid:

Display Table
doctypeproperty
render-modedefinition
whereParent = "Document Property Controls"

Note that the macro should be the first element of the document.

Properties within the table may refer to other properties, also long as the property has been defined earlier.

Warning Box

If you copy names and values for your properties table, there may be invisible elements that will prevent projectdoc to recognize your values properly. If for some reason you happen to not match a given value or your queries do not find a specific property, please check your code with the Confluence Source Editor!

See Cannot access Property from a Document for details.



Section
titleProperties


Section
titleDoctype

Specify the type of the document. Each document is required to have one and only one type.

The doctype may be overridden by the document property named

Static Document Link
documentDoctype - Document Property
. This is only supported to be backward compatible with documents that have been created where the doctype was specified by a property.

Version Box
since4.2

This parameter is available as a default value for the document's type since version 4.2.



Section
level2
titleOverride

If checked information passed from the space configuration will be overridden by this macro.

Note that every property will be overridden.


Section
level2
titleHide

If checked the table containing the properties will not be rendered.

For some pages the metadata is irrelevant to the reader or may be rendered by other means. In this case set this flag to true.

Note Box

The value may be set by the Space Property hide-metadata. If you want to override this, use Override.



Section
level2
titleDelegate Document

Allows to specify a document to delegate to in order to fetch properties and sections. The delegate document is consulted as a backup for properties and sections.

Note Box

This feature makes it easy to annotate an existing document. If a document should not be edited, e.g. because it is imported after a release, the delegation parameter allows to transclude content from that document and add additional sections.

If you need to transclude parts of a section and also have to add to that section additional information, use the Transclusion Macro.

Available since version 1.10.


Section
level2
titleRender As

Select a rendering mode for the document properties.

The following values are valid:

ValueDescription
table

The properties are rendered in a table. The first column is the property key, the second the property value. Controls are not rendered, since they are not important to the reader.

definition listThe properties are rendered as a definition list. The property key key is the definition term, the property value the definition value.


Note Box

The value may be set by the Space Property render-metadata-as. If you want to override this, use Override.



Section
level2
titleCSS Class

This controls the formatting of the table. The CSS class applied to the table or definition list.


Section
titleExtract Short Description

Renders the short description in front of the properties table.

The short description is displayed even if the properties table is set to hide.


...