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

first(item[, childrenNum])


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Last Altered: 

Operator Has Optional Arguments: 

Operator Has Newer Dot-Operator Variant: 

 Function  [other Function type actions]

 Item  [operators of similar scope]

 Query Boolean  [other Query Boolean operators]

 Baseline

 As at baseline

 [More on optional operator arguments]

Yes


first(item[, childrenNum])

Returns Boolean true if the current note is among the first itemsNum of children of item. If itemsNum is missing, a value of 1 is assumed. The item argument must be quoted unless an attribute reference. Ways to define item.

Both arguments are evaluated and can be a literal string/number, an attribute value or an action code expression evaluating to that same.

If the current note has a $SiblingOrder value of 2, then if first() is run on its parent container:

first("Note A", 5) returns true 

but if 'it has a $SiblingOrder value of 7:

first("Note A", 5) returns false

first() also has a logical opposite in last().

Legacy issues

This operator replaces the legacy #first query operator.