Versions Compared

Key

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

...

Section
titleProperties


Section
titleDocument

Specify the document to fetch the list of document references from.


Section
titleProperties

The names of the properties whose value is a list of document references.

If more than one property is specified, alld all documents are lined up by the name of the first property.


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsSelect


Section
titleTraverse Strategy

Select how the list of document references is traversed.

StrategyDescription
noneNo traversal of references in documents
breadth-firstDocuments are traversed breadth first
depth-firstDocuments are traversed depth first



Transclusion
taget-heading-level*
documentDisplay Table Macro
idsCounter Column


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsHeader Translations


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsCalculation Columns


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsRender no hits as blank


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsNo Hits Text


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsRender Mode


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsHeading Link


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsAdd Link


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsHide Empty Row


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsRemove Template Buttons


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsRender Reference Box


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsCaption


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsNo Table Heading


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsIdentifier


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsContext controlled


...

Section
titleDetails


Section
titleRemote Controlled Documents


Version Box

Remote Controlled Documents are available since version 2.0 of the projectdoc Toolbox.

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




Version Box
since3.1

Since version 3.1 these parameters can also be controlled by the context of the macro.




Section
indextrue
titleRelated macros

Display Table
doctypemacro
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
sort-bySort Key, Name
whereCategories = "Display / Query" OR $<Tags>=[Tour]

...