Group Objects

Tinderbox Icon

You sometimes need to specify a reference to a note relative to something else, like the current note. Group Objects are a set of generic relative references, or placeholders to a group [sic] of notes whose actual identity is context sensitive. Group placeholders are written with lower case starting letters and intercapitalised if multiword; e.g. sibling. Usage is case sensitive. In all cases the object word used in code is singular - plurals will not work (i.e. not 'ancestors', 'children', 'descendants' or 'siblings').

Thus, for a word count of the current note's children you use:

MyCount=sum(descendant,WordCount)

... and not ...

MyCount=sum(descendants,WordCount)

In older versions this would have required using an export code:

MyCount=^sum(descendant,WordCount)^

Some HTMLExport markup codes operate on groups of notes such as child, descendant, ancestor, and sibling.

If a group is empty - e.g. the current note has no children), the group operator returns the equivalent value/boolean for the current note instead.

There may be more groups — the manual is slightly vague about this.


Up: Objects & Concepts
Previous: Item Objects  Next: Links 

[Last updated: 1 Dec 2008]

Google search aTbRef for:  

Licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License
[See aTbRef CC licence Attribution/Waiver info info]

Creative Commons License

Made with Tinderbox