Name arguments marked in
--help-macros
as boolean: true
must either:- take no value and no
=
sign, in which case the value is implicitly set to1
- take value exactly
0
or1
- not be given, in which case a custom per-macro default is used. That value is the
default
from--help-macros
, or0
if such default is not given
For example, the
\x
full
argument of cross references is correctly written as:\x[boolean-argument]{full}
which renders as:
without the =
sign, or equivalently:\x[boolean-argument]{full=1}
which renders as:
The full=0
version is useful in the case of reference targets that unlike headers expand the title on the cross reference by default, e.g. images:\x[boolean-argument]{full=1}
which renders as:
The name "boolean argument" is given by analogy to the "boolean attribute" concept in HTML5.