Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
overridefalse
Short DescriptionWe like to think of document properties as metadata. But in some contexts it is natural to think of them as data for the entity described by the document.
 

Doctypetopichide
NameDocument Properties as Data
 

Parent
Parent Property
propertyParent
property-nameName
 

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Template Author
propertyAudience
empty-as-nonefalse
 

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

Expected Duration20 min
 

Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
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
 

Since1.11
 

Sort Keyhide
keywordsprojectdoc, properties, sections, transclusion, excerpt, glossary, index, dashboardhide
DC.subject
Display Property
property-namekeywords
hide
enable-heading-numberstruehide
Column
width300px
Panel
titleContents

Table of Contents
outlinetrue
indent10px
excludeDocument Properties as Data
stylenone
 

...

Section
titleUse Case

For this short tutorial we assume that we want to document the information systems that are relevant for our team.

  • We want a dashboard or index page that simply lists all information systems.
  • The information systems will be children of the dashboard.
Note Box
titleWhat about Doctypes?

projectdoc encourages you to define doctypes (that is blueprints with projectdoc documents) for this kind of work. You typically would define a doctype 'information-system' and use its template to document your information systems.

For simplicity, we choose to use the topic doctype for this example. This approach is totally valid in the real world as long as you just want to document a handful of information systems.

Alternatively to using the Topic doctype you could use the Generic doctype and even set the Doctype property to 'team-information-system'. This would not yield all the benefits of a real doctype, but would be sufficient for this small number of document instances.

Section
titleStep-by-Step
Caution Box
titlePrior to Version 1.11?

Before we start please note that this feature is only supported by the PDAC1 with version 1.11 or higher.

You may yield similar results with previous versions. Add the properties to the marker macro (instead of to the supplier) and use the Display Table Macro to show the relevant properties on the information system documents. This is more manual work and you need to adjust the selected properties in the Display Table Macro for each property you add to the marker macro.

The Transclude Documents Macro supports link rendering also since version 1.11. For prior versions you will need to include a property (such as name) to the table to show a link.

Section
titleCreate the Dashboard

We want to locate all descriptions on a dashboard.

Therefore we create a new document and add the Transclude Documents Macro to it.

ParameterValueExplanation
Identifiers-Description,!*We want to select the body of the Description, but without the title. No other sections should be transcluded.
SelectProduct, URLThese are the name of the properties we specify for the information systems. While the identifiers specify the sections to transclude, the Select parameter specifies the properties to be rendered in a table.
Heading Link
Image Modified
This will render the heading (which is the name of the document) as a link to the document.

All other parameters stay with their defaults.

Section
titleCreate an Information System

New create a new document as a child of the dashboard created in the first step.

Property / SectionContent
NameArtifact Server
Short DescriptionRepository for artifacts of our projects.
DescriptionThe artifact server stores artifacts required by our projects and the artifacts produced by out projects.
Access Information
Image Modified

Name and Short Descriptions are properties, Description and Access Information are sections. Within the Access Information section use the Document Properties Supplier Macro and add a two-column table to it. The keys (make sure to mark the first column as the table head!) are added to the first, the values to the second column.

Repeat this for one or more additional systems.

Section
titleView the Dashboard

After adding three topic documents to describe information systems, the dashboard looks like this.

Each system is rendered with its name as heading, the data of the information system in the table and the description without the section title.

Tip Box
titleSeparate Link

If clicking on the heading is not intuitive enough or is not allowed by your style guides, you may create an extra link to the document.

Set the "Add Link" property to the value "More ..." to get the following result.

...

Section
titleResources

Related information.

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

Document Properties Marker Macro
 

Document Properties Supplier Macro
 

Content Reuse
 

The projectdoc Toolbox is  available on the Atlassian Marketplace!

Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto