Versions Compared

Key

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

...

Document Properties Marker
overridefalse


Short DescriptionUsing sections and modules to organize and reference content.
Doctypetopichide
NameModularization
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
namesprojectdoc Toolbox, Confluence, Macros, modular, Single Sourcing
propertyTags

hide
Iteration

Iteration
valuefocusedfinished

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
propertyType


Level of Experience

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


Expected Duration15 5 min
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide


...

Section
show-titlefalse
titleDescription

The PDAC1 provides tools to create a modular documentation, supporting Single Sourcing. These tools include doctypes and macros for transclusion.

This short tip provides a brief introduction.

...

Section
titleSections

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.

projectdoc-box-tip
titleStep by step

The Step Doctype is a specialized type of section used to describe a sequence of actions.

Steps can also be listed inside a document by the use of the Steps Macro (as the container) and the Section Macro inside for each steps.



Section
titleModules

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.

Tip Box
titleCategorize

Use the type property to categorize your modules. This may make it easier for authors to organize modules.

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

...

Section
titleTopics 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.

projectdoc-box-tip
titleCategorize

Use the type property to categorize your topics. This may make it easier for readers to find information by browsing.



projectdoc-section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...

Section
titleResources

More information on modularization.

Tour
render-as-definition-listtrue
replace-title-with-nametrue





Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto


...