OurBigBook Docs
Every argument in OurBigBook is either positional or named.
For example, in a header definition with an ID:which is equivalent to the sane version:we have:
= My asdf
{id=asdf qwer}
{scope}\H[1][My asdf]
{id=asdf qwer}
{scope}- two positional argument:
[1]and[My asdf]. Those are surrounded by square brackets[]and have no name - two named arguments:
{id=asdf qwer}and{scope}.The first one has nameid, followed by the separator=, followed by the valueasdf qwer.The separator=always is optional. If not given, it is equivalent to an empty value, e.g.:is the same as:{id=}{id}
You can determine if a macro is positional or named by using and so we see that
--help-macros. Its output contains something like: "h": {
"name": "h",
"positional_args": [
{
"name": "level"
},
{
"name": "content"
}
],
"named_args": {
"id": {
"name": "id"
}
"scope": {
"name": "scope"
}
},level and the content argument are positional arguments, and id and scope are named arguments.Generally, positional arguments are few (otherwise it would be hard to know which is which is which), and are almost always used for a given element so that they save us from typing the name too many times.
The order of positional arguments must of course be fixed, but named arguments can go anywhere. We can even mix positional and named arguments however we want, although this is not advised for clarity.
The following are therefore all equivalent:
\H[1][My asdf]{id=asdf qwer}{scope}
\H[1][My asdf]{scope}{id=asdf qwer}
\H{id=asdf qwer}{scope}[1][My asdf]
\H{scope}[1]{id=asdf qwer}[My asdf]Just like named arguments, positional arguments are never mandatory.