Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
doctypedoctype
overridefalse
Short DescriptionA description of a given topic. A topic may describing or explaining a concept, a task to accomplish or a reference. There are a couple of topic types that set the expectations for the reader. Instances of the topic doctype usually have independent lifetimes from any referencing documents. 
Doctypedoctypehide
NameTopic 
IDtopic
SuiteCore 
SetCore hide
Parent
Parent Property
property-nameName
 

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
 

Documentation Type
Name List
doctypedoctype-type
namesQ1 - Process, Q2 - Project, Q3 - Product, Q4 - System
propertyDocumentation Type
 

Categories
Name List
doctypecategory
names/ Document / Entity
propertyCategories
 
Tags
Tag List
namesCore, Modular Documents, Allrounder
 
Iteration
Iteration
valuefocused
hide
Sort Keyhide

...

Section
titleSections
Section
titleDescription
Transclusion
documentDescription
idsDesignationDescription

Section
titleSummary
Transclusion
documentSummary
idsDesignationDescription

Note Box

This section has formally been called 'Abstract', but has changed for 'Summary' to be used by different doctypes.

Section
titlePrerequisites

Expected knowledge of the user or a list of documents suggested to be read before this one.

Tip Box

The title is not very inviting for readers. You may change the title to something like "Before you start" or "Check this out first", whatever best matches the tone your audience expects. To select this topic with transclusions you may still define an identifier of tag 'Prerequisites' in case you have to show topics for different audiences in an overview, using the Display Table Macro.

Section
titleSubordinate Topics

A larger topic may be broken down into individual subtopics.

Other than Section documents, subtopics may have an independent lifespan and may recognized as relevant standing on their own. If the subtopics do not satisfy this requirement, you may choose to break the topics into sections instead of subtopics.

Transclusion
documentDocument Sections
idsstandard-sections-bottom

...

Section
indextrue
titleRelated Doctypes
Section
titleTours

Tours are used to aggregate other document instances, especially topics. They are of a means to take an alternative walk through the documentation.

Section
titleSection

Sections do not stand for their own. That is, if the parent document is removed, section documents are also removed (or their information is moved to other documents where the fit better according to recent understanding).

Section
titleModule

Modules help to create modular content for single sourcing. These modules are transcluded by topics (and instances of other document types).

Section
titleGeneric

A generic document is like a topic, but has no default storage space. It is usually a related to another document. Use this doctype if you do not want the document instance show up in an index.

Typically you should either select Topic 62062623 or Section instead of a generic document.

Section
titleTopic Type

Besides the generic organization types Subject, Category, and Tag this type-specific category allows to create additional views on the set of topics.

...

Section
titleReferences

Section
titleResources

Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-doctype
Typecore