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 Categories
1
Renders an action button to link to a projectdoc document, Confluence page, or external resource.
2
Render the property value of an ancestor of this document, for the first ancestor that matches the specified document type.
3
Renders apanel with title and body, layouted with a custom CSS configuration.
4
Access properties from aspect documents.
5
Autoconnect to aspect documents.
6
Access sections from aspect documents.
7
Renders a code block from an attached file with placeholders replaced by properties.
8
9
Renders a document graph in a graph language allowing the body to contain arbitrary content (including transclusions).
10
Renders a breadcrumb for the current page.
11
Renders a box containing a caution message.
12
Renders document history information.
13
Renders the list of child documents, matching the given filter criteria.
14
Renders a cite to a resource document.
15
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.
16
Renders wiki syntax as a definition list. Does allow HTML tags and therefore is vulnerable to XSS attacks.
17
Renders wiki syntax as a definition list. Does not allow any HTML tags.
18
Marks a piece of content within a document. This content can be referenced for transclusion.
19
Renders the count of rows, list items, or definition terms.
20
Renders template button to create a page. After the page is created, the macro renders a link to this page. 
21
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.
22
Renders a box containing a deprecation warning for the reader.
23
Displays all properties of a document as a writing tool for authors.
24
Renders all properties referenced by the current space.
25
Renders a template with property references.
26
Renders the value of a document property as an image. The property value is required to an URL that points to an image.
27
Renders the value of a document property as a link with an alternative label.
28
Renders the value of a property of a document.
29
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.
30
Displays a document property from a referenced document.
31
Lists references to projectdoc documents in a list. List contain names and optional short descriptions.
32
Lists references to projectdoc documents in a list. List items are defined by templates referencing properties.
33
Renders a space attribute value.
34
Renders a space property value.
35
Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
36
A table containing document properties. Three columns: name, value and meta data (aka controls) to a property.
37
A table supplying additional document properties from an attached file.
38
Import properties from another projectdoc document.
39
A table containing additional document properties. Three columns: name, value and meta data (aka controls) to a property.
40
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.
41
Renders an image generated from an Enterprise Architect diagram, transcluded from a server.
42
Renders an example within a box.
43
Renders a locale dependent link to an external resource. The body of the macro contains the link label.
44
Renders a quote to an external resource with author and source.
45
Renders a box containing a fault message reported by a team member for the author.
46
Renders a box containing a feedback message from a reader with write privilege.
47
Generic boxes help to easily define one's own boxes to apply certain CSS styles to them.
48
Renders a document graph in a graph language.
49
Hides a text fragment from an anonymous user.
50
Hides a page fragment from a user with read-only permissions.
51
Hides a text fragment from a user that has no edit permissions.
52
Transclude HTML content from a remote server.
53
Renders simple HTML span elements into a page.
54
Renders an image with an overlay text.
55
Renders transcluded content fetched from documents of a result set.
56
Renders a table of index entries.
57
Renders a box containing an info message.
58
Selects an iteration phase from a fixed set of stages.
59
60
Renders an block or inline element of a page.
61
Renders the level of the document within its hierarchy. The level is derived from a parent document's level of the same document type.
62
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.
63
Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name.
64
65
Renders something to note by the reader.
66
Supports page inclusion dependent on the space of the primary page.
67
Renders the property of the parent document, if it has the same doctype.
68
Renders a box containing a pending message to be handled later by the author.
69
Renders the value of a document property from the primary page.
70
Renders a box containing an open question.
71
Renders a quote from a resource with author and source.
72
Transcludes random content from a document marked with the content marker macro.
73
Renders code of attached file, referenced by local property, with placeholders replaced by properties.
74
Renders a box with references to further information.
75
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.
76
Compiles local sections with transcluded content by a reference list.
77
Renderes an index over the section on a document with intra-page links.
78
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.
79
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.
80
Renders spaces with their attributes in a table or list.
81
Renders the stakeholder rating that is based on the power and interest of a stakeholder in the project.
82
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.
83
Present a step-by-step guide. Use the Section Macro to define each step with a section inside the steps macro.
84
Renders an image transcluded from a remote server.
85
86
Transclude content from a resource from a remote system.
87
Merges tables (and lists) into one table (or list).
88
Applies a simple set operation on tables in its body.
89
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.
90
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.
91
Similar to the original Tasks Report Macro provided by Confluence, but allows to select on document with a Where clause.
92
93
Transclude text content from a remote server.
94
Renders a box with a tip for the reader.
95
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.
96
Renders a predefined list of documents in a table.
97
Renders transcluded content fetched from documents of a result set.
98
Transcludes content from a document marked with the content marker macro.
99
Transcludes content via a reference from a document marked with the content marker macro.
100
Transcludes content from a document marked with the content marker macro and renders it as plain text.
101
Renders a user story of a user story doctype.
102
103

 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
2
3
4
5
Transcludes a snippet from a project on a Subversion (SVN) server.

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.