Versions Compared

Key

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

...

Section
show-titlefalse
titleDescription

The space property controls how the projectdoc Toolbox is checking for document instances.

The service that checks for document instances is used by the Wiki Link Macro. The macro renders the link label to a doctype homepage in a different format dependent on whether there a documents of the given type or not. This makes it easier for users visiting the homepage of a space to determine which of the referenced doctype homepages actually have documents as their children.

The property recognizes three values that enforce different strategies to determine a result.

Search modeSemanticsProsCons
heuristic
(default)
Space

Quick, no search required

No reliable results based on naming conventions

searchSpaceReliable resultsSearch executed which drains performance when rendering a page with plenty of links
children-check (recommended)HomepageReliable resultsPage traversal required with additional checks which drains performance when rendering a page with plenty of links

Space semantics check for document instances in the whole space, while homepage semantics only check for document instances as children of the homepage.

In case you need reliable results, we recommend the children-check mode. If your use case is that users visiting the homepage should not click on a link pointing to a doctype homepage without documents, then this is your choice. In case your semantics allow a document instance to be anywhere in a space, use the search mode and check for performance issues. In case your main concern is performance, stick with the default value heuristic.

...