body.start.indent.xml 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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. <refsynopsisdiv>
  16. <src:fragment xml:id="body.start.indent.frag">
  17. <xsl:param name="body.start.indent">
  18. <xsl:choose>
  19. <xsl:when test="$fop.extensions != 0">0pt</xsl:when>
  20. <xsl:when test="$passivetex.extensions != 0">0pt</xsl:when>
  21. <xsl:otherwise>4pc</xsl:otherwise>
  22. </xsl:choose>
  23. </xsl:param>
  24. </src:fragment>
  25. </refsynopsisdiv>
  26. <refsection><info><title>Description</title></info>
  27. <para>This parameter provides
  28. the means of indenting the body text relative to
  29. section titles.
  30. For left-to-right text direction, it indents the left side.
  31. For right-to-left text direction, it indents the right side.
  32. It is used in place of the
  33. <parameter>title.margin.left</parameter> for
  34. all XSL-FO processors except FOP 0.25.
  35. It enables support for side floats to appear
  36. in the indented margin area.
  37. </para>
  38. <para>This start-indent property is added to the fo:flow
  39. for certain page sequences. Which page-sequences it is
  40. applied to is determined by the template named
  41. <literal>set.flow.properties</literal>.
  42. By default, that template adds it to the flow
  43. for page-sequences using the <quote>body</quote>
  44. master-reference, as well as appendixes and prefaces.
  45. </para>
  46. <para>If this parameter is used, section titles should have
  47. a start-indent value of 0pt if they are to be
  48. outdented relative to the body text.
  49. </para>
  50. <para>If you are using FOP, then set this parameter to a zero
  51. width value and set the <parameter>title.margin.left</parameter>
  52. parameter to the negative value of the desired indent.
  53. </para>
  54. <para>See also <parameter>body.end.indent</parameter> and
  55. <parameter>title.margin.left</parameter>.
  56. </para>
  57. </refsection>
  58. </refentry>