TableView:
confidoc-table
ListView:
confidoc-list
CardView:
confidoc-card
| The confidoc-table, confidoc-list, and confidoc-card macros are macros 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 |
|---|
|
ConfiDoc Field confidoc-field | Macro to define This macro defines a field to show display returned data within the ConfiDoc TableView or ConfiDoc ListView macros. | Field name | name | Name The name of the field to show (based on in the returned data returned to be displayed by ConfiDoc the TableView or ConfiDoc ListView macros) |
|---|
| Field label | label | Label to use, when showing this field The label for the field to be displayed inside the table or list |
|---|
| Choose Field type for the field | type | There is a set of field types supportedChoose the field type from these supported formats:Or ), so - : the value will be shown without
any transformations, but as-is |
|---|
| Input format | inputFormat | Useful when you have a date values you need to transform in more readable formatDefine 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 | Output format takes what was prepared by 'Input format' and tries to apply the formatting rules given on this value |
|---|
| CSS to apply on field value | css | CSS to apply on a rendered field |
|---|
| 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 | Visible only to groups/users | restrictions | Comma-separated list of group names/usernames this field is visible to. Leave - or user names; leave blank if there are no restrictions |
|---|
|
ConfiDoc Excerpt confidoc-excerpt | Macro to include HTML or binary content from any webserver inside your Confluence page | Name of the service to use | serviceId | Services are defined by Confluence administrators using ConfiDoc plugin configuration |
|---|
| Selector | root | CSS-like selector, but limited to a form: element attribute="value". To select elements by name - just give a tag name. Example: div - will select all the divs from the page To select all div elements with 'myclass' class: div class="myclass" |
|---|
| Download and cache resources (images) locally | downloadResources | Downloads external resources locally, and adds them as attachments. |
|---|
| Cache resources locally (30 minutes, by default) | useCache | You requests are cached locally, in Confluence cache. Useful when you want to improve page loading times and reduce number of requests to external servers |
|---|
| Content Type | contentType | Will force to use the given content type |
|---|
| Custom CSS styles to apply on rendered element | css | Custom CSS styles to apply on rendered element |
|---|
| Include as | type | |
|---|
| Caption for link, when loaded as binary | downloadBtnLabel | When the content to be loaded is binary, a download link will be rendered. This parameter set''s it''s caption |
|---|
|
ConfiDoc Excerpt Anchor confidoc-excerpt-anchor | The macro helps you to group content inside a block and easily reference this block later with the ConfiDoc Excerpt macro | Alphanumeric AnchorID (no spaces) | anchorId | You will be able to reference it from ConfiDoc Excerpt macro using ''div id="AnchorID"'' selector |
|---|
|
ConfiDoc Show-For (IF) Macro confidoc-show-for | Macro shows included content only for given users/user groups | Content is visible only to | restrictions | Comma-separated list of usergroup names/usernames |
|---|
|
ConfiDoc Globals confidoc-globals | Convenient way to store and show global variables in Confluence | Variable name | vars | Variable name |
|---|
|
CSS Rules for ConfiDoc Fields confidoc-field-css | Helper macro to use use when you want to show fields visually differently, based on their values | Field value or expression to match | condition | You can use values or expressions, similar to filters, Filters are very similar in functionality to ConfiForms Filters (the other plugin developed by Vertuna LLC) |
|---|
| Field name | fieldName | Name of the field this rule should be applied on, if left empty then rule is applied on the row |
|---|
| CSS to apply when condition is met | css | CSS to apply when condition is met |
|---|
|