Versions Compared

Key

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

...

Document Properties Marker
overridefalse


Doctypetopichide
NameSpace Properties
Short DescriptionLists the configuration options at space level.
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Documentation Architect, Documentation Gardener
propertyAudience

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience

Expected Duration
Tags
Tag List
namesSpace

Iteration

Iteration
value

filled

released

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesReference
propertyType

Sort Keyhide


...

Section
show-titlefalse
titleDescription

Space properties allow to configure projectdoc per-space.

The central properties are those that define the delegate-space Delegate Space and the search-space 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.

Example Box

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.


...

Section
titlePlaceholders

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.

Example Box


Code Block
version=1.42.73
url=httphttps://example.com/myservice/${version}/apidocs

Image Added

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.

...

Section
titleNaming 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.


property, space-
Section
idSubtopics


projectdoc-
display-table
doctype
hide-from-reader-macro

Create from template
blueprintModuleCompleteKeyde.smartics.atlassian.confluence.smartics-doctype-addon-app:projectdoc-blueprint-doctype-space-property
contentBlueprintId38ea2714-953e-47e3-9015-e8f489892eb1
templateName38ea2714-953e-47e3-9015-e8f489892eb1
createResultedit
buttonLabelCreate Space Property

Display Table

property

render-no-hits-as-blanktrue
select

Name, Short Description, Typerestrict-to-immediate-childrentruesort-by

§select.spaceProperties
where$<Doctype>=[space-property] OR ($<Doctype>=[property] AND $<AncestorNames>=[${Name}])
header-translationsS=Short Description, T=Type

Sort Key, Name


Section
titleUser 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.

...

Section
titleResources


Tour
render-as-definition-listtrue
replace-title-with-nametrue