Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel2
outlinefalse
typeflat
separatorpipe
printablefalse

Overview

Provides information about text values.

Details

Name:

Text Supplier

Prefix:

text(optional)

Supported Content:

Text

Provided By:

Reporting for Confluence

Supported Keys

The following are the list List of keys which that this supplier will return returns a value for.

Key

Content Types

Return Type

Description

size

Text

Number

The number of characters in the text value.

trim

Text

Text

Trims any white space (spaces, tabs, etc) from the text value.

 Trim only works for plain text, and currently does not support Rich text.

lower case

Text

Text

Converts the text to lower case.

upper case

Text

Text

Converts the text to upper case.

first [X]

Text

Text

Trims the text to only include the first X characters.

For example

, "

  • first 10

".

after first [X]

Text

Text

(Since 4.0.0) Trims

Trims the text to only include characters after the first X.

Status
colourBlue
titleFrom v4.0.0

For example

: "

  • after first 10

".

last [X]

Text

Text

Trims the text to only include the last X characters.

For example

, "

  • last 15

".

before last [X]

Text

Text

(Since 4.0.0) Trims

Trims the text to only include characters before the last X characters.

Status
colourBlue
titleFrom v4.0.0

For example

"

  • before last 10

".

url encode

Text

Text

URL-encodes the text value so it is safe to include in a URL.

html escape

Text

Text

Escapes any special HTML characters so they will display correctly in HTML content.

xml escape

Text

Text

Escapes any special XML characters so they will display correctly in XML content.

equals [X]

Text

Boolean

(Since 2.0.0) Tests

Tests if the text equals the 'X' value supplied.

e.g.: "equals Foo Bar".

Status
colourBlue
titleFrom v2.0.0

For example

  • equals Foo Bar

Info

This is case-sensitive.

starts with [X]

Text

Boolean

(Since 2.0.0) Tests

Tests if the text starts with the 'X' value supplied.

Eg. "

Status
colourBlue
titleFrom v2.0.0

For example

  • starts with Foo

".
Info

This is case-sensitive.

ends with [X]

Text

Boolean

(Since 2.0.0) Tests

Tests if the text ends with the 'X' value supplied.

Eg. "

Status
colourBlue
titleFrom v2.0.0

For example

  • ends with Bar

".
Info

This is case-sensitive.

match [X]

Text

Match

(Since 3.1.0) Tries

Tries to match the current complete text value with the specified regular expression.

Status
colourBlue
titleFrom v3.1.0

Info

If successful, a Match is returned.

find [X]

Text

List of Matches

(Since 3.1.0) Tries

Tries to match a subset of the current text value with the specified regular expression.

Status
colourBlue
titleFrom v3.1.0

Info

If there is more than one match in the text value, each will be an item in the returned list.

split with [X]

Text

List of Text

(Since 3.2.0) Splits

Splits the text value into chunks, divided by sub-text that matches the specified regular expression.

Status
colourBlue
titleFrom v3.2.0

as number [X]

Text

Number

(Since 3.2.0) Converts

Converts the text into a Number, using the provided format to parse it.

Status
colourBlue
titleFrom v3.2.0

Info

If no format is provided it will try to parse it as a simple number.

as date [X]

Text

Date

(Since 3.2.0) Tries

Tries to convert the text value into a Date based on the provided format.

Status
colourBlue
titleFrom v3.2.0

is empty

Text

Boolean

(Since 3.2.0) Is true if

Is true if the text value has no characters.

Status
colourBlue
titleFrom v3.2.0

is blank

Text

Boolean

(Since 3.2.0) Is true if

Is true if the text value is empty or all characters are white-space.

...

Status
colourBlue
titleFrom v3.2.0