Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
overridefalse


Short DescriptionA documentation module is a fragment which is usually transcluded by other documents. The lifetime of a module document is independent of the lifetimes of the documents that reference it.
 

Doctypedoctypehide
NameModule
 

IDdocmodule
 

SuiteCore
SetCore
 
hide
Parent
Parent Property
property-nameName
 

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

Documentation Type
Name List
doctypedoctype-type
render-no-hits-as-blanktrue
namesQ1 - Process, Q2 - Project, Q3 - Product, Q4 - System
propertyDocumentation Type
 

Categories
Name List
doctypecategory
render-no-hits-as-blanktrue
names/ Document / Entity
propertyCategories
 

Tags

Tag List
namesCore, Modular Documents, Transclusion

 

Iteration
Iteration
valuefocused
hide
Sort Keyhide



Section
indextrue
show-titlefalse
titleDescription

Single sourcing demands modular documentation. This document type allows to create and store these modules to be reused by transclusion.

The lifetime of a module document is independent of the lifetimes of the documents that reference it. This is different from the Section doctype, where the lifetime of the referencing parent doctype is usually bound to that of the sections.

To aggregate documents use the topic documentation type. Topics may then themselves, together with other document types, be assembled by Tour documents.

...

Section
titleSections


Section
titleDescription

Describes the intention of the module and how to use it. Use if the short description is not enough.


Section
titleSummary

Typically there is only a summary in a module document. Therefore this section contains the content to be transcluded.

Use the id of "Summary" for reference using the Transclusion Macro or Transclude Documents Macro.


Section
Summary
title

Typically there is only a summary in a module document. Therefore this section contains the content to be transcluded.

Use the id of "Summary" for reference using the Transclusion Macro or Transclude Documents Macro.

Section
titleSubordinate Modules

Helps to organize documentation modules hierarchically. This is helpful if there are different pieces of information that a closely related.


Section
titleTranscluded By

Displays all pages (restricted by the referenced spaces) that transclude this module.

Authors who change the content of the module may want to check where the information is transcluded.


Transclusion
documentDocument Sections
idsstandard-sections-bottom


...

Section
titleReferences


Section
titleResources


Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categoryprojectdoc-doctype
Typecore