Documentation for the ConfiDoc Plugin for Confluence
Info |
---|
See also tutorials for easy to follow examples on how to use ConfiDoc in different scenarios |
TableView: confidoc-table
ListView: confidoc-list
CardView: confidoc-card
| The confidoc-table, confidoc-list, and confidoc-card macros are used to present the REST service content (or RSS, CSV, XML) as a table, list (WYSIWYG), or card, each with filtering and data sorting/ordering. Name of the service | serviceId | Services are defined by the Confluence administrator using the plugin's configuration screen |
---|
Root element | root | Apply additional filters to the returned JSON data using field names as inputs |
---|
Sorting/Ordering | sort | See examples below |
---|
Filter | filter | Apply a filter on returned data; see examples below |
---|
Cache resources locally | useCache | Request results can be stored locally in the Confluence cache in order to improve page loading times and to reduce the number of requests to external servers; default local cache duration is 30 minutes |
---|
Show service configuration dialog | enableLookup | Users will be able to configure their own parameters for a configured service request |
---|
Define configuration parameters | lookupLabels | Define labels for the configuration dialog using key-value pairs, separated by "&" (as in URL notation), where key is the parameter name, and value is the text to be used as the label |
---|
Caption for configuration button | lookupBtnLabel | Provide a helpful pointer under the configuration dialog submit button |
---|
Set HTML element ID | elementId | Useful, when you want to have a predictable and constant element id in HTML for generated content. Important: "_viewport" will be added to the name |
---|
|
ConfiDoc Field confidoc-field | This macro defines a field to display returned data within the ConfiDoc TableView or ListView macros. Field name | name | The name of the field in the returned data to be displayed by the TableView or ListView macros |
---|
Field label | label | The label for the field to be displayed inside the table or list |
---|
Field type | type | Choose the field type from these supported formats:- Link
- Date
- Number
- Image
- 'as-is' (blank: the value will be shown without transformation)
|
---|
Input format | inputFormat | Define the format in a returned data field in order to reformat using Output format (below), for example, to transform returned date values into more readable form |
---|
Output format | outputFormat | Define the transformation rules for Output to be applied to data in the Input format (above) |
---|
CSS | css | Define CSS rules to be applied on returned data in a rendered field |
---|
Access control | restrictions | Control access to this field with a comma-separated list of group- or user names; leave blank if there are no restrictions |
---|
Set HTML element ID | elementId | Useful, when you want to have a predictable and constant element id in HTML for generated content |
---|
|
ConfiDoc Excerpt confidoc-excerpt | Use this macro to include in the Confluence page the HTML or binary content (such as images) from an external webserver Name of the service | serviceId | Services are defined by Confluence administrators with the ConfiDoc plugin configuration |
---|
Selector | root | A CSS-like selector, but limited to a form: element attribute="value".
To select elements by name, give the element's name; for example: div will select all the divs in the page To select all div elements in the page with the myclass class name, use: div class="myclass" |
---|
Download and cache resources locally | downloadResources | You can: - leave links to external resources "as is"
- download external resources (such as images) to the Confluence server and adds them as attachments to the page
- proxy external resources though local proxy
|
---|
Cache resources locally | useCache | Store requests locally in the Confluence cache to improve page-loading times and to reduce the number of requests to external servers (default cache duration is 30 minutes) |
---|
Content Type | contentType | Force ConfiDoc to use the given content type |
---|
Custom CSS styles | css | Custom CSS rules to apply on the rendered element |
---|
Include as | type | This option provides a way to control how the macro outputs the returned data. Available types include: - Link
- Date
- Number
- Image
- 'as-is' (blank: the value will be shown without transformation)
|
---|
Show service configuration dialog | enableLookup | Users will be able to configure their own parameters for a configured service request |
---|
Define configuration parameters | lookupLabels | Define labels for the configuration dialog using key-value pairs, separated by "&" (as in URL notation), where key is the parameter name, and value is the text to be used as the label |
---|
Caption for configuration button | lookupBtnLabel | Provide a helpful pointer under the configuration dialog submit button |
---|
Caption | downloadBtnLabel | When the content to be loaded is binary, a download link will be rendered; this parameter sets the label on that link |
---|
Set HTML element ID | elementId | Useful, when you want to have a predictable and constant element id in HTML for generated content. Important: "_viewport" will be added to the name |
---|
|
ConfiDoc Excerpt Anchor confidoc-excerpt-anchor | This macro helps you to group content elements inside a block and easily reference this block later with the ConfiDoc Excerpt macro Alphanumeric AnchorID (no spaces) | anchorId | Reference this block from the ConfiDoc Excerpt macro using the ''div id="AnchorID"'' selector |
---|
|
ConfiDoc Show-For (IF) Macro confidoc-show-for | This macro displays included content only for given users and/or groups Content is visible only to | restrictions | A comma-separated list of group names and/or user names |
---|
|
ConfiDoc Globals confidoc-globals | This macro provides a convenient way to store and display global variables in Confluence Variable name | vars | Variable name |
---|
|
CSS Rules for ConfiDoc Fields confidoc-field-css | This is a helper macro to format fields visually based on their values Field value or expression | condition | Use values or expressions in order to match returned data much as you would for filters; ConfiDoc filters are very similar in functionality to ConfiForms Filters (also developed by Vertuna LLC) |
---|
Field name | fieldName | Define the name of the field to which this rule should be applied (if blank, then the rule is applied to the row) |
---|
CSS to be applied | css | CSS to apply when the above condition is met |
---|
|
...