between

Purpose

Finds a text fragment between arguments.

Syntax

between(argument_1, argument_2)

Arguments

The function accepts two arguments. The function also accepts the following optional named arguments:

  • endpoint:=yes/no/left/right (set to "no" by default). Includes in the result both arguments/left argument/right argument respectively.

  • scope:=text/sentence/paragraph/line. Allows to search within a sentence/paragraph/line.

  • allow_punct:=yes/no allows or prohibits punctuation between arguments (set to "yes" by default).

  • match:=first/last/shortest/longest matches the first/last/shortest/longest result.

  • trim_punct:=yes/no/left/right includes or excludes punctuation only between the interval and the outputted argument (set to "yes" by default). If the parameter’s value is "yes", then it removes punctuation at the beginning and at the end of the interval. When the parameter is set to "no", punctuation marks are not removed. When set to "left", the parameter removes punctuation at the beginning of the interval. When set to "right", the parameter removes punctuation at the end of the interval.

Returned Value

Documents matching the query.

Note

  1. By default, arguments are not included in the result.

  2. The trim_punct parameter is ignored when punctuation occurs between the interval and the outputted argument.

  3. The match parameter can be combined with scope:=sentence/text/paragraph/line:

    • match:=shortest, scope:=sentence matches the shortest result within a sentence.

    • match:=last, scope:=paragraph matches the last result within a paragraph.

    • match:=first, scope:=text matches the first result within a text.

Examples

between(a, b, endpoint:=left) matches a text fragment between a and b, including b in the result.

between("(", ")") matches a text fragment in brackets.

between(a, b, scope:=sentence) matches a text fragment between a and b in a sentence.

between(company, "document type", trim_punct:=left) matches "Green Planet Channel;" in the text "Company: Green Planet Channel; document type: cooperation agreement".