Versions Compared

Key

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

...

Section
titleBackground Information
Expand
titleShow background information ...
Transclusion
taget-heading-level*
documentSpaces Introduction
idsSpaces as a Tool

Transclusion
render-document-name-as-headingtrue
taget-heading-level*
documentDocument Types and Templates
ids-Description, !*

Section
titleDoctype Homepages

The documents of a given doctype are organized in homepages. Most of the doctypes have a homepage where the central documents of their types are stored. For each doctype that provides a homepage, the blueprint wizard to create a document provides a checkbox to store the new document as a child of the doctype homepage.

Confluence index pages collect each document created with a given blueprint wizard. Homepages of doctypes reference only those documents that are send to them. There are two kinds of documents that are not stored on the homepage:

  1. documents that are children of a document of the same type (with their root parent being a child of the doctype homepage)
  2. documents that are children of documents a different type

While the first imposes a natural organization of documents and subdocuments (think of roles where the subdocuments document refer to specialized roles of their parents), the second usage implies a close relationship between the documents. This second close relationship implies defines that the subdocument has to be deleted if when the parent document is deleted. That is: they have the same lifespan.

Homepages may change their structure over time. Some doctypes will only contain a very limited number of documents (e.g. their are typically only a few roles in a small project), but others may have large numbers (e.g. the minutes of meetings may get plenty for larger teams). Therefore expect that the homepage may have subpages that collect documents that match to organize documents matching certain criteria. The documents will always be stored to as children of the type homepage.

Section
titleDelegate Space

Some documents are relevant to more than one space. If you have a large project with multiple large components you may want to have a space for each component to you describe. Each component team may share the same roles and topic types. So there is no need to have them copied around spaces but instead . Instead have them stored in a commonly collaboratively used delegate space. The index space is by definition a default delegate space. But you may declare any space as the delegate space of a given space by adding the space property delegate-space.

Once you have one (or more) delegate space(s) declared, you may remove the homepages of those document types you want to store in the delegate space. If a user selects as the target location of a new page via the "Send to Homepage" parameter, projectdoc automatically selects the homepage from the nearest delegate space.

Note Box

If there is no homepage, the page is stored as a child to the current page.

Section
titleSearch Space

The search space is defined by the search-space space property. It defines for all projectdoc query macros provided by projectdoc the spaces to search for documents. Per default the search space is the same as the delegate space. You may change that by the use of the space property use-default-delegate-space-as-search-space.

If you want to list all documents with some criteria of a given doctype, then all documents from the spaces listed as search space that match these criteria are in the result set.

Section
titleHands-on Steps
Section
titleCreate a Workspace

Let's create Create a workspace that uses the index space as delegate space.

  1. Create a new space based on the Workspace Blueprint
  2. Add the required information and click 'Create'

The new space is created with the homepages defined for the Workspace space.

Section
titleUse Delegate Space

Workspaces do not have homepages for roles. If you create a new role and send it to the homepage, it will be stored on the delegate's homepage for that document typerole documents.

  1. Go to the homepage of the workspace My Workspace you have created in the previous exercise
  2. Create a new page based on the Role blueprint
    Image RemovedImage Added
  3. Add the required information to the wizard and check the 'Send to Homepage' box
  4. Click 'Create'
  5. Click 'Save' at the bottom of the page

The document is stored on the homepage of the index space.

Image RemovedImage Added

Section
titleUse Search Space
  1. Go to the homepage of the workspace of  'My Workspace' you have created in the a previous exercise
  2. Edit the page
  3. Add a Display Table Macro
    1. Specify to select all documents with the doctype 'role'.
    2. Save the macro
  4. Save the page

You have the The role 'User' that is stored in the delegate space, is automatically in part of the result set.

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

...