projectdoc Toolbox

Define the default search space for index spaces.

Audience
Type
Level of Experience
Expected Duration
10 min

Index spaces are meant to collect common configuration for spaces using the projectdoc Toolbox for Confluence . This includes space properties and homepages for doctypes.

A type doctype is a doctype that is used to categorize document instances of one other doctype. The doctype using the categorization defines a document property named Type (this is just a naming convention).

 

For instance a resource type doctype defines types for the resource doctype . The resource doctype defines a document property named Type.

On a type document typically all document instances of the given type are listed. So a type document is simply a view on your documents of a given doctype and type.

 

For this example a resource type document is named Specification.

Each type document instance has a section called Resources of this Type.

In this section there is an instance of the Display Table Macro that automatically lists all resource documents of this resource type.

In this example the document named Specification lists all resource documents of type Specification.

Since index spaces are used by multiple spaces, documents from all this spaces should be listed. Per default only the document instances of the index space itself are listed (which are typically none).

One option to fix this is to specify the spaces to search in explicitly. The Display Table Macro provides a parameter named Space Keys for this.

Entering the same set of spaces for each type document instance is quite cumbersome. This tip shows how to fix this more easily.

Configuration

The search-space property is used by the Display Table Macro if no space to select documents has been explicitly specified.

Root Index Space

A root index space is the index space for all spaces.

Set the search-space space property to @all. Then all searches without specifying a space as query constraint will automatically refer to all spaces on a Confluence server.

Use space-local to not export the search space of the index space.

Space Group

A space may only be defined as an index space for a subset of spaces on a Confluence server. This group of spaces is created by sharing the same space label (e.g my-label ).

The Display Table Macro allows to select the search space by refering to that space label (e.g #my-label ) .

To use a space group as the default search space, set the seach-space space property to reference the space label of the group (e.g #my-label ).

Resources

More tips on related topics.

Spaces Introduction
Provides a gentle introduction to the concept of spaces using projectdoc.
Using Spaces
A short introduction on using spaces with the projectdoc Toolbox for Confluence.
Using Space Properties
Space properties are defined for spaces and are accessed via the Space Property Macro. This tip goes into detail in how to use space properties with inheritence and extension pages.
Employ the Autolist Feature with Categories
Categories, tags, and others allow to organize the pages in your wiki. First define categories pages with display table macros. Second tag your pages with these categories. With this two-step process it is easy to have multiple views to link to your information in your wiki.