projectdoc Toolbox

List of all macros of the projectdoc Toolbox.

#NameShort Description
1Action Button Macro
Renders an action button to link to a projectdoc document, Confluence page, or external resource.
2Ancestor Property Macro
Render the property value of an ancestor of this document, for the first ancestor that matches the specified document type.
3Aside Panel Macro
Renders apanel with title and body, layouted with a custom CSS configuration.
4Aspect Properties Macro
Access properties from aspect documents.
5Aspect References Macro
Autoconnect to aspect documents.
6Aspect Sections Macro
Access sections from aspect documents.
7Attachment Code Block Placeholder Macro
Renders a code block from an attached file with placeholders replaced by properties.
8
9Body Graph Macro
Renders a document graph in a graph language allowing the body to contain arbitrary content (including transclusions).
10Breadcrumb Macro
Renders a breadcrumb for the current page.
11Calculation Macro
Run calculations on a set of result documents and renders the results.
12Calculation Result Macro
Renders a single result of a calculation provided by the Calculation Macro.
13Caution Box Macro
Renders a box containing a caution message.
14Changelog Macro
Renders document history information.
15Child Documents Macro
Renders the list of child documents, matching the given filter criteria.
16Cite Macro
Renders a cite to a resource document.
17Code 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.
18Compact Definition List Macro
Renders wiki syntax as a definition list. Does allow HTML tags and therefore is vulnerable to XSS attacks.
19Compact No-HTML Definition List Macro
Renders wiki syntax as a definition list. Does not allow any HTML tags.
20Content Marker Macro
Marks a piece of content within a document. This content can be referenced for transclusion.
21Count Macro
Renders the count of rows, list items, or definition terms.
22Create One Document Macro
Renders template button to create a page. After the page is created, the macro renders a link to this page. 
23Definition 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.
24Deprecated Box Macro
Renders a box containing a deprecation warning for the reader.
25Display All Document Properties Macro
Displays all properties of a document as a writing tool for authors.
26Display All Space Properties
Renders all properties referenced by the current space.
27Display Document Properties Macro
Renders a template with property references.
28Display 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
Renders the value of a document property as a link with an alternative label.
30Display Document Property As List Macro
Renders the list value of a document property.
31Display Document Property Macro
Renders the value of a property of a document.
32Display 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.
33Display Document Property Ref Macro
Displays a document property from a referenced document.
34Display List Macro
Lists references to projectdoc documents in a list. List contain names and optional short descriptions.
35Display List Template Macro
Lists references to projectdoc documents in a list. List items are defined by templates referencing properties.
36Display Space Attribute Macro
Renders a space attribute value.
37Display Space Property Macro
Renders a space property value.
38Display Table Macro
Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
39Document Properties Marker Macro
A table containing document properties. Three columns: name, value and meta data (aka controls) to a property.
40Document Properties Supplier Attachment Macro
A table supplying additional document properties from an attached file.
41Document Properties Supplier From Documents Macro
Import properties from another projectdoc document.
42Document Properties Supplier Macro
A table containing additional document properties. Three columns: name, value and meta data (aka controls) to a property.
43
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
Renders an image generated from an Enterprise Architect diagram, transcluded from a server.
45Example Box Macro
Renders an example within a box.
46
Renders a locale dependent link to an external resource. The body of the macro contains the link label.
47External Quote Macro
Renders a quote to an external resource with author and source.
48Fault Box Macro
Renders a box containing a fault message reported by a team member for the author.
49Feedback Box Macro
Renders a box containing a feedback message from a reader with write privilege.
50Generic Box Macro
Generic boxes help to easily define one's own boxes to apply certain CSS styles to them.
51Graph Macro
Renders a document graph in a graph language.
52Hide From Anonymous User
Hides a text fragment from an anonymous user.
53Hide From Reader
Hides a page fragment from a user with read-only permissions.
54Hide From Viewer Macro
Hides a text fragment from a user that has no edit permissions.
55HTML Snippet Macro
Transclude HTML content from a remote server.
56HTML Span Macro
Renders simple HTML span elements into a page.
57Image Element Macro
Renders an image with an overlay text.
58
Renders a static link to a location within the same document. This is a static document link macro with a specialized interface.
59Index Card Macro
Renders transcluded content fetched from documents of a result set.
60Index Entries Table Macro
Renders a table of index entries.
61Info Box Macro
Renders a box containing an info message.
62Iteration Macro
Selects an iteration phase from a fixed set of stages.
63
64Layout Element Macro
Renders an block or inline element of a page.
65Level 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.
66Name 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.
67Name 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
69Note Box Macro
Renders something to note by the reader.
70Page Include Macro
Supports page inclusion dependent on the space of the primary page.
71Parent Property Macro
Renders the property of the parent document, if it has the same doctype.
72Pending Box Macro
Renders a box containing a pending message to be handled later by the author.
73Primary Page Display Document Property Macro
Renders the value of a document property from the primary page.
74Property Calculation Macro
Execute a calculation in the context of a property value.
75Question Box Macro
Renders a box containing an open question.
76Quote Macro
Renders a quote from a resource with author and source.
77Random Transclusion Macro
Transcludes random content from a document marked with the content marker macro.
78Reference Attachment Code Block Placeholder Macro
Renders code of attached file, referenced by local property, with placeholders replaced by properties.
79References Box Macro
Renders a box with references to further information.
80Role 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.
81Section Compiler by Reference Macro
Compiles local sections with transcluded content by a reference list.
82Section Index Macro
Renderes an index over the section on a document with intra-page links.
83Section 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.
84Selection 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.
85Space List Macro
Renders spaces with their attributes in a table or list.
86Stakeholder Rating Macro
Renders the stakeholder rating that is based on the power and interest of a stakeholder in the project.
87
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.
88Steps Macro
Present a step-by-step guide. Use the Section Macro to define each step with a section inside the steps macro.
89
Renders an image transcluded from a remote server.
90
91System Transclusion Macro
Transclude content from a resource from a remote system.
92Table Merger Macro
Merges tables (and lists) into one table (or list).
93Table Set Macro
Applies a simple set operation on tables in its body.
94Tag 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.
95Tag 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.
96Tasks Report Macro
Similar to the original Tasks Report Macro provided by Confluence, but allows to select on document with a Where clause.
97
Allows to render a link constructed with a template to a document dependent on the space closure.
98
99Text Snippet Macro
Transclude text content from a remote server.
100Tip Box Macro
Renders a box with a tip for the reader.
101Tour Macro
Renders a predefined list of documents in a table.
102Tour-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.
103Transclude Documents Macro
Renders transcluded content fetched from documents of a result set.
104Transclusion Macro
Transcludes content from a document marked with the content marker macro.
105Transclusion Reference Macro
Transcludes content via a reference from a document marked with the content marker macro.
106Transclusion to Text Macro
Transcludes content from a document marked with the content marker macro and renders it as plain text.
107User Story Macro
Renders a user story of a user story doctype.
108Version Box Macro
109

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.

#NameShort DescriptionCategories
1
2
3
4
5Subversion Transclusion Macro
Transcludes a snippet from a project on a Subversion (SVN) server.

Transcluded By

NameShort DescriptionDoctype
Macros
List of macros provided by the projectdoc Toolbox.
docsection