]> git.stg.codes - stg.git/blob - doc/xslt/params/section.container.element.xml
Ticket 26. The std::string modulePath variable definition moved after
[stg.git] / doc / xslt / params / section.container.element.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="section.container.element">
7 <refmeta>
8 <refentrytitle>section.container.element</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
10 <refmiscinfo class="other" otherclass="value">block</refmiscinfo>
11 <refmiscinfo class="other" otherclass="value">wrapper</refmiscinfo>
12 </refmeta>
13 <refnamediv>
14 <refname>section.container.element</refname>
15 <refpurpose>Select XSL-FO element name to contain sections</refpurpose>
16 </refnamediv>
17
18 <refsynopsisdiv>
19 <src:fragment xml:id="section.container.element.frag">
20 <xsl:param name="section.container.element">block</xsl:param>
21 </src:fragment>
22 </refsynopsisdiv>
23
24 <refsection><info><title>Description</title></info>
25
26 <para>Selects the element name for outer container of
27 each section. The choices are <literal>block</literal> (default)
28 or <literal>wrapper</literal>.
29 The <literal>fo:</literal> namespace prefix is added
30 by the stylesheet to form the full element name.
31 </para>
32
33 <para>This element receives the section <literal>id</literal>
34 attribute and the appropriate section level attribute-set.
35 </para>
36
37 <para>Changing this parameter to <literal>wrapper</literal>
38 is only necessary when producing multi-column output
39 that contains page-wide spans.  Using <literal>fo:wrapper</literal>
40 avoids the nesting of <literal>fo:block</literal>
41 elements that prevents spans from working (the standard says
42 a span must be on a block that is a direct child of 
43 <literal>fo:flow</literal>).
44 </para>
45
46 <para>If set to <literal>wrapper</literal>, the
47 section attribute-sets only support properties
48 that are inheritable.  That's because there is no
49 block to apply them to.  Properties such as
50 font-family are inheritable, but properties such as
51 border are not.
52 </para>
53
54 <para>Only some XSL-FO processors need to use this parameter.
55 The Antenna House processor, for example, will handle 
56 spans in nested blocks without changing the element name.
57 The RenderX XEP product and FOP follow the XSL-FO standard 
58 and need to use <literal>wrapper</literal>.
59 </para>
60
61 </refsection>
62 </refentry>