projectdoc Toolbox

Document the usage of a document section for your users.

Categories
/ Doctype / API
ID
document-section
Suite
Since
1.0

Sections structure the body of documents. Typically these are child documents of a doctype document. Sections that are used by more than one doctype are detached and stored on the section doctype homepage.

Properties

The document type document-section 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.

Type

Declare the type of this document section. This information is used for categorization and allows to collect all document sections on the referenced type page.

Content

Since

Specify since which version this feature is available.

Deprecated

Specify since which version this feature is marked as deprecated.

Removed

Specify since which version this feature has been removed.

Sections

Description

Provide a description what the document section is about. Limit this description to one to three paragraphs.

Details

Provide further information about the section and maybe provide usage examples.

Subordinate Document Sections

Provide information about subordinate document sections.

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.