projectdoc Toolbox

Document the purpose and usage of a page blueprint.

Categories
/ Doctype / API
ID
page-blueprint
Suite
Since
1.0

Properties

The document type page-blueprint 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 page blueprint identifier.

Type

Declare the type of this page blueprint. This information is used for categorization and allows to collect all blueprints 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

 Document the purpose and usage of your page blueprint.

Subordinate Page Blueprints

Provide information for page blueprints that define pages that are added as children to pages created by this blueprint.

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.