Create an index space to learn what it is and what it is used for.

Background Information

Index Space

An index space is a Confluence space that stores information in form of documents that are relevant for all other spaces. There is only one index space per Confluence instance. The index space is a tool for information reuse.

index-space-hierarchy

An index space allows to specify space properties that are used as defaults for all depending space.

index-space-w-sp-hp
 Show more background information ...

Reusing Tags

 

Index spaces may store tag documents that define a tag and list all documents that have this tag attached. These tag documents are the same for all spaces. Having them compiled in an index space makes it very easy to reuse them.

Reusing Categories

The following document types are typically stored in an index space.

Other spaces may add additional documents of these types that are only relevant in their domain.

Repositories

Index spaces may also contain corporation wide repositories for the following document types:

  • FAQ - a corporation-wide FAQ repository
  • Resource - a corporation-wide library
  • Glossary Item - a corporation-wide glossary
  • Person - a corporation-wide address book
  • Organization - a corporation-wide repository of partner and customer corporations
  • Module - a corporation-wide repository of reusable page fragments to be reused with transclusion

Space Properties

A space property is a property that is defined at space level. It can be defined via the Display Space Property Macro on space homepages and can be used to control the output (e.g. the Required Space Properties parameter in the Section Macro) or to configure macros (e.g. the Code Block Placeholder Macro). It can be accessed via Display Space Property Macro.

In contrast to the Display Space Property Macro the Display Space Attribute Macro displays space attributes defined by Confluence.

Like document properties, space properties also support controls. There are a number of controls that are only defined for space properties.

Hands-on Steps

Create an new space that will be your index space.

Create an Agile Project Space

  1. The Core Doctypes Add-on provides the index space blueprint.

    Until 8.x

     

    Prior to version 9.0 of the Core Doctypes: Select the Agile Project Space space blueprint for the creation of your index space.

  2. Choose IDX for the space key of your index.

     

    If you cannot use IDX as the space key, use any other key. The only drawback is that you have to set the index space for all your spaces explicitly.

    All spaces delegate to the space with key IDX per default. To switch off this default behaviour, set use-default-space to false.

    For more information refer to: delegate-space.

  3. Have a look at the new index space (for versions prior to 9.0)

The new index space provides homepages to store documents that are relevant to all your spaces.

 Explain the screenshot ...

Types

The box labelled with Index contains references to homepages for the following types

The Team & Stakeholdes box contains a reference to Roles that are used globally.

Repositories

Repositories are defined in the Documentation, Project Library, Team & Stakeholders, and For Authors box:

  • Documentation
    • Tours - group material for readers in a given context
    • FAQs - a corporation-wide FAQ repository
    • Topics - information relevant for all users
  • For Authors
    • Modules - a corporation-wide repository of reusable page fragments to be reused with transclusion

Specify a Space Property

The space property extract-short-description-from-metadata-table controls whether a short description is rendered within the properties table of a document or in front of it.

Sample Page with Short Description

First we need to create a page with a short description (for this exercise only):

  1. Create a page with the projectdoc Blank Document Blueprint
  2. Provide a name and a short description, then check the box to send the document to its homepage
  3. Click 'Create' to see the document in the editor
  4. Click 'Save' at the bottom of the page

This is the new document:

Add a Space Property

Now add a property to the space homepage.

  1. Open the homepage of your index space
  2. Click 'Edit' to edit the homepage
  3. Add a property named extract-short-description-from-metadata-table and value true (choose hide as a value for the third column, which is called the property control) to the table within the Document Property Marker Macro at the top of the document

  4. Save the homepage

Finally have a look at the test document you created in the index space in the previous step.

The short description is rendered in front of the properties table. The space property extract-short-description-from-metadata-table controls the rendering of every document in the space (or any space that delegates to this space and does not override this property).

Tips staying sane

 
  1. To have a look at the currently set space properties, add the Display All Space Properties Macro to a page
  2. projectdoc is picky with the entered values: There must not be any markup for the space property name or value, just the pure text value. Use the Confluence Source Editor Add-on to check the values
  3. To have a look at the document properties in the view, use the Display All Document Properties Macro Macro
  4. The Document Properties Marker Macro allows to override space properties with the Override parameter

Next Step

Continue with the next step: Create a Personal Space

Content