[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Groff-commit] groff/contrib/hdtbl ChangeLog groff_hdtbl.man
|
From: |
Werner LEMBERG |
|
Subject: |
[Groff-commit] groff/contrib/hdtbl ChangeLog groff_hdtbl.man |
|
Date: |
Mon, 04 Feb 2013 09:07:13 +0000 |
CVSROOT: /cvsroot/groff
Module name: groff
Changes by: Werner LEMBERG <wl> 13/02/04 09:07:13
Modified files:
contrib/hdtbl : ChangeLog groff_hdtbl.man
Log message:
* groff_hdtbl.man: Revised.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/groff/contrib/hdtbl/ChangeLog?cvsroot=groff&r1=1.36&r2=1.37
http://cvs.savannah.gnu.org/viewcvs/groff/contrib/hdtbl/groff_hdtbl.man?cvsroot=groff&r1=1.14&r2=1.15
Patches:
Index: ChangeLog
===================================================================
RCS file: /cvsroot/groff/groff/contrib/hdtbl/ChangeLog,v
retrieving revision 1.36
retrieving revision 1.37
diff -u -b -r1.36 -r1.37
--- ChangeLog 20 Sep 2012 18:18:34 -0000 1.36
+++ ChangeLog 4 Feb 2013 09:07:13 -0000 1.37
@@ -1,3 +1,11 @@
+2013-02-04 Werner LEMBERG <address@hidden>
+
+ * groff_hdtbl.man: Revised.
+
+2013-02-03 Bernd Warken <address@hidden>
+
+ * groff_hdtbl.man: Correct and extend this man-page.
+
2012-09-20 Werner LEMBERG <address@hidden>
Simplify enviroment handling.
@@ -289,7 +297,7 @@
* Import of hdtbl 0.91 (with some further modifications). Still
many rough edges.
-Copyright 2006, 2008-2012
+Copyright 2006, 2008-2013
Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
Index: groff_hdtbl.man
===================================================================
RCS file: /cvsroot/groff/groff/contrib/hdtbl/groff_hdtbl.man,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -b -r1.14 -r1.15
--- groff_hdtbl.man 3 Feb 2013 22:26:03 -0000 1.14
+++ groff_hdtbl.man 4 Feb 2013 09:07:13 -0000 1.15
@@ -202,18 +202,19 @@
.
.SH USAGE
.
-In this and the next section, we present examples to help
-understanding how to use
+In this and the next section, we present examples to help users
+understand the basic workflow of
.BR hdtbl .
.
-If you want to it you must first call its
-.I tmac
-file.
+First of all, you must load
+.I hdtbl.tmac
+file to the document.
.
-That means that you must include the following line in your
+That means that you must add the following line to your
.I roff
-file before using
-.BR hdtbl :
+file before using any macros of the
+.B hdtbl
+package:
.
.PP
.nf
@@ -225,23 +226,22 @@
.RE
.
.PP
-Then you can include on or more tables in your document, each one must
-be started with the command
+Then you can include on or more tables in your document, where each one
+must be started and ended with the
.CR .TBL
-and ended by the command
-.CR ".ETB \fR."
+and
+.CR .ETB
+macros, respectively.
.
-We will show the output of each example in the
+.PP
+In this man page, we approximate the result of each example in the
.I tty
-format.
-.
-But the graphical output is much more beautiful, it cannot however be
-shown in the
-.B man
-output.
+format to be as generic as possible since
+.B hdtbl
+currently only supports the PS and PDF output devices.
.
.PP
-The simplest well\-formed table consists of just single calls to the
+The simplest well-formed table consists of just single calls to the
four base table macros in the right order.
.
Here we construct a table with only one cell.
@@ -260,21 +260,21 @@
.RE
.
.PP
-Its
+A
.I tty
-output is
+representation is
.
.PP
.nf
.nh
.RS
-| |
-+contents-of-the-table-cell--------------------------------------+
++------------------------------------------------------+
+| contents-of-the-table-cell |
++------------------------------------------------------+
.RE
.hy
.fi
.
-
.PP
Equivalent to the above is the following notation.
.
@@ -282,7 +282,7 @@
.RS
.nh
.nf
-.CRI ".TBL .TR .TD " "contents of the table cell" " .ETB"
+.CRI ".TBL .TR .TD \[dq]" "contents of the table cell" "\[dq] .ETB"
.fi
.hy
.RE
@@ -315,19 +315,19 @@
.RE
.
.PP
-Its
+A
.I tty
-output is
+representation is
.
.PP
.nf
.nh
.RS
-| | |
-|1*1 | 1*2 |
-+-------------------------------+--------------------------------+
-+2*1----------------------------+-2*2----------------------------+
- |
++--------------------------+---------------------------+
+| 1*1 | 1*2 |
++--------------------------+---------------------------+
+| 2*1 | 2*2 |
++--------------------------+---------------------------+
.RE
.hy
.fi
@@ -397,7 +397,9 @@
.RE
.
.PP
-are similar but not identical.
+are similar but not identical (the use of
+.B .nop
+is purely cosmetic to get proper indentation).
.
.PP
The first table looks like
@@ -406,11 +408,13 @@
.nf
.nh
.RS
++------------------------------------------------------+
+| 1*1 1*2 |
++------------------------------------------------------+
| |
-|1*1 1*2 |
-+----------------------------------------------------------------+
+| 2*1 2*2 |
| |
-+-2*1----------------------------2*2-----------------------------+
++------------------------------------------------------+
.RE
.hy
.fi
@@ -422,10 +426,11 @@
.nf
.nh
.RS
-| |
-|1*1 1*2 |
-+-------------------------------+--------------------------------+
-+2*1----------------------------+-2*2----------------------------+
++------------------------------------------------------+
+| 1*1 1*2 |
++---------------------------+--------------------------+
+| 2*1 | 2*2 |
++---------------------------+--------------------------+
.RE
.hy
.fi
@@ -444,8 +449,9 @@
.RE
.
.PP
-If a macro has one or more arguments, and it is not starting a line, it must
-be enclosed in double quotes.
+If a macro has one or more arguments (see below), and it is not starting a
+line, everything belonging to this macro including the macro itself must be
+enclosed in double quotes.
.
.
.SH MACROS AND ARGUMENTS
@@ -761,11 +767,9 @@
.nf
.nh
.CR .TBL cols=3
-.CR .TR \[rq].TH colspan=2 header1+2\[rq] \[rq].TH header3\[rq]
-.CR .TR \[rq].CR .TD 1*1 .TD 1*2 .TD 1*3\[rq]
-.CR .TR
-.CR .TD 1*2
-.CR .TD colspan=2 2+3*2
+.CR ". TR" \[dq].TH colspan=2\[dq] header1+2 .TH header3
+.CR ". TR" .TD 1*1 .TD 1*2 .TD 1*3
+.CR ". TR" .TD 2*1 \[dq].TD colspan=2\[dq] 2*2+3
.CR .ETB
.fi
.hy
@@ -778,13 +782,13 @@
.RS
.nf
.nh
-| | |
++------------------------------+---------------+
| header1+2 | header3 |
-+--------------------+---------------------+---------------------+
-|1*1 | 1*2 |1*3 |
-+--------------------+---------------------+---------------------+
-|1*2 | 2+3*2 |
-+--------------------+-------------------------------------------+
++--------------+---------------+---------------+
+| 1*1 | 1*2 | 1*3 |
++--------------+---------------+---------------+
+| 2*1 | 2*2+3 |
++--------------+-------------------------------+
.RE
.hy
.fi
@@ -799,31 +803,31 @@
.nf
.nh
.CR .TBL cols=3
-.CR .TR
-.CR .TD 1*1
-.CR .TD rowspan=2 1*2
-.CR .TD 1*3
+.CR ". TR"
+.CR ". TD" 1*1
+.CR ". TD" rowspan=2 1+2*2
+.CR ". TD" 1*3
.CR .
-.CR .TR
-.CR .TD 2*1
-.CR .TD 2*3
+.CR ". TR"
+.CR ". TD" 2*1
+.CR ". TD" 2*3
.CR .ETB
.fi
.hy
.RE
.
.PP
-That looks like
+which looks like
.
.PP
.RS
.nf
.nh
-| | | |
-|1*1 | 1*2 |1*3 |
-+--------------------+- +---------------------+
-+2*1-----------------+---------------------+2*3------------------+
- | |
++--------------+---------------+---------------+
+| 1*1 | 1+2*2 | 1*3 |
++--------------+ +---------------+
+| 2*1 | | 2*3 |
++--------------+-------------------------------+
.hy
.fi
.RE
- [Groff-commit] groff/contrib/hdtbl ChangeLog groff_hdtbl.man,
Werner LEMBERG <=