stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/marker.section.level.xml

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