]> git.stg.codes - stg.git/blob - doc/xslt/params/sidebar.float.type.xml
Ticket 26. The const MODULE_SETTINGS & ms parameter added to the
[stg.git] / doc / xslt / params / sidebar.float.type.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="sidebar.float.type">
7 <refmeta>
8 <refentrytitle>sidebar.float.type</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
10 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
11 <refmiscinfo class="other" otherclass="value">before</refmiscinfo>
12 <refmiscinfo class="other" otherclass="value">left</refmiscinfo>
13 <refmiscinfo class="other" otherclass="value">start</refmiscinfo> 
14 <refmiscinfo class="other" otherclass="value">right</refmiscinfo>
15 <refmiscinfo class="other" otherclass="value">end</refmiscinfo>     
16 <refmiscinfo class="other" otherclass="value">inside</refmiscinfo>
17 <refmiscinfo class="other" otherclass="value">outside</refmiscinfo> 
18 </refmeta>
19 <refnamediv>
20 <refname>sidebar.float.type</refname>
21 <refpurpose>Select type of float for sidebar elements</refpurpose>
22 </refnamediv>
23
24 <refsynopsisdiv>
25 <src:fragment xml:id="sidebar.float.type.frag">
26 <xsl:param name="sidebar.float.type">none</xsl:param>
27 </src:fragment>
28 </refsynopsisdiv>
29
30 <refsection><info><title>Description</title></info>
31
32 <para>Selects the type of float for sidebar elements.
33 </para>
34 <itemizedlist>
35 <listitem>
36 <para>If <parameter>sidebar.float.type</parameter> is
37 <quote><literal>none</literal></quote>, then 
38 no float is used.
39 </para>
40 </listitem>
41 <listitem>
42 <para>If <parameter>sidebar.float.type</parameter> is
43 <quote><literal>before</literal></quote>, then 
44 the float appears at the top of the page.  On some processors,
45 that may be the next page rather than the current page.
46 </para>
47 </listitem>
48
49 <listitem>
50 <para>If <parameter>sidebar.float.type</parameter> is
51 <quote><literal>left</literal></quote>,
52 then a left side float is used.
53 </para>
54 </listitem>
55
56 <listitem>
57 <para>If <parameter>sidebar.float.type</parameter> is
58 <quote><literal>start</literal></quote>,
59 then when the text direction is left-to-right a left side float is used.
60 When the text direction is right-to-left, a right side float is used.
61 </para>
62 </listitem>
63
64 <listitem>
65 <para>If <parameter>sidebar.float.type</parameter> is
66 <quote><literal>right</literal></quote>,
67 then a right side float is used.
68 </para>
69 </listitem>
70
71 <listitem>
72 <para>If <parameter>sidebar.float.type</parameter> is
73 <quote><literal>end</literal></quote>,
74 then when the text direction is left-to-right a right side float is used.
75 When the text direction is right-to-left, a left side float is used.
76 </para>
77 </listitem>
78
79 <listitem>
80 <para>If your XSL-FO processor supports floats positioned on the
81 <quote><literal>inside</literal></quote> or
82 <quote><literal>outside</literal></quote>
83 of double-sided pages, then you have those two 
84 options for side floats as well.
85 </para>
86 </listitem>
87 </itemizedlist>
88
89 </refsection>
90 </refentry>