Tinderbox v9 Icon

Functions

Tinderbox allows user-defined operators, also called 'functions'. Such operators are typically defined in notes inside the Library container in the document's built-in Hints container (if not present this should be added to the document) though they may be defined in other contexts too.

Notes in that container which have names enclosed in parentheses, such as /Hints/Library/(What’s This) are treated as documentation; all other notes are executed at document startup and after they are edited.

Why use functions?

Functions provide a 'define once / use multiple times' feature in documents, and allow:

What sort of things can functions do?

Functions are set of action code instructions, 'bundled' together to achieve a specific outcome. A simple case is as shown in the example below (explained in more detail here).

function fAddTax(iPrice){return(1.18*iPrice);}; 

Functions fall into broad categories of use:

More about functions

The following sections should be read through completely on first encounter but are structured as small articles to assist cross-referencing and later reference for refreshing understanding or syntax.

Important note: all examples follow aTbRef naming conventions. These may seem verbose or over-descriptive to experienced programmers but are provided to help the learner, not the expert.

Aspects of using functions: