Using document and space properties as variables in the projectdoc Toolbox for Confluence.
Using Properties
A property can be used in a number of ways. We will focus on document properties for our examples.
Property Reference
A property may simply be referenced with a Display Document Property Macro. Whenever the value of the property is changed, the value will change in the page using this macro is rendered.
Allowed as Property Value
The macro can also be used as a property values, since a page gets updated whenever a referenced page is.
There is a number of macros that allows user to render property values.
| Macro | Short Description |
|---|---|
Renders the value of a property of a document. | |
Renders a template with property references. | |
Displays a document property from a referenced document. | |
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. |
Authors may also choose to render properties of a list of documents in tabular form using the Tour Macro. Each property is rendered in a column or multiple properties may be rendered in a table cell using a template.
Control Rendering Section
With document and space properties authors can control whether or not to render a section (using the Section Macro) or a region (using the Content Marker Macro) on a page.
Authors may also check for a property for any value (i.e. require the property not to be empty.
List Documents
Document properties can be used to control which documents are shown in dynamic list. The Display List Macro and Display Table Macro provide a parameter named Where to specify queries. A Where clause looks like this:
The following shows the same query but with exact match. While the query above will also match Types like "Great Tip" and "Lousy Tip", the query below matches only for "Tip".
Once the value of a property changes, the query will update the results the next time the page with the dynamic list is rendered.
