A remote controlled document uses macros that enable to control the content being rendered by request parameters.
Remote documents allow to select the content of the document to be rendered. A remote controlled document uses macros that expose some or all of their parameters to be controlled by query parameters provided with the HTTP request.
This feature is useful for use cases where the content of a page should be controlled by an external information system. A typical use case is to aggregate a page based on an error code. The remote system can reference a remote controlled document on a Confluence server and select the information by providing the error code and some context information.
Supporting Macros
A number of macros from the projectdoc Toolbox support being controlled remotely:
- Display List Macro
- Lists references to projectdoc documents in a list. List contain names and optional short descriptions.
- Display List Template Macro
- Lists references to projectdoc documents in a list. List items are defined by templates referencing properties.
- Display Table Macro
- Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
- Index Entries Table Macro
- Renders a table of index entries.
- Random Transclusion Macro
- Transcludes random content from a document marked with the content marker macro.
- Tour-by-Property Macro
- Renders 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.
- Transclude Documents Macro
- Renders transcluded content fetched from documents of a result set.
- Transclusion Macro
- Transcludes content from a document marked with the content marker macro.
- Transclusion Reference Macro
- Transcludes content via a reference from a document marked with the content marker macro.
- Transclusion to Text Macro
- Transcludes content from a document marked with the content marker macro and renders it as plain text.
Resources
More information on remote controlled documents.
