...
| Section | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
The first use case is about metadata. How can an author provide metadata on a Confluence page? The answer is properties! The Document Properties Marker Macro is similar to the Page Properties Macro. The macro expects a table with property keys and values. Different to the Page Properties Macro there is a third column for property controls. A document property requires a name (first column). It may or may not have a value and it may or may not have a control. While the Page Properties Report Macro renders the information provided by the Page Properties Macro, the projectdoc Toolbox provides a collection of macros to fetch this information. The one that comes close to the Page Properties Report Macro is the Display Table Macro. Here is a selection of macros that render document properties.
You may know that page properties are accessible via a REST API (
|
| Section | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
The second use case is about reusing content from one page from a number of other pages. The Excerpt Macro allows to define content on a page for reuse. The content can then by displayed in another page. The projectdoc Toolbox calls this feature transclusion. The content is defined with the Section Macro (if it has a title and a body) or the Content Marker Macro (for any other part of a page that needs to be transcluded).
While the excerpt macro may only provide one content on a page for reuse, the projectdoc macros may be used any number of times and provides some enhanced transclusion features. To render the content on another page, Confluence provides the Excerpt Include Macro. The projectdoc provides the Transclusion Macro to do this. But transclusion (especially with sections) is provided by a number of other macros.
|
| Section | ||
|---|---|---|
| ||
This article should show that using the projectdoc Toolbox in only two of its use cases, is not too different than using macros already on-board with Confluence. We do not want to indicate that the Confluence macros are bad and should not be used. In the contrary: If these macros support your use cases they are easy to use and this should be the your way to go. But if you miss some features to make your documentation work more fun, check out the projectdoc Toolbox! |
...
