[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 06/07: groff_hdbtl(7): Fix style nits.
From: |
G. Branden Robinson |
Subject: |
[groff] 06/07: groff_hdbtl(7): Fix style nits. |
Date: |
Wed, 4 Nov 2020 07:32:51 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit 4342b3ef91e3e7755652b8bae7ef561d2a1a1c03
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Nov 4 22:50:42 2020 +1100
groff_hdbtl(7): Fix style nits.
I noticed these while cleaning up filling and hyphenation requests in
the previous commit. This was not an editing pass; much remains to be
done with this page.
* Set macro package names in italics, not bold.
* Talk about "terminals", not "tty"s (in italics no less!).
* Say "output drivers" rather than "output devices" (see
1bcd8af31274b76a670a5ee784dd6a418a054369, 28 October).
* Break input lines after commas.
* Use a full and accurate path to the common.roff example file. Let it
break after slashes and before dots.
* Use two empty requests where inter-paragraph space is expected.
---
contrib/hdtbl/groff_hdtbl.7.man | 38 ++++++++++++++++++++------------------
1 file changed, 20 insertions(+), 18 deletions(-)
diff --git a/contrib/hdtbl/groff_hdtbl.7.man b/contrib/hdtbl/groff_hdtbl.7.man
index e88416e..3a13aa3 100644
--- a/contrib/hdtbl/groff_hdtbl.7.man
+++ b/contrib/hdtbl/groff_hdtbl.7.man
@@ -203,7 +203,7 @@ this is not implemented yet.
.
In this and the next section, we present examples to help users
understand the basic workflow of
-.BR hdtbl .
+.IR hdtbl .
.
First of all, you must load the
.I hdtbl.tmac
@@ -229,7 +229,7 @@ Either add the line
to your
.I roff
file before using any macros of the
-.B hdtbl
+.I hdtbl
package, or add the option
.
.PP
@@ -242,7 +242,7 @@ package, or add the option
.
.PP
to the command line of groff (before the document file which contains
-.B hdtbl
+.I hdtbl
macros).
.
Then you can include on or more tables in your document, where each one
@@ -254,11 +254,15 @@ macros, respectively.
.
.
.PP
-In this man page, we approximate the result of each example in the
-.I tty
-format to be as generic as possible since
-.B hdtbl
-currently only supports the PS and PDF output devices.
+In this man page,
+we approximate the result of each example as terminal ouput to be as
+generic as possible since
+.I hdtbl
+currently only supports the
+.B ps
+and
+.B pdf
+output drivers.
.
.
.PP
@@ -281,9 +285,7 @@ Here we construct a table with only one cell.
.
.
.PP
-A
-.I tty
-representation is
+A terminal representation is
.
.
.PP
@@ -339,9 +341,7 @@ can be written as
.
.
.PP
-A
-.I tty
-representation is
+A terminal representation is
.
.
.PP
@@ -492,7 +492,7 @@ enclosed in double quotes.
The order of macro calls and other tokens follows the HTML model.
.
In the following list, valid predecessors and successors of all
-.B hdtbl
+.I hdtbl
macros are given, together with the possible arguments.
.
.PP
@@ -1163,6 +1163,8 @@ Before creating the first table, you should configure
default values
to minimize the markup needed in each table.
.
The following example sets up defaults suitable for typical papers:
+.
+.
.PP
.RS
.EX
@@ -1176,7 +1178,7 @@ The following example sets up defaults suitable for
typical papers:
.
.PP
The file
-.B examples/common.roff
+.I \%@EXAMPLEDIR@/\:hdtbl/\:\%common\:.roff
provides another example setup
in the \[lq]minimal Page setup\[rq] section.
.
@@ -1203,7 +1205,7 @@ For example, say
.
.PP
if you use the
-.B ms
+.I ms
macro package.
.
.
@@ -1233,7 +1235,7 @@ For example:
.
.PP
If you use the
-.B ms
+.I ms
macro package.
.
.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 06/07: groff_hdbtl(7): Fix style nits.,
G. Branden Robinson <=