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=topic


The list of parameters allowed to override:

  • doctype
  • select
  • where
  • header-translations
  • render-counter-column
  • space-key
  • space-keys
  • separator
  • insert-short-names
  • render-index
  • render-index-access-panel
  • table-caption
  • suppress-table-heading
  • restrict-to-immediate-children
  • render-no-hits-as-blank
  • render-no-hits-as-blank-text


Section
titleDebugging

If a term specified in the body of the macro does not exist, the term is simply dropped. This makes it difficult for long lists to identify missing term definitions.

If the space property 

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

Version Box
since4.12

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



...