doc/xslt/params/body.start.indent.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="body.start.indent">
   7 <refmeta>
   8 <refentrytitle>body.start.indent</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>body.start.indent</refname>
  13 <refpurpose>The start-indent for the body text</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17 <src:fragment xml:id="body.start.indent.frag">
  18 <xsl:param name="body.start.indent">
  19   <xsl:choose>
  20     <xsl:when test="$fop.extensions != 0">0pt</xsl:when>
  21     <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
  22     <xsl:otherwise>4pc</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 indenting the body text relative to
  32 section titles.
  33 For left-to-right text direction, it indents the left side.
  34 For right-to-left text direction, it indents the right side.
  35 It is used in place of the
  36 <parameter>title.margin.left</parameter> for
  37 all XSL-FO processors except FOP 0.25.
  38 It enables support for side floats to appear
  39 in the indented margin area.
  40 </para>
  41 <para>This start-indent property is added to the fo:flow
  42 for certain page sequences.  Which page-sequences it is
  43 applied to is determined by the template named
  44 <literal>set.flow.properties</literal>.
  45 By default, that template adds it to the flow
  46 for page-sequences using the <quote>body</quote>
  47 master-reference, as well as appendixes and prefaces.
  48 </para>
  49 <para>If this parameter is used, section titles should have
  50 a start-indent value of 0pt if they are to be
  51 outdented relative to the body text.
  52 </para>
  53
  54 <para>If you are using FOP, then set this parameter to a zero
  55 width value and set the <parameter>title.margin.left</parameter>
  56 parameter to the negative value of the desired indent.
  57 </para>
  58
  59 <para>See also <parameter>body.end.indent</parameter> and
  60 <parameter>title.margin.left</parameter>.
  61 </para>
  62
  63 </refsection>
  64 </refentry>