doc/xslt/params/margin.note.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="margin.note.float.type">
   7 <refmeta>
   8 <refentrytitle>margin.note.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>margin.note.float.type</refname>
  21 <refpurpose>Select type of float for margin note customizations</refpurpose>
  22 </refnamediv>
  23
  24 <refsynopsisdiv>
  25 <src:fragment xml:id="margin.note.float.type.frag">
  26 <xsl:param name="margin.note.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 margin notes.
  33 DocBook does not define a margin note element, so this
  34 feature must be implemented as a customization of the stylesheet.
  35 See <parameter>margin.note.properties</parameter> for
  36 an example.
  37 </para>
  38 <itemizedlist>
  39 <listitem>
  40 <para>If <parameter>margin.note.float.type</parameter> is
  41 <quote><literal>none</literal></quote>, then
  42 no float is used.
  43 </para>
  44 </listitem>
  45 <listitem>
  46 <para>If <parameter>margin.note.float.type</parameter> is
  47 <quote><literal>before</literal></quote>, then
  48 the float appears at the top of the page.  On some processors,
  49 that may be the next page rather than the current page.
  50 </para>
  51 </listitem>
  52 <listitem>
  53 <para>If <parameter>margin.note.float.type</parameter> is
  54 <quote><literal>left</literal></quote> or
  55 <quote><literal>start</literal></quote>, then
  56 a left side float is used.
  57 </para>
  58 </listitem>
  59 <listitem>
  60 <para>If <parameter>margin.note.float.type</parameter> is
  61 <quote><literal>right</literal></quote> or
  62 <quote><literal>end</literal></quote>, then
  63 a right side float is used.
  64 </para>
  65 </listitem>
  66 <listitem>
  67 <para>If your XSL-FO processor supports floats positioned on the
  68 <quote><literal>inside</literal></quote> or
  69 <quote><literal>outside</literal></quote>
  70 of double-sided pages, then you have those two
  71 options for side floats as well.
  72 </para>
  73 </listitem>
  74 </itemizedlist>
  75
  76 </refsection>
  77 </refentry>