Forest

Sets the value of ⟨option⟩ of the current node to ⟨value⟩.

Note that option types ⟨keylist⟩ and ⟨autowrapped toks⟩ redefine this basic key.

Sets the value of ⟨register⟩ to ⟨value⟩.

Note that register types ⟨keylist⟩ and ⟨autowrapped toks⟩ redefine this basic key.

Sets the value of ⟨option⟩ of the node specified by ⟨relative node name⟩ to ⟨value⟩.

Notes:

contains TeX’s ⟨balanced text⟩ [Knuth 1996, 275].

A toks ⟨option⟩ additionally defines the following keys:

is a subtype of ⟨toks⟩ and contains TeX’s ⟨balanced text⟩ [Knuth 1996, 275].

⟨option⟩=⟨toks⟩ of an autowrapped ⟨option⟩ is redefined to ⟨option⟩/.wrap value=⟨toks⟩ of a normal ⟨toks⟩ option.

Keyvals ⟨option⟩+=⟨toks⟩ and +⟨option⟩=⟨toks⟩ are redefined to ⟨option⟩+/.wrap value=⟨toks⟩ and +⟨option⟩/.wrap value=⟨toks⟩, respectively. The normal toks behaviour can be accessed via keys ⟨option⟩’, ⟨option⟩+’, and +⟨option⟩’.

is a subtype of ⟨toks⟩ and contains a comma-separated list of ⟨key⟩[=⟨value⟩] pairs.

Augmented assignment operators ⟨option⟩+ and +⟨option⟩ automatically insert a comma before/after the appended/prepended material.

Augmented assignment operator ⟨option⟩-=⟨keylist⟩ deletes the keys from keylist ⟨option⟩. ⟨keylist⟩ specifies which keys to delete. If a key is given no value, all occurrences of that key will be deleted. If a key is given a value, only occurrences with that value will be deleted. To delete occurrences without value, use special value \ forestnovalue. (Note: if you include a key in ⟨keylist⟩ more than once, only the last occurrence counts.)

⟨option⟩=⟨keylist⟩ of a keylist option is redefined to ⟨option⟩+=⟨keylist⟩. In other words, keylists behave additively by default. The rationale is that one usually wants to add keys to a keylist. The usual, non-additive behaviour can be accessed by ⟨option⟩’=⟨keylist⟩.

Manipulating the keylist option using augmented assignments might have the side-effect of adding an empty key to the list.

contains a dimension.

The value given to a dimension option is automatically evaluated by pgfmath. In other words, ⟨option⟩=⟨value⟩ is implicitly understood as ⟨option⟩/.pgfmath=⟨value⟩.

For a ⟨dimen⟩ option ⟨option⟩, the following additional keys (“augmented assignments”) are defined:

The evaluation of ⟨pgfmath⟩ can be quite slow. There are two tricks to speed things up if the ⟨pgfmath⟩ expression is simple, i.e. just a TeX ⟨dimen⟩:

1. pgfmath evaluation of simple values can be sped up by prepending + to the value [Tantau 2007, §62.1];

2. use the key ⟨option⟩’=⟨value⟩ to invoke a normal TeX assignment.

The two above-mentioned speed-up tricks work for the augmented assignments as well. The keys for the second, TeX-only trick are: ’+, ’-, ’*, ’: — note that for the latter two, the value should be an integer.

contains an integer.

The additional keys and their behaviour are the same as for the ⟨dimen⟩ options.

contains \(0\) (false) or \(1\) (true).

In the general case, the value given to a ⟨boolean⟩ option is automatically parsed by pgfmath (just as for ⟨count⟩ and ⟨dimen⟩): if the computed value is non-zero, \(1\) is stored; otherwise, \(0\) is stored. Note that pgfmath recognizes constants true and false, so it is possible to write ⟨option⟩=true and ⟨option⟩=false.

If key ⟨option⟩ is given no argument, pgfmath evaluation does not apply and a true value is set. To quickly set a false value, use key not ⟨option⟩ (with no arguments).

These macros expand to the value of the given option or register. Note that \ forestoption and \ foresteoption expand to the value of the given option of the current node; to access option values of a non-current node, use pgfmath functions.

In the context of \edef, \forestoption and \forestregister expand precisely to the token list of the option value, while \foresteoption and \foresteregister fully expand the value.

• These macros can be useful in TeX code introduced by TeX or PGF’s handler .expanded [Tantau 2007, §55.4.6].

Declares a ⟨toks⟩ option.

Declares an ⟨autowrapped toks⟩ option.

Declares a ⟨keylist⟩ option.

Declares a ⟨dimen⟩ option. The default value is processed by ⟨forestmath⟩.

Declares a ⟨count⟩ option. The default value is processed by ⟨forestmath⟩.

Declares a ⟨boolean⟩ option. The default value is processed by ⟨forestmath⟩.

Declares a ⟨toks⟩ register.

Declares an ⟨autowrapped toks⟩ register.

Declares a ⟨keylist⟩ register.

Declares a ⟨dimen⟩ register.

Declares a ⟨count⟩ register.

Declares a ⟨boolean⟩ register.

temptoksb, temptoksc, temptoksd Predefined ⟨toks⟩ registers.

tempkeylistb, tempkeylistc, tempkeylistd Predefined ⟨keylist⟩ registers.

tempdimb, tempdimc, tempdimd, tempdimx, tempdimy, tempdiml, tempdims, tempdimxa, tempdimya, tempdimla, tempdimsa, tempdimxb, tempdimyb, tempdimlb, tempdimsb Predefined ⟨dimen⟩ registers.

tempcountb, tempcountc, tempcountd Predefined ⟨count⟩ registers.

tempboolb, tempboolc, tempboold Predefined ⟨boolean⟩ registers.