Versions Compared

Key

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

...

Document Properties Marker
hidetrue
overridefalse


Short DescriptionAdjust your Confluence Personal Space personal space to work as a Personal Space personal space for projectdoc. 
Doctypetopichide
NameCreate a Personal Space 
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
valuefilled
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTutorial
propertyType
 
Previous StepCreate an Index Attachment Spacehide
Next StepCreate a Workspacehide
Sort Key000200hide


...

Section
titleBackground Information


Expand
titleShow background information ...


Section
titlePersonal Space

A personal space is a space of a user of Confluence. User can add their information to pages and blog posts and make them available to their team and other stakeholders.


Section
titlePersonal Space Properties

Personal space properties are space properties that are defined in the personal space with the Document Properties Marker Macro on the personal homepage.

Not every space property makes sense to be defined in the personal space. Some properties are restricted to be used in the personal space. Space property controls are defined for spaces and especially personal space properties to control the use of that property outside the space it is defined in.

The properties defined as personal space properties are consulted as overriding values to the properties defined in other spaces.


Section
titleTypical Properties

Typical space properties for the personal space are:

  • Display Properties
    documentpretend-being-aPretend Being A
  • Display Properties
    documentprojectdoc-doctype-(doctype)-homeDoctype Home
  • Display Properties
    documentprojectdoc-subject-(subject-name)-homeSubject Home

projectdoc knows basically two kind of roles: writers and readers. Technically there is a third role called printer which is a specialized reader. The purpose of these roles is to configure the rendering. Authors have some tools that help them to access information quickly. For instance a transclusion renders a convenient border around the content so that the document from which the content is transcluded can be accessed with just one click.

This border must not be rendered There is no transclusion border for readers. They should be ignorant from which documentation module the content is drawnThe original source of the information displayed in a page is made transparent for them. Therefore this box (and its controls) are useless for the reader and must not be rendered.

Authors are able to see documents from the reader's view by setting the space property pretend-being-a Pretend Being A to the value of reader.




Section
titleHands-on Steps


Section
titleTransform Homepage to Document

Add the Document Properties Marker Macro to the homepage of your personal space. Then add a table with three-columns (name, value, controls) for properties you need.

The following screenshot shows an example of the Document Properties Marker Macro containing a table with properties that may be useful for a personal space (see Display Space Attribute Macro and Tag List Macro for more information on macros used in this example).

Image Modified

Now the space properties are available in the personal space and serve as defaults for all other spaces. To control this export to other spaces use space property controls.

Note Box

The properties in the macro are called 'document properties'. In case the page is a space homepage, they are also called 'space properties'.



Section
titleControl your Space Properties

Space properties in your personal space are enforced on every document you visit in Confluence. Typically you would want to use space properties in this space very sparely. In case you work extensively, this would be a bummer. To control whether or not properties are seen outside your personal space, use the following controls:

Tour


TitleShort Description
space-local
default-only



Tip Box

Use the space-local control extensively in your personal space to make sure that certain configuration is only applied when working with documents in the personal space.



Section
titlePretend a Role

Let's add a space property to your homepage!

  1. Open the test document (or you create in a new one)previous step, then add a description and save it
    Image Added
  2. Save the page
    Image Added
  3. Open your homepage (or any other page) in the editor and add a the Transclusion Macro
    1. Specify the test document (or the document you have created) as the document to transclude from for the mandatory Document parameter
    2. Specify the Description section as id value for the Identifiers parameter
      Image Added
    3. Save the macro
    4. Save the page

You now see the transcluded content with the transclusion border.

Image Added

  1. Now open your homepage and add the space property pretend-being-a Pretend Being A with the value of reader.
    Image Added
  2. Save the page

The transclusion box is now removed around the transcluded content.

Image Added

  1. Open the homepage again and change the value of pretend-being-a Pretend Being A from reader to writer (or remove the property from the table).
  2. Save the page

The transclusion box is visible again.


...