]> git.stg.codes - stg.git/blobdiff - doc/help/xslt/params/margin.note.width.xml
DocBook documentation stub added
[stg.git] / doc / help / xslt / params / margin.note.width.xml
diff --git a/doc/help/xslt/params/margin.note.width.xml b/doc/help/xslt/params/margin.note.width.xml
new file mode 100644 (file)
index 0000000..3ee0aa4
--- /dev/null
@@ -0,0 +1,35 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="margin.note.width">
+<refmeta>
+<refentrytitle>margin.note.width</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>margin.note.width</refname>
+<refpurpose>Set the default width for margin notes</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="margin.note.width.frag">
+<xsl:param name="margin.note.width" >1in</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>Sets the default width for margin notes when used as a side
+float.  The width determines the degree to which the margin note block
+intrudes into the text area.
+</para>
+<para>If <parameter>margin.note.float.type</parameter> is
+<quote><literal>before</literal></quote> or 
+<quote><literal>none</literal></quote>, then 
+this parameter is ignored.
+</para>
+
+</refsection>
+</refentry>