Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Document clean process
Document Properties Marker
doctooldoctool
overridefalse
Doctypedoctoolhide
NameDocumentation Dashboard
Short DescriptionDisplays collaboration boxes found in the documentation.
Parent
Parent Property
property-nameName

Audience
Name List
render-no-hits-as-blanktrue
doctoolrole

Tags
Iteration
Iteration
valuefinished
hide
Add-onCore Doctypes
Since11.0
Sort Keyhide
Section
indextrue
show-titlefalse
titleDescription

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:

Display Table
doctypemacro
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
sort-bySort Key, Name
where$<Tags> = [Box] AND Categories = "Box / Collaboration"

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.

Image Added

Note
titleAuthor'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.

Section
indextrue
titleRelated Doctools

Section
indextrue
titleSub-DoctoolsOlder Versions
Display Table
render-no-hits-as-blanktrue
doctooldoctool
render-modedefinition
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...