Expressions

[Attribute]() - find value

Tests whether a regular expression can be found in an attribute of a note.

Deprecated - use .contains/.icontains.

See the original tests on the deprecated code page.

abs

computes the absolute value of a number.

Wiki: Math

untitled

This function allows execution of code without the need for a return value.

any()

scans each item of a group to see whether any of those items meets a criterion. Data are taken from the following example:

Wiki: Groups

atan()

compute the arctangent of a number; the result is reported in radians.

Wiki: Math

attributeEncode

XML/OPML-safe encoding of attribute values:> The following characters are converted to numeric HTML entities (e.g. like '
'): left angle bracket, right angle bracket, ampersand, (straight) double quote, (straight) apostrophe, and line feed character (ASCII #10).

avg

Computers the mean of a numeric attribute for a group of notes. The data are the following:

Wiki: Groups

avg_if()

Computers the mean of a numeric attribute for a group of notes. The data are the following:

Wiki: Groups

between(value,min,max)

A value lies between a specified minimum and maximum. The value may be equal to min but must be less than max. Thus between 1 and 10, means 1.0 to 9.999...etc. and not 1.0 to 10.0.

brightness(color)

return the relative brightness, on a scale of 0-100, of a color.

Deprecated - use Color.brightness.

See the original tests on the deprecated code page.

capitalize()

Transforms a string or attribute to use initial capitals.

ceil()

Rounds the input number upwards to the nearest integer: i.e. ceil(5.1) is 6.

collect()

Construct a set of the unique values of an attribute of a collection of notes. Sample data are taken from the following:

Wiki: Groups

collect_if()

Construct a set of the unique values of an attribute of a collection of notes, filtered by an expression (the second parameter).

Wiki: Groups

compositeFor()

compositeFor("item") returns a List-type list of paths of all notes in the composite containing note item.

untitled

untitled

untitled

untitled

untitled

untitled

contains

tests whether a note is among this note's immediate children.

Sample data are taken from the following:

• fruit
  • apple
  • pear
  • lemon
  • lime

cos()

Compute the cosine of an angle, in radians

Wiki: Math

count()

counts the number of items in a set

date()

convert a string to a date, or construct a date from numeric values for year, month, and day. For the purposes of this test, $Date is 20/01/2009, 00:00.

day()

extract the day of the month from a date. Also, construct a date from an existing date, specifying the day of the month. For the purposes of this test, $Date is 20 Jan 2009 09:00

days(start,end)

compute the number of days between two dates.

degrees()

Takes an angle specified in radians and returns the angle in degrees.

descendedFrom

tests whether the current note is a descendant of a named note.

Sample data are taken from the following:

• fruit
  • apple
  • pear
  • lemon
  • lime

distance()

Returns the distance in map distance between the centres of two notes.

do( theMacro [,argument, anotherArgument, etc.] )

Execute the named macro (macro must already be defined in the current TBX).

escapeHTML()

encode a string in a form suitable for HTML, replacing characters such as '<' and '&' with HTML entities.

eval()

evaluates an expression

every()

scan each item of a group to see whether all items meets a criterion. Compare any() and collect_if(). Data are taken from the following example:

Wiki: Groups

exp(N)

Returns the exponential to the power N

exportedString()

applies an export template to a note and returns the result as a string. exportedString() is occasionally useful as a bridge between the export template syntax and Tinderbox's action syntax.

PRETTY CERTAIN THIS BROKEN FOR THE MOMENT

find(query)

Returns a list of one or more path strings to matching items - so can match item or group scope with appropriate query argument.

first

tests whether a note is among the first n notes in its container.

Sample data are taken from the following:

• fruit
  • apple
  • pear
  • lemon
  • lime

firstWord()

Returns as a String the first lexical word of the input parameter - a quoted string literal or a String attribute/expression.

floor()

Rounds the input number downwards to the nearest integer; i.e. floor(5.9) is 5.

format()

converts dates, strings, numbers, and sets to strings, with various options to determine the presentation of the formatted string.

hasLocalValue()

Tests if an attribute of the current note has a locally set value - true, as opposed to the default/inherited value - false.

Note the argument is a quote-enclosed string name. If a $-prefix is used the value of the referenced attribute is evaluated and that value is expected to be an attribute name.

hour()

extract the hour of the time from a date. Also, construct a date from an existing date, specifying the hour of the day. For the purposes of this test, $Date is never

hours(start,end)

Returns the whole number of hours between the start and end times

hue(color)

computers the hue of a color, expressed as a color-wheel angle from 0 to 360°. Also, transforms a color by changing its hue while leaving its brightness and saturation unchanged.

Deprecated - use Color.hue.

See the original tests on the deprecated code page.

idEncode()

HTML and XML ID's must begin with a number or an underscore. Tinderbox's idEncode() makes it easy to use a $Name or other convenient text attribute as an ID.

indented

returns true if the note is n generations removed from the top of the outline, or from specified ancestor. Useful, for example, for assigning different styles to top-level, secondary, and tertiary outline items.

Sample data are taken from the following:

• data
  • fruit
    • apple
    • pear
    • lemon
    • lime

inside

tests whether a note is one of the immediate children of a container.

Sample data are taken from the following:

• fruit
  • apple
  • pear
  • lemon
  • lime

interval

Return the days/hours/minutes/seconds, positive or negative between two data times. Outputs Interval-type data which is rendered in the forms:

[neg][days] hh:mm:ss

-2 days 14:12:00

1 day 12:03:00

or, if no days:

[neg]hh:mm:ss

-06:04:00

02:30:00

isbn10()

Converts an ISBN-13 code string to an ISBN-10 format number-only string. Dashes or other punctuation will be ignored. If the argument is not a valid ISBN code, the functions return the empty string.

isbn13()

Converts an ISBN-10 code string to an ISBN-13 format format number-only string. Dashes or other punctuation will be ignored. If the argument is not a valid ISBN code, the functions return the empty string.

jsonEncode()

This operator (added in v5.7.0) returns a JSON-encoded UTF-8 version of a string attribute's value. The straight double quote, solidus (forward slash) and backslash characters are all escaped by a preceding backslash character.

Prior to v5.11.2 the apostrophe (straight single quote) was escaped but this was dropped as it interferes with some AJAX functions in browsers (and is not required by the JSON spec).

last

tests whether a note is among the last n notes in its container.

Sample data are taken from the following:

• fruit
  • apple
  • pear
  • lemon
  • lime

lastWord()

Returns as a String the last lexical word of the input parameter - a quoted string literal or a String attribute/expression.

linkedFrom

tests linkage values among a collection of linked notes. The data are taken from the following example:

linkedTo

tests linkage values among a collection of linked notes. The data are taken from the following example:

linkFrom()

This function creates a link and returns nothing. It can't easily be tested in a cookbook context.

linkFromOriginal()

This function creates a link, always between originals (if/either both linked item s are aliases), and returns nothing. It can't easily be tested in a cookbook context.

links

creates a set of values among a collection of linked notes. The data are taken from the following example:

linkTo()

This function creates a link and returns nothing. It can't easily be tested in a cookbook context.

linkToOriginal()

This function creates a link, always between originals (if/either both linked item s are aliases), and returns nothing. It can't easily be tested in a cookbook context.

list()

Creates a list from evaluated arguments

locale()

Return or set the locale used by TB for date and other formatting.

The second test’s rule is disabled as it otherwise puts unnecessary load Tinderbox’s rule/agent process.

log(argument)

returns the natural logarithm of a number.

Wiki: Math

lowercase()

Transforms a string or attribute to use all lower case.

max()

returns the largest element of a list (List or Set types). N.B., lists are always a string of semi-colon delimited values, even if the values are numbers. If no context is provided, max() compares elements lexically unless every element is a number.

Wiki: Math

min()

returns the smallest element of a list (List or Set types). N.B., lists are always a string of semi-colon delimited values, even if the values are numbers. If no context is provided, min() compares elements lexically unless every element is a number

Wiki: Math

minute()

extract the minute of the time from a date. Also, construct a date from an existing date, specifying the minute of the day. For the purposes of this test, $Date is never

minutes(start,end)

Offset in whole minutes between two date/times.

mod

Modulo arithmetic: divides the first argument by the second argument and returns the remainder.

Wiki: Math

month()

extracts the month (as a number from 1-12) from a date. With two arguments, converts a date to a new date, replacing the original date’s month by a new month.

months(start,end)

Offset in whole months between two date/times.

notify()

Send a notification to the OS.

pow(N,K)

Raises N to the power K

radians()

converts degrees to radians.

Wiki: Math

rand()

computes a pseudo random number between 0-1

Wiki: Math

rgb()

constructs a color from separate intensities of red, green, and blue, on a scale of 0-255.

round(argument)

rounds an number to the nearest integer

Wiki: Math

runCommand()

provides a link between Tinderbox actions and external programs. Executes a command-line process. The second argument, if supplied, is passed to the new process’ standard input, and the process' standard output is the result of the command.

saturation(color)

computes the saturation of a color — the intensity of its hue, on a scale of 0 (completely neutral) to 100 (intensely saturated). Alternatively, creates a new color whose hue and brightness are unchanged, but with a new saturation.

Deprecated - use Color.saturation.

See the original tests on the deprecated code page.

seconds()

Returns the whole number of seconds between the start and end times

similarTo

returns true if this note is similar to the named note.

sin(argument)

computes the sine of an angle, in radians.

Wiki: Math

sqrt()

calculates the square root of a number

Wiki: Math

substr(data,startN,lengthN)

Return a substring from data, being of lengthN characters from startN position. startN is zero-based. If lengthN is omitted everything from startN to end of string is returned.

substr() does negative indices are not supported - though String.substr() does.

sum_if()

Adds a numeric attribute for a group of notes. The data are the following:

Wiki: Groups

sum()

Adds a numeric attribute for a group of notes. The data are the following:

Wiki: Groups

tan()

computes the tangent of an angle, in radians

Wiki: Math

time()

extract the time of day, as a string, from a date or date expression. Also, modify a date to set a specific time of day. In these examples, $Date is 1/20/2009.

twitter()

Pass username and status text and (if authorised - Tinderbox will ask) a tweet to sent from that account.

unlinkFrom()

This function deletes a link and returns nothing. It can't easily be tested in a cookbook context.

unlinkFromOriginal()

This function deletes a link, always between originals (if/either both linked item s are aliases), and returns nothing. It can't easily be tested in a cookbook context.

unlinkTo

This function deletes a link and returns nothing. It can't easily be tested in a cookbook context.

unlinkToOriginal()

This function deletes a link, always between originals (if/either both linked item s are aliases), and returns nothing. It can't easily be tested in a cookbook context.

uppercase()

Transforms a string or attribute to use all upper case.

urlEncode

URLs may only contain a restricted character set. urlEncode() converts any illegal characters in a string to the appropriate representation; for example, a space is converted to the string %20.

utf8("theString")

utf8("theString")

Deprecated - not needed as Tinderbox now outputs UTF-8 as the default encoding.

See the original tests on the deprecated code page.

values(attr)

Returns a unique (set (list) of all the discrete strings (or individual list items) for a given attribute across the whole document. The attribute input is evaluated so is either a quoted attribute name (no $ prefix) or an attribute reference holding an attribute name, or an expression yielding the same.

var(x) {}

Declare a temporary/local variable. A local variable acts in most ways like a user attribute. The variable name, i.e. whatever string (no spaces or special characters) is given in var(), is available for local use for either the duration of the action or, when they appear inside curly brackets { ... } their scope is the rest of the clause - i.e the individual statements within the {}.

word()

tests whether a word occurs in the text or title of a note. This is faster than regular expression search, but less flexible.

year()

extract the year from a date. Also, construct a date from an existing date, specifying the year. For the purposes of this test, $Date is never

years(start,end)

Returns the whole number of years between the start and end times