<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <HTML> <HEAD> <TITLE>Xapian: Documentation</TITLE> </HEAD> <BODY BGCOLOR="white" TEXT="black"> <center> <A HREF="install.html">install</A> | <A HREF="quickstart.html">quickstart</A> | <A HREF="overview.html">overview</A> | <A HREF="admin_notes.html" title="Notes for sysadmins">sysadmins</A> | <A HREF="scalability.html">scalability</A> | <A HREF="apidoc/html/annotated.html" title="API reference">API</A> | <A HREF="deprecation.html" title="Deprecated and removed API features">deprecated</A> | <A HREF="intro_ir.html" title="Information Retrieval">IR</A> | <A HREF="http://wiki.xapian.org/">wiki</A> </center> <hr> <CENTER> <H1>Xapian - the open source search engine</H1> </CENTER> <H2>Documentation</H2> A number of pieces of documentation are available. <P> We suggest you start by reading the <A HREF="install.html">Installation Guide</A>, which covers downloading the code, and unpacking, configuring, building and installing it. <P> For a quick introduction to our software, including a walk-through example of an application for searching through some data, read the <A HREF="quickstart.html">Quickstart</A> document. <p>The <a href="glossary.html">glossary</a> provides definitions for specialized terminology you might encounter while using Xapian.</p> <P> The <A HREF="overview.html">Overview</A> explains the API which Xapian provides to programmers. A full <A HREF="apidoc/html/index.html">API Reference</A> is automatically collated using doxygen from documentation comments in the source code. There's also a list of <A HREF="deprecation.html">deprecated features</A> which lists features scheduled for removal, and also features already removed, along with suggestions for replacements. </p> <P> If you want to learn more about probabilistic information retrieval, there's a (reasonably mathematical) <A HREF="intro_ir.html">introduction to the ideas behind Xapian</A> which also suggests some books you might want to read. <p> There are a number of documents which cover particular features: </p> <ul> <li> <a href="bm25.html">BM25 Weighting Scheme</a> <li> <a HREF="termgenerator.html">Indexing</a> <li> <a href="queryparser.html">Query Parser</a> <li> <a href="remote.html">Remote Backend</a> <li> <a href="sorting.html">Sorting Results</a> <li> <a href="spelling.html">Spelling Correction</a> <li> <a href="stemming.html">Stemming Algorithms</a> <li> <a href="synonyms.html">Synonym Support</a> <li> <a href="valueranges.html">Value Ranges</a> </ul> <p> For those wishing to do development work on the Xapian library itself, there is <a HREF="internals.html">documentation of Xapian's internals</a> available. </p> <P> We also have a <A HREF="http://wiki.xapian.org/">wiki</A> for documentation and examples contributed by the Xapian community. <!-- FOOTER $Author: olly $ $Date: 2007-12-03 17:11:44 +0000 (Mon, 03 Dec 2007) $ $Id: index.html 9804 2007-12-03 17:11:44Z olly $ --> </BODY> </HTML>
