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.
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.
In contrast to modules, sections are not intended to be used by other documents (but they may be used by reference or transclusion). The lifetime of a section is, contrary to modules, bound to the lifetime of its parent document. That is, if the parent document, this section is part of, is deleted, so is the section. Modules on the other side are not bound to the lifetime of documents that reference or transclude them.
If you do not want subdocuments to be bound to the lifetime of the parent document, use another doctype, usually Topics.
Properties
The document type section provides the following properties:
Sections
Subordinate Sections
Lists subsections attached as child documents.
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.
Details
Naming
The association of a section document with its parent is by adding the title of the parent document to the title of the section document. This helps to make the document's name unique within the space.
In addition it is usually a subdocument with a parent reference in the document properties section.