Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionTools and information elated to the Aspects Feature of the projectdoc Toolbox.
Doctypetaghide
NameAspectshide
Short Name
Parent
Parent Property
property-nameName
hide
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

Flagshide
Iteration

Iteration
valueproduction

hide
Classification
Type
Name List
doctypetag-type
render-no-hits-as-blanktrue
propertyType

Sort Keyhide
Section
show-titlefalse
titleDescription

The Aspects Feature of the projectdoc Toolbox for Confluence introduces Aspects to projectdoc documents.

Aspects allow to provide additional information to a document by adding new documents as children. With aspects you could have a document about a service and add additional aspects (like security, technical support, or performance considerations) in form of additional child documents. Properties and sections defined in these aspects will be incorporated into the parent document.

To create an aspect, the projectdoc document requires a property named is-a with the value of aspect. This could be implemented as a document type metadata or document property.

All properties and sections that are part of the aspect need to be tagged with the supply keyword. As a document property control in case of a property, as a tag in case of a section.

The document that uses aspects need to link to the aspect documents by the use of a document property named Aspects. The value of this property is typically the Aspect References Macro. To import the supplied aspect properties, marked with supply, the document uses the Aspect Properties Macro. To import the supplied aspect sections, the document uses the Aspect Sections Macro.

For a walk-through have a look at the tip Using Aspects.

...