stylesheets/styleguide/docbook-xsl-1.75.2/params/header.column.widths.xml

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