You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

projectdoc Toolbox

Using sections and modules to organize and reference content.

Audience
Type
Level of Experience
Expected Duration
15 min

The projectdoc Toolbox provides tools to create a modular documentation. This short tip provides a brief introduction.

Sections

projectdoc documents are defined by properties and sections. A section is typically defined by the Section Macro. Such sections can be referenced, but require the fragment identifier to do so. In order to modularize a document, sections can be added by the use of the Section Doctype and transcluded by a transclusion macro – either one-by-one using the Transclusion Macro or the Transclude Documents Macro. The section documents are typically stored as child documents to the transcluding document. Therefore the Transclude Documents Macro allows to create a document divided into section documents easily. In addition to that these section documents ca be referenced more easily.

Modules

The Module Doctype's main and only purpose is to define content to be used for transclusion. Typically it has a section for the content to be transcluded. All other sections and all properties are used to categorize the module and add references to related information. The Module Doctype also provides a section that lists all documents that transclude content from the document instance.

As with the Section Doctype, transclusions are easy with macros from the projectdoc Toolbox.

Topics and Tours

The Topic Doctype is used to document a topic. In contrast to the Section Doctype the topic is a document on its own. In contrast to the Module Doctype the topic's main purpose is not designed primarily for reuse. Use the Tour Doctype to organize topics in a single document.

Resources

More information on modularization.

Modular Documentation
Use rich multi-excerpts (transclusion) for content reuse - even from page result lists. Replace parameters in excerpts. Include properties and sections from pages. Hide content dependent on roles and properties.
Module
A 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.
Section
Sections of a document are typically part of a document. But the size of sections may vary. To support a team to write collaboratively on the documentation, a larger document may be subdivided into external section documents.
Transclusion
Tools to provide or consume content to support reuse.
Modular Documents
Tools (especially doctypes) that support the modularization of documentation.

  • No labels