Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
overridefalse


Short DescriptionThe projectdoc Toolbox provides doctypes and macros to support teams to modularize their documentation.
Doctypefeaturehide
NameSingle Sourcing
Short Name
Parent
Parent Property
propertyParent
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Iteration

Iteration
valuefinished

hide
Type
Name List
doctypefeature-type
propertyType

Importance
Feature Importance

Sort Keyhide



Section
show-titlefalse
titleDescription

Single sourcing is an approach to reuse content by making sure that each piece of information has only one authoritative location.

There are a couple of tools in the projectdoc Toolbox to support single sourcing:

  1. The Section Macro and the Content Marker Macro allow to define pieces of information on a projectdoc Document. Using the Transclusion Macro or the Transclude Documents Macro the content, defined in a single location, can be rendered on any other page.
  2. Also Dynamic Linking allows to automatically pick sections from other documents.
  3. The Module and Module Type doctypes allow to specify a piece of information on a separate document. By defining types of modules, the individual pieces may be organized to be found by browsing. Additionally the documents may provide additional metadata used to filter or be provided as helpful information for other authors.

...