A documentation module is a fragment which is usually transcluded by other documents. The lifetime of a module document is independent of the lifetimes of the documents that reference it.
Single sourcing demands modular documentation. This document type allows to create and store these modules to be reused by transclusion.
The lifetime of a module document is independent of the lifetimes of the documents that reference it. This is different from the Section doctype, where the lifetime of the referencing parent doctype is usually bound to that of the sections.
The document type module 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.
The Module Type allows to organize modules by type.
Describes the intention of the module and how to use it. Use if the short description is not enough.
Typically there is only a summary in a module document. Therefore this section contains the content to be transcluded.
Helps to organize documentation modules hierarchically. This is helpful if there are different pieces of information that a closely related.
Displays all pages (restricted by the referenced spaces) that transclude this module.
Authors who change the content of the module may want to check where the information is transcluded.
- Module Type - Categorization of document modules for single sourcing.
- Section - Sections of a document are typically part of a document. But the size of sections may vary. To support a team to write collaboratively on the documentation, a larger document may be subdivided into external section documents.
- Topic - A description of a given topic. A topic may describing or explaining a concept, a task to accomplish or a reference. There are a couple of topic types that set the expectations for the reader. Instances of the topic doctype usually have independent lifetimes from any referencing documents.
- Tour - Guided tours through existing information. This allows to aggregate topics for a given question or audience, thus providing a view on a topic.