We like to think of document properties as metadata. But in some contexts it is natural to think of them as data for the entity described by the document.
Step-by-Step
Prior to Version 1.11?
Before we start please note that this feature is only supported by the projectdoc Toolbox with version 1.11 or higher.
You may yield similar results with previous versions. Add the properties to the marker macro (instead of to the supplier) and use the Display Table Macro to show the relevant properties on the information system documents. This is more manual work and you need to adjust the selected properties in the Display Table Macro for each property you add to the marker macro.
The Transclude Documents Macro supports link rendering also since version 1.11. For prior versions you will need to include a property (such as name) to the table to show a link.
Create the Dashboard
We want to locate all descriptions on a dashboard.
Therefore we create a new document and add the Transclude Documents Macro to it.
| Parameter | Value | Explanation |
|---|---|---|
| Identifiers | -Description,!* | We want to select the body of the Description, but without the title. No other sections should be transcluded. |
| Select | Product, URL | These are the name of the properties we specify for the information systems. While the identifiers specify the sections to transclude, the Select parameter specifies the properties to be rendered in a table. |
| Heading Link |  | This will render the heading (which is the name of the document) as a link to the document. |
All other parameters stay with their defaults.
Create an Information System
New create a new document as a child of the dashboard created in the first step.
| Property / Section | Content |
|---|---|
| Name | Artifact Server |
| Short Description | Repository for artifacts of our projects. |
| Description | The artifact server stores artifacts required by our projects and the artifacts produced by out projects. |
| Access Information |  |
Name and Short Descriptions are properties, Description and Access Information are sections. Within the Access Information section use the Document Properties Supplier Macro and add a two-column table to it. The keys (make sure to mark the first column as the table head!) are added to the first, the values to the second column.
Repeat this for one or more additional systems.
View the Dashboard
After adding three topic documents to describe information systems, the dashboard looks like this.
Each system is rendered with its name as heading, the data of the information system in the table and the description without the section title.
Separate Link
If clicking on the heading is not intuitive enough or is not allowed by your style guides, you may create an extra link to the document.
Set the "Add Link" property to the value "More ..." to get the following result.
