projectdoc Toolbox

Document the purpose and usage of the macro.

Categories
/ Doctype / API
ID
app-macro
Suite
Since
1.0

Properties

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

ID

Specify the unique macro identifier.

Type

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

Suite

Specify the suite of tools the macro belongs to.

App Tool

Specify the app the macro belongs to.

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

Give a short overview over what the macro is about (very brief) and what information this document provides.

Parameters

Provide information about the purpose and usage of each of the macro''s parameters.

Macro Body

Specify what the macro accepts as content for its body. Leave empty if the macro accepts no body content.

Details

Provide detailed information on using this macro within documents. This allows to give background information on concepts and best practices.

Related Macros

Provide information on how this macro interacts with other macros. You may also provide information on when to use which macro for a given problem.

Subordinate Macros

If a macro is divided in different variants or composed of other macros, mention them here.

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.