Metadata documents provide tables of simple key/value pairs. This information can be used as an aspect or as additional space properties to be available for reference on your wiki.
- ID
metadata- Suite
- Categories
- Tags
- Since
- 4.0.0
Description
Metadata documents provide tables of simple key/value pairs. This information can be used as an aspect or as additional space properties to be available for reference on your wiki.
Metadata documents may be subdocuments of Version documents. Homepages reference a single Version document to transclude all properties specified by this version and all its Metadata subdocuments.
Metadata documents may also be a generic doctype to be used to provide additional information (properties and sections) as an aspect to a given document. See Aspects for more information on this topic.
The Aspects Feature has been added to the projectdoc Toolbox version 4.0 and therefore is available to the Core doctypes since version 12.2.
Properties
The document type metadata provides the following properties:
Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.
Sections
Description
A description of the metadata.
This usually provides information of the type of metadata and possibly where this information has been fetched from (if the source if this information is another information system).
Notes
These are internal notes that are usually not exported and only visible to team members with write access.
But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.
The text of notes sections is also indexed.
References
For a document the references section contains pointers to resources that prove the statements of the document.
Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.
For further information please refer to References and Resources.
Resources
The resources section provides references to further information to the topic of the document.
This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.
For further information please refer to References and Resources.
Details
No Homepages
There are no homepages for metadata documents.
Document instances are supposed to be added as children either as aspects to a documents or to a Version document. They may also be added to other Metadata documents to keep complex metadata modular.
Related Doctypes
- Version
- Document a version of a product or service.
- Maven POM Import
- Import project information from Maven POM files. Provides information about required configuration to get this import running.
Resources
- Using Aspects
- Add a document as a child and automatically make supplied properties and sections available in the parent. A short walk-through to use the Aspect Feature in your information architecture.
- Aspects
- Tools and information elated to the Aspects Feature of the projectdoc Toolbox.
- supply
- Marks a property as importable by other projectdoc documents.