Skip to content

alias TokenlistParameter

(alias) TokenlistParameter = ("errhelp"|"everycr"|"everydisplay"|"everyeof"|"everyhbox"|"everyjob"|"everymath"|"everypar"|"everyvbox"|"output")
    | "errhelp" -- Tokens that will be displayed if the user asks further help after an `\errmessage`.
    | "everycr" -- Token list inserted after every `\cr` or non-redundant `\crcr`.
    | "everydisplay" -- Token list inserted at the start of a display.
    | "everyeof" -- The content of this token list is injected when a file ends.
    | "everyhbox" -- Token list inserted at the start of a horizontal box.
    | "everyjob" -- Token list that is inserted at the start of each new job.
    | "everymath" -- Token list inserted at the start of non-display math.
    | "everypar" -- Token list inserted in front of paragraph text.
    | "everyvbox" -- Token list inserted at the start of a vertical box.
    | "output" -- Token list with instructions for shipping out pages.

The tokenlist parameters accept and return Lua strings. Lua strings are converted to and from token lists using \the\toks style expansion: all category codes are either space (10) or other (12). It follows that assigning to some of these, like tex.output, is actually useless, but it feels bad to make exceptions in view of a coming extension that will accept full-blown token strings.

Reference: