Versions Compared

Key

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

...

Section
titlePrerequisites

This tip assumes that readers are familiar with the tip Aspects light.

This tip only works with the projectdoc Toolbox version 4.0 and greater.

Section
titleCreate the Service Document

To prepare the service document as a receiver of aspects it needs three integration points:

  1. Aspects Property with automatic references to all aspects
  2. Import of properties of all referenced aspects
  3. Import of sections of all referenced aspects
Section
titleAspects Property

The document has a property named Aspects and uses the Aspect References Macro as value.

This macro will list automatically all child documents that are flagged with the is-a property and the value aspect

Note Box

This is typically be done with a metadata property. A metadata property is provided by the doctype, but can only be provided by a doctype add-on.

The property can also be set with a standard document property, named is-a.

Section
titleAspect Properties

To import the supplied properties from aspects use the Aspect Properties Macro.

Section
titleAspect Sections

To import supplied sections from aspects use the Aspect Sections Macro.

We have both macros within one section. This is not a requirement. Both macros can be placed anywhere in the body of a document.

Note Box

Make sure that the name of the property holding the references (Aspects) is different from the name of the section holding the other sections (Service Aspects). The name of the section can be anything, the name of the property is required to be Aspects.

Section
titleView on the Service

When saved the new service document shows not much information.

Now let's add two aspects as we follow the trail of Aspects light.

...