Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Documentation for ConfiDoc plugin for Confluence

ConfiDoc TableView

Macro to visualize your REST service content (or RSS, CSV, XML) as table, with filtering and data sorting/ordering

Name of the service to useServices are defined by Confluence administrators using ConfiDoc plugin configuration
Root element to useUse it when you need an additional filter over returned JSON. Accepts field names as an input.
Sorting/OrderingSee examples below
Filter to apply on returned dataSee examples below
Cache resources locally (30 minutes, by default)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
ConfiDoc ListView

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 useServices are defined by Confluence administrators using ConfiDoc plugin configuration
Root element to useUse it when you need an additional filter over returned JSON. Accepts field names as an input.
Sorting/OrderingSee examples below
Filter to apply on returned dataSee examples below
Cache resources locally (30 minutes, by default)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
ConfiDoc CardView

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 useServices are defined by Confluence administrators using ConfiDoc plugin configuration
Root element to useUse it when you need an additional filter over returned JSON. Accepts field names as an input.
Sorting/OrderingSee examples below
Filter to apply on returned dataSee examples below
Cache resources locally (30 minutes, by default)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
ConfiDoc Field

Macro to define a field to show within ConfiDoc TableView or ConfiDoc ListView macros.

Field nameName of the field to show (based on the data returned by ConfiDoc TableView or ConfiDoc ListView macros)
Field labelLabel to use, when showing this field inside the table
Choose type for the fieldThere is a set of field types supported:
  • Link
  • Date
  • Number
  • Image
Or 'as-is' (blank), so the value will be shown without any transformations, but as-is
Input formatUseful when you have a date values you need to transform in more readable format
Output formatOutput format takes what was prepared by 'Input format' and tries to apply the formatting rules given on this value
CSS to apply on field valueCSS to apply on a rendered field
ConfiDoc Excerpt

Macro to include HTML or binary content from any webserver inside your Confluence page

Name of the service to useServices are defined by Confluence administrators using ConfiDoc plugin configuration
SelectorCSS-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) locallyDownloads external resources locally, and adds them as attachments.
Cache resources locally (30 minutes, by default)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
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)You will be able to reference it from ConfiDoc Excerpt macro using ''div id="AnchorID"'' selector
ConfiDoc Show-For (IF) Macro

Macro shows included content only for given users/user groups

Content is visible only toComma-separated list of usergroup names/usernames
ConfiDoc Globals

Convenient way to store and show global variables in Confluence



CSS Rules for ConfiDoc FieldsHelper macro to use use when you want to show fields visually differently, based on their values
  • No labels