gbranden pushed a commit to branch master
in repository groff.
commit f51c2d9743967990b37037049baeb0c2af2b8d9a
Author: G. Branden Robinson <[email protected]>
AuthorDate: Mon Sep 14 03:53:41 2026 -0500
tbl(1): Revise for clarity.
Content:
* Elevate discussion of default table layout from commentary in
configuration parameters to "Overview" section. This way a newcomer
better understands what to expect from a simple table description.
* Drop "general caveat" paragraph; as noted, it discusses nothing unique
to _tbl_, and I need the space to maintain nice page breaks (on US
letter paper).
Style:
* Favor active voice over passive.
---
src/preproc/tbl/tbl.1.man | 55 ++++++++++++-----------------------------------
1 file changed, 14 insertions(+), 41 deletions(-)
diff --git a/src/preproc/tbl/tbl.1.man b/src/preproc/tbl/tbl.1.man
index 658dffc0e..fdc332bb1 100644
--- a/src/preproc/tbl/tbl.1.man
+++ b/src/preproc/tbl/tbl.1.man
@@ -160,8 +160,8 @@ table descriptions beyond the first must each be preceded
by an input line beginning with
.BR .T& .
.
-This mechanism does not start a new table region;
-all table descriptions are treated as part of their
+.I tbl \" generic
+treats all table descriptions as part of their
.BR .TS / .TE
enclosure,
even if they are boxed or have column headings that repeat on subsequent
@@ -169,40 +169,6 @@ pages
(see below).
.
.
-.\" XXX: The following is a general caveat about preprocessors (or would
-.\" be, once recast); move it.
-.P
-(Experienced
-.I roff
-users should observe that
-.I @g@tbl
-is not a
-.I roff
-language interpreter:
-the default control character must be used,
-and no spaces or tabs are permitted between the control character and
-the macro name.
-.
-These
-.I @g@tbl
-input tokens remain as-is in the output,
-where they become ordinary macro calls.
-.
-Macro packages often define
-.BR TS ,
-.BR T& ,
-and
-.B TE
-macros to handle issues of table placement on the page.
-.
-.I @g@tbl
-produces
-.I troff \" generic
-requests to define these macros as empty
-if their definitions do not exist
-when the formatter encounters a table region.)
-.
-.
.P
Each table region may begin with
.I region options.
@@ -215,6 +181,18 @@ These entries comprise the
.I table data.
.
.
+.P
+By default,
+.I tbl \" generic
+sets its output at the existing indentation,
+with 3n separation between columns,
+and uses as much of the output line length
+as is necessary to accommodate the widths
+of its entries and its column separations.
+.
+Region options and format specifications can alter these defaults.
+.
+.
.
.\" ====================================================================
.SS "Region options"
@@ -335,11 +313,6 @@ Spread the table horizontally to fill the available space
(line length minus indentation)
by increasing column separation.
.
-Ordinarily,
-a table is made only as wide as necessary to accommodate the widths of
-its entries and its column separations
-(whether specified or default).
-.
When
.B \%expand
applies to a table that exceeds the available horizontal space,
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit