]> git.stg.codes - stg.git/blob - doc/xslt/params/sidebar.float.width.xml
Help book chapter 3 complete
[stg.git] / doc / xslt / params / sidebar.float.width.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.width">
7 <refmeta>
8 <refentrytitle>sidebar.float.width</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>sidebar.float.width</refname>
13 <refpurpose>Set the default width for sidebars</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="sidebar.float.width.frag">
18 <xsl:param name="sidebar.float.width">1in</xsl:param>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>Sets the default width for sidebars when used as a side float.
25 The width determines the degree to which the sidebar block intrudes into
26 the text area.
27 </para>
28 <para>If <parameter>sidebar.float.type</parameter> is
29 <quote><literal>before</literal></quote> or 
30 <quote><literal>none</literal></quote>, then 
31 this parameter is ignored.
32 </para>
33
34 </refsection>
35 </refentry>