contrib/groff/contrib/hdtbl/examples/short_reference.roff

   1 .\" -*- mode: roff -*-
   2 .ig
   3
   4 short_reference.roff
   5
   6 This file is part of groff, the GNU roff type-setting system.
   7
   8 Copyright (C) 2005, 2006, 2009 Free Software Foundation, Inc.
   9 written by Joachim Walsdorff <Joachim.Walsdorff@urz.uni-heidelberg.de>.
  10
  11 groff is free software; you can redistribute it and/or modify it under
  12 the terms of the GNU General Public License as published by the Free
  13 Software Foundation, either version 3 of the License, or
  14 (at your option) any later version.
  15
  16 groff is distributed in the hope that it will be useful, but WITHOUT
  17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19 for more details.
  20
  21 You should have received a copy of the GNU General Public License
  22 along with this program. If not, see <http://www.gnu.org/licenses/>.
  23
  24 ..
  25 .
  26 .time start
  27 .pv 1.2 1.2 "" x
  28 .H Short Reference for the HDtbl-Macros
  29 This Short Reference describes the Heidelberger Table Macros
  30 using the macros themselves.
  31 .br
  32 .nr t*csp .3n
  33 .nr t*cpd .3n
  34 .ds t*ff HN
  35 .ds t*val m
  36 .ds t*hal l
  37 .xig
  38 .TBL "width=10% 40% 25% 25%" border= "fsz=1 .8"
  39 .CPTN Base- Optional- and Utility-Macros val=b
  40 .TR
  41 .TH Macro .TH Description .TH Predecessors .TH Successors
  42 .TR
  43 .TD \&.TBL .TD Begin a new table .TD \&.TD \&.TH \%.ETB cell content
  44 .TD \&.CPTN \&.TR
  45 .TR
  46 .TD \&.CPTN .TD Optional numbered or unnumbered table caption
  47 .TD \&.TBL .TD \&.TR
  48 .TR
  49 .TD \&.TR .TD Begin a new table row .TD \&.TBL \&.CPTN cell content
  50 .TD \&.TD \&.TR
  51 .TR
  52 .TD \&.TH .TD Optional begin table header cell
  53 .TD \&.TR \&.TD \&.TH \%.ETB cell content
  54 .TD \&.TD \&.TH \&.TR \%.ETB cell content
  55 .TR
  56 .TD \&.TH .TD Begin table data cell .TD \&.TR \&.TD \&.TH \%.ETB cell content
  57 .TD \&.TD \&.TH \&.TR \%.ETB cell content
  58 .TR
  59 .TD \&.ETB .TD Finish and print table .TD \&.TD \&.TH \%.ETB cell content
  60 .TD \&.TBL \&.TR \&.TD \&.TH \%.ETB cell content
  61 .TR
  62 .TD \&.t*free
  63 .TD colspan=3 val=t Utility macro to free held tables. Use it outside any table.
  64 .ETB
  65 .bp
  66 .x.
  67 .TBL "fsz=1 .8" "width=20% 32% 8% 8% 8% 8% 8% 8%" border=
  68 .TR
  69 .TH Argument .TH Value .TH \&.TBL .TH \&.CPT .TH \&.TR .TH \&.TH .TH \&.TD .TH \&.ETB
  70 .TR
  71 .TD border=\fI[n]\fP
  72 .TD border thickness .TD .ce X .TD .TD .TD .TD .TD
  73 .TR
  74 .TD bc=\fI[c]\fP
  75 .TD color of border and cellseperatorlines .TD .ce X .TD .TD .ce X .TD .ce X .TD .ce X .TD
  76 .ETB
  77 .H ------ incomplete -------
  78 .time end