gbranden pushed a commit to branch master in repository groff. commit e3a21747289c2846ef0c66c203e7b9dc50919560 Author: G. Branden Robinson <g.branden.robin...@gmail.com> AuthorDate: Wed Sep 13 13:10:15 2023 -0500
eqn(1): Fix content, style, and markup nits. Content: * Note the "delim on" incompatibility early in the document. * Mention "reset" as a new primitive in that subsection. Style: * Quote language keywords when confusable with English words (as might happen when font style formatting is lost). * Prevent inference that `\x` is a groff extension. * Use active voice more. * Recast and tighten wording. Markup: * Annotate unprefixed reference to command that can take one. --- src/preproc/eqn/eqn.1.man | 60 ++++++++++++++++++++++++++++++----------------- 1 file changed, 38 insertions(+), 22 deletions(-) diff --git a/src/preproc/eqn/eqn.1.man b/src/preproc/eqn/eqn.1.man index 275c08935..8594808be 100644 --- a/src/preproc/eqn/eqn.1.man +++ b/src/preproc/eqn/eqn.1.man @@ -194,7 +194,7 @@ these may safely be ignored if you do not know \*[tx]. . . .P -Three points are worth special note. \" good, bad, and different +Four points are worth special note. . . .IP \[bu] 3n @@ -214,7 +214,7 @@ though it may suffice for simple inputs. . .IP \[bu] GNU -.I eqn +.I eqn \" GNU sets the input token .RB \[lq] .\|.\|.\& \[rq] as an ellipsis on the text baseline, @@ -225,6 +225,15 @@ Set an ellipsis on the math axis with the GNU extension macro .BR cdots . . . +.IP \[bu] +GNU +.IR eqn 's\" GNU +.B delim +command does not treat an +.RB \[lq] on \[rq] +argument as a pair of equation delimiters. +. +. .\" ==================================================================== .SS "Anatomy of an equation" .\" ==================================================================== @@ -270,7 +279,8 @@ the output. . . .P -The following input characters separate tokens along with other tasks. +Beyond their primary functions, +the following input characters separate tokens as well. . . .TP @@ -595,12 +605,14 @@ and .SS "New primitives" .\" ==================================================================== . -The GNU extension primitives +We describe the GNU extension primitives .RB \[lq] type \[rq] and .B \%chartype -are discussed in subsection \[lq]Spacing and typeface\[rq] above; +in subsection \[lq]Spacing and typeface\[rq] above; .RB \[lq] set \[rq] +and +.RB \[lq] reset \[rq] in subsection \[lq]Customization\[rq] below; and .BR gbfont , @@ -621,17 +633,19 @@ Set as an accent over .IR e1 . . +.I @g@eqn +assumes that .I e2 -is assumed to be at the appropriate height for a lowercase letter -without an ascender; -.I @g@ eqn -vertically shifts it depending on +is at the appropriate height for a lowercase letter without an ascender, +and shifts it vertically based on .IR e1 's height. . For example, +.I @g@eqn +defines .B hat -is defined as follows. +as follows. . . .RS @@ -1038,7 +1052,7 @@ right delimiters, respectively. . If yours does, -consider swapping them, +swap them, or select others. . . @@ -1069,12 +1083,11 @@ or select others. The integer .RI value\~ n , in hundredths of an em, -increases the vertical spacing between rows, -using -.IR groff 's +uses the formatter's .B \[rs]x -escape sequence; -the value has no effect in MathML mode. +escape sequence to increase the vertical spacing between rows; +.I @g@eqn +ignores it when producing MathML. . Negative values are accepted but have no effect. . @@ -1100,9 +1113,9 @@ They have no effect when generating MathML, which delegates typesetting to a MathML rendering engine. . Configure these parameters with the -.B set +.RB \[lq] set \[rq] and -.B reset +.RB \[lq] reset \[rq] primitives. . . @@ -1903,9 +1916,9 @@ The default device is .I @MACRODIR@/\:\%eqnrc initializes the preprocessor. . -Any +Any valid .I @g@eqn -valid input is accepted. +input is accepted. . . .\" ==================================================================== @@ -1922,8 +1935,11 @@ does. . . .IP \[bu] 3n -.I @g@eqn -customization parameters have no effect on generated MathML. +GNU +.IR eqn 's\" GNU +rendering parameters +(see section \[lq]Customziation\[rq] above) +have no effect on generated MathML. . . .IP \[bu] _______________________________________________ Groff-commit mailing list Groff-commit@gnu.org https://lists.gnu.org/mailman/listinfo/groff-commit