- Created by Robert Reiner, last modified on 12. Jul 2017
projectdoc Toolbox
A table containing additional document properties. Three columns: name, value and meta data (aka controls) to a property.
- Audience
- Categories
- Tags
- Type
- Since
- 1.11
This macro contains additional document properties separated from those defined by the Document Properties Marker Macro.
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.
The document can be structured and its properties may be part of a section where additional information regarding the properties is provided.
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.
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.
Details
Length of Property Values
The value of a property is stored in the database as an unlimited string (StringLength.UNLIMITED). It depends on the database of the Confluence installation how large this actually is.
Keep in mind that most clients assume that these values are typically small. The values are also cached for fast access.
Static Values
The property value should either be text or have a macro that always returns the same value.
Dynamic Content as Property Value - think twice!
If the macro returns dynamic values, the value cannot be used in queries.
Values are stored in the Lucene Index at the time the document is stored. If the document contains dynamic content, changes in the content will not be reflected in the index until the page is stored again.
There is no guarantee that a dynamic value renders the same way in two different situations.
It is important to note that there are use cases where a dynamic property value is used, but these use cases (typically) must not include searching. Therefore the projectdoc Toolbox does not prevent the use of such macros as property values. If you ensure that the values are static in the context of the use case, then you may use a dynamic macro. For example:
- Use a separate space with documents that do rarely change. On every change on documents of that space all depending spaces, that is a space where there a documents with property values that make searches, need to be reindexed.
- It is save to use the dynamic content properties as long as the macros point to properties on the same page.
As a rule of thumb: The Name List Macro (and its relatives) provide static content, while the Display Table Macro or the Display Document Property Macro does not. Since the display property macros keep track of references they are in many use cases safe to use. Searches, like executed by the Display Table Macro and its relatives, should be avoided (and maybe will be forbidden in future versions of the projectdoc Toolbox).
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 From Documents Macro | Import properties from another projectdoc document. |
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 the Document Properties Supplier Macro.
- 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.
