[gnomeweb-wml] Tracker: Don't duplicate documentation on live.gnome.org, just link it
- From: Martyn James Russell <mr src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gnomeweb-wml] Tracker: Don't duplicate documentation on live.gnome.org, just link it
- Date: Mon, 18 Jan 2010 10:30:46 +0000 (UTC)
commit 443039568e569ca8cd51b0a8bfed7922f9dbfe1e
Author: Martyn Russell <martyn lanedo com>
Date: Mon Jan 18 10:30:12 2010 +0000
Tracker: Don't duplicate documentation on live.gnome.org, just link it
projects.gnome.org/tracker/documentation.html | 64 ++-----------------------
1 files changed, 4 insertions(+), 60 deletions(-)
---
diff --git a/projects.gnome.org/tracker/documentation.html b/projects.gnome.org/tracker/documentation.html
index 85ec0ec..d5fe8ff 100644
--- a/projects.gnome.org/tracker/documentation.html
+++ b/projects.gnome.org/tracker/documentation.html
@@ -41,6 +41,9 @@
</div>
<div id="content">
+ <h2>Documentation</h2>
+ <p>The bulk of the documentation is on the live <a href="http://live.gnome.org/Tracker/Documentation" alt="">wiki</a>. This includes details about public APIs, architecture illustrations, query examples and much more.</p>
+
<h2>How Can I Use It?</h2>
<p>There are two very distinct ways to use Tracker. One is by
the command line (which is more for developer's and people
@@ -70,66 +73,7 @@
<h4>Desktop Integration</h4>
<p>There are Tracker plugins
for <a href="http://projects.gnome.org/totem/">Totem</a>, <a href="http://projects.gnome.org/nautilus/">Nautilus</a>
- and the GTK+ File Chooser.
-
- <h3>Command Line Tools</h3>
- <p>There are also a range of command line utilities to use with Tracker:</p>
- <ul>
- <li><strong>tracker-control</strong><br/>Manage Tracker processes and data</li>
- <li><strong>tracker-info</strong><br/>Get all information about one or more files</li>
- <li><strong>tracker-search</strong><br/>Search for terms in all data</li>
- <li><strong>tracker-stats</strong><br/>Show statistics for all Nepomuk defined ontology classes</li>
- <li><strong>tracker-status</strong><br/>Monitor and control status</li>
- <li><strong>tracker-sparql</strong><br/>Query or update using SPARQL</li>
- <li><strong>tracker-tag</strong><br/>Add, remove or list tags</li>
- </ul>
-
- <h2>API</h2>
- <p>There are two approaches to the API for Tracker. There is
- an API for applications to build their own data miners and by
- doing this contribute to the data store which we have in
- Tracker. There is also an API for querying the data in the
- databases (which is most likely the API you want).</p>
-
- <p>For more information which might not be covered here, visit the documentation <a href="http://live.gnome.org/Tracker/Documentation" alt="">wiki</a>.</p>
-
- <p>NOTE: This page will detail the documentation for Tracker
- 0.7+ only.</p>
-
- <h3>Data Mining</h3>
- <p>There are many libraries internally for Tracker which are
- shared amongst the processes. The ones of particular interest
- are:</p>
- <ul>
- <li><a href="http://library.gnome.org/devel/libtracker-common/unstable/" alt="">libtracker-common</a></li>
- <li><a href="http://library.gnome.org/devel/libtracker-miner/unstable/" alt="">libtracker-miner</a></li>
- </ul>
-
- <h3>Data Querying</h3>
- <p>For querying and updating data you should use:</p>
- <ul>
- <li><a href="http://library.gnome.org/devel/libtracker-client/unstable/" alt="">libtracker-client</a></li>
- </ul>
-
- <h2>Architecture</h2>
- <p>Tracker is split up into several main components. They are:</p>
- <ul>
- <li><strong>tracker-store</strong><br/>The data store and daemon to interface to Tracker's databases</li>
- <li><strong>tracker-miner-fs</strong><br/>The file system crawler to mine data from local files</li>
- <li><strong>tracker-extract</strong><br/>The meta-data extraction application used on each file</li>
- <li><strong>tracker-writeback</strong><br/>The application for writing meta-data back to files</li>
- </ul>
-
- <p>To illustrate the relationships between libraries in the tracker stack, see how <a href="images/tracker-store.png">tracker-store</a> and <a href="images/tracker-miner-fs.png">tracker-miner-fs</a> are designed architecturally.</p>
-
- <h2>Configuration</h2>
- <p>All of Tracker's configuration is kept in <tt>$HOME/.config/tracker</tt>. There are manual pages for each of the configurations should you want more information about them. For example, you can use:</p>
- <pre>$ man tracker-miner-fs.cfg</pre>
-
- <h2>Data & Logging</h2>
- <p>The databases are kept in <tt>$HOME/.cache/tracker</tt>. The user's data backup is kept in <tt>$HOME/.local/share/tracker/data</tt>.</p>
- <p>If Tracker is configured to have the logging verbosity (set in each .cfg file for each main component) set to a value higher than 0, then logs are generated and stored in <tt>$HOME/.local/share/tracker</tt></p>
-
+ and the GTK+ File Chooser.</p>
</div> <!-- content -->
</div> <!-- container -->
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]