You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
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.
Description
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.
To aggregate documents use the topic documentation type. Topics may then themselves, together with other document types, be assembled by Tour documents.
Properties
The document type module provides the following properties:
Type
The Module Type allows to organize modules by type.
Sections
Description
Describes the intention of the module and how to use it. Use if the short description is not enough.
Summary
Typically there is only a summary in a module document. Therefore this section contains the content to be transcluded.
Use the id of "Summary" for reference using the Transclusion Macro or Transclude Documents Macro.
Summary
Typically there is only a summary in a module document. Therefore this section contains the content to be transcluded.
Use the id of "Summary" for reference using the Transclusion Macro or Transclude Documents Macro.
Subordinate Modules
Helps to organize documentation modules hierarchically. This is helpful if there are different pieces of information that a closely related.
Transcluded By
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.
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.
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.
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.
