projectdoc Toolbox

Quotes relevant for the project. Allows to store the content and metadata to the quote.

ID
quote
Suite
Documentation Type
Categories
Tags

Description

Quote documents contain a quote that may be easily transcluded from other documents in your wiki. It also allows to collect quotes for authors (on the Person document) easily.

If you only add a quote for one context, you may stick with simply using the Quote Macro.

Properties

The document type provides only standard properties.

Sections

Description

Provides some context for the quote. May also add some information on the relevance of the quote for the project.

Quote

Add the quote here. This is the section that is typically transcluded.

Consider to use one of the projectdoc quote macros that allow you to render quotes consistently within your wiki.

Related Quotes

Quotes related to this one may be added as subordinate documents and automatically listed in this section.

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.

Related Doctypes

Resource

Usually a resource document is referenced by a quote document. Use the Quote Macro for quoting.

Excerpt

The Excerpt Doctype is, like the Quote Doctype, closely associated with the Resource Doctype.

While a quote document provides an exact reference to an information in the document referenced by the resource, the excerpt document may provide quotes, cites and paraphrased texts.

Person

Quotes that reference a person as their author are automatically collected on the author's person document (if such a document exists).