projectdoc Toolbox

Displays collaboration boxes found in the documentation.

Add-on
Since
11.0

The documentation dashboard keeps track of documents that are marked for improvement. It provides an overview over lists that collect faults, feedbacks, and pending information.

These boxes are added by the author or her team members to collaboratively help to improve the documentation.

The collaboration boxes are:

Fault Box Macro
Renders a box containing a fault message reported by a team member for the author.
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.

This version provides a link to pages that list boxes on individual pages. Therefore users not only have a list of pages where boxes of a given type appear, they can also see the pending boxes and their contents under a clickable heading with the name of the containing document.

Author's Reference Box

Please note that authors have access to the extra frame, the reference box, with the editor symbol. This also allows to jump to the document where the pending boxes are part of. In addition to open navigate to the document in view mode, a new window may be opened in edit mode.

Users without write permission have the linked heading for navigation only.

Older Versions

Documentation Dashboard (before version 11.0)
The documentation dashboard keeps track of documents that are marked for improvement. Lists faults and feedbacks added by readers (with write permission) and pending boxes provided by authors.