table.default.position.xml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<refentry id="table.default.position">
  <refmeta>
    <refentrytitle>table.default.position</refentrytitle>
  </refmeta>
  <refnamediv>
    <refname><parameter>table.default.position</parameter></refname>
    <refpurpose>Default table float placement policy</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <programlisting>
      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="syn/table.default.position.xml"/>
    </programlisting>
  </refsynopsisdiv>
  <refsection>
    <title>Description</title>
    <para>Default table float placement algorithm. The value
    must contain enclosing square braces (<literal>[]</literal>).
    Order is significant, the first match which produces acceptable
    output is used.</para>

    <para id="float-placement-choices">The meaning of the characters are:
    <variablelist>
      <varlistentry>
        <term><literal>h</literal></term>
        <listitem>
          <para>Meaning: <quote>here</quote></para>
          <para>Place the float where it occurs in the DocBook source.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><literal>t</literal></term>
        <listitem>
          <para>Meaning: <quote>top</quote></para>
          <para>Place the float at the top of the page.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><literal>b</literal></term>
        <listitem>
          <para>Meaning: <quote>bottom</quote></para>
          <para>Place the float at the bottom of the page.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><literal>p</literal></term>
        <listitem>
          <para>Meaning: <quote>page</quote></para>
          <para>Place the float on a special page just for floats.</para>
        </listitem>
      </varlistentry>
    </variablelist>

    Any of the characters may be followed by an exclamation
    point (<literal>!</literal>) to force LaTeX to be more aggressive
    when trying the placement algorithm.</para>

    <para>The default value is <literal>[htbp]</literal>.</para>
  </refsection>
</refentry>