Versions Compared

Key

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

...

Document Properties Marker
doctypemacro
overridefalse


Short DescriptionRenders a predefined list of documents in a table . Documents are selected by a document property. Allows to select document properties for columns. Also non-list representations are provided.
Doctypemacrohide
NameTour-by-Property Macro
Parent
Parent Property
property-nameName

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

Categories
Name List
doctypecategory
namesDisplay / Query

Tags

Tag List
cssprojectdoc-compact
namesProperty Value Transclusion, Tour, Remote Control, Deep Link, Context Control, Remote Controller


Type

Name List
doctypemacro-type
namesContent Reuse


Iteration

Iteration
valueproduction

hide
Since1.16
Supports Wiki Markup(tick)
Sort Keyhide


...

Section
titleDetails


Section
titleRemote Controlled Documents

Remote Controlled Documents allow to control the content at request time. A HTTP request may override parameters of the macro. A request parameter addresses a macro by its identifier. After the identifier the name of the parameter is appended, separated by a colon.

Example Box
titleOverride Parameters

Assume that the identifier of the macro is set to 'my', the following call will override the property parameter on the page 'MyPage' in space 'MYS'.

Code Block
confluence/display/MYS/MyPage?my:property=Help


The list of parameters allowed to override:

  • document
  • property
  • select
  • traverse
  • render-counter-column
  • header-translations
  • calc-columns
  • render-no-hits-as-blank
  • render-mode
  • render-heading-as-link
  • render-link-label
  • hide-empty-row
  • remove-buttons
  • render-reference-box
  • table-caption
  • suppress-table-heading

These parameters can also be controlled by the context of the macro.


Section
titleDebugging

This macro renders information from names read from a given property. If that name is not referencing a projectdoc document then this name is simply dropped. This may be considered a configuration issue.

together with the page coordinates (space key, title, identifier) 

If the space property 

Static Document Link
documentDebug Mode
is set to true, then – depended on
Static Document Link
documentDebug Access Mode
– an error box is rendered that lists all undefined terms.

Version Box
since4.13

This feature is available since version 4.13 of the projectdoc Toolbox.



...