doc/xslt/params/header.column.widths.xml

   1 <refentry xmlns="http://docbook.org/ns/docbook"
   2           xmlns:xlink="http://www.w3.org/1999/xlink"
   3           xmlns:xi="http://www.w3.org/2001/XInclude"
   4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
   5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
   6           version="5.0" xml:id="header.column.widths">
   7 <refmeta>
   8 <refentrytitle>header.column.widths</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>header.column.widths</refname>
  13 <refpurpose>Specify relative widths of header areas</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv><src:fragment xml:id="header.column.widths.frag">
  17 <xsl:param name="header.column.widths">1 1 1</xsl:param>
  18 </src:fragment></refsynopsisdiv>
  19
  20 <refsection><info><title>Description</title></info>
  21
  22 <para>Page headers in print output use a three column table
  23 to position text at the left, center, and right side of
  24 the header on the page.
  25 This parameter lets you specify the relative sizes of the
  26 three columns.  The default value is
  27 "1 1 1".</para>
  28
  29 <para>The parameter value must be three numbers, separated
  30 by white space. The first number represents the relative
  31 width of the inside header for
  32 double-sided output.  The second number is the relative
  33 width of the center header.  The third number is the
  34 relative width of the outside header for
  35 double-sided output.
  36 </para>
  37 <para>For single-sided output, the first number is the
  38 relative width of left header for left-to-right
  39 text direction, or the right header for right-to-left
  40 text direction.
  41 The third number is the
  42 relative width of right header for left-to-right
  43 text direction, or the left header for right-to-left
  44 text direction.</para>
  45
  46 <para>The numbers are used to specify the column widths
  47 for the table that makes up the header area.
  48 In the FO output, this looks like:
  49 </para>
  50
  51 <programlisting>
  52 &lt;fo:table-column column-number="1"
  53     column-width="proportional-column-width(1)"/&gt;
  54 </programlisting>
  55
  56 <para>
  57 The <literal>proportional-column-width()</literal>
  58 function computes a column width by dividing its
  59 argument by the total of the arguments for all the columns, and
  60 then multiplying the result by the width of the whole table
  61 (assuming all the column specs use the function).
  62 Its argument can be any positive integer or floating point number.
  63 Zero is an acceptable value, although some FO processors
  64 may warn about it, in which case using a very small number might
  65 be more satisfactory.
  66 </para>
  67
  68 <para>For example, the value "1 2 1" means the center
  69 header should have twice the width of the other areas.
  70 A value of "0 0 1" means the entire header area
  71 is reserved for the right (or outside) header text.
  72 Note that to keep the center area centered on
  73 the page, the left and right values must be
  74 the same. A specification like "1 2 3" means the
  75 center area is no longer centered on the page
  76 since the right area is three times the width of the left area.
  77 </para>
  78
  79 </refsection>
  80 </refentry>