- Created by Robert Reiner, last modified on 14. Nov 2018
projectdoc Toolbox
Categorization of document modules for single sourcing.
- ID
module-type- Suite
- Documentation Type
- Categories
- Tags
- Target Types
Properties
The document type module type 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
Description of the module type.
This helps authors to select the appropriate type for their document modules.
Related Indices
Lists space index documents related to this type.
Every space index that references this type by the property Module Type Constraint is listed in this section. This makes it easier for readers to navigate to related information by browsing.
Since 11.1
This section is available since version 11.1.
Subordinate Types
Group module types by putting them in a hierarchy.
Modules of this Type
An overview over document modules of this type.
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.
Related Doctypes
Here is a list of related doctypes that define types for categorization of document instances:
| Name | Short Description | Set | Target Types |
|---|---|---|---|
| Association Type | Categorize associations by a type. | Core | Association |
| Category Type | Categorize categories by a type. | Core | Category |
| Charter Type | Categorize charters by a type. | Core | Charter |
| Excerpt Type | Categorize excerpts by a type. | Core | Excerpt |
| Experience Level | Defines the context through which readers acquire skills. The level sets the expectation on the author's techniques to teach. | Core | Topic |
| Experience Level Type | Categorize experience levels by a type. | Core | Experience Level |
| FAQ Type | Categorize FAQs by a type. | Core | FAQ |
| Generic Type | Categorize generic documents by a type. | Core | Generic |
| Glossary Item Type | Categorize glossary items by a type. | Core | Glossary Item |
| Media Type | Resources are identified by their media type. This may be the MIME type, but also a human readable string, that identifies the syntactic format. | Core | Resource |
| Media Type Type | Categorize media types by their type. | Core | Media Type |
| Metadata Type | Categorize metadata documents by a type. | Core | Metadata |
| Organization Type | Categorize organizations by a type. | Core | Organization |
| Person Type | Categorize persons by a type. | Core | Person |
| Profile Type | Categorize profiles by a type. | Core | Profile |
| Quote Type | Categorize quotes by a type. | Core | Quote |
| Relation | Organizes glossary items. | Core | Glossary Item |
| Relation Type | Categorize relations by a type. | Core | Relation |
| Resource Type | Resources are identified by their type. This is not the MIME type, but human readable string, that identifies the semantic, rather than the syntactic format. | Core | Resource |
| Role Type | Categorize roles by a type. | Core | Role |
| Section Type | Categorize sections by a type. | Core | Section |
| Space Index Type | Categorize space indexes by a type. | Core | Space Index |
| Stakeholder Type | Categorize stakeholders by a type. | Core | Stakeholder |
| Step Type | Categorize steps by a type. | Core | Step |
| Subject Type | Categorize subjects by a type. | Core | Subject |
| Tag Type | Categorize tags by a type. | Core | Tag |
| Topic Type | A topic type is a semantic type of the topic. It helps to set the expectations of potential readers. | Core | Topic |
| Version Type | Categorize versions by a type. | Core | Version |
Resources
- Module Types - examples of document instances for use in your project.
