You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
Lists the configuration options at space level.
Description
Space properties allow to configure projectdoc per-space.
The central properties are those that define the delegate-space and the search-space. But every macro may also provide defaults here that are taken into account if not overridden in the macro configuration. This way documentation architects may provide defaults (e.g. for colours or other rendering options particular macros provide), so that document authors do not have to bother with this styling issues.
Placeholders
Since version 1.11 space property values may reference other space properties. Use the placeholder syntax to create these references. Note that these references are only enforced within the Document Properties Marker Macro of the space homepage. If you need to refer to a space property value within a page then use the Display Space Property Macro.
Naming Convention
Space properties are defined in the homepage of a space in the document properties table. To distinguish space properties from document properties there is a naming convention:
- Document Property Names start with a capital letter and are human readable. That is they may contain spaces, e.g. "My Document Property".
- Space Property Names start with a lower case letter and are tokens. That is they are separated by dashes, e.g "my-space-property".
User Space Properties
Users may override space properties with their personal preferences. This is useful to override rendering options.
Add a document properties table to the user's homepage.
The example overrides one property: hide-metadata.
Resources
- Using Space Properties - 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.