This version is out of date, covering development from v8.0.0 to v8.x.x. It is maintained here only for inbound reference links from elsewhere. It is no longer actively updated.

Jump to the current version of aTbRef

Tinderbox v8 Icon

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


Code Type: 

Code Scope of Action: 

Code First Added: 

Code Altered: 

 Data Include   [other codes of this type]

 item   [codes with similar scope]

 Baseline

 format"


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

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. The parentheses my be omitted if no parameters are supplied.

^text^ exports the current note

^text(this)^ exports the current note

^text(/Tasks/Task1)^ exports the $Text of note at path '/Tasks/Task1'

^text("Task2")^ exports the $Text of note 'Task2'

Item can also be a string attribute holding a path or title of a note. Thus if $MyString has the value "Task2"

^text($MyString")^ exports the $Text of note 'Task2'

If the note only contains an image, the image's tag () is exported.

Alternative usages…

N words of $Text

The first N words of the text of the item or note, where N is a number:

^text( item, N )^ 

Alternatively, the first N words of the text of the item or note, without added HTML mark-up and where N is a number:

^text( item, N, plain )^ 

Plain text export

If no HTML text mark-up is required.

^text( plain )^ 

The text of the current note without any added HTML mark-up codes, or use ^value($Text)^ instead. The latter code is effectively the same as ^text(this,plain)^.

N.B. The 'plain' option is still subject to the effects of HTMLQuoteHTML and HTMLMarkupText. For instance, if the latter is true, then the phrase "This & that." will get exported as "This & that." which might not be as intended, e.g. if exporting via runCommand().

Alternatively, to get the text of the note, totally untouched by other processes, use ^value($Text)^.