This version is out of date, covering development from v9.0.0 to v9.3.0. 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 v9 Icon

The XML TBX format

This section describes the XML source data in a TBX file.

WARNING. This is not formal vendor documentation of the format. Always work with back-ups. If doing significant interchange to from TBX files via some other workflow you may well need to contact technical support at some point. However, this section should still give you a good overview of the TBX file as used with v6.x of Tinderbox.

A TBX file can be opened and read in any competent text.code editing app. The file's data is valid XML in UTF-8 encoding and using Unix-style (line feed character) line endings. Thus much of the data can be read 'by eye' in source from. The only real exception to this is the RTFD versions of notes' text. An un-styled plain text version of the the $Text is stored so can still be read, albeit without stylistic markup.

However, to keep the data file slim, inherited values are not stored for every note. Rather, notes only store intrinsic attributes and those set locally in that note.

This section is structured to read like the TBX data structure with similar nesting of notes. When reading this, it is useful to also open a TBX in your code editor for reference.

Note that in general, tags write their internal tag attributes in the same order in each case (not true in early versions of the app), though you may still discover otherwise, so treat that assumption as tentative.

The top level objects of the XML (TBX) file: