Go to start of metadata
- Created by Robert Reiner, last modified on 30. Sep 2020
projectdoc Toolbox
List of macros provided by the projectdoc Toolbox.
Macros of the projectdoc Toolbox
The projectdoc Toolbox provides a large number macros that help teams to create and maintain their project documentation.
Especially important are the display and transclusion macros. These macros help to reuse information from other pages to create a modular documentation. There are also macros to fetch information from remote information systems and macros to support template designers creating their own templates.
The video (about 3,5 minutes) is based on a Prezi presentation: projectdoc Macros
It shows a short listing of all projectdoc macros. This overview provides brief visual clues on how to use these macros. For detailed information, please follow the links on this page.
For more videos, please refer to Screencasts for projectdoc or jump to the projectdoc playlist at YouTube.
Or step through at your own pace with with our Prezi Presentation!
Related Documentation
The following links direct you to related documentation within this wiki.
Note that many projectdoc macros only work with projectdoc documents!
A projectdoc document is a Confluence page using the projectdoc Document Properties Marker Macro.
This macro contains a table with document properties.
The Macros Introduction helps you to learn about the projectdoc macros in different usage scenarios.
| # | Name | Short Description |
|---|---|---|
| 1 | Action Button Macro | Renders an action button to link to a projectdoc document, Confluence page, or external resource. |
| 2 | Ancestor Property Macro | Render the property value of an ancestor of this document, for the first ancestor that matches the specified document type. |
| 3 | Aside Panel Macro | Renders apanel with title and body, layouted with a custom CSS configuration. |
| 4 | Aspect Properties Macro | Access properties from aspect documents. |
| 5 | Aspect References Macro | Autoconnect to aspect documents. |
| 6 | Aspect Sections Macro | Access sections from aspect documents. |
| 7 | Attachment Code Block Placeholder Macro | Renders a code block from an attached file with placeholders replaced by properties. |
| 8 | Attachment Link Macro | Renders a link to an attached file for download. |
| 9 | Body Graph Macro | Renders a document graph in a graph language allowing the body to contain arbitrary content (including transclusions). |
| 10 | Breadcrumb Macro | Renders a breadcrumb for the current page. |
| 11 | Calculation Macro | Run calculations on a set of result documents and renders the results. |
| 12 | Calculation Result Macro | Renders a single result of a calculation provided by the Calculation Macro. |
| 13 | Caution Box Macro | Renders a box containing a caution message. |
| 14 | Changelog Macro | Renders document history information. |
| 15 | Child Documents Macro | Renders the list of child documents, matching the given filter criteria. |
| 16 | Cite Macro | Renders a cite to a resource document. |
| 17 | Code Block Placeholder Macro | Passes a text containing placeholders to the Code Block Macro. The placeholders are replaced by the properties of a document and/or the space properties. |
| 18 | Compact Definition List Macro | Renders wiki syntax as a definition list. Does allow HTML tags and therefore is vulnerable to XSS attacks. |
| 19 | Compact No-HTML Definition List Macro | Renders wiki syntax as a definition list. Does not allow any HTML tags. |
| 20 | Content Marker Macro | Marks a piece of content within a document. This content can be referenced for transclusion. |
| 21 | Count Macro | Renders the count of rows, list items, or definition terms. |
| 22 | Create One Document Macro | Renders template button to create a page. After the page is created, the macro renders a link to this page. |
| 23 | Definition List Macro | Renders term and definition information as a definition list. Currently Conflucene does not easily support authors to write definition lists. But definition lists allow to render this form of information efficiently. |
| 24 | Deprecated Box Macro | Renders a box containing a deprecation warning for the reader. |
| 25 | Display All Document Properties Macro | Displays all properties of a document as a writing tool for authors. |
| 26 | Display All Space Properties | Renders all properties referenced by the current space. |
| 27 | Display Document Properties Macro | Renders a template with property references. |
| 28 | 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. |
| 29 | Display Document Property As Link Macro | Renders the value of a document property as a link with an alternative label. |
| 30 | Display Document Property As List Macro | Renders the list value of a document property. |
| 31 | Display Document Property Macro | Renders the value of a property of a document. |
| 32 | 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. |
| 33 | Display Document Property Ref Macro | Displays a document property from a referenced document. |
| 34 | Display List Macro | Lists references to projectdoc documents in a list. List contain names and optional short descriptions. |
| 35 | Display List Template Macro | Lists references to projectdoc documents in a list. List items are defined by templates referencing properties. |
| 36 | Display Space Attribute Macro | Renders a space attribute value. |
| 37 | Display Space Property Macro | Renders a space property value. |
| 38 | Display Table Macro | Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided. |
| 39 | Document Properties Marker Macro | A table containing document properties. Three columns: name, value and meta data (aka controls) to a property. |
| 40 | Document Properties Supplier Attachment Macro | A table supplying additional document properties from an attached file. |
| 41 | Document Properties Supplier From Documents Macro | Import properties from another projectdoc document. |
| 42 | Document Properties Supplier Macro | A table containing additional document properties. Three columns: name, value and meta data (aka controls) to a property. |
| 43 | Dynamic Document Link Macro | Renders a dynamic link to a projectdoc document in the wiki. A dynamic link is a link to a Confluence page that is identified by the page title and the delegate space closure. The target of the link is calculated at render time. In case the delegate space closure changes, a different document may be the target of the link. |
| 44 | Enterprise Architect Image Link Macro | Renders an image generated from an Enterprise Architect diagram, transcluded from a server. |
| 45 | Example Box Macro | Renders an example within a box. |
| 46 | External Link Macro | Renders a locale dependent link to an external resource. The body of the macro contains the link label. |
| 47 | External Quote Macro | Renders a quote to an external resource with author and source. |
| 48 | Fault Box Macro | Renders a box containing a fault message reported by a team member for the author. |
| 49 | Feedback Box Macro | Renders a box containing a feedback message from a reader with write privilege. |
| 50 | Generic Box Macro | Generic boxes help to easily define one's own boxes to apply certain CSS styles to them. |
| 51 | Graph Macro | Renders a document graph in a graph language. |
| 52 | Hide From Anonymous User | Hides a text fragment from an anonymous user. |
| 53 | Hide From Reader | Hides a page fragment from a user with read-only permissions. |
| 54 | Hide From Viewer Macro | Hides a text fragment from a user that has no edit permissions. |
| 55 | HTML Snippet Macro | Transclude HTML content from a remote server. |
| 56 | HTML Span Macro | Renders simple HTML span elements into a page. |
| 57 | Image Element Macro | Renders an image with an overlay text. |
| 58 | In-Document Link Macro | Renders a static link to a location within the same document. This is a static document link macro with a specialized interface. |
| 59 | Index Card Macro | Renders transcluded content fetched from documents of a result set. |
| 60 | Index Entries Table Macro | Renders a table of index entries. |
| 61 | Info Box Macro | Renders a box containing an info message. |
| 62 | Iteration Macro | Selects an iteration phase from a fixed set of stages. |
| 63 | Javadoc Link Macro | Links API documentation pages for Java elements. |
| 64 | Layout Element Macro | Renders an block or inline element of a page. |
| 65 | Level Macro | Renders the level of the document within its hierarchy. The level is derived from a parent document's level of the same document type. |
| 66 | Name Body List Macro | Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name hat is added to the body. |
| 67 | Name List Macro | Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name. |
| 68 | Nexus Link Macro | Renders a link to an artifact stored on a Nexus server. |
| 69 | Note Box Macro | Renders something to note by the reader. |
| 70 | Page Include Macro | Supports page inclusion dependent on the space of the primary page. |
| 71 | Parent Property Macro | Renders the property of the parent document, if it has the same doctype. |
| 72 | Pending Box Macro | Renders a box containing a pending message to be handled later by the author. |
| 73 | Primary Page Display Document Property Macro | Renders the value of a document property from the primary page. |
| 74 | Property Calculation Macro | Execute a calculation in the context of a property value. |
| 75 | Question Box Macro | Renders a box containing an open question. |
| 76 | Quote Macro | Renders a quote from a resource with author and source. |
| 77 | Random Transclusion Macro | Transcludes random content from a document marked with the content marker macro. |
| 78 | Reference Attachment Code Block Placeholder Macro | Renders code of attached file, referenced by local property, with placeholders replaced by properties. |
| 79 | References Box Macro | Renders a box with references to further information. |
| 80 | Role List Macro | Renders a name list while taking care of special role semantics. Confluence names of groups with view permissions are added to the list of values. |
| 81 | Section Compiler by Reference Macro | Compiles local sections with transcluded content by a reference list. |
| 82 | Section Index Macro | Renderes an index over the section on a document with intra-page links. |
| 83 | Section Macro | Renders a section, if the body is not empty. Supports authors to create content, clutter-free rendering without empty sections. Allows to transclude the content. |
| 84 | Selection Macros | Lists macros that allow to select from a fixed set of values. These macros are used to define the range of document property values. So they are a tool for template authors. |
| 85 | Space List Macro | Renders spaces with their attributes in a table or list. |
| 86 | Stakeholder Rating Macro | Renders the stakeholder rating that is based on the power and interest of a stakeholder in the project. |
| 87 | Static Document Link Macro | Renders a static link to a projectdoc document in the wiki. A static link is a link to a Confluence page that is identified by its space key and document title. |
| 88 | Steps Macro | Present a step-by-step guide. Use the Section Macro to define each step with a section inside the steps macro. |
| 89 | System Image Link Macro | Renders an image transcluded from a remote server. |
| 90 | System Link Macro | Links to a resource on a server. |
| 91 | System Transclusion Macro | Transclude content from a resource from a remote system. |
| 92 | Table Merger Macro | Merges tables (and lists) into one table (or list). |
| 93 | Table Set Macro | Applies a simple set operation on tables in its body. |
| 94 | Tag Body List Macro | Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name hat is added to the body. |
| 95 | Tag List Macro | Renders a name list while taking care of special tag semantics. Confluence labels are added virtually to this list and displayed in the tags table row of the document properties table. |
| 96 | Tasks Report Macro | Similar to the original Tasks Report Macro provided by Confluence, but allows to select on document with a Where clause. |
| 97 | Template Document Link Macro | Allows to render a link constructed with a template to a document dependent on the space closure. |
| 98 | Term Link Macro | Renders a dynamic link to a Glossary Item in the wiki. |
| 99 | Text Snippet Macro | Transclude text content from a remote server. |
| 100 | Tip Box Macro | Renders a box with a tip for the reader. |
| 101 | Tour Macro | Renders a predefined list of documents in a table. |
| 102 | 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. |
| 103 | Transclude Documents Macro | Renders transcluded content fetched from documents of a result set. |
| 104 | Transclusion Macro | Transcludes content from a document marked with the content marker macro. |
| 105 | Transclusion Reference Macro | Transcludes content via a reference from a document marked with the content marker macro. |
| 106 | Transclusion to Text Macro | Transcludes content from a document marked with the content marker macro and renders it as plain text. |
| 107 | User Story Macro | Renders a user story of a user story doctype. |
| 108 | Version Box Macro | Renders information related to a version. |
| 109 | Wiki Link Macro | Allows to render a link to a wiki page. |
Deprecated Macros ...
Macros with functions that are provided by other macros are marked as deprecated. Please use the replacements of these macros since they may be removed in the future.
| # | Name | Short Description | Categories |
|---|---|---|---|
| 1 | Hudson Link Macro | Render links to jobs and services on a Hudson server. | Link / Information System |
| 2 | Site Link Macro | Links to a resource on a versioned site. | Link / Information System |
| 3 | Sonar Link Macro | Renders a link to a project on a Sonar service. | Link / Information System |
| 4 | Subversion Link Macro | Renders a link to a resource on a Subversion (SVN) repository. | Link / Information System |
| 5 | Subversion Transclusion Macro | Transcludes a snippet from a project on a Subversion (SVN) server. | Link / Information System |
Resources
More information on macros from the projectdoc Toolbox.
- Macros Introduction
- This is a gentle introduction to the core macros. The macros are grouped semantically to make it easier for users to build a conceptual mind map for them.
- Categories of Information System Macros
- Overview over the different categories of macros that are part of the Information Systems Extension.
