]> git.stg.codes - stg.git/blob - doc/xslt/params/marker.section.level.xml
Minor change in stg's Makefile.
[stg.git] / doc / xslt / params / marker.section.level.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="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
16 <refsynopsisdiv>
17 <src:fragment xml:id="marker.section.level.frag">
18 <xsl:param name="marker.section.level" >2</xsl:param>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>The <parameter>marker.section.level</parameter> parameter
25 controls the depth of section levels that may be displayed
26 in running headers and footers.  For example, if the value
27 is 2 (the default), then titles from <tag>sect1</tag> and 
28 <tag>sect2</tag> or equivalent <tag>section</tag>
29 elements are candidates for use in running headers and
30 footers.
31 </para>
32 <para>Each candidate title is marked in the FO output with a
33 <tag>&lt;fo:marker marker-class-name="section.head.marker"&gt;</tag>
34 element.
35 </para>
36 <para>In order for such titles to appear in headers
37 or footers, the <literal>header.content</literal>
38 or <literal>footer.content</literal> template
39 must be customized to retrieve the marker using
40 an output element such as:
41 </para>
42 <programlisting>
43 &lt;fo:retrieve-marker retrieve-class-name="section.head.marker"
44                        retrieve-position="first-including-carryover"
45                        retrieve-boundary="page-sequence"/&gt;
46 </programlisting>
47
48
49 </refsection>
50 </refentry>