projectdoc Toolbox

Lists the configuration options at space level.

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.

 

An example may be a highlighting macro where authors may select a theme or rendering style. If this style is not set to the default, every author would have to select the property style for the code macro. With space properties, the code macro should be set to 'Space Default' so that the decision of styles is propagated to the space configuration.

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 (that is: only available for space properties). If you need to refer to a space property value within a page then use the Display Space Property Macro.

 
version=1.42.73
url=http://example.com/myservice/${version}/apidocs

Note that templates are resolved on request time, while the use of display macros are resolved at document save time. That also includes that documents cannot be queried by resolved template values. So if you need to query documents per property value, you need to use tools to resolve values at save time, not request time.

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:

  1. Document Property Names start with a capital letter and are human readable. That is they may contain spaces, e.g. "My Document Property".
  2. Space Property Names start with a lower case letter and are tokens. That is they are separated by dashes, e.g "my-space-property".
  3. Break convention number 2 if you specify a value from your domain as a space property.
Name Short Description Type
Toggles checking the existence of resources.
boolean
Specifies the default language to be passed to the Code Block Macro.
string
Activates the page fragment cache for a space.
boolean
Controls if missing sections should render an error message (false) or just display nothing (true).
boolean
List of spaces to delegate documents on creation to. Also works as a search space for upstream spaces.
List of space keys
Controls whether or not the name of the document should be set as the title for Scroll Office.
boolean
The URI to a JSON document containing the URLs to the documentation for the blueprints.
string
Controls whether or not section headings should be numbered. The numbers are added via CSS, therefore they won't work for export formats that do not take CSS into account.
boolean
The property to control how short description from the document properties tables within a space should be rendered.
boolean
Controls the max depth to which headings are numbered.
int
Controls the top heading level for a document.
int
The property to set the document type box displayed on each page to be hidden or not.
boolean
The property to set metadata in document properties tables to be hidden or not by default. May only be overridden if document properties macro specifies "override" to true or if the property is not set for the space.
boolean
The property to set metadata in document properties tables to be hidden or not for printing. Printing includes PDF, Word and HTML-Export.
boolean
List of space property names that refer to a remote information system URL. Elements of the list may be specifier with a system ID and a system type.
List of Strings
Controls to render sets of metadata based on document properties.
list
Controls, the default whether or not the Name List Macro renders a small box around each entry for a specific doctype. The default behavior is false and can be set to true by using the space property name-list-default-boxstyle.
boolean
Controls, the default whether or not the Name List Macro renders a small box around each entry. Its possible to overwrite this default for each doctype using the name-list-<doctype>-boxstyle space property.
boolean
The property points to the default Nexus repository. The identifier is used by the Nexus Macro to set a space-wide default.
string
Contains the URL to the nexus service to download artifacts.
A switch to control the assumed role of the logged in user. The property is set as a property of the user's private space.
string
Controls which quirk modes are to be applied to adjust the output for a range of formats.
list
The artifact identifier of the project. The value is used as a default value by macros referencing information systems.
string
The classifier of the main artifact created by the project. The value is used as a default value by macros referencing information systems.
string
Specifies a doctype-specific pattern to match against the title property to derive the name property of a projectdoc document.
Specifies for the name pattern the doctype-specific group to select.
Controls the location of the homepage of a given document type. Use the identifier of the doctype.
Specifies a pattern to match against the title property to derive the name property of a projectdoc document.
Specifies for the name pattern the default group to select.
Specifies the type used for rendering graphs.
String
Allows to discard list items.
String
Allows to render an additional node using the CSS class 'first'.
A space property to control the location of the homepage of a given subject. Use the name of the subject to define the space property name. The value is a link to the page to store documents associated with the specified subject. Only available for versions prior to 2.0.
The group identifier of the project. The value is used as a default value by macros referencing information systems.
string
The type of the main artifact created by this project. The value is used as a default value by macros referencing information systems.
string
The version of the project. The value is used as a default value by macros referencing information systems.
string
Controls the rendering of brackets around the date.
boolean
Specifies the prefix for specifying page locations for quotes and cites.
string
Signals to insert a non-breaking space between the page location prefix and the actual page location information.
boolean
Signals to suppress the adding of the prefix, if the first character of the page location is already a letter. This is useful if the format of citing depends on a language, but there is a default language for the space.
boolean
The property to control how the document properties tables within a space should be rendered.
enum
Controls the rendering of transclusion boxes.
enum
List of spaces to include in downstream searches. Use @all to refer to all spaces.
List of space keys
List of spaces to include in downstream searches to be used for the defining space only. Use @all to refer to all spaces.
List of space keys
boolean
Links to documents that contain additional space properties. The order of the references to documents is important. The first location a value for a property is found, defines the value to the property. Later reference cannot override that value.
List of references to documents.
The property that stores the names of doctypes to take as space properties extensions into account, if found as children if the document this property is defined in.
List of references to documents.
Stores the regular expression pattern to create a reference to a space properties extension.
A regular expression as a string
Controls the suppression of heading numbers dependent on the doctype.
List of strings
Suppresses transclusions when set to 'true' on the user's space.
boolean
Sets the mode for rendering transcluded content in transclusion suppression mode.
enum
Controls the format of the date rendered on the transclusion box.
Controls the rendering of dates on the transclusion box.
boolean
Configuration to switch between our projectoc macro style in edit mode and back to the confluence default macro style.
boolean
Controls, if the the default space (IDX) should be used, if no space is explicitly specified.
boolean
Controls, if the delegate space should be used as a search space in case that no search space is explicitly specified.
boolean

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

Space Properties
Properties may be set on space level and are inherited through space hierarchies.
Space Hierarchies
Organize spaces in hierachies with delegate and search spaces.
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.
Space Property
A property defined on the space homepage that takes effect on the space and delegating spaces.
Space Properties Extension
Information related to tools that allow to define space properties not necessarily on the space homepage.