- Created by Robert Reiner, last modified on 05. Mar 2016
projectdoc Toolbox
Macros to support single sourcing for creating modular documents.
- Parent
- Audience
- Level of Experience
- Type
The macros listed in this document help to structure a document. This includes sections and marker to hide page elements from readers.
Transclusion
Transclusion macros allow the transclusion of content of one wiki page into another wiki page.
The following macros allow to mark content to be transcluded or to actually transclude content.
| Name | Short Description |
|---|---|
| Enterprise Architect Image Link Macro | Renders an image generated from an Enterprise Architect diagram, transcluded from a server. |
| Index Card Macro | Renders transcluded content fetched from documents of a result set. |
| Random Transclusion Macro | Transcludes random content from a document marked with the content marker macro. |
| System Image Link Macro | Renders an image transcluded from a remote server. |
| Transclude Documents Macro | Renders transcluded content fetched from documents of a result set. |
| Transclusion Macro | Transcludes content from a document marked with the content marker macro. |
| Transclusion Reference Macro | Transcludes content via a reference from a document marked with the content marker macro. |
| Transclusion to Text Macro | Transcludes content from a document marked with the content marker macro and renders it as plain text. |
Property Value Transclusion
Transcludes properties from a projectdoc document. The projectdoc uses the Document Properties Marker Macro to define properties to be transcluded.
The tour macro is a special form and allows to define a list of references, where the properties to be transcluded are specified by columns. Use it if you want to control the lines of the table (otherwise use the Display Table Macro).
| Name | Short Description |
|---|---|
| Display Document Properties Macro | Renders a template with property references. |
| 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 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. |
| 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. |
| Document Properties Supplier Macro | A table containing additional document properties. Three columns: name, value and meta data (aka controls) to a property. |
| Tour Macro | Renders a predefined list of documents in a table. |
| Tour-by-Property Macro | Renders a predefined list of documents in a table . Documents are selected by a document property. Allows to select document properties for columns. Also non-list representations are provided. |
Remote Transclusion
Remote transclusion allows to transclude content from remote servers.
| Name | Short Description |
|---|---|
| HTML Snippet Macro | Transclude HTML content from a remote server. |
| Subversion Transclusion Macro | Transcludes a snippet from a project on a Subversion (SVN) server. |
| System Transclusion Macro | Transclude content from a resource from a remote system. |
| Text Snippet Macro | Transclude text content from a remote server. |
Make sure to not transclude content you do not control. Otherwise you make your Confluence instance vulnerable to cross-site-scripting (XSS) attacks.
Image Transclusion
Transclude images from remote servers. Images are naturally transcluded with HTML.
