projectdoc Toolbox

Macros to render information in a visually appealing format.

Parent: Macros Introduction
Audience: Author, Template Author
Level of Experience: Novice
Type: Tutorial

The macros listed in this document help to render information in a visually appealing format. The information is easier to understand or quicker to find.

Contents

Boxes

Boxes highlight information for the reader.

Reader Boxes

The information of the boxes is provided for the reader.

Standard Boxes

Boxes that are an industry standard.

Name	Short Description
Caution Box Macro	Renders a box containing a caution message.
Note Box Macro	Renders something to note by the reader.
Tip Box Macro	Renders a box with a tip for the reader.

Extra Boxes

Extra boxes that may be useful in special contexts.

Name	Short Description
Deprecated Box Macro	Renders a box containing a deprecation warning for the reader.
Example Box Macro	Renders an example within a box.
Info Box Macro	Renders a box containing an info message.
Question Box Macro	Renders a box containing an open question.
References Box Macro	Renders a box with references to further information.

Collaboration Boxes

The information of the boxes is provided for authors. This is a collaboration tool to create documentation with a team.

Name	Short Description
Fault Box Macro	Renders a box containing a fault message reported by a team member for the author.
Feedback Box Macro	Renders a box containing a feedback message from a reader with write privilege.
Pending Box Macro	Renders a box containing a pending message to be handled later by the author.

Generic Box

The Generic Box Macro helps to define boxes using CSS.

Definition List

Definition lists allow a compact representation of key value pairs. Definition lists are also often used for glossaries.

Name	Short Description
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.
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.

Code Renderer

Code render allow to pretty print code snippets.

Name	Short Description
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.
HTML Snippet Macro	Transclude HTML content from a remote server.
Subversion Transclusion Macro	Transcludes a snippet from a project on a Subversion (SVN) server.
System Transclusion Macro	Transclude content from a resource from a remote system.
Text Snippet Macro	Transclude text content from a remote server.

Project Quotes

Projects often reference quotes and cite information. These macros help to render them similarly.

Name	Short Description
Cite Macro	Renders a cite to a resource document.
External Quote Macro	Renders a quote to an external resource with author and source.
Quote Macro	Renders a quote from a resource with author and source.

Extension Add-on Macros

The following macros are provided by extensions to render information visually appealing.

Name	Short Description
User Story Macro	Renders a user story of a user story doctype.

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