"aTbRef" is a reference file to some of Tinderbox's objects and functions. It includes changes up to and including v5.12.1 (23 Jan 2013). The web pages are created from some 3496 notes in the source TBX.
A Change Log section lists significant per-release changes since v5.0.0 (10 Dec 09), that being the baseline version for this re-release of aTbRef. Those users who always update to the current version can generally just ignore the text's references to version numbers (apart from checking the most recent changes) whereas users of older versions can easily see whether their installed version includes certain improvements or not. This release has updated code examples to use v4.6+ syntax. Although both old and new syntax is currently supported this is unlikely to remain the case and users of pre-existing TBXs should review and update their code before support for old syntax is dropped! A listing of deprecated usage is provided to help with updating code.
- Basic Configuration & Concepts
- User Interface Basics
- Using Tinderbox
- Coding in Tinderbox
- Under The Hood
The HTML pages include a Google search box in the footer. Note that if using a local copy you must be online to use the search; Google will search the online pages - that might possibly be more recent than your own - and the search result links will likewise be to the online pages. If you've downloaded the TBX source, simply use Tinderbox's own Find tool to look for things.
If reading the TBX source file, ignore the UTILS section which contains agents, prototypes, etc., used to create and maintain this file.
Not all Tinderbox users are English speakers so to try and help with that all pages now include an in-page Google Translate feature (top right). The feature offers automatic translation of page content into any of the languages supported by the Translate service. Doubtless the translation it is not fluent but it may help non-English speakers get more out of this resource.
By design aTbRef is a document intended to be exported to HTML and the TBX of this file includes the necessary templates to enable that process. A default (custom internal) text export template is also defined and set to avoid the problems reported in older aTbRef versions when using Nakakoji views.
REMARKS AND CAVEATS
This file is supposed to go along with the existing manual & release notes (available via the app's Help menu), the Tinderbox forum as well as the TinderboxWiki. It is therefore incomplete regarding the global Tinderbox culture. Its main aim is to serve as an "on the go" (online) as well as a personal (TBX file) reference to Tinderbox use. Tinderbox's author Mark Bernstein has also written a book, The Tinderbox Way, that discusses some of the design ideas encapsulated in Tinderbox as well as some practical examples as to usage.
If you are using the source TBX file version of aTbRef, bear in mind nearly all of the caret (^) symbols will be written doubled in order the they don't get interpreted as export codes when outputting the HTML pages. A further benefit from using - or just viewing - the source TBX is that is contains all the export templates needed to produce this site and which can be instructive if learning the HTML export aspects of Tinderbox.
This file is shared "as is", the author will not be held responsible for its content; it may be used/republished under the following Creative commons licence.