<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                      "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
]>

<book id="index" lang="en">
  <bookinfo>
    <title>tumbler Reference Manual</title>
    <releaseinfo>Version <xi:include href="version.xml" parse="text"/></releaseinfo>
    <copyright>
      <year>2009</year>
      <holder>Jannis Pohlmann</holder>
    </copyright>
    <legalnotice id="legalnotice">
      <para>
        Permission is granted to copy, distribute and/or modify this document
        under the terms of the GNU Free Documentation License, Version 1.1 or
        any later version published by the Free Software Foundation; with no
        Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
        Texts. The complete license text is available from the <ulink
        type="http" url="http://www.gnu.org/">Free Software Foundation</ulink>.
      </para>
    </legalnotice>
    <authorgroup>
      <author>
        <firstname>Jannis</firstname>
        <surname>Pohlmann</surname>
        <affiliation>
          <address><email>jannis@xfce.org</email></address>
        </affiliation>
      </author>
    </authorgroup>
  </bookinfo>

  <part>
    <title>Overview</title>
    <para>
      The <application>tumbler</application> library depends on the following libraries:
      <variablelist>
        <varlistentry>
          <term>D-Bus</term>
          <listitem>
            <para>
              TODO
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>D-Bus GLib Bindings</term>
          <listitem>
            <para>
              TODO
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>GLib</term>
          <listitem>
            <para>
              A general-purpose utility library, not specific to graphical user interfaces.
              GLib provides many useful data types, macros, type conversions,
              string utilities, file utilities, a main loop abstraction, and so on.
            </para>
          </listitem>
        </varlistentry>
      </variablelist>
    </para>
  </part>

  <part id="miscellaneous">
    <title>Miscellaneous</title>
    <xi:include href="xml/tumbler-error.xml"/>
    <xi:include href="xml/tumbler-enum-types.xml"/>
    <xi:include href="xml/tumbler-config.xml"/>
    <xi:include href="xml/tumbler-util.xml"/>
    <xi:include href="xml/tumbler-marshal.xml"/>
  </part>

  <part id="thumbnails">
    <title>Querying and Generating Thumbnails</title>
    <xi:include href="xml/tumbler-thumbnailer.xml"/>
    <xi:include href="xml/tumbler-thumbnail-flavor.xml"/>
    <xi:include href="xml/tumbler-file-info.xml"/>
    <xi:include href="xml/tumbler-thumbnail.xml"/>
    <xi:include href="xml/tumbler-cache.xml"/>
    <xi:include href="xml/tumbler-cache-plugin.xml"/>
  </part>

  <part id="extension-api">
    <title>Extension API</title>
    <xi:include href="xml/tumbler-provider-factory.xml"/>
    <xi:include href="xml/tumbler-provider-plugin.xml"/>
    <xi:include href="xml/tumbler-abstract-thumbnailer.xml"/>
    <xi:include href="xml/tumbler-thumbnailer-provider.xml"/>
  </part>

  <part id="extension-tutorial">
    <title>Tutorial: Extending Tumbler</title>
  </part>

  <part id="object-tree">
    <title>Object Hierarchy</title>
    <xi:include href="xml/tree_index.sgml"/>
  </part>

  <index id="api-index-full">
    <title>API Index</title>
    <xi:include href="xml/api-index-full.xml">
      <xi:fallback />
    </xi:include>
  </index>

  <xi:include href="xml/annotation-glossary.xml">
    <xi:fallback />
  </xi:include>
</book>
