Using Aspects

Section

Column

Document Properties Marker

override	false

Short Description

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.

Doctype

topic

hide

Name

Using Aspects

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
render-list-as-comma-separated-values	true
names	Documentation Architect, Documentation Gardener, Template Author, Author
property	Audience

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder
render-no-hits-as-blank	true
property	Sponsors

Sort Key

hide

enable-heading-numbers

true

hide

Column

Table of Contents

outline	true
indent	10px
exclude	Resources\|References
style	none

...

Section

title	Prerequisites

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.

projectdoc-section

title	Create the Service Document

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

Aspects Property with automatic references to all aspects
Import of properties of all referenced aspects
Import of sections of all referenced aspects

Section

title	Aspects 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

title	Aspect Properties

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

Section

title	Aspect 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

title	View 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.

...

Section

title	Rendered Service Document

We extract the short description, hide the Iteration property and the Subordinate Documents section. The rendered service document will look like this:

Image RemovedImage Added

Note that the transclusion boxes are only rendered for users with write access.

...

Section

required-permissions	write-access
title	Notes

Section

title	References

More information on the the Aspects Feature:

Tour

render-no-hits-as-blank	true
render-as-definition-list	true
marker-column-property-name	Title
replace-title-with-name	true

Title	Short Description
Aspect
#Aspects
Aspect References Macro
Aspect Properties Macro
Aspect Sections Macro

Section

title	Resources

Related information to this tip:

Tour

render-no-hits-as-blank	true
render-as-definition-list	true
marker-column-property-name	Title
replace-title-with-name	true

Title	Short Description
Supply Documents
Child Documents Macro
Document Properties Supplier From Documents Macro
Aspects light

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-tip
Type	howto

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 2

New Version Current

Key

About

Keep up-to-date!

Powered by