Renders a box containing a feedback message from a reader with write privilege.
Description
Agile documentation fo software projects is created collaboratively by the team. The feedback box allows a team member to add feedback to a page for the author.
Queries
The author may define queries with the Display Table Macro to select feedback for her documents. The feedback 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 feedbacks:
<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-feedback*</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.