Export 1

^action( action )^

Perform the specified action code, possibly changing the values of one or more attributes. Nothing is exported.

^any( group , attribute[, data] )^

Returns true if any member of the group has a value for the given attribute. Alternatively, it returns true if the specified data is matched.

Examples are based on the following data:

^backslashEncode( data )^

Prefaces single and double quotation marks in data with a single backslash.

beginsWith

Tests if the target string begins with the data string. Unlike contains(), beginsWith uses simple string match, not regular expressions.

^capitalize( data )^

Transforms a string or attribute to use initial capitals.

^children( [template] )^

Includes only the immediate children of the current note (or agent) in the current Web page using their default template file or with the specified template file.

In Tinderbox versions prior to 4.6, ^children() exported all descendants and ^justChildren exported immediate children. From 4.6 on, ^children exports immediateChildren and is a synonym for ^justChildren, whole ^descendants exports all the descendants of a note.

^cloud( item, count] )^

Exports the information displayed in the Common Words view, note tab.

^comment( data )^

All of the data within the parentheses of the comment is ignored when using the template to create Web pages.

^contains( target, data )^

Tests if the target string contains the data string using regular expressions.

^count( group )^

Counts the number of notes within the specified group (container or group placeholder).

Data for the examples is taken from the following example, taken from /data/todo.

• todo
  • Groceries
    • apple
    • garlic
    • lemons
  • Calls
    • Jackson
  • Letters
    • Dr. Bryan
    • Edmund Morris
    • Mike Bonifer
  • Work
    • back up hard disk
    • write chapter 17
    • pay bills

^created( item[, format] )^

Date/time (with optional formatting) of the creation of specified note based on $Created.

^creator( item )^

Name of the creator of the specified note as in $Creator (derived from Preferences).

^days( date, N )^

Tests if date is within N days of today.

^descendants( [template] )^

Includes all descendants (children, children of those children, etc.) of the current note (or agent) in the current Web page using their default template file or with the specified template file.

^directory( item )^

Name of the exported directory (i.e. parent folder name) of the note specified.

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

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

^docTitle^

The name of the current Tinderbox document (i.e. the OS filename). The '.tbx' file extension is omitted if present.

^documentCloud( [count] )^

Exports the information displayed in the Common Words view, document tab.

^else^

Branching code for ^if conditional statements. See also ^else^ and ^endIf^.

^encode( [data] )^

Encodes the argument string, replacing common non-ASCII characters with the corresponding HTML entities in &#NNNN form where NNNN is 2 or more characters holding a hexadecimal number value. For example, '&' is converted to '&'

NOTE: since the move to utf-8 output, the need for this code has reduced. Indeed, using it may cause double-encoding to occur so the entities are shown rather then the intended character they represent.

^endIf^

Closing code for ^if statements, use being optional. See ^if and ^else^

^endsWith( )^

Tests if the target string ends with the data string using simple string matching, in contrast to false which matches regular expressions.

^equal( data1, data2 )^

Returns the Boolean result of comparing data1 string with data 2 string. Primarily used with

^every( group , attribute[, data] )^

Returns true if every member of the group has a value for the given attribute. Alternatively, it returns true if the specified data is matched.

Examples are based on the following data:

^exists( item | attribute)

Returns a Boolean evaluation within an ^if condition of whether an item note/object exists or if an attribute holds a value.

^file( item )^

The filename of the file for the web page of a item (or note), i.e. $HTMLExportFileName.

^firstWord( data )^

Extracts the first word from the data string/

^get( )^

fetch the value of any attribute of this note. If the optional second attribute is supplied, it specifies the formatting to be used. This allows custom formatting of dates.

^getFor(path | item, attribute[, format] )^

Fetch the value of any attribute of the note cited as a path or item. If the optional third attribute is supplied, it specifies the formatting to be used. This allows custom formatting of dates.

^host^

The host of the site of this Web page, derived from HTML preferences' URL.

