doc/xslt/fo/table.xml

   1 <?xml version="1.0"?>
   2
   3 <reference xml:id="table-templates"><?dbhtml dir="fo"?>
   4
   5   <info>
   6     <title>Formatting Object Table Reference</title>
   7     <releaseinfo role="meta">
   8       $Id: table.xsl 8814 2010-08-09 21:19:53Z bobstayton $
   9     </releaseinfo>
  10   </info>
  11   <partintro xml:id="partintro">
  12     <title>Introduction</title>
  13
  14 <para>This is technical reference documentation for the FO
  15       table-processing templates in the DocBook XSL Stylesheets.</para>
  16
  17
  18 <para>This is not intended to be user documentation.  It is
  19       provided for developers writing customization layers for the
  20       stylesheets.</para>
  21
  22   </partintro>
  23
  24 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="template.calc.column.width">
  25 <refnamediv>
  26 <refname>calc.column.width</refname>
  27 <refpurpose>Calculate an XSL FO table column width specification from a
  28 CALS table column width specification.</refpurpose>
  29 </refnamediv>
  30 <refsynopsisdiv>
  31 <synopsis>&lt;xsl:template name="calc.column.width"&gt;
  32 &lt;xsl:param name="colwidth"&gt;1*&lt;/xsl:param&gt;
  33   ...
  34 &lt;/xsl:template&gt;</synopsis>
  35 </refsynopsisdiv>
  36 <refsect1><title>Description</title>
  37
  38 <para>CALS expresses table column widths in the following basic
  39 forms:</para>
  40
  41
  42
  43 <itemizedlist>
  44 <listitem>
  45
  46 <para><emphasis>99.99units</emphasis>, a fixed length specifier.</para>
  47
  48 </listitem>
  49 <listitem>
  50
  51 <para><emphasis>99.99</emphasis>, a fixed length specifier without any units.</para>
  52
  53 </listitem>
  54 <listitem>
  55
  56 <para><emphasis>99.99*</emphasis>, a relative length specifier.</para>
  57
  58 </listitem>
  59 <listitem>
  60
  61 <para><emphasis>99.99*+99.99units</emphasis>, a combination of both.</para>
  62
  63 </listitem>
  64 </itemizedlist>
  65
  66
  67
  68 <para>The CALS units are points (pt), picas (pi), centimeters (cm),
  69 millimeters (mm), and inches (in). These are the same units as XSL,
  70 except that XSL abbreviates picas "pc" instead of "pi". If a length
  71 specifier has no units, the CALS default unit (pt) is assumed.</para>
  72
  73
  74
  75 <para>Relative length specifiers are represented in XSL with the
  76 proportional-column-width() function.</para>
  77
  78
  79
  80 <para>Here are some examples:</para>
  81
  82
  83
  84 <itemizedlist>
  85 <listitem>
  86
  87 <para>"36pt" becomes "36pt"</para>
  88
  89 </listitem>
  90 <listitem>
  91
  92 <para>"3pi" becomes "3pc"</para>
  93
  94 </listitem>
  95 <listitem>
  96
  97 <para>"36" becomes "36pt"</para>
  98
  99 </listitem>
 100 <listitem>
 101
 102 <para>"3*" becomes "proportional-column-width(3)"</para>
 103
 104 </listitem>
 105 <listitem>
 106
 107 <para>"3*+2pi" becomes "proportional-column-width(3)+2pc"</para>
 108
 109 </listitem>
 110 <listitem>
 111
 112 <para>"1*+2" becomes "proportional-column-width(1)+2pt"</para>
 113
 114 </listitem>
 115 </itemizedlist>
 116
 117 </refsect1><refsect1><title>Parameters</title>
 118
 119 <variablelist>
 120 <varlistentry><term>colwidth</term>
 121 <listitem>
 122
 123 <para>The CALS column width specification.</para>
 124
 125 </listitem>
 126 </varlistentry>
 127 </variablelist>
 128
 129 </refsect1><refsect1><title>Returns</title>
 130
 131 <para>The XSL column width specification.</para>
 132
 133 </refsect1></refentry>
 134 </reference>
 135