From 818c508554e96bd14374798dc225accc009dcc13 Mon Sep 17 00:00:00 2001 From: wl Date: Fri, 2 Jan 2009 23:10:57 +0000 Subject: * README: Renamed to... * TODO: This, removing most of its contents. * groff_hdtbl.man: Add customization info which was in file README. --- contrib/hdtbl/ChangeLog | 9 ++++- contrib/hdtbl/README | 94 ------------------------------------------- contrib/hdtbl/TODO | 21 ++++++++++ contrib/hdtbl/groff_hdtbl.man | 39 +++++++++++++++++- 4 files changed, 67 insertions(+), 96 deletions(-) delete mode 100644 contrib/hdtbl/README create mode 100644 contrib/hdtbl/TODO diff --git a/contrib/hdtbl/ChangeLog b/contrib/hdtbl/ChangeLog index 341668fd..f061c258 100644 --- a/contrib/hdtbl/ChangeLog +++ b/contrib/hdtbl/ChangeLog @@ -1,3 +1,10 @@ +2009-01-03 Werner LEMBERG + + * README: Renamed to... + * TODO: This, removing most of its contents. + + * groff_hdtbl.man: Add customization info which was in file README. + 2008-01-04 Werner LEMBERG * groff_hdtbl.man: Replace .MTO with .MT/.ME. @@ -189,7 +196,7 @@ * Import of hdtbl 0.91 (with some further modifications). Still many rough edges. -Copyright 2006, 2008 +Copyright 2006, 2008, 2009 Free Software Foundation, Inc. Copying and distribution of this file, with or without modification, diff --git a/contrib/hdtbl/README b/contrib/hdtbl/README deleted file mode 100644 index 4daa392f..00000000 --- a/contrib/hdtbl/README +++ /dev/null @@ -1,94 +0,0 @@ - Copyright (C) 2005, 2006 - Free Software Foundation, Inc. - - Copying and distribution of this file, with or without modification, - are permitted in any medium without royalty provided the copyright - notice and this notice are preserved. - -This is Version 0.91 of hdtbl -============================= - -Content: --------- - - hdtbl.tmac Definition of the 4 base and three optional - hdtbl-macros. - Definition of internal utility macros. - Default settings for macro arguments. - - hdmisc.tmac Some macros from the hdgroff system internally - used bei hdtbl. - Some further hdgroff macros for the examples. - - groff_hdtbl.7 The hdtbl manpage. - groff_hdtbl.7.txt raw text manpage. - groff_hdtbl.7.ps PostScript formatted manpage. - groff_hdtbl.7.pdf PDF-formatted manpage. - groff_hdtbl.7.html HTML-formatted manpage. - - examples directory with 3 subdirectories: - - hdtblgroff: some hdtbl examples - - hdtblps: PS-formatted hdtbl examples - - hdtblpdf: PDF-formatted hdtbl examples - -Preparing the use of hdtbl: ---------------------------- - -For an easy use of the hdtbl macros you can copy the macro files -`hdtbl.tmac´ and `hdmisc.tmac´ in the directory `site-tmac´ of groff, -typical in `/usr/share/groff´ or `/usr/local/share/groff´. -A place for the man page `groff_hdtbl.7´ could be `/usr/man/man7´, -`/usr/share/man/man7´ or `/usr/local/man/man7´. - -Now you can call `groff -m hdtbl ...´ and `man groff_hdtbl´. -If you don't have access to the `site-tmac´ directory you can put -`hdtbl.tmac´ and `hdmisc.tmac´ into a private macro directory `xyz´ -and reference this with the aditional flag `-`M xyz´ when calling groff. - -If you like to use hdtbl in conjunction with another macro package, -e.g. ms, say `groff -m ms ...´ and in your document `.mso hdtbl.tmac´. -To get the behaviour, that a table, which does not fit on a partially -filled page, will be printed automatically on the top of the next page -you must append the little hdtbl utility macro `t*hm´to the page header -macro of the other macro package, e.g. for the ms macros: - - .am pg@top \" the ms pageheader macro - .t*hm - .. - -hdtbl has builtin pageheader- and pagebottom makros HM and BM. If they -interfere with your own, replace them with `.rm HM´ and `.rm BM´. - -You can change the default settings for hdtbl and the builtin pageheader -and -bottom macros by overwriting the corresponding registers and strings -at the beginning of file `hdtbl.tmac´. - -HDtbl is clean groff, but some of the examples and additional macros -in `hdmisc.tmac´ necessary for some examples use system requests via -`.sy´ and `.pso´. This requires a) to call groff with the `-U´ flag and -b) to provide for Windows an Unix environment like Cygwin or MinGW. - -To Do: ------- - -* Macro TOTC (Table Of Table Captions). - -* Automatic recognition of the number of columns. - -* Optional automatic calculation of the cellwidths from the widths of - the first line of the cellcontent instead of the explicit - specification with the width argument. This seems to be nontrivial - without a preprocessor or additional external calls vial .sy or .pso. - -* Handling of pagebreaks in tables. - -* Floating text left and/or right from tables. - -* Converter hdtbl2html (awk, elisp, perl?); should be easy to write. - -* Support for nroff. - -Enjoy with hdtbl! diff --git a/contrib/hdtbl/TODO b/contrib/hdtbl/TODO new file mode 100644 index 00000000..a3684e54 --- /dev/null +++ b/contrib/hdtbl/TODO @@ -0,0 +1,21 @@ +TODO +---- + +* Macro TOTC (Table Of Table Captions). + +* Automatic recognition of the number of columns. + +* Optional automatic calculation of the cell widths from the widths of the + first line of the cell content instead of the explicit specification with + the width argument. This seems to be non-trivial without a preprocessor + or additional external calls via .sy or .pso. + +* Handling of pagebreaks in tables. + +* Floating text left and/or right from tables. + +* Converter hdtbl2html (awk, elisp, perl?); should be easy to write. + +* Support for nroff. + +* Support for -Thtml. diff --git a/contrib/hdtbl/groff_hdtbl.man b/contrib/hdtbl/groff_hdtbl.man index 8ffd7962..83189954 100644 --- a/contrib/hdtbl/groff_hdtbl.man +++ b/contrib/hdtbl/groff_hdtbl.man @@ -1,5 +1,5 @@ .ig -Copyright (C) 2005, 2006, 2008 +Copyright (C) 2005, 2006, 2008, 2009 Free Software Foundation, Inc. Written by Joachim Walsdorff @@ -895,6 +895,43 @@ argument above. .XDEFS vl=s t*vl . . +.SH HDTBL CUSTOMIZATION +. +A table which does not fit on a partially filled page is printed +automatically on the top of the next page if you append the little +utility macro +.CR t*hm +to the page header macro of your document's main macro package. +For example, say +. +.PP +.RS +.nf +.CR ".am pg@top" +.CR ". t*hm" +.CR ".." +.fi +.RE +. +.PP +if you use the +.B ms +macro package. +. +.PP +.B hdtbl +has built-in page header and page footer macros, +.B HM +and +.BR BM . +If they interfere with your own header and footer macros, simply +say +.CR ".rm\ HM" +and +.CR ".rm\ BM" +to remove them. +. +. .SH AUTHOR . .MT Joachim.Walsdorff@urz.uni-heidelberg.de -- cgit v1.2.1