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

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.