Document Property Controls

Lists valid controls for properties to be used in document properties tables.

Audience
Author, Documentation Architect, Documentation Gardener
Type
Reference

List of Controls

Name Short Description Since
delegate
Signals that the property should be transcluded from the delegate document.
1.10
export
Exports the property as metadata.
1.10
export-schema
Exports the property as schema information.
1.10
force-property
Enforces to treat a property with dynamic value as property.
6.0
hide
Prevents the property from being displayed. This allows to add properties to use for selection in queries, but hide them when displaying the document.
1.0
is-block
Prevents the property value from being disblocked.
1.13
is-no-template
Marks the value of a property as not being a template despite it may contrain a placeholder reference.
1.13
is-single-value
Prevents the property value from being split into a list of values.
1.13
mandatory
Tags a property to be mandatory.
2.0
mat
Materialize the controlled property by an artificial property with the given path.
4.5
noindex
Prevents the property from being indexed with Lucene. A property marked with this control will neither be added with a keyword nor added to the body of the document as text.
1.1.3
no-property
Controls whether a line in a document properties marker macro is actually a property.
6.0
no-render-cache
Controls whether or not a rendered property value can be cached.
4.5
preserve
Prevents cleanup services from applying their changes to name, value, and controls of a property.
1.14
show
Renders a property even if the value is blank.
2.0
supplied
Marks a property as being imported from another projectdoc document.
2.3
supply
Marks a property as importable by other projectdoc documents.
2.3
unsupplied
Marks a property as being imported from another projectdoc document, but its supplied status overridden by a local configuration.
2.3
value-separator
Allows to specify an alternative value separator.
1.17

Resources

More on related information to document property controls.

Document Property
A property is metadata for a document. It has name, a value, and a control (such as hide).
Document Properties
Properties are metadata that can be added to every projectdoc document. If you require a set of metadata for each instance of a document type, you should write your own doctype.
Space Properties
Lists the configuration options at space level.
Space Property Controls
Lists valid controls for properties to be used as space properties.