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

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.