Designators
This is Tinderbox Cookbook version 2.0.1, created in conjunction with Tinderbox 7.3.2. The locale settings used to export this document: en-US. Most date tests were written/tested on a UK day/month order system and thus tests may fail if exported using different locale settings.Many of the Action and Export codes accept placeholder values, referred to as Designators. These allow code to specify something like the current note's next sibling without having to specify it by exact $Name value.
Deprecation. Some codes are now marked 'deprecated'. This means that while they may still work, such syntax should be avoided. New documents should not use such syntax and existing documents in regular use should be have their code reviewed to avoid retaining deprecated usage.Item Codes
These codes always apply to a single item.
- adornment
- agent
- child
- cover
- current
- firstSibling
- grandparent
- lastChild
- lastSibling
- next
- nextSibling
- original
- parent
- prevSibling -- deprecated alternative: previousSibling
- previous
- randomChild
- that
- this
- [literal $Name or $Path value]
Group Codes
These codes always apply to a group of item(s) - i.e. one or more.
- all
- ancestors -- deprecated alternative: ancestor
- children -- deprecated alternative: child
- descendants -- deprecated alternatives: descendant, descendent
- sibling
- [literal list of $Name or $Path values]
The find(condition) operator
This operator returns a list of $Path values for item(s) matching the condition argument. It can be used as either a group or item designator, although care should be taken in the item-scope contact to ensure the condition only matches one item
Link-related designators
These designators can be used by links():
- destination
- source
This designator can be used with the linkedFrom() or lnkedTo():
- asterisk (*)
This designator can be used with word cloud exports:
- document
Not used in action code but export has a ^root^ code:
- root