Fault Box Macro

...

Document Properties Marker

doctype	macro
override	false

Doctype

macro

hide

Name

Fault Box Macro

Short Description

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

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
render-list-as-comma-separated-values	true
names	Author, Reader

Tags

Tag List

names	Box, Collaboration, Author Box

Iteration

value	production

hide
Sort Key		hide

Section

index	true
title	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.

Fault 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.

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:

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-fault*</ac:parameter>
  <ac:parameter ac:name="sort-by"><at:i18n at:key="projectdoc.doctype.common.sortKey"/></ac:parameter>
</ac:structured-macro>

...

Section

title	Properties

The macro provides the following properties for configuration.

Section

title	Title

The title is an optional parameter.

Here is an example with title:

Fault Box

title	The Title of the Fault Box

This is the feedback for the author.

Section

title	Show Icon

The checkbox allows to remove the icon from the box.

Fault Box

title	The Title of the Fault Box
show-icon	false

This is the feedback for the author.

Section

title	Tags

Tag the box to use for transclusion.

By default the tag fault-box is added.

Section

title	Details

Transclusion

document	print-quirk-modes Hint for Box Macros
ids	Content

...

Section

index	true
title	Related macros

Boxes are used to add visual emphasis.

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

Display Table

doctype	macro
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
sort-by	Sort Key, Name
where	Tags = "Box" AND Categories = "Box / Collaboration"
exclude-self	true

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

Display Table

doctype	macro
render-no-hits-as-blank	true
select	Name, Short Description, Tags
sort-by	Sort Key, Name
where	Tags = "Box" AND NOT Categories = "Box / Collaboration"
exclude-self	true

Section

index	true
title	Sub-Macros

Display Table

sort-by

doctype	macro
render-no-hits-as-blank	true
select	Name, Short Description	Sort Key, Name
restrict-to-immediate-children	true
sort-by	Sort Key, Name

Section

title	Notes

Section

title	References

Section

title	Resources

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-macro
Type	document

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 1

New Version Current

Key

About

Keep up-to-date!

Powered by