Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
indextrue
titleDescription

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.

Feedback Box

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

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:

Code Block
<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>


...

Section
titleProperties

The macro provides the following properties for configuration.

Section
titleTitle

The title is an optional parameter.

Here is an example with title:

Feedback Box
titleThe Title of the Feedback Box

This is the feedback for the author.



Section
titleShow Icon

The checkbox allows to remove the icon from the box.

Feedback Box
titleThe Title of the Feedback Box
show-iconfalse

This is the feedback for the author.




Section
titleTags

Tag the box to use for transclusion.

By default the tag feedback-box is added.



Section
titleDetails


Transclusion
documentprint-quirk-modes Hint for Box Macros
idsContent


...

Section
titleReferences


Section
titleResources


Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categoryprojectdoc-macro
Typedocument