Versions Compared

Key

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

...

Section
show-titlefalse
titleDescription

If you need to render a Confluence page dependent on the context of the caller, one form of implementation is to respond to the reader's request. This feature of the PDAC1 for Confluence is called Remote Controlled Document.

The configuration of many macros of the projectdoc Toolbox can be controlled by providing a HTTP query string to the page URL pointing to a page.

Example Box
titleControl Query

For instance the Display Table Macro is used to list projectdoc document references according to specified query criterias. Therefore it works similar to the Page Properties Report Macro provided by Confluence. In contrast it provides Where or Select parameters instead of CQL.

Additionally the Display Table Macro can be remote controlled by adding a HTTP query string to override macro parameters on the targeted page. This effectively changes the query criterias and in consequence the rendered list of documents on that page.


Example Box
titleControl Transclusion

Another example is the transclusion of page fragments which can be controlled by altering parameters of the Transclude Documents Macro or the Transclusion Macro.

As in the previous example these macros expose their parameters to be overridden by parameters of the HTTP query string by the caller. Therefore the caller can again control the contents of the page – i.e. what is transcluded by the macros.

One use case is allowing to render information from a remote information system on a page. A system may render the documentation for error codes by adding context information about the error to the request URL that points to a page on the Confluence server.

Another use case is to render a page from the context of the calling page. With version 2.3.14, the Wiki Link Macro allows to provide request parameters. This way a reader clicking on a link created by this macro has a view on the rendered page that knows the context of the page the reader is coming from. This tip will show this use case in detail.

...