Using Space Properties

Section

Column

Document Properties Marker

override	false

Short Description

Space properties are defined for spaces and are accessed via the Space Property Macro. This tip goes into detail in how to use space properties with inheritence and extension pages.

Doctype

topic

hide

Name

Using Space Properties

Parent

Parent Property

property	Parent
property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
render-list-as-comma-separated-values	true
names	Author, Confluence Administrator, Template Author
property	Audience
empty-as-none	false

Level of Experience

Name List

doctype	experience-level
render-no-hits-as-blank	true
names	Advanced Beginner
property	Level of Experience
empty-as-none	false

Expected Duration

30 min

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder
render-no-hits-as-blank	true
property	Sponsors

Sort Key

hide

keywords

Property, Variable, Confluence, Add-on, projectdoc

hide, export

DC.subject

Display Property

property-name	keywords

hide, export

enable-heading-numbers

true

hide

Section

show-title	false
title	Description

Organizing spaces often implies some variation by using a centralized configuration of variables. The projectdoc Toolbox implements these variables as space properties.

Space properties are properties defined on the space home page within the Document Properties Marker Macro. Multiple macros of the projectdoc Toolbox take advantage of this space-local configuration option.

This tip introduces the concept of space properties and provides links to further resources for advanced usage scenarios.

Column

width	40%

Panel

title	Contents

Table of Contents

outline	true
indent	10px
exclude	Using Space Properties\|Resources\|Space Resources\|Get Started
style	none

...

Section

title	Advanced Features

For more complex documentation scenarios, projectdoc provides a number of advanced features.

Section

title	Inherit Properties from Spaces

projectdoc allows you to set spaces in hierarchies using the delegate-space Delegate Space property, which is a space property. Any properties defined in delegate spaces are automatically visible in the delegating space.

Please refer to Space Hierarchies for more information on this topic.

Section

title	Organize Properties by Extension Documents

The number of space properties may be rising with time. To manage large amounts of space properties you may group them semantically and store them on separate pages.

Use the space property space-properties-extension Space Properties Extension (Space Property) to list pages that provide additional space properties as a space property on your space home page.

Section

title	User-specific Settings

Properties specified within the properties table of the Document Properties Marker Macro on the home page of the user are also taken into account when rendering space properties.

These properties are used to define user-specific home pages for document types or allow users to switch roles.

Tip Box

Using user space properties may cause confusion within a team. One team member may have set a property another team member has not and therefore they get different renderings of a page. The reason for the difference is often not instantly obvious. Compare the properties for each user with the Display All Space Properties to see the differences in the configuration. The macro also shows where a particular space property is defined.

Use Space Property Controls to limit the export of space properties.

Section

title	Templating with Space Properties

Template authors may want to display certain content only if a given space property is set. The Content Marker Macro allows to specify space properties that need to be set to show the content.

This option is also available for sections.

Section

title	Use Cases

Here are a couple of use cases that employ space properties.

Section

title	Maven Projects

With projectdoc you may create spaces for software projects built with Maven. Create a space by reading the project's POM file. The properties of the POM are automatically made available as space properties.

Depending on the version of the product, different space properties may be enforced by using space properties extensions.

Note Box

The doctype add-on is not yet available on the Atlassian Marketplace. Large POM files take a long time to create the space. While developers may deal with this, other users may be annoyed by the import process.

Until this problem is fixed users may choose to fork and build the add-on on their own. It is available on Bitbucket!

For more information on documenting projects built with Maven, please refer to:

Tour

render-as-definition-list	true

Title	Short Description
Using projectdoc to document Maven Plugins
projectdoc for Maven Developers
Maven Extension

Section

title	Being a Pretender

Sometimes an author needs to look at a page as if she is a reader. For these use cases there is the pretend-being-a Pretend Being A property that is only allowed to be specified as a user space property.

Section

title	User-specific Home Pages

Users may want to define home pages for certain types of documents individually. It is also possible to store documents of a given subject automatically to a specific page.

The example shows how to set the home page for all Resource documents to 'Library' and direct all documents with the Subject 'Team Announcement' to the 'Announcements' page.

For more information on this topic, please refer to:

Tour

render-as-definition-list	true

Title	Short Description
projectdoc.doctype.(doctype).home Doctype Home	projectdoc.subject.(subject-name).home
Subject Home
Home and Index Pages

Section

title	Macro Configuration

A number of macros in the PDAC1 refer to space properties for a central configuration.

Here are two examples:

Section

title	Remote Information Systems

Space properties allow to specify URLs to remote information systems to be used by macros of the Information Systems Extension. If the URL to such an information system changes, the URL needs to be edited only in one place.

Display Table

doctype	macro
select	Name, Iteration, Short Description
where	$<Extension>=[Information Systems Extension]
header-translations	Iteration=Status
render-counter-column	true

Note Box
Prior to version 1.11 of the projectdoc Toolbox these macros where part of the add-on. We decided to move them to an extension add-on since they are not required by all users. The extension is available for free, but needs the commercial projectdoc Toolbox Add-on installed.

Section

title	Rendering Configuration

The Code Block Placeholder Macro takes advantage of space properties. You may for example define a default language with the code-language Code Language property.

Section

title	Prerequisites

...

Section

title	Resources

Section

title	Space Resources

Find more information on using spaces with projectdoc here:

Display Table

select	Name, Short Description, Doctype
where	$<Tags> = [Space]
header-translations	Doctype=Type

Section

title	Get Started

To get started with the projectdoc Toolbox have a look at the following resources:

Tour

replace-title-with-name	true

Title	Short Description
Introduction for projectdoc new Users
Hands-on Tutorial
Basic Concepts and Conventions for projectdoc
projectdoc on the Atlassian Marketplace	Install the projectdoc Toolbox and doctype add-ons via the Atlassian Marketplace.

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-tip
Type	howto

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 1

New Version Current

Key

About

Keep up-to-date!

Powered by