Provide more detailed information about a component of a tool.
Typically a user does not need to get into too much detail to employ a tool such as a macro or blueprint. But sometimes it is valuable to provide some more detailed information about a part of this tool. Add this document as a child document to the tool it provides information about.
Properties
The document type app-component provides the following properties:
Type
Declare the type of this component. This information is used for categorization and allows to collect all components on the referenced type page.
Suite
Specify the suite of tools the macro belongs to. Typically inherited from the parent document.
Sections
Description
Describe the component and its relevance for the user.
Subordinate Components
Provide information of subordinate components if this is relevant to the user of this component.
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.
