Document the purpose and usage of the app parameters of this type.

Categories: / Doctype / Type
ID: app-parameter-type
Suite: App
Since: 1.0

Types are used to categorize app parameters. The page that defines the type automatically collects and displays the parameters associated with that type.

Properties

The document type app-parameter-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

Document the purpose and usage of the parameters of this type.

Subordinate Types

Automatic list of the subtypes to this type. Subtypes are attached as child pages to this type.

Space Properties of this Type

Automatic list of app parameters 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.