Import properties from another projectdoc document.

Audience
Categories
Tags
Type
Content Organization, Content Reuse, Properties Management
Since
3.2

This macro allows to import additional document properties from other documents. These properties are added to those properties already defined by the Document Properties Marker Macro or other supplier macros.

Only properties with the property control named supply are imported.

By grouping macro values and rendering them at different location on a page, authors are able to use properties not only as metadata to a document, but also as content.

 

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.

Properties

Override

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

Note that every property will be overridden.

Hide

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.

 

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

Documents

Provide a list of references to projectdoc documents to fetch properties from.

If the list is empty, properties from the current document are imported. This is only allowed if the Properties parameter is set.

Properties

Provide a list of property names that have references to projectdoc documents as their values. This allows to define a property, typically in the same document as the macro, and fetch the information from the references given there.

Property names and the references in the referenced properties are separated by comma.

Identifier

The unique identifier of the set of properties in this document.

The identifier allows to list only properties imported by this macro. In case more than one Document Properties Supplier From Documents Macro is used on a document, a unique identifier is required.

Render 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.
horizontal tableThe properties are rendered with a heading (property key) in the first and the data (property value) in the second row. Available since version 6.0.4.
 

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

CSS Class

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

Related macros

Macros to define document properties.

The query matched no documents.

Macros related to the Document Properties Supplier Macro.

The query matched no documents.