- Created by Robert Reiner, last modified on 03. Sep 2019
projectdoc Toolbox
Import properties from another projectdoc document.
- Audience
- Categories
- Tags
- Type
- 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:
| Value | Description |
|---|---|
| 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 list | The properties are rendered as a definition list. The property key key is the definition term, the property value the definition value. |
| horizontal table | The 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.
| Name | Short Description | Tags |
|---|---|---|
| Document Properties Marker Macro | A table containing document properties. Three columns: name, value and meta data (aka controls) to a property. | |
| Document Properties Supplier Attachment Macro | A table supplying additional document properties from an attached file. | |
| Document Properties Supplier Macro | A table containing additional document properties. Three columns: name, value and meta data (aka controls) to a property. |
Macros related to the Document Properties Supplier Macro.
| Name | Short Description | Tags |
|---|---|---|
| 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 As List Macro | Renders the list value of a document property. | |
| 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 Document Properties Macro | Renders a template with property references. | |
| Display Space Attribute Macro | Renders a space attribute value. | |
| Display Space Property Macro | Renders a space property value. | |
| Document Properties Marker Macro | A table containing document properties. Three columns: name, value and meta data (aka controls) to a property. | |
| Display List Macro | Lists references to projectdoc documents in a list. List contain names and optional short descriptions. | |
| Display List Template Macro | Lists references to projectdoc documents in a list. List items are defined by templates referencing properties. | |
| Display Table Macro | Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided. | |
| Index Entries Table Macro | Renders a table of index entries. | |
| Transclude Documents Macro | Renders transcluded content fetched from documents of a result set. | |
| Index Card Macro | Renders transcluded content fetched from documents of a result set. |
Resources
Resources related to this macro.
- supply
- Marks a property as importable by other projectdoc documents.
- supplied
- Marks a property as being imported from another projectdoc document.
- projectdoc Document
- projectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections.
- Document Properties
- Properties are metadata that can be added to every projectdoc document. If you require a set of metadata for each instance of a document type, you should write your own doctype.
- Document Property Controls
- Lists valid controls for properties to be used in document properties tables.
