Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
overridefalse
Short DescriptionShow how to import properties from other projectdoc documents into a projectdoc document.
Doctypetopichide
NameSupply Documents
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesDocumentation Architect, Documentation Gardener, Template Author, Author
propertyAudience


Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags

Tag List
namesprojectdoc Toolbox, Confluence, Modular Documentation, Topic based documentation,
propertyTags

hide
Flagshide
Iteration

Iteration
valuefinished

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
propertyType


Level of Experience

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


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

Sort Keyhide
enable-heading-numberstruehide
Column
Panel
titleContents

Table of Contents
outlinetrue
indent10px
excludeSummary|References
stylenone

Section
show-titlefalse
titleDescription

For modular documentation it is important to wrap pieces of information in a cohesive and coherent way. Keep information that belongs together at one place and make it identifiable with clear boundaries to other pieces of information.

One use case in IT service management (ITSM). To define services or systems you may need to define configuration options. These options could be implemented as properties on the projectdoc document for a specific service or system. But this has two drawbacks:

  1. The configuration options are intermingled with other service/system properties, like service level agreement (SLA) information
  2. The configuration options cannot be referenced by themselves

To provide a solution for use cases where changes to properties of one document is automatically updating importing documents, the new Document Properties Supplier From Documents Macro has been added. This macro allows to define a configuration document for the ITSM use case and to imports theses properties to a service or system. Changes to the configuration are automatically updating the service or system document. This tip shows how to do this.

...

Section
required-permissionswrite-access
titleNotes

Section
numberingfalse
titleReferences
Tour
render-no-hits-as-blanktrue
render-as-definition-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue

...