Versions Compared

Key

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

...

Section
Column
Document Properties Marker
overridefalse
Short DescriptionStarting with the projectdoc Toolbox might be intimidating at first. So start small using the basic features and add what is needed, when it is needed. 
Doctypetopichide
NameThink big, start small 
Parent
Parent Property
propertyParent
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 
Level of Experience

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

 
Expected Duration20 min 
Subject
Name List
doctypesubject
propertySubject
 
Categories
Name List
doctypecategory
propertyCategories
 
Tags

Tag List
render-list-as-comma-separated-valuestrue
namestutorial, projectdoc, add-on, Confluence, Atlassian
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
 
Sort Keyhide
Section
show-titlefalse
titleDescription

This There is the only just one rule to follow to always have the full potential of the toolbox ready to be unleashed:

Panel
titleColorwhite
titleBGColordarkgreen
titleThe one rule

To get
the full potential of the projectdoc Toolbox
make sure that
every Confluence page is a projectdoc document

This needs just To follow this rule you need just these two macros:

  1. Document Properties Marker Macro
  2. Section Macro

This short tip shows what a projectdoc document is, how it can be created with those two macros and provides some tips to new users on how to continue working with the PDAC1.

Column
width30%
Panel
titleContents

Table of Contents
indent20px
stylenone

...

Section
titleprojectdoc Document

A projectdoc document has properties and sections.

Section
titleProperties

Properties are defined You define properties within the Document Properties Marker Macro in a three-column table.

The first column contains the name of the property, the second the value. The third column stores controls that influence the value in a given context. For instance, the hide control will suppress the rendering of the property within the table.

Think of properties as data and metadata of the document. Properties do not need to be simple values. Typical properties are short description, subject, and categories. They may also contain an image, like a project icon. For specific documents, like a user story, there may be properties like the story points or the business value of that story.

Tip Box

You may hide individual properties or the whole table at once, if you do not need some or all metadata on the top of the page.

Use the hide parameter of the Document Properties Marker Macro to hide the whole table.

Please note that hidden information is still on the page and can be accessed by anyone with access rights to the page. Therefore it must not contain sensitive information!

Section
titleSections

Sections form the body of a document. Sections consist of a title (which can be hidden) and text. Sections may be nested and are defined with the Section Macro.

 

For Confluence pages authors typically add headings and text without additional macros. This is fast and easy. So why should one you bother with sections?

If authors need to have the content accessible through transclusion, they need to mark it. Confluence provided the Excerpt and the Excerpt Include Macro for this. projectdoc takes this idea to the extreme and recommends to put any content inside a section. The title of the section is the default identifier to be used by the Transclusion Macro and the Transclude Documents Macro. The first macro allows multiple transclusions from one specified document while the latter allows multiple transclusions from multiple documents that are identified by a query.

Tip Box

The use cases for these macros may not be obvious at first sight. Here is one example use case for each of the two macros.

Transclusion Macro: A decision document may contain information about what has been decided, the reasons for the decision and a list of alternatives. Besides this there may be further sections containing detailed information, why a particular alternative has been rejected. It may also list the experts that decided and reference material they used to decide. In an overview document an author may only be interested in the decision, the reason, and the list of alternatives. The Transclusion Macro allows to do that.

Transclude Documents Macro: Assume the last use case but now you want to list the information of all decision documents that are tagged with the term "software architecture". The Transclude Documents Macro will fetch each matching document and renders only the sections containing the decision, the reason, and the list of alternatives.

...