diff options
Diffstat (limited to 'kdoctools/docbook/xsl/params/header.column.widths.xml')
| -rw-r--r-- | kdoctools/docbook/xsl/params/header.column.widths.xml | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/kdoctools/docbook/xsl/params/header.column.widths.xml b/kdoctools/docbook/xsl/params/header.column.widths.xml new file mode 100644 index 000000000..f88dc6fb1 --- /dev/null +++ b/kdoctools/docbook/xsl/params/header.column.widths.xml @@ -0,0 +1,69 @@ +<refentry id="header.column.widths"> +<refmeta> +<refentrytitle>header.column.widths</refentrytitle> +<refmiscinfo role="type">string</refmiscinfo> +</refmeta> +<refnamediv> +<refname>header.column.widths</refname> +<refpurpose>Specify relative widths of header areas</refpurpose> +</refnamediv> + +<refsynopsisdiv><src:fragment id='header.column.widths.frag'> +<xsl:param name="header.column.widths" select="'1 1 1'"/> +</src:fragment></refsynopsisdiv> + +<refsect1><title>Description</title> + +<para>Page headers in print output use a three column table +to position text at the left, center, and right side of +the header on the page. +This parameter lets you specify the relative sizes of the +three columns. The default value is +"1 1 1".</para> + +<para>The parameter value must be three numbers, separated +by white space. The first number represents the relative +width of the left header for +single-sided output, or the inside header for +double-sided output. The second number is the relative +width of the center header. The third number is the +relative width of the right header for +single-sided output, or the outside header for +double-sided output. +</para> + +<para>The numbers are used to specify the column widths +for the table that makes up the header area. +In the FO output, this looks like: +</para> + +<programlisting> +<fo:table-column column-number="1" + column-width="proportional-column-width(1)"/> +</programlisting> + +<para> +The <literal>proportional-column-width()</literal> +function computes a column width by dividing its +argument by the total of the arguments for all the columns, and +then multiplying the result by the width of the whole table +(assuming all the column specs use the function). +Its argument can be any positive integer or floating point number. +Zero is an acceptable value, although some FO processors +may warn about it, in which case using a very small number might +be more satisfactory. +</para> + +<para>For example, the value "1 2 1" means the center +header should have twice the width of the other areas. +A value of "0 0 1" means the entire header area +is reserved for the right (or outside) header text. +Note that to keep the center area centered on +the page, the left and right values must be +the same. A specification like "1 2 3" means the +center area is no longer centered on the page +since the right area is three times the width of the left area. +</para> + +</refsect1> +</refentry> |