ConfiDoc

Page tree

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

Compare with Current View Page History

« Previous Version 8 Next »

Documentation for the ConfiDoc Plugin for Confluence


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 serviceserviceIdServices are defined by the Confluence administrator using the plugin's configuration screen
Root elementrootApply additional filters to the returned JSON data using field names as inputs
Sorting/OrderingsortSee examples below
FilterfilterApply a filter on returned data; see examples below
Cache resources locallyuseCacheRequest 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 dialogenableLookupUsers will be able to configure their own parameters for a configured service request
Define configuration parameterslookupLabelsDefine 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 buttonlookupBtnLabelProvide 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 namenameThe name of the field in the returned data to be displayed by the TableView or ListView macros
Field labellabelThe label for the field to be displayed inside the table or list
Field typetypeChoose the field type from these supported formats:
  • Link
  • Date
  • Number
  • Image
  • 'as-is' (blank: the value will be shown without transformation)
Input formatinputFormatDefine 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 formatoutputFormatDefine the transformation rules for Output to be applied to data in the Input format (above)
CSScssDefine CSS rules to be applied on returned data in a rendered field
Access controlrestrictionsControl 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

Use this macro to include in the Confluence page the HTML or binary content (such as images) from an external webserver

Name of the serviceserviceIdServices are defined by Confluence administrators with the ConfiDoc plugin configuration
SelectorrootA 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 locallydownloadResourcesDownloads external resources (such as images) to the Confluence server and adds them as attachments to the page.
Cache resources locallyuseCacheStore 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 TypecontentTypeForce ConfiDoc to use the given content type
Custom CSS stylescssCustom CSS rules to apply on the rendered element
Include astype

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)
CaptiondownloadBtnLabelWhen the content to be loaded is binary, a download link will be rendered; this parameter sets the label on that link

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)anchorIdYou 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 torestrictionsComma-separated list of usergroup names/usernames

ConfiDoc Globals

confidoc-globals

Convenient way to store and show global variables in Confluence

Variable namevarsVariable 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 matchconditionYou 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 namefieldNameName 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 metcssCSS 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).

Operators AND and OR are case-sensitive!

Supports not notation, to filter records that do not match the given filter: '!' is used for that. Example: !f1:[empty] - will look for records where f1 field value is not empty (has some value)

Supports simple ariphmetic operations on dates (to add or substract days from today's date). See examples below

Valid example: (f1:*success AND f2:>[yesterday]) OR (f3:accepted) - matches records with field values having 'success' and where f2 field value is after yesterday or where f3 filed value is equals to 'accepted'

Valid example: (f1:*success AND f2:>[today]-1) OR (!f3:[empty]) - matches records with field values having 'success' and where f2 field value is after yesterday or where f3 field value is not empty

Invalid example: (f1:*success AND (f2:>[yesterday] OR (f3:accepted)). As ConfiDoc does not support inner brackets in expressions (yet)

Reserved words to use in expressions:

[empty]To match empty values for particular field. Example: field1:[empty] - will match records where field1 is empty (does not have a value, but the form defines this field)
[now]Current time and date, useful with '<' and '>' for comparing with dates stored. Example: someDateField:<[now] - will match records where field 'someDateField' has value which is in the past compared to now (current time)
[today]Same as [now], but without time
[tomorrow]To compare against tomorrow's date. Also something like [today]+1 could be used instead
[yesterday]To compare against yesterday's date. Also something like [today]-1 could be used instead
'<' and '>'Can be used together with date and datetime fields, as well as to compare values for numeric fields stored
!To reverse the filter condition. Example: !field1:[empty] - will find records that have 'field1' field filled

Some examples:

  • 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

Supports ASC and DESC directions, syntax is similar to SQL syntax, and the ordering rules must be coma separated.

Order directions ASC and DESC are case-sensitive!

To limit the number of records returned a LIMIT operator is used.

Example: f1 ASC, f2 DESC - will sort the dataset by f1 field values in ASC order and by f2 in DESC order

Example2: f1 ASC, f2 DESC LIMIT 2 - will sort the dataset by f1 field values in ASC order and by f2 in DESC order and limit the number of records returned to 2

Example3: LIMIT 2 - will limit the number of records returned to 2

  • No labels