Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionLinks allow readers to find related information. Autocomplete allows authors to recall the names of related information. Let's have a closer look on the Autocomplete Feature of the projectdoc Toolbox!
Doctypetopichide
NameSupport Recalling
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
namesAuthor, Documentation Architect, Template Author
propertyAudience


Subject
Name List
doctypesubject
propertySubject

Categories

Name List
doctypecategory
property-restrict-value-rangetrue
propertyCategories


Tags

Tag List
namesAutocomplete
propertyTags


Flagshide
Iteration

Iteration
valuefilled


Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
property-restrict-value-rangetrue
propertyType


Level of Experience

Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesCompetent
propertyLevel of Experience


Expected Duration
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide
projectdoc.autocomplete.activeConstraint$<Iteration>~(Released, Production, Deprecated) OR $<Doctype>~(event,todo)hide
Section
show-titlefalse
titleDescription

Our brains are not that good with recalling information. Even paper is better 1 . That is why we write documentation even if the documented tool is only used by us or a small team 2 : we communicate with our future self, relieve our overworked brains from the necessity to recall information. The projectdoc Toolbox for Confluence now brings this principle of "brain relieving" to authors, especially when they try to recall the name or title of a document. This new feature is called Autocomplete and this tip provides some insights for authors, but also for information architects or template authors, on how to use this brand new supplement of the projectdoc Toolbox.

...

Section
titleDisplay Document Property in Action

The Display Document Property Macros allow to select multiple documents. At least two characters are required to be entered to start the Autocomplete.

Display Property


Further constraints can be specified by the Autocomplete Constraints parameter. The sort order is specified by Autocomplete Sort. Again, if not specified, the natural sort order is applied.

...