Versions Compared

Key

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

...

Section
titleNavigating by multiple Type Properties

Navigating by multiple type properties requires one additional document. This document defines a query to show documents associated with all type properties.

Then we need to specify links to this special document.

Section
titleSpace Index Document

While the section for type doctypes is rendered per default, space index documents to list documents with a given set of categories need to be created manually.

This example lists all documents with the subject projectdoc and the Todo Type named 'Release'.

The Subject is set to projectdoc, the Todo Type Constraint references the Release document of type Todo Type.

For this case we require to list all upcoming and previous releases.

Image RemovedImage AddedThe Display Table Macro for both sections is very similar.

The only difference is the NOT instead of an AND for listing upcoming releases instead of those that have already been accomplished.

Code Block
languagetext
titleWhere Parameter for Upcoming Releases
$<Subject> = °${Subject}° AND $<Type>=°${Todo Type Constraint}° NOT $<Iteration>~[finished, production, released, deprecated]
Code Block
languagetext
titleWhere Parameter for Previous Releases
$<Subject> = °${Subject}° AND $<Type>=°${Todo Type Constraint}° AND $<Iteration>~[finished, production, released, deprecated]

The part to select documents of the given subject and todo type is quite straight forward. Note the degree sign indicating that not only documents with the given subject and todo type are requested, but also all documents tagged with one of their child subjects and child todo types.

Section
titleType Document

The latest type doctypes support rendering related indices. This is a section with a Display Table Macro to list all Space Index documents that declare using that type as a constraint.

The Where clause for the Display Table Macro looks like this:

Code Block
languagetext
titleWhere Parameter
$<Todo Type Constraint>=[${Name}]

Therefore the macro lists all documents that reference it by the property Todo Type Constraint. This naming convention uses the name of the type (Todo Type in the example) and append the suffix ' Constraint'.

Here is an example of the rendered section of a Todo Type named 'Release'.

Section
titleNon-Type Document

Doctypes for documents that do not document types this special feature is not supported per default. Therefore authors who need to render a link to the space index document have to add this manually.

Add a link manually, either in the Resources section or as an additional property.

Alternatively add a section to related indices and add a Display Table Macro with a Where clause to select on space index documents that list document of this type (just like the section type documents provide per default).



...