Skip to content

alias ReadWriteIntegerParameter


(alias) ReadWriteIntegerParameter = ("adjdemerits"|"binoppenalty"|"brokenpenalty"|"catcodetable"|"clubpenalty"|"day"|"defaulthyphenchar"|"defaultskewchar"|"delimiterfactor"|"displaywidowpenalty"...)
    | "adjdemerits" -- Penalty for adjacent visually incompatible lines. Default: `10000`.
    | "binoppenalty" -- Penalty for breaking after a binary operator not enclosed in a subformula. Default: `700`.
    | "brokenpenalty" -- Additional penalty for breaking a page after a hyphenated line. Default: `100`
    | "catcodetable" -- Catcode tables are a new feature that allows you to switch to a predefined catcode regime in a single statement.
    | "clubpenalty" -- Extra penalty for breaking a page after the first line of a paragraph. In Plain TeX this is `150`. This amount, and the following penalties, are added to the `\interlinepenalty`, and a penalty of the resulting size is inserted after the `\hbox` containing the first line of a paragraph instead of the `\interlinepenalty`.
    | "day" -- The day of the current job.
    | "defaulthyphenchar" -- Value of `\hyphenchar` when a font is loaded. Default: `‘\-`.
    | "defaultskewchar" -- Value of `\skewchar` when a font is loaded.
    | "delimiterfactor" -- `1000` times the fraction of a delimited formula that should be covered by a delimiter. Default: `901`.
    | "displaywidowpenalty" -- Extra penalty for breaking a page before the last line above a display formula. The default value in Plain TeX is `50`.
    | "doublehyphendemerits" -- Penalty for consecutive lines ending with a hyphen. Default: `10000`.
    | "endlinechar" -- The character code of the end-of-line character appended to input lines. IniTEX default: `13`.
    | "errorcontextlines" -- (TeX3 only) Number of additional context lines shown in error messages.
    | "escapechar" -- Number of the character that is to be used for the escape character when control sequences are being converted into character tokens. IniTEX default: `92` (`\`).
    | "exhyphenpenalty" -- Penalty for breaking a horizontal line at a discretionary item in the special case where the prebreak text is empty. Default: `50`.
    | "fam" -- The number of the current font family.
    | "finalhyphendemerits" -- Penalty added when the penultimate line of a paragraph ends with a hyphen. Default: `5000`.
    | "floatingpenalty" -- Penalty added when an insertion is split.
    | "globaldefs" -- Parameter for overriding \global prefixes. IniTEX default: `0`.
    | "hangafter" -- If positive, this denotes the number of lines before indenting starts; if negative, the absolute value of this is the number of indented lines starting with the first line of the paragraph. Default: `1`.
    | "hbadness" -- Amount of tolerance before TEX reports an underfull or overfull horizontal box.
    | "holdinginserts" -- (TeX3 only) If this is positive, insertions are not placed in their boxes at output time.
    | "hyphenpenalty" -- Penalty associated with break at a discretionary item in the general case. Default: `50`.
    | "interlinepenalty" -- Penalty for breaking a page between lines of a paragraph. Default: `0`
    | "language" -- Choose a set of hyphenation patterns and exceptions.
    | "lastlinefit" -- A readable and writable integer parameter that accepts and returns Lua numbers.
    | "lefthyphenmin" -- (TeX3 only) Minimal number of characters before a hyphenation. Default: `2`.
    | "linepenalty" -- Penalty value associated with each line break. Default: `10`.
    | "localbrokenpenalty" -- Local broken penalty (from `\localbrokenpenalty`).
    | "localinterlinepenalty" -- Local interline penalty (from `\localinterlinepenalty`).
    | "looseness" -- Number of lines by which this paragraph has to be made longer than it would be ideally.
    | "mag" -- `1000` times the magnification of the document.
    | "maxdeadcycles" -- The maximum number of times that the output routine is allowed to be called without a `\shipout` occurring. IniTEX default: `25`.
    | "month" -- The month of the current job.
    | "newlinechar" -- Number of the character that triggers a new line in `\write` statements.
    | "outputpenalty" -- Value of the penalty at the current page break, or `10000` if the break was not at a penalty.
    | "pausing" -- Specify that TEX should pause after each line that is read from a file.
    | "postdisplaypenalty" -- Penalty placed in the vertical list below a display. Default: `0`.
    | "predisplaydirection" -- An internal read/write integer, to indicate the direction of the last partial paragraph before a display; it is used to control the placement of elements such as equation numbers, and can be explictly set to affect this placement.
    | "predisplaypenalty" -- Penalty placed in the vertical list above a display. Default: `10000`.
    | "pretolerance" -- Tolerance value for a paragraph without hyphenation. Default: `100`.
    | "relpenalty" -- Penalty for breaking after a binary relation not enclosed in a subformula. Default: `500`.
    | "righthyphenmin" -- (TeX3 only) Minimum number of characters after a hyphenation. Default: `3`.
    | "savinghyphcodes" -- When a `\patterns` command is executed and \savinghyphcodes has a positive value, the current `\lccode` values are saved as hyphenation codes for the current language.
    | "savingvdiscards" -- When ε-TEX’s parameter `\savingvdiscards` has been assigned a positive value, these ‘discarded items’ are saved in two lists and can be recovered by the commands `\pagediscards` and `\splitdiscards` that act like ‘unvboxing’ hypothetical box registers containing a vbox with the discarded items.
    | "showboxbreadth" -- Number of successive elements on each level that are shown when boxes are displayed.
    | "showboxdepth" -- The number of levels of box dump that are shown when boxes are displayed.
    | "time" -- Number of minutes after midnight that the current job started.
    | "tolerance" -- Tolerance value for lines in a paragraph with hyphenation. Default: `200`.
    | "tracingassigns" -- When the program is compiled with the code for collecting statistics and `\tracingassigns` has a value of `1` or more, all assignments subject to TeX’s grouping mechanism are traced.
    | "tracingcommands" -- If this is `1` TEX displays primitive commands executed; if this is `2` or more the outcome of conditionals is also recorded.
    | "tracinggroups" -- When `\tracinggroups` has a value of `1` or more, the start and end of each save group is traced, together with the starting line and grouping level.
    | "tracingifs" -- When `\tracingifs` has a value of `1` or more, all conditionals (including `\unless`, `\or`, `\else`, and `\fi`) are traced, together with the starting line and nesting level.
    | "tracinglostchars" -- If this parameter is positive, TeX gives diagnostic messages whenever a character is accessed that is not present in a font. Plain default: `1`.
    | "tracingmacros" -- If this is `1`, the log file shows expansion of macros that are performed and the actual values of the arguments; if this is `2` or more token parameters such as `\output` and `\everypar` are also traced.
    | "tracingnesting" -- When `\tracingnesting` has a value of `1` or more, these anomalies are shown; when `\tracingnesting` has a value of `2` or more, the current context (traceback) is shown as well.
    | "tracingonline" -- If this parameter is positive, TeX will write trace information to the terminal in addition to the log file.
    | "tracingoutput" -- If this is positive, the log file shows a dump of boxes that are shipped to the dvi file.
    | "tracingpages" -- If this parameter is positive, TeX generates a trace of the page breaking algorithm.
    | "tracingparagraphs" -- If this parameter is positive, TeX generates a trace of the line breaking algorithm.
    | "tracingrestores" -- If this parameter is positive, TEX will report all values that are restored when a group ends.
    | "tracingscantokens" -- When `\tracingscantokens` has a value of `1` or more, the opening and closing of pseudo-files (generated by `\scantokens`) is recorded as for any other file, with ‘␣’ as filename.
    | "tracingstats" -- If this parameter is `1`, TeX reports at the end of the job the usage of various internal arrays; if it is `2`, the memory demands are given whenever a page is shipped out.
    | "uchyph" -- Positive to allow hyphenation of words starting with a capital letter. Default: `1`.
    | "vbadness" -- Amount of tolerance before TEX reports an underfull or overfull vertical box.
    | "widowpenalty" -- Additional penalty for breaking a page before the last line of a paragraph. Default: `150`.
    | "year" -- The year of the current job.

The integer parameters accept and return Lua numbers. These are read-write:

Reference: