Documentation for the ConfiDoc Plugin for Confluence
TableView: ListView: CardView:
| 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.
| ||||||||||||||||||||||||
ConfiDoc Field confidoc-field | This macro defines a field to display returned data within the ConfiDoc TableView or ListView macros.
| ||||||||||||||||||||||||
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
| ||||||||||||||||||||||||
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
| ||||||||||||||||||||||||
ConfiDoc Show-For (IF) Macro confidoc-show-for | Macro shows included content only for given users/user groups
| ||||||||||||||||||||||||
ConfiDoc Globals confidoc-globals | Convenient way to store and show global variables in Confluence
| ||||||||||||||||||||||||
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
|
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