]> git.stg.codes - stg.git/blob - doc/xslt/params/title.margin.left.xml
Use common functions in admin tests and service tests.
[stg.git] / doc / xslt / params / title.margin.left.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="title.margin.left">
7 <refmeta>
8 <refentrytitle>title.margin.left</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>title.margin.left</refname>
13 <refpurpose>Adjust the left margin for titles</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="title.margin.left.frag">
18 <xsl:param name="title.margin.left">
19   <xsl:choose>
20     <xsl:when test="$fop.extensions != 0">-4pc</xsl:when>
21     <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
22     <xsl:otherwise>0pt</xsl:otherwise>
23   </xsl:choose>
24 </xsl:param>
25 </src:fragment>
26 </refsynopsisdiv>
27
28 <refsection><info><title>Description</title></info>
29
30 <para>This parameter provides
31 the means of adjusting the left margin for titles
32 when the XSL-FO processor being used is
33 an old version of FOP (0.25 and earlier).
34 It is only useful when the <parameter>fop.extensions</parameter>
35 is nonzero.</para>
36
37 <para>The left margin of the body region
38 is calculated to include this space,
39 and titles are outdented to the left outside
40 the body region by this amount,
41 effectively leaving titles at the intended left margin
42 and the body text indented.
43 Currently this method is only used for old FOP because
44 it cannot properly use the <parameter>body.start.indent</parameter>
45 parameter.
46 </para>
47 <para>
48 The default value when the <parameter>fop.extensions</parameter>
49 parameter is nonzero is -4pc, which means the
50 body text is indented 4 picas relative to
51 the titles.
52 The default value when the <parameter>fop.extensions</parameter>
53 parameter equals zero is 0pt, and
54 the body indent should instead be specified
55 using the <parameter>body.start.indent</parameter>
56 parameter.
57 </para>
58 <para>
59 If you set the value to zero, be sure to still include
60 a unit indicator such as <literal>0pt</literal>, or
61 the FO processor will report errors.
62 </para>
63
64 </refsection>
65 </refentry>