projectdoc Toolbox

Tools and information elated to the Aspects Feature of the projectdoc Toolbox.

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.

Documents

Documents in your wiki concerned with this tag.

NameShort DescriptionDoctype
Aspect
An aspect is a document attached to another document to supply properties and sections. Aspects support modular documentation while the information can be still accessed in one document.
glossary-item
Aspect Properties Macro
Access properties from aspect documents.
app-macro
Aspect References Macro
Autoconnect to aspect documents.
app-macro
Aspect Sections Macro
Access sections from aspect documents.
app-macro
Using Aspects
Add a document as a child and automatically make supplied properties and sections available in the parent. A short walk-through to use the Aspect Feature in your information architecture.
topic