| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
| |
Also adjust dead-tree pagination.
|
| |
|
|
| |
Also shift some forward references into footnotes.
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Content:
* Document that AF can end a TL-initiated title as AU can.
* Describe AF's behavior when specified multiple times.
* Add cross references in AF, macro descriptions.
* Clarify that AT interacts with letters.
* Cross-reference LI and LE macros in all list-beginning macro
descriptions.
* Drop explicit documentation of how some macros handle empty arguments
are handled when this information is presented in a table; these
already list "none", and the introduction to the "Macros" section
explains how to explicitly pass empty macro arguments.
* When discussing "compatibility reasons", identify what we're trying to
be compatible with (DWB mm).
* Stop reporting values of string defaults in macro descriptions; these
are properly documented in the "Strings" section.
* Begin more macro descriptions with meaningful imperative statements.
Stop bending into pretzel shapes trying to make these expansions of an
abbreviation that the macro name encodes.
* Stop associating `FC` with MT memoranda; they don't use it. (The
internal macro `let@mt-closing` appears to be misleadingly named.)
* Explain what the second argument to `FD` does.
* Drop synopses of hook macros in favor of their descriptions in the
in the macros that call them. (Except for EOP and TP, which demand
further consideration before recasting because they are called by
traps, which aren't otherwise described.)
* Drop example from `IND` macro description; it communicated nothing
that isn't said as well in prose.
* Document `Rf` string.
* Document `Ref` register and its use by the IND macro.
Style:
* Format macro names without leading dot.
* Recast descriptions of macros 1C, AF, AL, AT, AU, AV, AVL, BL, BS,
BVL, COVER, COVEND, DF, DL, DS, FC, FD, FE, FS, H, HY, HZ, IA, IE,
IND, INDP, INITI, LB, LC, LE, LI, LO, LT, MULB, ND, nP, NS, PGFORM,
PGNH, RL, RS, SM, TL, VL, WA, and WE; and Verbnm string.
* Fix comma splice (BE).
* Parallelize wording, particularly when macros or diversions are used
to collect input.
* Stop further indenting tables and code displays in macro descriptions.
Aligning them with the paragraphs suffices.
* Set "none" in italics when presenting tables of parameter meanings.
* In tables, use sentences more and fragments less.
* Use more idiomatic English.
* Fix fractured wording (mine, I think) in EQ description.
* More consistently capitalize table column headings when they aren't
metasyntactic variables.
* Fix subject/verb agreement in Le/Lf/Lt/Lx register description.
Markup:
* Use \~ instead of \space in macro synopses.
* Use \c and font alternation macros instead of \f in macro synopses.
* Use tbl(1) more idiomatically when presenting lists of strings
available to EOP and TP macros.
* Adjust dead-tree pagination with `br` and `ne` requests.
|
| | |
|
| |
|
|
|
| |
Survey some major features to give the reader without a copy of the DWB
mm manual handy a means of entry to this huge package.
|
| | |
|
| |
|
|
|
|
|
| |
* Express requirement that an mm(7) macro be called to initialize the
package.
* Relocate advise regarding simple mm documents earlier, and further
simplify.
|
| | |
|
| |
|
|
|
| |
* Explicitly tell the reader how to end section heading text.
* Describe the handling of display distance in more detail.
|
| | |
|
| |
|
|
|
|
| |
It's the placement, not the spacing, of headers and footers that the
`hm`, `fm`, `tm`, and `bm` registers control. A reader might interpret
"spacing" as "vertical spacing".
|
| |
|
|
|
|
|
|
| |
* doc/groff.texi (Manipulating Filling and Adjustment): Recast.
Tighten wording. Document conventional space width. Fully discuss
inter-sentence spacing behavior before documenting registers.
* man/groff_diff.7 (Extended requests): Sync with the foregoing.
* man/groff.7 (Read-only registers): Use less cramped English.
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Content:
* Present concepts of font families, styles, and what makes special
fonts special.
* Reform terminology: migrate to "page description language" from
"device-independent output format" and "intermediate output".
* Elaborate on preprocessors' frequent use of their own languages.
* Drop redundant sentence about "tmac files".
* Add cross reference to groff_tmac(5) page when discussing availability
of macro packages.
Style:
* Put vertical space before list of (relatively) well-known
preprocessors that groff doesn't provide.
* Stop hyphenating adverbially enhanced attributive phrase.
* Tighten wording.
* Generally recast, particularly material I hadn't already edited.
Markup:
* Use `\|` more aggressively to improve kerning (avoid glyph crowding)
when changing styles.
* Ensure that the example won't break in a confusing place.
* Bump copyright range.
|
| |
|
|
| |
This makes it clearer to the novice that they need not be typed.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Content:
* Say "break" instead of "line break".
* Say "GNU troff" instead of "groff" where we are specifically
describing the formatter's behavior.
* Clarify that "w" command applies only to "normal" inter-word spaces.
Style:
* Simplify internal cross references to other commands.
* Clarify contextuality of positioning, writing, and drawing commands.
Markup:
* Drop unnecessary macro agument quotation.
* Fix missing input line break after macro call.
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
* Shift example of `sp` interaction with traps to follow initial
presentation of request.
* Revise examples for clarity. Add comments to explain requests not yet
formally introduced.
* Clarify separateness of extra pre- and post-vertical line spacing.
* More explicitly motivate why we don't have a "most recent extra
pre-vertical line spacing" register.
* Add forward cross reference to "Drawing Requests" node, since the
bracket-building escape sequence has not yet been introduced.
* Tighten wording.
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
Use ellipsis more idiomatically, favoring it over plurals, and including
it within instead of outside option brackets for clarity.
The construction:
foo bar [baz] ...
is ambiguous. If I specify no "baz", can "bar"s be repeated?
Also say "argument" when we mean an option OR an operand.
|
| |
|
|
|
|
| |
Delete some Texinfo @codequote* commands, thus marking the "Tabs and
Fields", "Leaders", and "Fields" nodes as reviewed for ` and ' glyph
usage in examples.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* Document text baseline location as a property of the output line.
* Recast description of `sp` request entirely, describing more aspects
of its behavior. Add forward cross references to implicated topics.
Drop some material about trap interaction spread amid examples since we now handle that
both earlier, in the initial presentation, and later, via cross
references to the presentation of vertical position traps.
* Recast description of `ls` request and `.L` register.
* Recast description of `\x` escape sequence and `.a` register. Preview
the terminology that occurs again later when the `vs` and `pvs`
requests are presented. Say more to motivate the existence of these
features.
* Recast description of `ns` and `rs` requests and `.ns` register.
* Shift Texinfo @codequote* commands, marking the section/node
"Manipulating Spacing" as reviewed for ` and ' glyph usage in
examples.
Thanks to Dave Kemper for compelling me to review this subject.
|
| | |
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Content:
* More carefully distinguish escape sequences from device control
commands; the former are more general.
* The *roff `\X` escape sequence is a device control command, not a
"special". *roff already freights the latter term with enough meaning
without hauling in TeX's use for it.
* The "ps:" or "pdf:" part of a device control command escape sequence
parameter is the "tag", not the entire parameter. It is a name
spacing convention.
* Clarify operation of `xrev` device control command.
Style:
* Recast: all device control commands are "extensions"; there is no
standard set.
* Convert mentions of (g)pic(1) and grops(1) to man page cross
references.
* Set pic(1) command names in bold, not italics.
* Set "mom" macro package name in italics, not bold.
* Set "gropdf" in italics, not bold.
* Capitalize "PDF" in prose.
* Protect Perl's "localtime" function name from hyphenation.
* Hyphenate adjectival phrases.
* Hyphenate metasyntactic variable consistently with its introduction.
* Otherwise recast for (attempted) clarity and concision.
Markup:
* Use two empty requests where vertical space is expected.
* Annotate a mismatch in conventions between grotty(1) and gropdf(1).
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Content:
* Introduce the concept of convenience macros earlier, then rely on it.
* Align terminology regarding page location traps with the rest of
groff's documentation.
* Align header/footer terminology with the rest of groff's
documentation.
Style:
* Tighten wording.
* Set macro call literals in bold.
* Use imperative voice more when describing device control commands.
* Present convenience macros _after_ full discussion of device control
command behavior, not in the midst of it.
* Coalesce some single-sentence paragraphs into their predecessors.
Markup:
* Set file names in italics.
* Protect macro call literals from hyphenation.
* Use an empty request between sentences.
* Use two empty requests where vertical space is expected.
|
| |
|
|
|
| |
The page references it several times; we should explain what it is and
link to it.
|
| | |
|
| |
|
|
|
| |
Drop a paragraph break after a very short paragraph to buy a vee and fix
an orphaned line on U.S. letter paper.
|
| | |
|
| |
|
|
| |
Also drop an unnecessary paragraph break in glilypond(1).
|
| | |
|
| |
|
|
| |
...to put it in (mostly) lexicographic order.
|
| |
|
|
|
|
|
|
|
| |
* Explicitly state that register renaming doesn't affect read-only state
or other special properties.
* Add cautionary note above removing built-in registers.
* Document difference from AT&T troff, which ignored attempts to remove
read-only (but not writable built-in) registers.
* Consistently use Texinfo @: command after prose colons.
|
| |
|
|
| |
This recovers good page breaks in roff(7).
|
| | |
|
| |
|
|
| |
Also slightly recast in places for better style.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* Recast description of `bd`, `backtrace`, and `lf` requests.
* Explicitly associate `bd` request with `.b` register.
* Introduce metasyntactic variable `message` for use with `ab` and
`tm`-family requests, since it is interpreted differenly from the
`contents` argument of string assignment and appendment requests.
Document that special character escape sequences in a `message` are
not interpreted.
* Clarify that groff_diff(7) details only GNU troff extensions.
* Set default argument assumed by `af` request in bold.
* Document behavior of `ce` and `rj` requests when used with negative
agument.
* Fully discuss `ce`, `cf`, and `trf`'s interfaces before presenting
examples.
* Use "file" instead of "filename" as metasyntactic variable name with
requests.
|
| |
|
|
|
|
| |
It applies to the _next_ input line not the current one. (This differs
from AT&T troff and is documented as such in groff_diff(7) and our
Texinfo manual.)
|
| |
|
|
|
|
|
| |
It tried to be helpful, but risked the reader inferring too much, i.e.,
can you _not_ test non-Boolean-valued registers with control flow
requests? (You can.) The preceding sections "Numeric expressions" and
"Conditional expressions" provide the necessary foundation.
|
| | |
|
| | |
|
| | |
|
| |
|
|
|
|
|
| |
* Add more cross references to related requests as registers.
* Recast descriptions of Boolean-valued registers for consistency.
* Clarify behavior of `.z` register when in top-level diversion, a term
that once was not defined in this man page but now is.
|
| |
|
|
|
|
|
|
|
| |
* Describe backtracing less circularly.
* Use active voice more.
* Drop this section's introductory paragraph from groff(7), which
doesn't require it, being more of a reference.
* Wrap long input line.
* Bump document date.
|
| | |
|
| | |
|
| |
|
|
| |
Thanks to Alex Colomar (and mandoc(1)) for pointing it out.
|
| |
|
|
|
|
| |
The Euro glyph is important beyond Europe.
Tighten wording.
|
| |
|
|
| |
Implemented in commit 41d05cbfac, 4 July 2019.
|
| | |
|
