| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
|---|
| 2 | <HTML> |
|---|
| 3 | <HEAD> |
|---|
| 4 | <TITLE>Xapian: Documentation</TITLE> |
|---|
| 5 | </HEAD> |
|---|
| 6 | <BODY BGCOLOR="white" TEXT="black"> |
|---|
| 7 | |
|---|
| 8 | <center> |
|---|
| 9 | <A HREF="install.html">install</A> |
|---|
| 10 | | |
|---|
| 11 | <A HREF="quickstart.html">quickstart</A> |
|---|
| 12 | | |
|---|
| 13 | <A HREF="overview.html">overview</A> |
|---|
| 14 | | |
|---|
| 15 | <A HREF="admin_notes.html" title="Notes for sysadmins">sysadmins</A> |
|---|
| 16 | | |
|---|
| 17 | <A HREF="scalability.html">scalability</A> |
|---|
| 18 | | |
|---|
| 19 | <A HREF="apidoc/html/annotated.html" title="API reference">API</A> |
|---|
| 20 | | |
|---|
| 21 | <A HREF="deprecation.html" title="Deprecated and removed API features">deprecated</A> |
|---|
| 22 | | |
|---|
| 23 | <A HREF="intro_ir.html" title="Information Retrieval">IR</A> |
|---|
| 24 | | |
|---|
| 25 | <A HREF="http://wiki.xapian.org/">wiki</A> |
|---|
| 26 | </center> |
|---|
| 27 | <hr> |
|---|
| 28 | |
|---|
| 29 | <CENTER> |
|---|
| 30 | <H1>Xapian - the open source search engine</H1> |
|---|
| 31 | </CENTER> |
|---|
| 32 | |
|---|
| 33 | <H2>Documentation</H2> |
|---|
| 34 | |
|---|
| 35 | A number of pieces of documentation are available. |
|---|
| 36 | <P> |
|---|
| 37 | We suggest you start by reading the <A HREF="install.html">Installation |
|---|
| 38 | Guide</A>, which covers downloading the code, and unpacking, configuring, |
|---|
| 39 | building and installing it. |
|---|
| 40 | |
|---|
| 41 | <P> |
|---|
| 42 | For a quick introduction to our software, including a walk-through example |
|---|
| 43 | of an application for searching through some data, read the |
|---|
| 44 | <A HREF="quickstart.html">Quickstart</A> document. |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | <p>The <a href="glossary.html">glossary</a> provides definitions for |
|---|
| 48 | specialized terminology you might encounter while using Xapian.</p> |
|---|
| 49 | |
|---|
| 50 | <P> |
|---|
| 51 | The <A HREF="overview.html">Overview</A> explains the API which Xapian |
|---|
| 52 | provides to programmers. A full |
|---|
| 53 | <A HREF="apidoc/html/index.html">API Reference</A> is automatically |
|---|
| 54 | collated using doxygen from documentation comments in the source code. |
|---|
| 55 | There's also a list of <A HREF="deprecation.html">deprecated features</A> |
|---|
| 56 | which lists features scheduled for removal, and also features already |
|---|
| 57 | removed, along with suggestions for replacements. |
|---|
| 58 | </p> |
|---|
| 59 | |
|---|
| 60 | <P> |
|---|
| 61 | If you want to learn more about probabilistic information retrieval, |
|---|
| 62 | there's a (reasonably mathematical) |
|---|
| 63 | <A HREF="intro_ir.html">introduction to the ideas behind Xapian</A> |
|---|
| 64 | which also suggests some books you might want to read. |
|---|
| 65 | |
|---|
| 66 | <p> |
|---|
| 67 | There are a number of documents which cover particular features: |
|---|
| 68 | </p> |
|---|
| 69 | |
|---|
| 70 | <ul> |
|---|
| 71 | <li> <a href="bm25.html">BM25 Weighting Scheme</a> |
|---|
| 72 | <li> <a HREF="termgenerator.html">Indexing</a> |
|---|
| 73 | <li> <a href="queryparser.html">Query Parser</a> |
|---|
| 74 | <li> <a href="remote.html">Remote Backend</a> |
|---|
| 75 | <li> <a href="sorting.html">Sorting Results</a> |
|---|
| 76 | <li> <a href="spelling.html">Spelling Correction</a> |
|---|
| 77 | <li> <a href="stemming.html">Stemming Algorithms</a> |
|---|
| 78 | <li> <a href="synonyms.html">Synonym Support</a> |
|---|
| 79 | <li> <a href="valueranges.html">Value Ranges</a> |
|---|
| 80 | </ul> |
|---|
| 81 | |
|---|
| 82 | <p> |
|---|
| 83 | For those wishing to do development work on |
|---|
| 84 | the Xapian library itself, there is <a HREF="internals.html">documentation |
|---|
| 85 | of Xapian's internals</a> available. |
|---|
| 86 | </p> |
|---|
| 87 | |
|---|
| 88 | <P> |
|---|
| 89 | We also have a <A HREF="http://wiki.xapian.org/">wiki</A> for documentation |
|---|
| 90 | and examples contributed by the Xapian community. |
|---|
| 91 | |
|---|
| 92 | <!-- FOOTER $Author$ $Date$ $Id$ --> |
|---|
| 93 | </BODY> |
|---|
| 94 | </HTML> |
|---|
