Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
overridefalse
Short DescriptionA short introduction on using spaces with the projectdoc Toolbox for Confluence.
Doctypetopichide
NameUsing Spaces
Short Name
Parent
Parent Property
propertyParent
property-nameName
hide
Audience

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


Level of Experience

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


Expected Duration
Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags

Tag List
namesprojectdoc Toolbox, add-on, Confluence, spaces, delegate space, search space, workspace, topic space, index space, attachment space
propertyTags

hide
Iteration

Iteration
valuefilledproduction

hide
Type

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


Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide
Section
show-titlefalse
titleDescription

Spaces are a great tool provided by Confluence to organize information in a wiki. They give purpose to the collection of pages and they contain and make it easy to control access to those pages. Searches can be limited to a number of selected spaces and once a space is no longer needed it may be archieved (or even discarded) with all pages inside.

There is often the question of how to organize pages in spaces. The number of pages stays the same regardless the number of spaces they are distributed over. Too many spaces make it difficult to locate the information, but too few spaces have the same effect.

With the PDAC1 we developed names for the purpose of spaces. This makes it easier to categorize spaces, organize them, and hopefully hit the right number of spaces for an organization or a given project.

Column
width300px
Panel
titleContents

Table of Contents
outlinetrue
indent10 px
excludeSummary|Resources
stylenone

...

Section
titleSpace Relations

With the PDAC1 spaces can be put in a delegate and search relation. Both relations allow to create hierarchies of spaces. These hierarchies make spaces easier to handle.

Section
titleDelegate Space

A delegate space contains space properties and doctype homepages. Spaces related by delegation simply reuse information.

Example Box

Consider that a number of teams often use the same tags to provide metadata for the documents. Instead of each team documenting these tags on their own, these teams decide to create a delegate space and curate the documentation on the used tags together.

Think of a delegation space as a associated space that contains information on behalf of the delegating space.

Note Box

A Name List Macro will reference documents in the delegation space hierarchy.

Section
titleSearch Space

For search macros (such as the Display Table Macro) spaces can be connected as search spaces. If information is queried in one space, all its declared search spaces are also automatically included.

Example Box

A team may have a separate space for each product of a product suite. It then may provide a homespace that provides the entry point to all information on the product suite. On the homepage of this space there is a list of related resources for each product of the suite. Since the spaces are related by the search-space Search Space property, each use of a search macro will automatically include the same spaces in their search context.


Section
titleProviding Spaces

Based on the delegate space relation, index and attachment spaces provide similar functions.

While the index space is a typical delegate space with space properties and homepages for organizing document types, an attachment space aggregates entities used in multiple spaces. Both space types provide structure for the team's collaborative work on information.

Section
titleIndex Space

Use an index space to define space properties that should be applied to all delegating spaces (that is: a space setting the index space as a delegate-space Delegate Space).

For instance setting extract-short-description-from-metadata-table Extract Short Description From Metadata Table to true will render the short description of a document in front of the document properties table. Setting this property in an index space will automatically apply this render rule to all documents of all delegating spaces.

Another example is configuring the metadata sets for HTML metadata in a central index space. The configuration is reused by all delegating spaces.

So any space property of a delegate space is available in a delegating space, if this property is not overridden.

Additional to space properties, index spaces provide home pages for organizing document types such as subjects, categories, or tags. These organization schemes require work to create and are often quiet similiar (at least for the generic types) within an organization. Think of resource types like book or article, module types such as reference or figure, or the expected experience level of the audience, such as beginner or expert.

Section
titleAttachment Space

Documents describing external resources (such as books, organizations, or people) may be of value for more than one space. These documents should be stored in attachment spaces. Their metadata will make it easy to compile lists of related information.

Resources that describe books or articles may be collected in a single library space. A particular resource may deal with more than one domain. By tagging the resource with the name of the domain, resources can be easily compiled using a search macro as the Display Table Macro. The same goes with organizations and people collected in an address book.

...