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

Tinderbox URL schema

Tinderbox has its own private pseudo-protocol URL scheme. Entering a Tinderbox URL in a browser or similar program will launch Tinderbox (if installed!) and request specific actions.

The schema is as follows:

tinderbox://document/path?action 

The protocol handler for tinderbox:// URLs will automatically open and bring to focus documents in the Recent Files list as well as documents that are already open.

A Tinderbox URL pointing at (selecting) the current note in the current view type can be copied to the clipboard using the Note menu or the view pane selection's context menu. This URL is also exposed for any note via the read-only $NoteURL attribute. The desired selection is cited by that note's $ID. If there is a multiple selection the discrete $IDs are a semi-colon delimited list.

document is the name of an open document, without the '.tx' file extension.

path is a conventional Tinderbox path within the document to a specific note (or container).

actions, which may be multiple, joined with an ampersand.

Schema Actions

pane, which opens an inspector to the designated pane (there is no documentation of valid pane values):

?inspect=pane 

view, selects a tab with the designated parent and view type, or creates a new tab in no existing tab can be found. Allowed values for viewType include {map, outline, chart, attributeBrowser}.

?view=viewType 

select, which selects the desired note(s) when the target document takes focus:

?select=ID 

Thus:

tinderbox://Notes/Issues?select=1429560859 

tinderbox://Notes/Issues?select=1429560859;1429458942 

tinderbox://Notes/Issues?select=1429560859&view=map