Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionAutomatic lists are part of every Confluence instance. Especially the Dashboard lists all recent changes automatically. And there are macros to list documents by label and other properties. The projectdoc Toolbox supports queries on any properties defined for your documents. This allows you to provide lists of references to your readers that are relevant in a given context.
 

Doctypetopichide
NameAutomatic Lists
 

Parent
Parent Property
propertyParent
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

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

Expected Duration
 
10 min
Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
propertyTags
 

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

Sort Keyhide
Section
show-titlefalse
titleDescription

Section
show-titlefalse
titleSummary

Teams who work collaboratively typically need to communicate continuously. New information needs to be published effortless to get team members informed in-time. New members of your team can catch-up quickly. So you typically create a new page, then add the valuable information, and finally continue with the next task from the board.

Being able to release information about what has been recently done in a given context is not only relevant for team, but also for individuals. Think of journals where you track your work, note discoveries, new ideas, or notes for activities to do in the future.

Developer Diary

There is little to no time to add links to pages to make the new document browsable. Therefore the wiki need to add links to this information automatically. Confluence provides a number of macros that allow to render these links. The PDAC1 supports queries on any properties defined for your documents. Template authors use automatic lists for creating new page blueprints.

The macros to support this automatic, sometimes called dynamic, linking are:

  • Display Properties
    documentDisplay Table Macro
  • Display Properties
    documentDisplay List Macro

This is how it works:

On the right side you see the Display Table Macro.

    

The macro parameters allow to specify

ParameterDescription
SelectThe properties of the documents in the result set you want to display.
WhereThe query constraint to select documents with the given properties.
Sort ByThe sorting criteria for the documents in the result set.

So in pseudo syntax, this is what you actually specify:

Code Block
languagesql
SELECT Name  Short Description, Documentation Type, Iteration, Categories
WHERE Tags = "Core"
SORT BY Sort Key, Name

On the left side you see the result of the query in a table.

The Where Parameter allows to specify complex Lucene queries.

Code Block
languagesql
PropertyOne = "Some String" AND 
        (PropertyTwo = "Another String" OR PropertyFive = "Something")

The

Display Properties
documentTransclude Documents Macro
is a cousin of the two macros mentioned above. It also allows you to query for documents. Instead of rendering links, it renders excerpts from the documents in the result list.

...

Section
titleResources
  • Display Properties
    documentSearch Tips
  • Macros to define content to search
    • Display Properties
      documentDocument Properties Marker Macro
    •  
      Display Properties
      documentSection Macro
  • Query macros
    • Display Properties
      documentDisplay Table Macro
    • Display Properties
      documentDisplay List Macro
    • Display Properties
      documentTransclude Documents Macro
Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto