Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
overridefalse
Short DescriptionThe projectdoc Toolbox provides a number of features to help teams to reuse content. Content can be transcluded individually or in form of a multitransclude. Authors can even transclude content from multiple documents in the wiki, effectively combining transclusion with automatic lists.
 

Doctypetopichide
NameContent Reuse
 

Parent
Parent Property
propertyParent
property-nameName
 

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Documentation Gardener, Documentation Architect
propertyAudience
empty-as-nonefalse
 

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

Expected Duration30min
 

Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
namesTransclusion
propertyTags
 

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

Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors
 

keywordstransclusion, excerpt, projectdoc Toolbox, tips, multi-excerpt, Confluence, add-on, modular documentation, reusehide
DC.subject
Display Property
property-namekeywords
hide
Sort Keyhide
enable-heading-numberstruehide
Column
width400px
Panel
titleContents

Table of Contents
outlinetrue
indent10px
excludeContent Reuse
stylenone

...

Section
titleDocument as the Building Block

A projectdoc document defines properties and sections. The projectdoc document is the base for most of the macros in the projectdoc Toolbox.

Properties are data and meta data of a document that teams define in tables with the Document Properties Marker Macro and the Document Properties Supplier Macro. This information is transcluded with the Display Document Property Macro and its cousins.

Sections define text to be transcluded by the Section Macro. Sections may have titles. Authors needing to refer to a chunk of content that is not a section use the Content Marker Macro. Content is transcluded by the use of the Transclusion Macro, the Transclude Documents Macro, and some related macros.

Since version 1.11 of the projectdoc Toolbox neither the transcluding document nor the document transcluded from is required to be a projectdoc document. 


Note Box
titleCompare to Confluence Macros

Confluence provides macros that work similar. Here is a short line-up including macros dealing with properties and sections.

While the Confluence macros are easier to use, the macros of the projectdoc Toolbox provide some additional features to make team collaboration and communication a lot easier.

For more information on this topic, please refer to Compare with built-in Features. 


Tip Box
titleTip for an easy Start

To get started with projectdoc we recommend to use the projectdoc Blank Document for your experiments. It provides the basic structure of a projectdoc document with properties and sections.

For more advanced use cases consider to install one or more of the projectdoc doctype add-ons (especially the Core Doctypes). Install the doctype add-ons from the Atlassian Marketplace for free. They are also available on Bitbucket for customization.

...

Section
titleResources

More information on transclusion and related topics:

Tour
replace-title-with-nametrue

The projectdoc Toolbox is  available on the Atlassian Marketplace!

...

Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto