projectdoc Toolbox

Categorize sections by a type.

ID
section-type
Suite
Documentation Type
Categories
Tags
Target Types
Since
9.0

Use the Section Type to organize Section documents.

Properties

The document type section type 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

Description

Describe the type of a section.

Related Indices

Lists space index documents related to this type.

Every space index that references this type by the property Section Type Constraint is listed in this section. This makes it easier for readers to navigate to related information by browsing.

Since 11.1

 

This section is available since version 11.1.

Subordinate Types

Group section types by putting them in a hierarchy.

Sections of this Type

An overview over sections of this type.

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

Here is a list of related doctypes that define types for categorization of document instances:

NameShort DescriptionSetTarget Types
Association Type
Categorize associations by a type.
CoreAssociation
Category Type
Categorize categories by a type.
CoreCategory
Charter Type
Categorize charters by a type.
CoreCharter
Excerpt Type
Categorize excerpts by a type.
CoreExcerpt
Experience Level
Defines the context through which readers acquire skills. The level sets the expectation on the author's techniques to teach.
CoreTopic
Experience Level Type
Categorize experience levels by a type.
CoreExperience Level
FAQ Type
Categorize FAQs by a type.
CoreFAQ
Generic Type
Categorize generic documents by a type.
CoreGeneric
Glossary Item Type
Categorize glossary items by a type.
CoreGlossary Item
Media Type
Resources are identified by their media type. This may be the MIME type, but also a human readable string, that identifies the syntactic format.
CoreResource
Media Type Type
Categorize media types by their type.
CoreMedia Type
Core
Module Type
Categorization of document modules for single sourcing.
CoreModule
Organization Type
Categorize organizations by a type.
CoreOrganization
Person Type
Categorize persons by a type.
CorePerson
Profile Type
Categorize profiles by a type.
CoreProfile
Quote Type
Categorize quotes by a type.
CoreQuote
Relation
Organizes glossary items.
CoreGlossary Item
Relation Type
Categorize relations by a type.
CoreRelation
Resource Type
Resources are identified by their type. This is not the MIME type, but human readable string, that identifies the semantic, rather than the syntactic format.
CoreResource
Role Type
Categorize roles by a type.
CoreRole
Space Index Type
Categorize space indexes by a type.
CoreSpace Index
Stakeholder Type
Categorize stakeholders by a type.
CoreStakeholder
Step Type
Categorize steps by a type.
CoreStep
Subject Type
Categorize subjects by a type.
CoreSubject
Tag Type
Categorize tags by a type.
CoreTag
Topic Type
A topic type is a semantic type of the topic. It helps to set the expectations of potential readers.
CoreTopic
Version Type
Categorize versions by a type.
CoreVersion