Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: typos
Section
Column
Document Properties Marker
overridefalse
Short DescriptionCategories provide easy navigation. The category page documenting the category automatically lists all documents tagged with this category. A defined set of categories has per default no such homepage.
Doctypetopichide
NameNavigating Documentations
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesDocumentation Architect, Documentation Gardener, Template Author, Author
propertyAudience


Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags

Tag List
propertyTags


Flagsprojectdoc Toolbox, Confluence, navigationhide
Iteration

Iteration
valuefocused

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
propertyType

Level of Experience

Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesCompetent
propertyLevel of Experience


Expected Duration
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide
Column
width300px
Panel
titleContents

Table of Contents
indent15px
excludeResources
stylenone

...

Section
titleNavigating by one Type Property

Navigating by a single type property is straight forward: the property is a link to tth the type, rendered with the document it belongs to.

Section
titleStandard Categories

The projectdoc Toolbox provides a number of standard categories that are supported by all doctypes.

Tour
header-translationsTitle=Doctype
TitleShort DescriptionProperty
Subject
Subject
Category
Categories
Tag
Tags

Each document instance of these types provide a section named 'Documents' that lists all documents associated with a given category.

Example Box

The document of type Tag named 'Security' describes what this tag is for and lists documents of any doctype that are categorized with this tag.

Section
titleDoctype-specific Types

Typically all doctypes provide a property named 'Type' to reference an instance of a doctype type document. These types are doctype-specific. That is in contrast to the standard categories shown above that are provided by all doctypes, these doctype-specific types are only supported by a single doctype.

Type doctypes typically also provide a section named 'Documents' to list documents of the given type.

Example Box

A document of doctype Topic Type lists documents of doctype Topic, if their Type property matches the name of the topic type.

Section
titleOther Doctypes

All doctypes can be used to categorize documents. The use of Role or Experience Level may seem more natural to categorize documents than Resource or Stakeholder. But ist it basically depends on the information model which categories make sense and which do not.

...

Section
titleResources
Tour
render-as-definition-listtrue
replace-title-with-nametrue
Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto