You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 4
Next »
Document the purpose and usage of a page blueprint.
Properties
The document type page-blueprint provides the following properties:
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.
Sections
Description
Document the purpose and usage of your page blueprint.
Properties
Provide information about the purpose and usage of each of the page blueprint's properties.
Sections
Provide information about the purpose and usage of each of the page blueprint's sections.
Details
Provide detailed information on using pages of this page blueprint. This allows to give background information on concepts and best practices.
Related Page Blueprints
Provide information on how documents of this page blueprint interact with documents of other page blueprints. You may also provide information on when to use which page blueprint for a given problem.
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.
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.
