projectdoc Toolbox

All Macros

List of all macros provided by the project.

Name	Short Description
Actor Type Macro	Allows to select the type of an actor.
Body Graph Macro	Renders a document graph in a graph language allowing the body to contain arbitrary content (including transclusions).
Bookmarklet Macro	Tool to create bookmarklets using the REST API.
Bookmarklets List Macro	List of bookmarklets provided by the projectdoc Toolbox.
Breadcrumb Macro	Renders a breadcrumb for the current page.
Caution Box Macro	Renders a box containing a caution message.
Changelog Macro	Renders document history information.
Child Documents Macro	Renders the list of child documents, matching the given filter criteria.
Cite Macro	Renders a cite to a resource document.
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.
Communication Type Macro	Allows to select the type of communication between two entities.
Compact Definition List Macro	Renders wiki syntax as a definition list. Does allow HTML tags and therefore is vulnerable to XSS attacks.
Compact No-HTML Definition List Macro	Renders wiki syntax as a definition list. Does not allow any HTML tags.
Complexity	Allows to select the complexity for an item.
Count Macro	Renders the count of rows, list items, or definition terms.
Create One Document Macro	Renders template button to create a page. After the page is created, the macro renders a link to this page.
Day Rating	Allows a user to select a rating for a day.
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.
Deprecated Box Macro	Renders a box containing a deprecation warning for the reader.
Display All Document Properties Macro	Displays all properties of a document as a writing tool for authors.
Display All Space Properties	Renders all properties referenced by the current space.
Display Document Properties Macro	Renders a template with property references.
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.
Display Document Property As Link Macro	Renders the value of a document property as a link with an alternative label.
Display Document Property As List Macro	Renders the list value of a document property.
Display Document Property Macro	Renders the value of a property of a document.
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.
Display Document Property Ref Macro	Displays a document property from a referenced document.
Display List Macro	Lists references to projectdoc documents in a list. List contain names and optional short descriptions.
Display List Template Macro	Lists references to projectdoc documents in a list. List items are defined by templates referencing properties.
Display Space Attribute Macro	Renders a space attribute value.
Display Space Property Macro	Renders a space property value.
Display Table Macro	Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
Document Properties Marker Macro	A table containing document properties. Three columns: name, value and meta data (aka controls) to a property.
Document Properties Supplier Attachment Macro	A table supplying additional document properties from an attached file.
Document Properties Supplier From Documents Macro	Import properties from another projectdoc document.
Document Properties Supplier Macro	A table containing additional document properties. Three columns: name, value and meta data (aka controls) to a property.
Documented Information Type Macro	Defines the type of a documented information.
Enterprise Architect Image Link Macro	Renders an image generated from an Enterprise Architect diagram, transcluded from a server.
Even Rating	Allows to select a rating from values between one and four. Since there is no middle ground, the selection is either on the lower or on the upper side.
Example Box Macro	Renders an example within a box.
External Link Macro	Renders a locale dependent link to an external resource. The body of the macro contains the link label.
External Quote Macro	Renders a quote to an external resource with author and source.
Fault Box Macro	Renders a box containing a fault message reported by a team member for the author.
Feature Importance Macro	Allows to select the importance of a feature.
Feedback Box Macro	Renders a box containing a feedback message from a reader with write privilege.
Generic Box Macro	Generic boxes help to easily define one's own boxes to apply certain CSS styles to them.
Graph Macro	Renders a document graph in a graph language.
Hide From Anonymous User	Hides a text fragment from an anonymous user.
Hide From Reader	Hides a page fragment from a user with read-only permissions.
Hide From Viewer Macro	Hides a text fragment from a user that has no edit permissions.
HML Rating	Allows to rate an item in three simple categories: High, Mid, and Low. This categories are especially useful to rate scenarios in quality trees.
HTML Snippet Macro	Transclude HTML content from a remote server.
HTML Span Macro	Renders simple HTML span elements into a page.
Hudson Link Macro	Render links to jobs and services on a Hudson server.
Index Card Macro	Renders transcluded content fetched from documents of a result set.
Index Entries Table Macro	Renders a table of index entries.
Info Box Macro	Renders a box containing an info message.
Iteration Macro	Selects an iteration phase from a fixed set of stages.
Javadoc Link Macro	Links API documentation pages for Java elements.
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.
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.
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.
Nexus Link Macro	Renders a link to an artifact stored on a Nexus server.
Note Box Macro	Renders something to note by the reader.
Open Issue Severity Macro	Allows to select a severity for an open issue.
Open Issue Status Macro	Allows to select a status for an open issue.
Parent Property Macro	Renders the property of the parent document, if it has the same doctype.
Pattern Domain	Allows to select the domain for a pattern.
Pending Box Macro	Renders a box containing a pending message to be handled later by the author.
Priority	Allows to prioritize an item in a range of five categories.
Project Constraint Type Macro	Allows to select the type of a project constraint.
Quality Scenario Type Macro	Allows to select the type of a quality scenario.
Question Box Macro	Renders a box containing an open question.
Quote Macro	Renders a quote from a resource with author and source.
Random Transclusion Macro	Transcludes random content from a document marked with the content marker macro.
References Box Macro	Renders a box with references to further information.
Resource Type	Allows to select the type of a resource from a fixed set of values.
Risk Phase Macro	Allows to select a phase of a risk.
Risk Probability Macro	Allows to select a probability for a risk.
Risk Severity Macro	Allows to select a severity for a risk.
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.
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.
Severity	Allows to select a value to define the severity for an item.
Site Link Macro	Links to a resource on a versioned site.
Sonar Link Macro	Renders a link to a project on a Sonar service.
Space List Macro	Renders spaces with their attributes in a table or list.
Stakeholder Rating Macro	Renders the stakeholder rating that is based on the power and interest of a stakeholder in the project.
Status	Allows to select a status for an issue.
Steps Macro	Present a step-by-step guide. Use the Section Macro to define each step with a section inside the steps macro.
Subversion Link Macro	Renders a link to a resource on a Subversion (SVN) repository.
Subversion Transclusion Macro	Transcludes a snippet from a project on a Subversion (SVN) server.
System Image Link Macro	Renders an image transcluded from a remote server.
System Link Macro	Links to a resource on a server.
System Transclusion Macro	Transclude content from a resource from a remote system.
Table Merger Macro	Merges tables (and lists) into one table (or list).
Table Set Macro	Applies a simple set operation on tables in its body.
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.
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.
Technical Debt Quality Macro	Allows to select the quality type of technical debt.
Text Snippet Macro	Transclude text content from a remote server.
Tip Box Macro	Renders a box with a tip for the reader.
Tour Macro	Renders a predefined list of documents in a table.
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.
Transclude Documents Macro	Renders transcluded content fetched from documents of a result set.
Transclusion Macro	Transcludes content from a document marked with the content marker macro.
Transclusion Reference Macro	Transcludes content via a reference from a document marked with the content marker macro.
Transclusion to Text Macro	Transcludes content from a document marked with the content marker macro and renders it as plain text.
Use Case Level Macro	Allows to select the level of an use case.
User Character Type Macro	Allows to select the type of an user character.
User Story Macro	Renders a user story of a user story doctype.
Version Box Macro	Renders information related to a version.
Vision Statement Type Macro	Allows to select the type of a vision statement.
Wiki Link Macro	Allows to render a link to a wiki page.
Word Type	Allows to select the type of word for a glossary term.

projectdoc.content.macros.home.title

Need more info?

Click the link below, if you need more information on documenting macros.

Macro

Related Documentation

The following links direct you to related documentation within your wiki.

projectdoc.content.doctypes.home.title

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

All Macros

About

Keep up-to-date!

Powered by