Versions Compared

Key

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

...

Document Properties Marker
doctypetopic
overridefalse


Short DescriptionThe projectdoc Toolbox does not support dynamic values as property values. Use sections to render dynamic values and select the contents of this section instead of property values.
Doctypetopichide

NameNo dynamic Property Values
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
namesTemplate Author
propertyAudience


Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags

Tag List
render-list-as-comma-separated-valuestrue
namesConfluence, projectdoc Toolbox, document, property, value, section
propertyTags

hide
Flagshide
Iteration

Iteration
valuefinished

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 Duration5 min
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide


...

Section
titleSelecting Dynamic Values

The value of a document property must not be dynamic. A dynamic value is a value that is calculated at page request. This is the case for instance if you use the Display Table Macro or the Display List Macro as part of the property value.

Why is this so? Since the property value is added to the Lucene Index to enable users to search for it, a dynamic value would have to be updated whenever a new document is added or an existing document is updated. It has to be checked, whether this new or updated document is part (or no longer part) of the result set of each dynamic value of each document. The projectdoc Toolbox does not do that.

There is a limited support in case you update information from a child or parent document. In this case the existing page is reevaluated and the updated values are written to the Lucene Index. But this probably fails may fail in case of a reindexrefresh / rebuild, where the proper order of document indexing is no defined. Therefore it is recommended not to use dynamic macros as property values.

Note Box
titleMore information on Rebuild Processes?

For more information on refresh and rebuild processes, please refer to 

Static Document Link
documentprojectdoc Rebuild Manual
.

If you need to present those values on a page – you just need to display the value but there is no need to find the document with a query – there is a workaround: Just add the value to a section or content marker in the document body outside the properties table and hide it.

The query (for instance using the Display Table Macro) allows to specify property names as well as section titles in its Select Clause.

Note Box

The full value for the Select parameter is: #N\{$[Name] ${Score} ${Scoring}\}, Short Description

The select value uses a template, named "N" where the Name (rendered with link to the document), the score (a property value) and the scoring (a section value) is rendered. The second value is the short description.

A template is introduced by the hashmark, followed by a name and the template in curly brackets. Please note the backslash to escape the curly brackets of the template boundary. If not escaped then Confluence will revolt. It has some parsing issues when curly brackets are involved. (sad)

With version 5.2 you may also chose to use the 

projectdoc-static-document-link-macro
documentno-property
control for the property with a dynamic value. In this case this property is no longer treated as property and is only rendered for display, but not as a property value. The advantage of this approach is that the information is rendered in the properties table, but it is not rendered with the other properties on refresh / rebuild.


projectdoc-section
titlePrerequisites

...

Section
titleResources


Tour
render-no-hits-as-blanktrue
render-as-definition-listtrue
replace-title-with-nametrue





Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto


...