You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

projectdoc Toolbox

Excerpts are abstracts of information found in a resource, such as a book. If you want to go into more detail for a given resource, there may be multiple excerpts as subpages of the resource document.

ID
excerpt
Suite
Documentation Type
Categories
Tags
Target Type

Description

Excerpts are abstracts of information found in a resource, such as a book.

If you want to go into more detail for a given resource, there may be multiple excerpts as subpages of a document.

Excerpts have their sort key created automatically generated so that they appear in their parent document in the creation order. Also the title contains the parent documents title, to make it more likely that the title is unique within the space.

Properties

The document type excerpt 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 Excerpts

For large excerpts divide them in parts and add them as child pages. This section lists these excepts.

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

Excerpts are usually child documents of resource documents. For important books there may be one (or more) excerpts per chapter. Excerpt documents may also be referenced from other documents or web sites more easily.

Quote

While excerpts contain quotes (usually using the Quote Macro), paraphrases and notes from and about the resource, a quote document only contains only one exact text passage from the resource. It is easier to reference quotes in quote documents than quotes anywhere in another type of document.


  • No labels