summaryrefslogtreecommitdiff
path: root/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
blob: 99b089c55d453b3c3d5228b7b590b1f8ca5e7b2f (plain)
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
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index">
  <bookinfo>
    <title>Tracker Miner Library Reference Manual</title>
    <releaseinfo>
	  for libtracker-miner &version;.
	  The latest version of this documentation can be found on-line at
	  <ulink role="online-location" url="http://library.gnome.org/devel/libtracker-miner/unstable/">
		http://library.gnome.org/devel/libtracker-miner/unstable
	  </ulink>.
	</releaseinfo>
  </bookinfo>

  <!-- The Library Overview -->
  <xi:include href="overview.sgml"/>

  <!-- The API Reference -->
  <part id="libtracker-miner-reference">
    <title>Reference</title>
    <partintro>
      <para>
        This section provides the detailed API of the Tracker Miner library.
      </para>
    </partintro>

    <chapter>
      <title>Base abstract miner classes</title>
      <xi:include href="xml/tracker-miner-object.xml"/>
      <xi:include href="xml/tracker-miner-web.xml"/>
      <xi:include href="xml/tracker-decorator.xml"/>
    </chapter>

    <chapter>
      <title>Miner classes for file system</title>
      <xi:include href="xml/tracker-miner-fs.xml"/>
      <xi:include href="xml/tracker-indexing-tree.xml"/>
      <xi:include href="xml/tracker-decorator-fs.xml"/>
    </chapter>

    <chapter>
      <title>Base abstract providers for network/password/etc control</title>
      <xi:include href="xml/tracker-network-provider.xml"/>
      <xi:include href="xml/tracker-password-provider.xml"/>
    </chapter>

    <chapter>
      <title>Utilities</title>
      <xi:include href="xml/tracker-miner-enums.xml"/>
    </chapter>
  </part>

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