Versions Compared

Key

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


Document Properties Marker
overridefalse


Short DescriptionDefine the default search space for index spaces.
Doctypetopichide
NameSearch Space for Index Spaceshide
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Documentation Architect, Documentation Gardener
propertyAudience


Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags

Tag List
namesConfluence, projectdoc Toolbox, search space
propertyTags

hide
Iteration

Iteration
valueproduction

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
propertyType


Level of Experience

Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesCompetent
propertyLevel of Experience


Expected Duration10 min
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide



Section
show-titlefalse
titleDescription

Index spaces are meant to collect common configuration for spaces using the PDAC1 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).

Example Box

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.

Example Box

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.


Section
titleSummary


Section
titlePrerequisites


Section
titleConfiguration

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

Section
titleRoot 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.


Section
titleSpace 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 ).



Section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name


Section
required-permissionswrite-access
titleNotes


Section
titleReferences


Section
titleResources

More tips on related topics.

Tour
render-as-definition-listtrue
replace-title-with-nametrue





Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto