You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
Documentation for ConfiDoc plugin for Confluence
ConfiDoc TableView confidoc-table | Macro to visualize your REST service content (or RSS, CSV, XML) as table, with filtering and data sorting/ordering Name of the service to use | serviceId | Services are defined by Confluence administrators using ConfiDoc plugin configuration |
---|
Root element to use | root | Use it when you need an additional filter over returned JSON. Accepts field names as an input. |
---|
Sorting/Ordering | sort | See examples below |
---|
Filter to apply on returned data | filter | See examples below |
---|
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 |
---|
Show lookup dialog for service | enableLookup | Users will be able to set own parameters for configured service request |
---|
Labels to use for lookup parameters | lookupLabels | Key-values, separated by & (as in URL), where key - is parameter name, and value is the text you want to use as label |
---|
Caption for action button in lookup dialog | lookupBtnLabel | |
---|
|
ConfiDoc ListView confidoc-list | Macro to visualize your REST service content (or RSS, CSV, XML) in WYSIWYG view (also supports filtering and data sorting/ordering) Name of the service to use | serviceId | Services are defined by Confluence administrators using ConfiDoc plugin configuration |
---|
Root element to use | root | Use it when you need an additional filter over returned JSON. Accepts field names as an input. |
---|
Sorting/Ordering | sort | See examples below |
---|
Filter to apply on returned data | filter | See examples below |
---|
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 |
---|
Show lookup dialog for service | enableLookup | Users will be able to set own parameters for configured service request |
---|
Labels to use for lookup parameters | lookupLabels | Key-values, separated by & (as in URL), where key - is parameter name, and value is the text you want to use as label |
---|
Caption for action button in lookup dialog | lookupBtnLabel | |
---|
|
ConfiDoc CardView confidoc-card | Macro to visualize your REST service content (or RSS, CSV, XML) as card (vertical table), with filtering and data sorting/ordering Name of the service to use | serviceId | Services are defined by Confluence administrators using ConfiDoc plugin configuration |
---|
Root element to use | root | Use it when you need an additional filter over returned JSON. Accepts field names as an input. |
---|
Sorting/Ordering | sort | See examples below |
---|
Filter to apply on returned data | filter | See examples below |
---|
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 |
---|
Show lookup dialog for service | enableLookup | Users will be able to set own parameters for configured service request |
---|
Labels to use for lookup parameters | lookupLabels | Key-values, separated by & (as in URL), where key - is parameter name, and value is the text you want to use as label |
---|
Caption for action button in lookup dialog | lookupBtnLabel | |
---|
|
ConfiDoc Field confidoc-field | Macro to define a field to show within ConfiDoc TableView or ConfiDoc ListView macros. Field name | name | Name of the field to show (based on the data returned by ConfiDoc TableView or ConfiDoc ListView macros) |
---|
Field label | label | Label to use, when showing this field inside the table |
---|
Choose type for the field | type | There is a set of field types supported:Or 'as-is' (blank), 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 format |
---|
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 |
---|
Visible only to groups/users | restrictions | Comma-separated list of group names/usernames this field is visible to. 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 | Macro helps you to group some content inside a block and easily reference later by 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 |
---|
|