granicus.if.org Git - docbook-dsssl/blob - jrefentry/jtest.xml

   1 <!DOCTYPE refentry PUBLIC "-//Norman Walsh//DTD JRefEntry V1.1//EN"
   2                           "jrefentry.dtd">
   3 <refentry>
   4 <refnamediv>
   5 <refname>calc.column.width</refname>
   6 <refpurpose>Calculate an XSL FO table column width specification from a
   7 CALS table column width specification.</refpurpose>
   8 </refnamediv>
   9
  10 <refdescription>
  11
  12 <para>CALS expresses table column widths in the following basic
  13 forms:</para>
  14
  15 <itemizedlist>
  16 <listitem>
  17 <para><emphasis>99.99units</emphasis>, a fixed length specifier.</para>
  18 </listitem>
  19 <listitem>
  20 <para><emphasis>99.99</emphasis>, a fixed length specifier without any units.</para>
  21 </listitem>
  22 <listitem>
  23 <para><emphasis>99.99*</emphasis>, a relative length specifier.</para>
  24 </listitem>
  25 <listitem>
  26 <para><emphasis>99.99*+99.99units</emphasis>, a combination of both.</para>
  27 </listitem>
  28 </itemizedlist>
  29
  30 <para>The CALS units are points (pt), picas (pi), centimeters (cm),
  31 millimeters (mm), and inches (in). These are the same units as XSL,
  32 except that XSL abbreviates picas "pc" instead of "pi". If a length
  33 specifier has no units, the CALS default unit (pt) is assumed.</para>
  34
  35 <para>Relative length specifiers are represented in XSL with the
  36 proportional-column-width() function.</para>
  37
  38 <para>Here are some examples:</para>
  39
  40 <itemizedlist>
  41 <listitem>
  42 <para>"36pt" becomes "36pt"</para>
  43 </listitem>
  44 <listitem>
  45 <para>"3pi" becomes "3pc"</para>
  46 </listitem>
  47 <listitem>
  48 <para>"36" becomes "36pt"</para>
  49 </listitem>
  50 <listitem>
  51 <para>"3*" becomes "proportional-column-width(3)"</para>
  52 </listitem>
  53 <listitem>
  54 <para>"3*+2pi" becomes "proportional-column-width(3)+2pc"</para>
  55 </listitem>
  56 <listitem>
  57 <para>"1*+2" becomes "proportional-column-width(1)+2pt"</para>
  58 </listitem>
  59 </itemizedlist>
  60
  61 </refdescription>
  62
  63 <refparameter>
  64
  65 <variablelist>
  66 <varlistentry><term>colwidth</term>
  67 <listitem>
  68 <para>The CALS column width specification.</para>
  69 </listitem>
  70 </varlistentry>
  71 </variablelist>
  72
  73 </refparameter>
  74
  75 <refreturn>
  76 <para>The XSL column width specification.</para>
  77 </refreturn>
  78
  79 </refentry>
  80