sidebar.float.type.xml 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  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. <refsynopsisdiv>
  24. <src:fragment xml:id="sidebar.float.type.frag">
  25. <xsl:param name="sidebar.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 sidebar elements.
  30. </para>
  31. <itemizedlist>
  32. <listitem>
  33. <para>If <parameter>sidebar.float.type</parameter> is
  34. <quote><literal>none</literal></quote>, then
  35. no float is used.
  36. </para>
  37. </listitem>
  38. <listitem>
  39. <para>If <parameter>sidebar.float.type</parameter> is
  40. <quote><literal>before</literal></quote>, then
  41. the float appears at the top of the page. On some processors,
  42. that may be the next page rather than the current page.
  43. </para>
  44. </listitem>
  45. <listitem>
  46. <para>If <parameter>sidebar.float.type</parameter> is
  47. <quote><literal>left</literal></quote>,
  48. then a left side float is used.
  49. </para>
  50. </listitem>
  51. <listitem>
  52. <para>If <parameter>sidebar.float.type</parameter> is
  53. <quote><literal>start</literal></quote>,
  54. then when the text direction is left-to-right a left side float is used.
  55. When the text direction is right-to-left, a right side float is used.
  56. </para>
  57. </listitem>
  58. <listitem>
  59. <para>If <parameter>sidebar.float.type</parameter> is
  60. <quote><literal>right</literal></quote>,
  61. then a right side float is used.
  62. </para>
  63. </listitem>
  64. <listitem>
  65. <para>If <parameter>sidebar.float.type</parameter> is
  66. <quote><literal>end</literal></quote>,
  67. then when the text direction is left-to-right a right side float is used.
  68. When the text direction is right-to-left, a left side float is used.
  69. </para>
  70. </listitem>
  71. <listitem>
  72. <para>If your XSL-FO processor supports floats positioned on the
  73. <quote><literal>inside</literal></quote> or
  74. <quote><literal>outside</literal></quote>
  75. of double-sided pages, then you have those two
  76. options for side floats as well.
  77. </para>
  78. </listitem>
  79. </itemizedlist>
  80. </refsection>
  81. </refentry>