contrib/hdtbl/examples/short_reference.roff

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