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.
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:
Sections
Description
The description section of a document informs about its content and intention. This is a descriptive abstract, similar to a table of contents, and a longer form of the Short Description document property.
The description helps potential readers to decide, whether or not relevant information can be found in the document.
Since the location of this section typically makes the intention of the text obvious, the section title may be hidden. For more information please refer to No need to render the Section Title in Tips.
Summary
Summarize the key findings or essential information of the document. This is the informative abstract, while a Description contains the descriptive abstract.
The summary helps readers to get informed about the key points in a short section. It is also a tool to help readers of the document to recall the contents without scanning the whole document.
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.
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.
