Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: typos

...

Section
titleHierarchy of Spaces

These single space use cases are typically not very common, if the organization allows to share configuration and information. In these cases, no space is an island!

The projectdoc Toolbox allows configuration on space level using space properties. The configuration of space properties can be delegated to another space – a delegate space. Multiple spaces may share the same delegate space. In fact the projectdoc Toolbox assumes such a default space to have the space key IDX. This is only a default. The delegate spaces for a particular space are defined by the space property delegate-spaceDelegate Space.

Example Box
titleCommonly used Configuration

Assume that for each space you want the short description of a document to be rendered in front of the property table.

Set the space property extract-short-description-from-metadata-table Extract Short Description From Metadata Table to the value true in the index space, then every space will automatically use this property and render the short description as instructed.

Sharing configuration is one aspect of a delegate space. The other aspect is the provision of homepages for doctypes. Index spaces define categorizing document types like tags, categories, subjects, and types, including topic type and tag type. These categories help readers to navigate a site. This categories are often shared between spaces. Usually there are some categories that are used in every space.

Example Box
titleResource Types commonly used

If you have resource types like books, article, magazine, there is no need to duplicate this information. In case you put this information in a sitewide index space, every team can reuse this information in their spaces to organized their content.

Since index spaces have typically sitewide access. For a public facing website this information is by default open to anonymous users. You may restrict the access to particular pages, but the users with least privileges have access to the homepage of the space and therefore to the configuration of this space.

To hide sensitive information or information that is not relevant to every space visitor, the information architect may decide to store information with higher access levels in separated spaces. These spaces are called attachment spaces since they are attached to another space. In many cases this central space for attachment spaces is an index space. Attachment spaces are responsible to store information of a given kind. The library stores resources. The address book stores persons and stakeholders.

Note Box

A library should not store resource types. While a team may not be interested in sitewide resources, they may want to reuse the organization of resources. So consider to store the resource types in an index space.

To attach a space to an index space, the space key is listed by the delegate-space Delegate Space property.

Note Box
titleReusing some types?

It is a bit cumbersome to ruse only some of the types in a downstream space. One approach is to establish a new homepage for the doctypes and use delegate documents. A delegate document references an existing document and reuses a subset of properties and sections.

This approach is very selective. A team can pick what information they want to use in their work. It also allows the team to have their navigation pages local in their space, not in a sitewide index space.

On the other hand this approach is also requiring much manual work. For each page another page needs to be created and the properties and sections to delegate to need to be selected.


...

Section
titleSitewide Spaces

Examples for attachment spaces are address books, glossaries, and libraries. In case you have the use case to provide this information for all your spaces, your sidewide sitewide spaces will have a structure similar to the following:

  • IDX - the sitewide index space
    • ADDR - the sitewide address book
    • GLOSS - the sitewide glossary
    • LIB - the sitewise library
Note Box

The Core Doctypes, a free doctype add-on for the projectdoc Toolbox, provide space blueprints to create spaces of these kinds.

Assume that the three attachment spaces already exist. To attach these spaces, the configuration for the index space has these lines. 

The search space will find documents in all spaces the current user has access to (search-space-localSearch Space Local=@all). The default space closure allows links from the index space point to pages in any spaces the current user has access to (default-space-closureDefault Space Closure=search-space). The three attachment spaces need to be configured manually in the index space (delegate-spaceDelegate Space=ADDR, GLOSS, LIB).

Note Box

For this configuration to work properly the attachment spaces and the index space must provide no or exactly one homepage for each doctype.

The current versions of the address book, glossary, and library space blueprints comply with this rule and can be used in combination.

No matter which page in a space of this configuration a user is visiting, when creating a new document, the send-to-homepage function of the page blueprint wizard will find the correct location for this new document.

...

Section
titleSpace Groups

In case a team needs a couple of spaces to meet their collaboration needs, the basic structure of index space and attachment spaces is also a valid solution.

A couple of spaces may use a shared configuration or also require specific attachment spaces. These spaces form a space group. Topic spaces or workspaces with a specific task, such as service management, project management, or risk management, may also be registered as delegate spaces to the space group's index space. Again, the information architect needs to make sure that there is at most one dedicated homepage for a specific doctype.

Instead of an index space with homespaces for various doctypes, a configuration space may be more handy. Required doctype homepages may be added later individually using the homepage blueprint wizard.

Version Box
since13.0

Configuration spaces are available since version 13.0 of the Core Doctypes Add-on.

Space groups may share the same space label. In this case the search space can be configured to automatically include all spaces of this group in the search space. Every new workspace, tagged with the space label, will be automatically part of the search index of all spaces in this group.

References Box

For more information on how to use space labels to define search spaces, please refer to search-spaceSearch Space.



Section
titleSpaces in an Organization


Example Box

Consider the following relationships of spaces.

Three teams use the sidewide sitewide index space with three attachment spaces. Team A decided to have an index space and an attachment space on their own. Team B only needs a configuration space (Index B), and Team C only uses a single topic space for their collaboration results.

When a team member adds a person document and sends it to its homepage, the projectdoc toolbox will find the sitewide address book.

When a member of Team B adds a new document for a book description while working on Workspace 2 (WS2), this document will be send to the sitewide library.

Since Team A has established their own library in their space group, a new resource would be stored in their library space. If the team member decides to move this resource to the sidewide sitewide library, this would need to be done manually.

Since Team A does not use a glossary in their space group, a new glossary item is contributed to the sidewide sitewide glossary.



Section
titleSummary

The reason to build a hierarchy of spaces is to reuse configurations (in form of space properties), categorization, or information. Configuration and categorization is provided by index spaces, information by attachment spaces.

Based on the index space and attachment spaces pattern, not only the sidewide sitewide spaces can be defined, but also spaces groups.

A space group typically uses the sidewide sitewide configuration, but also adds configuration and homepages required by its use case.

...