[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/01: src/preproc/tbl/*: Improve the license information.
|
From: |
Bernd Warken |
|
Subject: |
[groff] 01/01: src/preproc/tbl/*: Improve the license information. |
|
Date: |
Thu, 18 Sep 2014 00:14:05 +0000 |
bwarken pushed a commit to branch master
in repository groff.
commit 3730968ed5702700d170300f9dd8a3dd553973ff
Author: Bernd Warken <address@hidden>
Date: Thu Sep 18 02:14:00 2014 +0200
src/preproc/tbl/*: Improve the license information.
---
ChangeLog | 4 +
src/preproc/tbl/Makefile.sub | 5 +-
src/preproc/tbl/main.cpp | 4 +-
src/preproc/tbl/table.cpp | 3 +-
src/preproc/tbl/table.h | 4 +-
src/preproc/tbl/tbl.man | 368 ++++++++++++++++++++++++++++++------------
6 files changed, 273 insertions(+), 115 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 4cf3345..666f2c1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
2014-09-18 Bernd Warken <address@hidden>
+ * src/preproc/tbl/*: Improve the license information.
+
+2014-09-18 Bernd Warken <address@hidden>
+
* src/preproc/soelim/*: Improve the license information.
2014-09-18 Bernd Warken <address@hidden>
diff --git a/src/preproc/tbl/Makefile.sub b/src/preproc/tbl/Makefile.sub
index 55ebae3..f93b92a 100644
--- a/src/preproc/tbl/Makefile.sub
+++ b/src/preproc/tbl/Makefile.sub
@@ -2,10 +2,7 @@
#
# File position: <groff-source>/src/preproc/tbl/Makefile.sub
#
-# Copyright (C) 2014
-# Free Software Foundation, Inc.
-#
-# Last update: 2 Sep 2014
+# Copyright (C) 2014 Free Software Foundation, Inc.
#
# This file is part of `font utf8' which is part of `groff'.
#
diff --git a/src/preproc/tbl/main.cpp b/src/preproc/tbl/main.cpp
index 8732db9..55cf0e2 100644
--- a/src/preproc/tbl/main.cpp
+++ b/src/preproc/tbl/main.cpp
@@ -1,7 +1,5 @@
// -*- C++ -*-
-/* Copyright (C) 1989, 1990, 1991, 1992, 2000, 2001, 2002, 2003, 2004, 2005,
- 2007, 2008, 2009, 2010
- Free Software Foundation, Inc.
+/* Copyright (C) 1989-2014 Free Software Foundation, Inc.
Written by James Clark (address@hidden)
This file is part of groff.
diff --git a/src/preproc/tbl/table.cpp b/src/preproc/tbl/table.cpp
index 9a7789c..f43fe7d 100644
--- a/src/preproc/tbl/table.cpp
+++ b/src/preproc/tbl/table.cpp
@@ -1,6 +1,5 @@
// -*- C++ -*-
-/* Copyright (C) 1989-1992, 2000, 2003, 2004, 2007-2011
- Free Software Foundation, Inc.
+/* Copyright (C) 1989-2014 Free Software Foundation, Inc.
Written by James Clark (address@hidden)
This file is part of groff.
diff --git a/src/preproc/tbl/table.h b/src/preproc/tbl/table.h
index 7520b10..5892867 100644
--- a/src/preproc/tbl/table.h
+++ b/src/preproc/tbl/table.h
@@ -1,7 +1,5 @@
// -*- C++ -*-
-/* Copyright (C) 1989, 1990, 1991, 1992, 2001, 2002, 2003, 2004, 2007,
- 2008, 2009, 2010
- Free Software Foundation, Inc.
+/* Copyright (C) 1989-2014 Free Software Foundation, Inc.
Written by James Clark (address@hidden)
This file is part of groff.
diff --git a/src/preproc/tbl/tbl.man b/src/preproc/tbl/tbl.man
index 6db77e1..99fba01 100644
--- a/src/preproc/tbl/tbl.man
+++ b/src/preproc/tbl/tbl.man
@@ -3,12 +3,10 @@
.SH NAME
@address@hidden \- format tables for troff
.
-.\" --------------------------------------------------------------------
-.ig
-Copyright (C) 1989-1995, 2001-2004, 2006-2014
- Free Software Foundation, Inc.
-
-Last update: 21 Jul 2014
+.
+.\" license
+.de co
+Copyright (C) 1989-2014 Free Software Foundation, Inc.
Bernd Warken <address@hidden> added simple examples.
@@ -30,6 +28,8 @@ the original English.
.
.\" --------------------------------------------------------------------
.SH SYNOPSIS
+.\" --------------------------------------------------------------------
+.
.SY @address@hidden
.OP \-Cv
.RI [ files\~ .\|.\|.]
@@ -38,32 +38,42 @@ the original English.
.
.\" --------------------------------------------------------------------
.SH DESCRIPTION
+.\" --------------------------------------------------------------------
+.
This manual page describes the GNU version of
.BR tbl ,
which is part of the groff document formatting system.
+.
.B tbl
compiles descriptions of tables embedded within
.B troff
input files into commands that are understood by
.BR troff .
+.
Normally, it should be invoked using the
.B \-t
option of
.B groff.
+.
It is highly compatible with Unix
.BR tbl .
+.
The output generated by GNU
.B tbl
cannot be processed with Unix
.BR troff ;
it must be processed with GNU
.BR troff .
+.
If no files are given on the command line or a filename of
.B \-
is given, the standard input is read.
.
.
+.\" --------------------------------------------------------------------
.SH OPTIONS
+.\" --------------------------------------------------------------------
+.
.TP
.B \-C
Enable compatibility mode to
@@ -72,6 +82,7 @@ recognize
and
.B .TE
even when followed by a character other than space or newline.
+.
Leader characters (\[rs]a) are handled as interpreted.
.
.TP
@@ -81,6 +92,8 @@ Print the version number.
.
.\" --------------------------------------------------------------------
.SH "LANGUAGE OVERVIEW"
+.\" --------------------------------------------------------------------
+.
.B tbl
expects to find table descriptions wrapped in the
.B .TS
@@ -110,6 +123,7 @@ must always be finished by a
.
.TP
.I Table format specification
+.
This part must be given, it is not optional.
.
It determines the number of columns (cells) of the table.
@@ -123,7 +137,7 @@ at the end of the last line.
.
After each cell definition,
.I column specifiers
-can be appended, but that's optional.
+can be appended, but that\[aq]s optional.
.
.
.P
@@ -139,6 +153,8 @@ is an arbitrary character.
.
.\" --------------------------------------------------------------------
.SH "SIMPLE EXAMPLES"
+.\" --------------------------------------------------------------------
+.
The easiest table definition is.
.RS
.EX
@@ -237,11 +253,14 @@ which is here
.
.\" --------------------------------------------------------------------
.SS Global options
+.\" --------------------------------------------------------------------
+.
The line immediately following the
.B .TS
-macro may contain any of the following global options (ignoring the case of
-characters \[en] Unix tbl only accepts options with all characters lowercase
-or all characters uppercase), separated by spaces, tabs, or commas:
+macro may contain any of the following global options (ignoring the
+case of characters \[en] Unix tbl only accepts options with all
+characters lowercase or all characters uppercase), separated by
+spaces, tabs, or commas:
.
.TP
.B allbox
@@ -254,6 +273,7 @@ Enclose the table in a box.
.TP
.B center
Center the table (default is left-justified).
+.
The alternative keyword name
.B centre
is also recognized (this is a GNU tbl extension).
@@ -284,7 +304,9 @@ Same as doublebox (GNU tbl only).
.B expand
Make the table as wide as the current line length (providing a column
separation factor).
-Ignored if one or more `x' column specifiers are used (see below).
+.
+Ignored if one or more \[oq]x\[cq] column specifiers are used (see
+below).
.
.IP
In case the sum of the column widths is larger than the current line length,
@@ -305,11 +327,13 @@ type.
.
.TP
.B nokeep
-Don't use diversions to prevent page breaks (GNU tbl only).
+Don\[aq]t use diversions to prevent page breaks (GNU tbl only).
+.
Normally
.B tbl
attempts to prevent undesirable breaks in boxed tables by using diversions.
-This can sometimes interact badly with macro packages' own use of
+.
+This can sometimes interact badly with macro packages own use of
diversions, when footnotes, for example, are used.
.
.TP
@@ -318,8 +342,8 @@ Ignore leading and trailing spaces in data items (GNU tbl
only).
.
.TP
.B nowarn
-Turn off warnings related to tables
-exceeding the current line width (GNU tbl only).
+Turn off warnings related to tables exceeding the current line width
+(GNU tbl only).
.
.TP
.BI tab( x )
@@ -327,48 +351,64 @@ Use the character
.I x
instead of a tab to separate items in a line of input data.
.
+.
.LP
The global options must end with a semicolon.
-There might be whitespace between an option and its argument in parentheses.
.
+There might be whitespace between an option and its argument in
+parentheses.
.
+.
+.\" --------------------------------------------------------------------
.SS Table format specification
+.\" --------------------------------------------------------------------
+.
After global options come lines describing the format of each line of
the table.
-Each such format line describes one line of the table itself, except that
-the last format line (which you must end with a period) describes all
-remaining lines of the table.
+.
+Each such format line describes one line of the table itself, except
+that the last format line (which you must end with a period) describes
+all remaining lines of the table.
+.
A single-key character describes each column of each line of the table.
Key characters can be separated by spaces or tabs.
-You may run format specifications for multiple lines together on the same
-line by separating them with commas.
+.
+You may run format specifications for multiple lines together on the
+same line by separating them with commas.
+.
.
.LP
-You may follow each key character with specifiers that determine the font
-and point size of the corresponding item, that determine column width,
-inter-column spacing, etc.
+You may follow each key character with specifiers that determine the
+font and point size of the corresponding item, that determine column
+width, inter-column spacing, etc.
+.
.
.LP
-The longest format line defines the number of columns in the table; missing
-format descriptors at the end of format lines are assumed to be\~\c
+The longest format line defines the number of columns in the table;
+missing format descriptors at the end of format lines are assumed to
+be\~\c
.BR L .
-Extra columns in the data (which have no corresponding format entry) are
-ignored.
+.
+Extra columns in the data (which have no corresponding format entry)
+are ignored.
+.
.
.LP
The available key characters are:
.
.TP
.BR a , A
-Center longest line in this column and then left-justifies all other lines
-in this column with respect to that centered line.
-The idea is to use such alphabetic subcolumns (hence the name of the key
-character) in combination with\~
+Center longest line in this column and then left-justifies all other
+lines in this column with respect to that centered line.
+.
+The idea is to use such alphabetic subcolumns (hence the name of the
+key character) in combination with\~
.BR L ;
they are called subcolumns because
.BR A \~items
are indented by\~1n relative to
.BR L \~entries.
+.
Example:
.RS
.IP
@@ -419,13 +459,17 @@ Left-justify item within the column.
.BR n , N
Numerically justify item in the column: Units positions of numbers are
aligned vertically.
+.
If there is one or more dots adjacent to a digit, use the rightmost one for
vertical alignment.
+.
If there is no dot, use the rightmost digit for vertical alignment;
otherwise, center the item within the column.
-Alignment can be forced to a certain position using `\[rs]&'; if there is
-one or more instances of this special (non-printing) character present
-within the data, use the leftmost one for alignment.
+.
+Alignment can be forced to a certain position using \[oq]\[rs]&\[cq];
+if there is one or more instances of this special (non-printing)
+character present within the data, use the leftmost one for alignment.
+.
Example:
.RS
.IP
@@ -473,6 +517,7 @@ regime) relative to the widest
or
.BR R \~entry,
preserving the alignment of all numerical entries.
+.
Contrary to
.BR A \~type
entries, there is no extra indentation.
@@ -483,8 +528,9 @@ Using equations (to be processed with
within columns which use the
.BR N \~specifier
is problematic in most cases due to
-.BR tbl 's
+.BR tbl \[aq]s
algorithm for finding the vertical alignment, as described above.
+.
Using the global
.B delim
option, however, it is possible to make
@@ -501,24 +547,28 @@ Right-justify item within the column.
.TP
.BR s , S
Span previous item on the left into this column.
+.
Not allowed for the first column.
.
.TP
.B ^
Span down entry from previous row in this column.
+.
Not allowed for the first row.
.
.TP
.BR _ , -
Replace this entry with a horizontal line.
-Note that `_' and `-' can be used for table fields only,
+.
+Note that \[oq]_\[cq] and \[oq]-\[cq] can be used for table fields only,
not for column separator lines.
.
.TP
.B =
.
Replace this entry with a double horizontal line.
-Note that `=' can be used for table fields only,
+.
+Note that \[oq]=\[cq] can be used for table fields only,
not for column separator lines.
.
.TP
@@ -526,23 +576,29 @@ not for column separator lines.
The corresponding column becomes a vertical rule (if two of these are
adjacent, a double vertical rule).
.
+.
.LP
-A vertical bar to the left of the first key letter or to the right of the
-last one produces a line at the edge of the table.
+A vertical bar to the left of the first key letter or to the right of
+the last one produces a line at the edge of the table.
+.
.
.LP
To change the data format within a table, use the
.B .T&
command (at the start of a line).
-It is followed by format and data lines (but no global options) similar to
-the
+.
+It is followed by format and data lines (but no global options)
+similar to the
.B .TS
request.
.
.
+.\" --------------------------------------------------------------------
.SS Column specifiers
-Here are the specifiers that can appear in suffixes to column key letters
-(in any order):
+.\" --------------------------------------------------------------------
+.
+Here are the specifiers that can appear in suffixes to column key
+letters (in any order):
.
.TP
.BR b , B
@@ -553,9 +609,10 @@ Short form of
.TP
.BR d , D
Start an item that vertically spans rows,
-using the `^' column specifier or `\[rs]^' data item,
+using the \[oq]^\[cq] column specifier or \[oq]\[rs]^\[cq] data item,
at the bottom of its range rather
than vertically centering it (GNU tbl only).
+.
Example:
.RS
.IP
@@ -613,6 +670,7 @@ T};bar
.TP
.BR e , E
Make equally-spaced columns.
+.
All columns marked with this specifier get the same width; this happens
after the affected column widths have been computed (this means that the
largest width value rules).
@@ -622,6 +680,7 @@ largest width value rules).
Either of these specifiers may be followed by a font name (either one or two
characters long), font number (a single digit), or long name in parentheses
(the last form is a GNU tbl extension).
+.
A one-letter font name must be separated by one or more blanks from whatever
follows.
.
@@ -634,20 +693,27 @@ Short form of
.TP
.BR m , M
This is a GNU tbl extension.
+.
Either of these specifiers may be followed by a macro name
(either one or two characters long),
or long name in parentheses.
-A one-letter macro name must be separated by one or more blanks
-from whatever follows.
-The macro which name can be specified here
-must be defined before creating the table.
-It is called just before the table's cell text is output.
-As implemented currently, this macro is only called if block input is used,
-that is, text between `T{' and `T}'.
+.
+A one-letter macro name must be separated by one or more blanks from
+whatever follows.
+.
+The macro which name can be specified here must be defined before
+creating the table.
+.
+It is called just before the table\[aq]s cell text is output.
+.
+As implemented currently, this macro is only called if block input is
+used, that is, text between \[oq]T{\[cq] and \[oq]T}\[cq].
+.
The macro should contain only simple
.B troff
requests to change the text block formatting, like text adjustment,
hyphenation, size, or font.
+.
The macro is called
.I after
other cell modifications like
@@ -656,13 +722,16 @@ other cell modifications like
or
.B v
are output.
+.
Thus the macro can overwrite other modification specifiers.
.
.TP
.BR p , P
Followed by a number, this does a point size change for the affected fields.
-If signed, the current point size is incremented or decremented (using a
-signed number instead of a signed digit is a GNU tbl extension).
+.
+If signed, the current point size is incremented or decremented (using
+a signed number instead of a signed digit is a GNU tbl extension).
+.
A point size specifier followed by a column separation number must be
separated by one or more blanks.
.
@@ -677,13 +746,17 @@ Move the corresponding column up one half-line.
.
.TP
.BR v , V
-Followed by a number, this indicates the vertical line spacing to be used in
-a multi-line table entry.
-If signed, the current vertical line spacing is incremented or decremented
-(using a signed number instead of a signed digit is a GNU tbl extension).
-A vertical line spacing specifier followed by a column separation number
-must be separated by one or more blanks.
-No effect if the corresponding table entry isn't a text block.
+Followed by a number, this indicates the vertical line spacing to be
+used in a multi-line table entry.
+.
+If signed, the current vertical line spacing is incremented or
+decremented (using a signed number instead of a signed digit is a GNU
+tbl extension).
+.
+A vertical line spacing specifier followed by a column separation
+number must be separated by one or more blanks.
+.
+No effect if the corresponding table entry isn\[aq]t a text block.
.
.TP
.BR w , W
@@ -691,35 +764,44 @@ Minimum column width value.
Must be followed either by a
.BR @address@hidden (@MAN1EXT@)
width expression in parentheses or a unitless integer.
+.
If no unit is given, en units are used.
+.
Also used as the default line length for included text blocks.
+.
If used multiple times to specify the width for a particular column,
the last entry takes effect.
.
.TP
.BR x , X
An expanded column.
+.
After computing all column widths without an
.BR x \~specifier,
use the remaining line width for this column.
+.
If there is more than one expanded column, distribute the remaining
horizontal space evenly among the affected columns (this is a GNU
extension).
+.
This feature has the same effect as specifying a minimum column width.
.
.TP
.BR z , Z
-Ignore the corresponding column for width-calculation purposes, this is,
-don't use the fields but only the specifiers of this column to compute
-its width.
+Ignore the corresponding column for width-calculation purposes, this
+is, don\[aq]t use the fields but only the specifiers of this column to
+compute its width.
+.
.
.LP
A number suffix on a key character is interpreted as a column
separation in en units (multiplied in proportion if the
.B expand
option is on \[en] in case of overfull tables this might be zero).
+.
Default separation is 3n.
.
+.
.LP
The column
.RB specifier\~ x
@@ -743,22 +825,30 @@ or
.RB overrides\~ x .
.
.
+.\" --------------------------------------------------------------------
.SS Table data
+.\" --------------------------------------------------------------------
+.
The format lines are followed by lines containing the actual data for the
table, followed finally by
.BR .TE .
-Within such data lines, items are normally separated by tab characters (or
-the character specified with the
+.
+Within such data lines, items are normally separated by tab characters
+(or the character specified with the
.B tab
option).
-Long input lines can be broken across multiple lines if the last character
-on the line is `\[rs]' (which vanishes after concatenation).
+.
+Long input lines can be broken across multiple lines if the last
+character on the line is \[oq]\[rs]\[cq] (which vanishes after
+concatenation).
+.
.
.LP
Note that
.B @address@hidden
computes the column widths line by line, applying \[rs]w on each entry
-which isn't a text block.
+which isn\[aq]t a text block.
+.
As a consequence, constructions like
.IP
.EX
@@ -792,40 +882,53 @@ or
\&.TE
.EE
.
+.
.LP
-A dot starting a line, followed by anything but a digit is handled as a
-troff command, passed through without changes.
+A dot starting a line, followed by anything but a digit is handled as
+a troff command, passed through without changes.
+.
The table position is unchanged in this case.
.
+.
.LP
-If a data line consists of only `_' or `=', a single or double line,
-respectively, is drawn across the table at that point; if a single item in a
-data line consists of only `_' or `=', then that item is replaced by a
-single or double line, joining its neighbours.
-If a data item consists only of `\[rs]_' or `\[rs]=', a single or double line,
-respectively, is drawn across the field at that point which does not join
-its neighbours.
+If a data line consists of only \[oq]_\[cq] or \[oq]=\[cq], a single
+or double line, respectively, is drawn across the table at that point;
+if a single item in a data line consists of only \[oq]_\[cq] or
+\[oq]=\[cq], then that item is replaced by a single or double line,
+joining its neighbours.
+.
+If a data item consists only of \[oq]\[rs]_\[cq] or \[oq]\[rs]=\[cq],
+a single or double line, respectively, is drawn across the field at
+that point which does not join its neighbours.
+.
.
.LP
-A data item consisting only of `\[rs]Rx' (`x' any character) is replaced by
-repetitions of character `x' as wide as the column (not joining its
-neighbours).
+A data item consisting only of \[oq]\[rs]Rx\[cq] (\[oq]x\[cq] any
+character) is replaced by repetitions of character \[oq]x\[cq] as wide
+as the column (not joining its neighbours).
+.
.
.LP
-A data item consisting only of `\[rs]^' indicates that the field immediately
-above spans downward over this row.
+A data item consisting only of \[oq]\[rs]^\[cq] indicates that the
+field immediately above spans downward over this row.
.
.
+.\" --------------------------------------------------------------------
.SS Text blocks
-A text block can be used to enter data as a single entry which would be
-too long as a simple string between tabs.
-It is started with `T{' and closed with `T}'.
+.\" --------------------------------------------------------------------
+.
+A text block can be used to enter data as a single entry which would
+be too long as a simple string between tabs.
+.
+It is started with \[oq]T{\[cq] and closed with \[oq]T}\[cq].
+.
The former must end a line, and the latter must start a line, probably
-followed by other data columns (separated with tabs or the character given
-with the
+followed by other data columns (separated with tabs or the character
+given with the
.B tab
global option).
.
+.
.LP
By default, the text block is formatted with the settings which were
active before entering the table, possibly overridden by the
@@ -834,6 +937,7 @@ active before entering the table, possibly overridden by the
and
.B w
tbl specifiers.
+.
For example, to make all text blocks ragged-right, insert
.B .na
right before the starting
@@ -842,41 +946,50 @@ right before the starting
.B .ad
after the table).
.
+.
.LP
-If either `w' or `x' specifiers are not given for
+If either \[oq]w\[cq] or \[oq]x[cq] specifiers are not given for
.I all
-columns of a text block span, the default length of the text block (to be
-more precise, the line length used to process the text block diversion) is
-computed as L\[tmu]C/(N+1), where `L' is the current line length, `C' the
-number of columns spanned by the text block, and `N' the total number of
-columns in the table.
+columns of a text block span, the default length of the text block (to
+be more precise, the line length used to process the text block
+diversion) is computed as L\[tmu]C/(N+1), where \[oq]L\[cq] is the
+current line length, \[oq]C\[cq] the number of columns spanned by the
+text block, and \[oq]N\[cq] the total number of columns in the table.
+.
Note, however, that the actual diversion width as returned in register
.B \[rs]n[dl]
is used eventually as the text block width.
+.
If necessary, you can also control the text block width with a direct
insertion of a
.B .ll
-request right after `T{'.
+request right after \[oq]T{\[cq].
.
.
+.\" --------------------------------------------------------------------
.SS Miscellaneous
+.\" --------------------------------------------------------------------
+.
The number register
.B \[rs]n[TW]
-holds the table width; it can't be used within the table itself but is defined
-right before calling
+holds the table width; it can\[aq]t be used within the table itself
+but is defined right before calling
.B .TE
so that this macro can make use of it.
.
+.
.LP
.B tbl
also defines a macro
.B .T#
which produces the bottom and side lines of a boxed table.
+.
While
.B tbl
does call this macro itself at the end of the table, it can be used by
macro packages to create boxes for multi-page tables by calling it within the
page footer.
+.
An example of this is shown by the
.B \-ms
macros which provide this functionality if a table starts with
@@ -886,7 +999,10 @@ instead of the standard call to the
macro.
.
.
+.\" --------------------------------------------------------------------
.SH "INTERACTION WITH @address@hidden"
+.\" --------------------------------------------------------------------
+.
.BR @address@hidden (@MAN1EXT@)
should always be called before
.BR @address@hidden (@MAN1EXT@)
@@ -894,37 +1010,52 @@ should always be called before
automatically takes care of the correct order of preprocessors).
.
.
+.\" --------------------------------------------------------------------
.SH "GNU TBL ENHANCEMENTS"
+.\" --------------------------------------------------------------------
+.
There is no limit on the number of columns in a table, nor any limit on the
number of text blocks.
+.
All the lines of a table are considered in deciding column widths, not just
the first 200.
+.
Table continuation
.RB ( .T& )
lines are not restricted to the first 200 lines.
.
+.
.LP
Numeric and alphabetic items may appear in the same column.
.
+.
.LP
Numeric and alphabetic items may span horizontally.
.
+.
.LP
.B @address@hidden
uses register, string, macro and diversion names beginning with the digit\~\c
.BR 3 .
+.
When using
.B @address@hidden
you should avoid using any names beginning with a\~\c
.BR 3 .
.
.
+.\" --------------------------------------------------------------------
.SH "GNU TBL WITHIN MACROS"
+.\" --------------------------------------------------------------------
+.
Since
.B @address@hidden
defines its own macros (right before each table) it is necessary to use
-an `end-of-macro' macro. Additionally, the escape character has to be switched
-off. Here an example.
+an \[oq]end-of-macro\[cq] macro.
+.
+Additionally, the escape character has to be switched off.
+.
+Here an example.
.IP
.EX
\&.eo
@@ -941,6 +1072,7 @@ off. Here an example.
\&.ATABLE And \[dq]another one\[dq]
.EE
.
+.
.LP
Note, however, that not all features of
.B @address@hidden
@@ -948,34 +1080,43 @@ can be wrapped into a macro because
.B @address@hidden
sees the input earlier than
.BR @address@hidden .
+.
For example, number formatting with vertically aligned decimal points
fails if those numbers are passed on as macro parameters because
decimal point alignment is handled by
.B @address@hidden
-itself: It only sees `\[rs]$1', `\[rs]$2', etc., and therefore can't
-recognize the decimal point.
+itself: It only sees \[oq]\[rs]$1\[cq], \[oq]\[rs]$2\[cq], etc., and
+therefore can\[aq]t recognize the decimal point.
.
.
+.\" --------------------------------------------------------------------
.SH BUGS
+.\" --------------------------------------------------------------------
+.
You should use
.BR .TS\ H / .TH
in conjunction with a supporting macro package for
.I all
multi-page boxed tables.
+.
If there is no header that you wish to appear at the top of each page
of the table, place the
.B .TH
line immediately after the format section.
+.
Do not enclose a multi-page table within keep/release macros,
or divert it in any other way.
.
+.
.LP
A text block within a table must be able to fit on one page.
.
+.
.LP
The
.B bp
request cannot be used to force a page-break in a multi-page table.
+.
Instead, define
.B BP
as follows
@@ -988,18 +1129,22 @@ as follows
\&..
.EE
.
+.
.LP
and use
.B BP
instead of
.BR bp .
.
+.
.LP
Using \[rs]a directly in a table to get leaders does not work (except in
compatibility mode).
+.
This is correct behaviour: \[rs]a is an
.B uninterpreted
leader.
+.
To get leaders use a real leader, either by using a control A or like
this:
.
@@ -1015,13 +1160,14 @@ this:
.
.
.LP
-A leading and/or trailing `|' in a format line, such as
+A leading and/or trailing \[oq]|\[cq] in a format line, such as
.
.IP
.EX
|l r|.
.EE
.
+.
.LP
gives output which has a 1n\~space between the resulting
bordering vertical rule and the content of the adjacent column,
@@ -1036,6 +1182,7 @@ as in
\&.TE
.EE
.
+.
.LP
If it is desired to have zero space (so that the rule touches
the content), this can be achieved by introducing extra \[lq]dummy\[rq]
@@ -1051,21 +1198,36 @@ as in
\&.TE
.EE
.
+.
.LP
The resulting \[lq]dummy\[rq] columns are invisible and have zero width;
-note that such columns usually don't work with TTY devices.
+note that such columns usually don\[aq]t work with TTY devices.
.
.
+.\" --------------------------------------------------------------------
.SH REFERENCE
+.\" --------------------------------------------------------------------
+.
Lesk, M.E.: "TBL \[en] A Program to Format Tables".
For copyright reasons it cannot be included in the groff distribution,
but copies can be found with a title search on the World Wide Web.
.
.
+.\" --------------------------------------------------------------------
.SH "SEE ALSO"
+.\" --------------------------------------------------------------------
+.
.BR groff (@MAN1EXT@),
.BR @address@hidden (@MAN1EXT@)
.
+.
+.\" --------------------------------------------------------------------
+.SH COPYING
+.\" --------------------------------------------------------------------
+.
+.co
+.
+.
.\" Local Variables:
.\" mode: nroff
.\" End:
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 01/01: src/preproc/tbl/*: Improve the license information.,
Bernd Warken <=