Child pages
  • Document Property


A property is metadata for a document. It has name, a value, and a control (such as hide).

Short Name
Property
Relation

Description

A property is a simple key value pair on a projectdoc document.

The document type (doctype) defines which properties are present for a document of this type.

projectdoc defines a set of common properties that is provided by all doctypes.

A document property is specified with one of the following macros:

Document Properties Marker Macro
A table containing document properties. Three columns: name, value and meta data (aka controls) to a property.
Document Properties Supplier Attachment Macro
A table supplying additional document properties from an attached file.
Document Properties Supplier From Documents Macro
Import properties from another projectdoc document.
Document Properties Supplier Macro
A table containing additional document properties. Three columns: name, value and meta data (aka controls) to a property.

 

Since there is no relation between a blueprint and the document instance, authors may remove and add any properties after the document has been created. So there is no guarantee that a given property is actually present.

A property may have zero or more controls. These controls provide information about the property. Examples for controls are hide, show, and mandatory.

Related Terms

 Click here to expand...

Name Short Description
An aspect is a document attached to another document to supply properties and sections. Aspects support modular documentation while the information can be still accessed in one document.
Attachment spaces are delegate spaces for entity doctypes.
A context controlled macro uses properties from its context to control the content being rendered. This includes document and space properties.
A delegate document references one document to inherit properties and sections.
Delegate spaces help to organize information that is used by more than one space. Resources may be delegated to other spaces. This includes the definition of space properties and providing homepages for documents of a given type.
Doctype add-ons provide blueprints for the projectdoc Toolbox. All doctype add-ons are available in source code on Bitbucket. This way teams may download them and adapt them to their specific requirements.
A projectdoc document instance is based on a document type. Documents are created using page wizards provided by blueprints.
A document type defines property and sections. A section is part of a document with a title and a body. Sections may be nested.
A document type (doctype) defines the properties and section for document instances. It also provides home and index pages. In Confluence these doctypes are implemented as page blueprints, usually with one template. This template is used to create new pages in Confluence.
The default homepage for documents of a given type.
Index pages provide views on document instances of a given type.
Instances of this type provide information on an entity of the domain.
Delegate space that provides space properties and organizing doctype homepages for other spaces.
Feature to derive a document's name from its title.
A reference to a document or fragment of an existing document that does not exist.
Features we assume are not relevant to all users of the projectdoc Toolbox are available as extensions. Extensions are add-ons for Confluence that require the projectdoc Toolbox Add-on to be installed, but can be installed separately on demand.
A member of a set of document instances of a common doctype. Used to be imported into wiki instances since they provided information to be used in different projects. Examples are topic types, resource types, and module types.
A remote controlled document uses macros that enable to control the content being rendered by request parameters.
Remote controls are sequences that allow to configure macros in transcluded content. This reconfiguration alters the rendering result of the macro. Only macros supporting the remote control feature can be remote controlled.
Search spaces extend the search with projectdoc macros for a space per default on a number of other spaces.
A relation of spaces based on delegation or search.
A property defined on the space homepage that takes effect on the space and delegating spaces.
Designed to keep information that is relevant for a given domain and is mandated to be up-to-date.
Document types that define types for documents.
Designed to aggregate information that is relevant for a given spike or iteration.

Resources

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.
Document Properties as Data
We like to think of document properties as metadata. But in some contexts it is natural to think of them as data for the entity described by the document.
Document Properties Marker Macro
A table containing document properties. Three columns: name, value and meta data (aka controls) to a property.
Display Table Macro
Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
Document Section
A document type defines property and sections. A section is part of a document with a title and a body. Sections may be nested.