Renders a box containing a fault message reported by a team member for the author.
Description
Agile documentation fo software projects is created collaboratively by the team. The fault box allows a team member to alert the author about false information given in a document.
The author may define queries with the Display Table Macro to select fault reported by her team members. The faults may also be displayed with the Documentation Dashboard.
Here is an example with the Display Table Macro to show how to select the pages containing the fault reports:
<ac:structured-macro ac:name="projectdoc-display-table">
<ac:parameter ac:name="select">
<at:i18n at:key="projectdoc.doctype.common.name"/>,
<at:i18n at:key="projectdoc.doctype.common.shortDescription"/>,
<at:i18n at:key="projectdoc.doctype.common.doctype"/>,
<at:i18n at:key="projectdoc.doctype.common.tags"/>
</ac:parameter>
<ac:parameter ac:name="where">macroName:projectdoc-box-fault*</ac:parameter>
<ac:parameter ac:name="sort-by"><at:i18n at:key="projectdoc.doctype.common.sortKey"/></ac:parameter>
</ac:structured-macro>
Properties
The macro provides the following properties for configuration.
Title
The title is an optional parameter.
Here is an example with title:
Show Icon
The checkbox allows to remove the icon from the box.