List of Macros

List of all macros of the projectdoc Toolbox.

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

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.

Transcluded By

Name Short Description Doctype
List of macros provided by the projectdoc Toolbox.
docsection