You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
Macros to render information in a visually appealing format.
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.
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.
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. |
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.
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. |