...
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 |
---|
|
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 |
---|
|
ConfiDoc Excerpt confidoc-excerpt | Macro Use this macro to include in the Confluence page the HTML or binary content from any webserver inside your Confluence page(such as images) from an external webserver Name of the service to use | serviceId | Services are defined by Confluence administrators using with the ConfiDoc plugin configuration |
---|
Selector | root | A CSS-like selector, but limited to a form: element attribute="value".
To select elements by name - just give a tag name. Example: div - , give the element's name; for example: div will select all the divs from in the page To select all div elements in the page with 'the myclass ' class name, use: div class="myclass" |
---|
Download and cache resources (images) locally | downloadResources | Downloads external resources locally, (such as images) to the Confluence server and adds them as attachments to the page. |
---|
Cache resources locally (30 minutes, by default) | useCache | You Store requests are cached locally , in the Confluence cache . Useful when you want to improve page-loading times and to reduce the number of requests to external serversservers (default cache duration is 30 minutes) |
---|
Content Type | contentType | Will force Force ConfiDoc to use the given content type |
---|
Custom CSS styles to apply on rendered element | css | Custom CSS styles rules to apply on the rendered element |
---|
Include as | type | What goes here? Is this like 'type' above? Choose how the returned data should be included from these supported formats: - Link
- Date
- Number
- Image
- 'as-is' (blank: the value will be shown without transformation)
|
---|
CaptionCaption 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; this parameter sets the label on that link |
---|
|
ConfiDoc Excerpt Anchor confidoc-excerpt-anchor | The 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 | 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 |
---|
|
Using filters
Uses Lucene like syntax for expressions, supports grouping using brackets (at the moment no support for inner brackets). Supports filtering for expressions that start with a wild-card. Supports filtering per field as well as free text search (filter to match against any field value).
...
- field1:[today]-5 - assuming field1 is of type date (or datetime) this filter will return records where field1 value is not older than 5 days from now
- field1:[today]+10 - assuming field1 is of type date (or datetime) this filter will return records where field1 value is not after 10 days from now
Using sorting and limiting the number of records returned
...