Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Doctypetopichide
NameSpace Properties 
Short DescriptionLists the configuration options at space level. 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Documentation Architect, Documentation Gardener
propertyAudience
 
Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience
 
Expected Duration 
Tags
Tag List
namesSpace
 
Iteration
Iteration
valuefilled
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesReference
propertyType
 
Sort Keyhide
Section
show-titlefalse
titleDescription

Space properties allow to configure projectdoc per-space.

The central properties are those that define the delegate-space and the search-space. But every macro may also provide defaults here that are taken into account if not overridden in the macro configuration. This way documentation architects may provide defaults (e.g. for colours or other rendering options particular macros provide), so that document authors do not have to bother with this styling issues.

Example Box

An example may be a highlighting macro where authors may select a theme or rendering style. If this style is not set to the default, every author would have to select the property style for the code macro. With space properties, the code macro should be set to 'Space Default' so that the decision of styles is propagated to the space configuration.

...