Versions Compared

Key

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

...

Document Properties Marker
hidetrue
overridefalse


Short DescriptionCreate a space to work on a given topic. This spaces uses an index space to reuse content.
Doctypetopichide
NameCreate a Workspace
Parent
Parent Property
propertyParent
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesDocumentation Architect, Author
propertyAudience

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

Expected Duration
Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Iteration

Iteration
value

filled

finished

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTutorial
propertyType

Previous StepCreate a Personal Spacehide
Next StepDoctypes in Detailhide
Sort Key000300hide


...

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 refer to specialized roles of their parents), the second usage implies a close relationship between the documents. This close relationship defines that the subdocument has to be deleted 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 to organize documents matching certain criteria. The documents will always be stored 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 you describe. Each component may share the same roles and topic types. So there is no need to have them copied around spaces. Instead have them stored in a 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 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- Search Space space space property. It defines for all projectdoc query macros 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-delegate-space-as-search-space Use 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

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.


Changes in the Definitions!

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 role documents.

Section
titleUse Delegate Space
Caution Box
title
Space

Due to changes in our space definitions, it is currently no longer true that the workspace has no homepage for roles. Therefore the following part in the tutorial runs into a different result. Since there is a role homepage, the new role will simply be directed to there.

In case you want to exercise on having the new document been moved to a homepage on another space, please move the homepage for roles from the workspace to the index space. Another option is to make sure that there is no homepage for tags on the workspace and create a new document of type Tag.

Caution Box

Due to 

Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-1088
 you need to explicitly specify the delegate space IDX in your workspace.

Image Added

The issue is fixed in the projectdoc Toolbox version 3.3 and above.

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

The document is stored on the homepage or roles of the index spaceaddress book.

Image RemovedImage Added


Section
titleUse Search Space
  1. Go to the homepage of  'My Workspace' you have created in 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

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


...