Renders a box containing a fault message reported by a team member for the author.

Audience

Categories

Box / Collaboration

Tags

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.

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.

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:

The Title of the Fault Box

This is the feedback for the author.

Show Icon

The checkbox allows to remove the icon from the box.

The Title of the Fault Box

This is the feedback for the author.

Details

Hint to use this box with K15t Scroll-Office

To export a page using this macro with K15t Scroll Office the Print Quirk Modes should be enabled.

Related macros

Boxes are used to add visual emphasis.

Here are boxes that help the team to create documentation collaboratively:

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.

Here is a list of alternative boxes to use for your texts:

Name	Short Description	Tags
Caution Box Macro	Renders a box containing a caution message.	Box Standard
Deprecated Box Macro	Renders a box containing a deprecation warning for the reader.	Box Extra
Example Box Macro	Renders an example within a box.	Box Extra
Generic Box Macro	Generic boxes help to easily define one's own boxes to apply certain CSS styles to them.	Box
Info Box Macro	Renders a box containing an info message.	Box Extra
Note Box Macro	Renders something to note by the reader.	Box Standard
Question Box Macro	Renders a box containing an open question.	Box Extra
References Box Macro	Renders a box with references to further information.	Box Extra
Tip Box Macro	Renders a box with a tip for the reader.	Box Standard
Version Box Macro	Renders information related to a version.	Box

Fault Box Macro