margin.note.float.type.xml 2.7 KB

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