A trailing backslash is supplied, if one is not supplied in the source preference (q.v. ^root^).

^if( condition )^

Tests if condition is true. The condition may use agent query syntax for expressions

^include( item[, template] )^

Includes a single item or note (with its default template) in the web page for the current note. If template is supplied, that will be used to process the included material)

^indent( data )^

Exports the data as a string (sequence of characters) for each ancestor of the currently exported note, i.e. one indent per outline level, except the root. If data is not supplied a tab character is emitted per indent.

^isDescendedFrom( item )^

Boolean test if item is a descendant of the object in current scope.

^isInside( item )^

Boolean test if item is a direct child of the object in current scope.

^justChildren( [template] )^

Includes only the immediate children of the current note (or agent) in the current Web page using their default template file or with the specified template file.

From v4.6 this is the same as ^children^ and deprecated in favour of the latter.

^lastModified( item[, format] )^

Date/time (with optional formatting) of the creation of specified note based on $Modified.

^lastWord( data )^

Extracts the final word from the argument

^lowercase( data )^

Transforms a string or attribute to use all lower case.

^max( group , attribute[, precision] )^

Returns the maximum value of an attribute in the designated group, with an optional precision.

Examples are based on the following data:

^mean( group , attribute[, precision] )^

Returns the arithmetical mean value of an attribute in the designated group, with an optional precision.

Examples are based on the following data:

^min( group , attribute[, precision] )^

Returns the minimum value of an attribute in the designated group, with an optional precision.

Examples are based on the following data:

^not( condition )^

If the enclosed condition is normally false, this makes it true and vice versa. Most commonly used with ^if statements.

^opmlEncode( data )^

^paragraphs( [item,] N )^

Exports the first N paragraphs of the text of specified item (note). If item is not specified, content is drawn from 'this' note.

^path^

The relative path for this web page's file from the top-level directory you selected for storing HTML files to this file.

^randomChildOf( item [, template] )^

Includes an export of a random child of the specified item or note through its default template or supplied named template.

^randomLine( item )^

Scans the text of a designated item or note (or, if no argument is supplied, the current note). The text is split at paragraph breaks (e.g. carriage returns), and one line (i.e. a paragraph) is chosen at random.

^root^

Returns the relative path from the current file to the directory that contains the cover page. A trailing backslash is supplied (q.v. ^host^).

^sectionCloud( [item, count] )^

Exports the information displayed in the Common Words view, section tab.

^sectionNumber( item )^

The hierarchical number of the item (note) based on the present hierarchy and outline sort order; it items is omitted scope is 'this'.

^setRoot( [newRoot] )^

tells Tinderbox to use its first argument (newRoot) as the value of ^root^ until either another ^setRoot^ is found or the current file being exported is complete. To restore relative URLs, use ^setRoot()^ with no arguments.

^sum( group , attribute[, precision] )^

Returns the sum of an attribute in the designated group, with an optional precision.

Examples are based on the following data:

^text( item[, N, plain] )^

Returns the body (text and graphics) of the item or note, i.e. includes any existing mark-up. If a note name is not specified, 'this' is assumed as the focus. If the note only contains an image, the image's tag (<img>) is exported.

Optionally, just the first N words of the text of the item or note may be returned and/or the the text can be returned plain without added HTML mark-up.

^title( item )^

The title of the item or note, i.e. the contents of $Name.

^today( [item] [, format] )^

The current date and time. It item is supplied, it is ignored; it is accepted for consistency with other date operators ike ^created and ^modified. The format argument is also optional.

^uppercase( data )^

Transforms a string or attribute to use all upper case.

^urlEncode( data )^

item encodes URLs in accordance with RFC1738.

^value( expression )^

Evaluates an expression and returns it as a string.

^version^

Exports the version number of Tinderbox used to create this Web page. The number is exported as a string without a prefix, i.e. "4.6.0" not "v4.6.0".