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

Tinderbox Icon


Code Type:   Data Include
Code Scope of Action:   item

^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. If the note only contains an image, the image's tag (<img>) is exported.

Alternative usages:

^text( item, N )^

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

^text( item, N, plain )^

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 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 &amp; 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)^.


Possible relevant notes (via "Similar Notes" feature):

Up: Data Include

A Tinderbox Reference File : Export Codes : Export Code Types : Data Include : ^text( item[, N, plain] )^

Quicklinks: Attributes | Action Codes | Export Codes | Designators | Date Formats | aTbRef Site Map

[Last updated: 16 May 2012, using v5.11.1]


Search:

Google search aTbRef for:  


Creative Commons Licence

aTbRef by Mark Anderson is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.

[See aTbRef CC licence Attribution & Waiver info]

Made with Tinderbox