Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionUse
Single Sourcing & Transclusion
rich multi-excerpts (transclusion) for content reuse - even from page result lists. Replace parameters in excerpts. Include
document
properties and sections from
other
pages
easily
.
Show/
Hide content dependent on roles and properties.
 

Doctypetopichide
NameModular Documentation
 

Parent
Parent Property
propertyParent
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

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

Expected Duration
 

Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
propertyTags
 

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

Sort Key0020hide
Section
titleDescription

Section
show-titlefalse
titleSummary

Writing modular documentation is not an easy feat. Creating a long document is easier than a short one. Trapping one information in one topic is hard. Creating a documentation based on lots of topics is for skilled writers. In a project environment, where we create documentation by the team for the team, we are not looking for perfection. Still we need tools to organized the information in topics of different sizes and employ tools to help us to reuse this information.

Transclusion also helps to create documents independently. A team working on a task may create a document collaboratively by writing each chapter of the document in individual topics. These chapters may further be divided into sections, each on its own wiki page. The document is assembled of all these parts by transclusion. Once a fragment on a page is changed, the changes are reflected immediately on the transcluding document. This document can be exported easily.

...