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
namesTransclusion
propertyTags

 
hide
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.

Section
titleBuilding Blocks

The building blocks of a modular documentation are documents. The building blocks of documents are properties (defined by the Document Properties Marker Macro) and sections (defined by the Section Macro).

The projectdoc Toolbox allows to reuse these building blocks - properties and sections - easily with the Transclusion Macro and Display Document Property Macro.

You may even replace placeholders in the content while transcluding.

Tip Box

The tip Content Reuse provides an overview over the transclusion or excerpt features of the PDAC1.

Section
titleTransclusion made easy

Why easily? Suppose an author transcludes content from another page. In view mode the transcluded content is highlighted. By clicking on the name of the document at the top-right of the box, the author is able to jump to the page quickly. If clicking on the edit icon (pencil), the document is opened for editing with one click.

For performance reasons the fragments may be cached. In this case every transcluded content shows the last updated date and an icon to refresh the content from the cache (although the system typically recognizes stale content quickly).

Note Box
titleTools for Writers only

Note that these tools are only available for authors since readers typically have no interest in getting informed about content reuse.

If an author is interested in where a particular content is used, the information can be displayed on the page easily.

The projectdoc Toolbox also provided macros to make these sections only available for authors. But note that the content is only hidden and therefore not secure.

Panel
titleTransclusion in action!
Transclusion
documentSecurity Note for Hide Macros
idsbox

For more information on transclusion, please refer to Use Display Table for Transclusion References.

Tip Box

Just in case if you are bothering about transcluding content with inadequate section levels. Do not bother. The transclusion macros of the projectdoc Toolbox take care of adjusting the levels of the sections to the target level. For Confluence 5.8 and up this can even be done automatically!

Since version 1.10 of the projectdoc Toolbox you may even transclude tagged content from a document automatically and add additional sections and properties to the transcluding document. This feature is called delegate document. The delegate document is defined with the Document Properties Marker Macro.

...

Section
titleResources
Section
titleMore Information on Transclusion
  • Display Properties
    documentContent Reuse
  • Display Properties
    documentUse Display Table for Transclusion References
  • Display Properties
    documentExcerpt and Transclusion
  • Display Properties
    documentMACPLAY:Working with Transclusions
  • Display Properties
    documentRemote Transclusion
Section
titleTransclusion Macros

Define content to transclude

  • Display Properties
    documentSection Macro
  • Display Properties
    documentContent Marker Macro
  • Display Properties
    documentDocument Properties Marker Macro

Transclude text blocks

  • Display Properties
    documentTransclusion Macro
  • Display Properties
    documentTransclude Documents Macro
  • and many more to transclude content from outside the wiki ...

Transclude properties

  • Display Properties
    documentDisplay Document Property Macro
  • Display Properties
    documentDisplay Document Properties Macro
  • and many more specialized versions ...