Versions Compared

Key

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

...

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 doctype parameter on the page 'MyPage' in space 'MYS'.

Code Block
confluence/display/MYS/MyPage?my:doctype=code


The list of parameters allowed to override:

  • doctype
  • select
  • where
  • sort-by
  • max-hit-count
  • restrict-to-immediate-children
  • render-counter-column
  • header-translations
  • calc-columns
  • exclude-self
  • space-key
  • space-keys
  • render-no-hits-as-blank
  • render-no-hits-as-blank-text
  • render-mode
  • render-heading-as-link
  • hide-empty-row
  • remove-buttons
  • render-reference-box
  • table-caption
  • suppress-table-heading
projectdoc-box-version
since3.1

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


projectdoc-box-note

Since version 2.4 of the PDAC1 the Wiki Link Macro allows to specify parameters to call a Remote Controlled Document.



Section
titleTemplate Authors

Template authors may wish to reference the value of a property of the document the query is part of. Use ${...} to reference the value of a property.

  • Type = ${Name} - the type property of the documents queried is matched with the value of the name property of the document the query is part of.


...