projectdoc Toolbox

Compile other documents, yet space indices are themselves projectdoc documents. So they can be tagged and grouped.

ID
docsection
Suite
Documentation Type
Categories
Tags

Instances for homepages of document types to group and collect document instances. Any page that does not belong a document type, that is is a singular page, may be represented by an instance of the Space Index doctype.

An alternative would be to use a blank page. The Space Index doctype provides document properties to query and display space indices (with their short description) more easily.

Properties

The document type Space Index 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

Subordinate Space Indices

List of space indices related to this subject.

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.