marker.section.level.xml 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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="marker.section.level">
  7. <refmeta>
  8. <refentrytitle>marker.section.level</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>marker.section.level</refname>
  13. <refpurpose>Control depth of sections shown in running headers or footers</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="marker.section.level.frag">
  17. <xsl:param name="marker.section.level" >2</xsl:param>
  18. </src:fragment>
  19. </refsynopsisdiv>
  20. <refsection><info><title>Description</title></info>
  21. <para>The <parameter>marker.section.level</parameter> parameter
  22. controls the depth of section levels that may be displayed
  23. in running headers and footers. For example, if the value
  24. is 2 (the default), then titles from <tag>sect1</tag> and
  25. <tag>sect2</tag> or equivalent <tag>section</tag>
  26. elements are candidates for use in running headers and
  27. footers.
  28. </para>
  29. <para>Each candidate title is marked in the FO output with a
  30. <tag>&lt;fo:marker marker-class-name="section.head.marker"&gt;</tag>
  31. element.
  32. </para>
  33. <para>In order for such titles to appear in headers
  34. or footers, the <literal>header.content</literal>
  35. or <literal>footer.content</literal> template
  36. must be customized to retrieve the marker using
  37. an output element such as:
  38. </para>
  39. <programlisting>
  40. &lt;fo:retrieve-marker retrieve-class-name="section.head.marker"
  41. retrieve-position="first-including-carryover"
  42. retrieve-boundary="page-sequence"/&gt;
  43. </programlisting>
  44. </refsection>
  45. </refentry>