Compare the Page Properties Macro / Page Properties Report Macro with the Document Properties Marker Macro / Display Table Macro
Users employ the Page Property Report Macro to query pages with properties and display them in a table. In order to work the Confluence pages to select have to contain one or more instances of the Page Properties Macro. In the Page Properties Macro users define the properties of the page as key-value pairs in a table.
Users of the projectdoc Toolbox use the Display Table Macro to define the queries instead of the Page Property Report Macro. The Document Properties Marker Macro replaces the Page Properties Macro to define the document properties.
Confluence calls the properties page properties, while the projectdoc Toolbox uses the name document properties.
So let's first have a look at the differences in specifying properties.
Compare Defining Properties
Confluence Page Property Report Macro
The sample used in this demo: Topic with Page Properties 1.
Here is a screenshot from the Page Properties Macro:
You may have several sets of properties identified by a unique ID (which is optional). The table with the properties is straight forward. First column contains the name, the second column the value.
Document Properties Marker Macro
The sample used in this demo: Topic with Document Properties 1.
Here is a screenshot from the Document Properties Marker Macro:
You may only have one definition of properties per document. Instead of two columns, you have three. Besides the name and the value for the property there is a third column for Property Controls. A very handy control is hide that allows users to prevent a line in the table from rendering.
The macro configuration has the following parameters:
Besides the already mentioned identifier users decided whether to show the table as a whole or not at all.
The macro configuration has the following parameters:
The macro also allows to hide the whole table. it also allows to render the properties as a definition list and to extract a special property called Short Description. This allows to render the properties more compact.
The table with the properties is rendered on the page defining the properties as follows.
The table with the properties is rendered on the page defining the properties as follows.
Definition List
Table
So this is the end of defining properties for a Confluence page. Now have a look on how to query from pages!
Compare Defining Queries
Confluence Page Property Report Macro
The macro allows you to define a query based on a predefined set of properties.
The selection process is elegant, supporting the user very nicely to select on the properties.
projectdoc Display Table Macro
The macro allows to define a query based on any property.
The query has to be specified with a simple text field. The user is not as well guided through the selection process as with the Confluence macro. The benefit is that the constraint can be based on any property the user specified as a property.
Furthermore the query can be defined using AND, OR, NOT and brackets. It is an enhanced version of a Lucene query.
To select the properties to be shown in the table for the result set the process is straight forward:
To select the properties to be shown in the table for the result set the process is straight forward:
So here is a live result of the Page Property Report Macro:
| Name | Categories | Iteration | Property 1 |
|---|---|---|---|
| Topic with Page Properties 1 | Filled | Value 1 | |
| Topic with Page Properties 2 | Focused | Value 2 |
So here is a live result of the Display Table Macro:
| Name | Categories | Iteration | Property 1 |
|---|---|---|---|
| Content to Transclude | Filled | ||
| Content with Placeholders to Transclude | Filled | ||
| Topic with Document Properties 1 | Filled | Value 1 | |
| Topic with Document Properties 2 | Focused | Value 2 |
More Use Cases
The Page Property macros provide some features that are don't provided by the macros from the projectdoc Toolbox. For instance you may define multiple sets of properties and identify them by an ID. We expect readers to know about the features of the Confluence macros quite well. Therefore we do not show them here and instead show features of the projectdoc Toolbox macros that are not supported by Confluence natively.
Macro Configuration
Rendered Result
| Categories | Iteration | Name | Property 1 |
|---|---|---|---|
| Filled | Content to Transclude | ||
| Filled | Content with Placeholders to Transclude | ||
| Filled | Topic with Document Properties 1 | Value 1 | |
| Focused | Topic with Document Properties 2 | Value 2 |
Macro Configuration
Rendered Result
| Name | Description | Section 1 |
|---|---|---|
| Content to Transclude | ||
| Content with Placeholders to Transclude | ||
| Topic with Document Properties 1 | A description one. | Section content 1. |
| Topic with Document Properties 2 | A description two. |
Macro Configuration
Rendered Result
Macro Configuration
Rendered Result
| Name | MY PROPERTY |
|---|---|
| Content to Transclude | |
| Content with Placeholders to Transclude | |
| Topic with Document Properties 1 | Value 1 |
| Topic with Document Properties 2 | Value 2 |
Macro Configuration
Rendered Result
Macro Configuration
Rendered Result
- Content to Transclude - Provides content via the Content Marker Macro.
- Content with Placeholders to Transclude - Provides content using placeholders via the Content Marker Macro.
- Topic with Document Properties 1 - A short description 1.
- Topic with Document Properties 2 - A short description 2.
Macro Configuration
Rendered Result
| Name | Short Description | Iteration |
|---|---|---|
| Topic with Document Properties 1 | A short description 1. | Filled |
| Topic with Document Properties 2 | A short description 2. | Focused |
The complete where clause looks like this:
($[Property 1]="Value 1" OR Categories = "Cat 2") NOT Iteration=Facade
Summary
Confluence calls the properties page properties, while the projectdoc Toolbox uses the name document properties.
Macro Parameters
Here are screenshots to compare the configuration options of the two query macros visually.
