Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
doctypedoctype
overridefalse
Short DescriptionA topic type is a semantic type of the topic. It helps to set the expectations of potential readers. 
Doctypedoctypehide
NameTopic Type 
IDtopic-type 
SetCore 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
 
Documentation Type
Name List
doctypedoctype-type
namesQ1 - Process
propertyDocumentation Type
 
Categories
Name List
doctypecategory
names/ Organisation / Specific
propertyCategories
 
Tags
Tag List
namesCore, Type
 
Target Types
Name List
doctypedoctype
namesTopic
propertyDocumentation Type
 
Iteration
Iteration
valuefilledfocused
hide
Sort Keyhide
Section
indextrue
titleDescription

Grouping topics by type, the topic type also helps readers to set their expectations of the topic document's content.

Typical topic types are:

  • Howto
  • Tutorial
  • Article
  • Tip
Section
titleProperties
Transclusion
documentNote Box referencing common Document Properties
idsBox
No further properties are provided.

Section
titleSections
Section
titleDescription

A

more

detailed description of the topic type.

This helps authors to select the appropriate type for their topics.

Sub

Section
titleSubordinate Topic Types
As usual, this section allows to group topic types, if needed.

Group topic types by putting them in a hierarchy.

Section
titleTopics of this Type

An overview over topics of this type

.Note that this overview is usually limited by the amount of hits per query

.

Transclusion
documentDocument Sections
idsstandard-sections-bottom

...