Create an Attachment Space

Organized information of a context, such as a glossary or an address book, in a dedicated space. These spaces are called attachment spaces.

Audience
Documentation Architect, Author
Iteration
Finished
Level of Experience
Novice

Background Information

Attachment Space

Attachment spaces are corporation or team wide repositories for a semantic set of document types.

This information could be part of an index space. But keep in mind that the index space is mostly a public area. Therefore you may want to put sensitive information to an attachment space.

  • Person - a corporation-wide address book
  • Organization - a corporation-wide repository of partner and customer corporations

Besides access requirements, it may be easier to organize information, although publicly available in their own spaces. For instance a glossary. If users a looking for a term, they may either want to look only in the glossary, or anywhere but the glossary. Spaces are handy to put related information in one place.

You may also add images, graphics, and short topics of text in a separate space. A classic resource repository.

  • Module - a corporation-wide repository of reusable page fragments to be reused with transclusion
  • Step - information on action steps being reused in a couple of task descriptions

Hands-on Steps

Create an new attachment space that will be your address book.

Create an Address Book Space

  1. The Core Doctypes Add-on provides the address book space blueprint.
  2. There are no conventions on naming the address book.
  3. Have a look at the new address book.

    For fast access you see the listing of organizations and stakeholders on the left side. A click on an organization will list those persons that are working for that organization. For a list of all persons and roles there are links on the right side.
  4. Add the new address book space as an attachment space to another space. For this tutorial we will add it to the index space. Open the homepage of the index space and add the Delegate Space property to the list of properties on that page. Add the space key, in our case AB, of the address book space you have created.

With the attachment space you define that all documents of type Person, Organization, Role, and Stakeholder will be stored in this space. This is similar to index spaces that are home to all kinds of categorizing doctypes.

Next Step

Continue with the next step: Create a Personal Space