xapian-core/docs/index.rst

   1 .. raw:: html
   2
   3     <div align="center">
   4
   5 `website <https://xapian.org/>`_ \| `install <install.html>`_ \|
   6 `overview <overview.html>`_ \|
   7 `sysadmins <admin_notes.html>`_ \| `scalability <scalability.html>`_ \|
   8 `API <apidoc/html/annotated.html>`_ \| `deprecated <deprecation.html>`_
   9 \| `IR <intro_ir.html>`_ \| `wiki <https://trac.xapian.org/wiki>`_
  10
  11 .. raw:: html
  12
  13     </div>
  14     <hr>
  15
  16 Xapian - the open source search engine
  17 ======================================
  18
  19 Getting Started
  20 ---------------
  21
  22 There's a new
  23 `Getting Started with Xapian <http://getting-started-with-xapian.readthedocs.org/>`_
  24 guide, which is the recommended place to start.
  25
  26 Documentation
  27 -------------
  28
  29 The Omega search application has its `own documentation
  30 <https://xapian.org/docs/omega/>`_, and there's also separate
  31 documentation for the `other language bindings
  32 <https://xapian.org/docs/bindings/>`_.
  33
  34 We suggest you start by reading the `Installation
  35 Guide <install.html>`_, which covers downloading the code, and
  36 unpacking, configuring, building and installing it.
  37
  38 The `glossary <glossary.html>`_ provides definitions for specialized
  39 terminology you might encounter while using Xapian.
  40
  41 The `Overview <overview.html>`_ explains the API which Xapian provides
  42 to programmers.  A full `API Reference <apidoc/html/index.html>`_ is
  43 automatically collated using doxygen from documentation comments in
  44 the source code.  There's also a list of `deprecated features
  45 <deprecation.html>`_ which lists features scheduled for removal, and
  46 also features already removed, along with suggestions for
  47 replacements.
  48
  49 If you want to learn more about information retrieval, there's a (reasonably
  50 mathematical) `introduction to the ideas behind Xapian <intro_ir.html>`_ which
  51 also suggests some books you might want to read.
  52
  53 There are a number of documents which cover particular features:
  54
  55 -  `BM25 Weighting Scheme <bm25.html>`_
  56 -  `Collapsing <collapsing.html>`_
  57 -  `Database Replication <replication.html>`_
  58 -  `Faceting <facets.html>`_
  59 -  `Indexing <termgenerator.html>`_
  60 -  `PostingSource <postingsource.html>`_
  61 -  `Query Parser <queryparser.html>`_
  62 -  `Remote Backend <remote.html>`_
  63 -  `Serialising Queries and Documents <serialisation.html>`_
  64 -  `Sorting Results <sorting.html>`_
  65 -  `Spelling Correction <spelling.html>`_
  66 -  `Stemming Algorithms <stemming.html>`_
  67 -  `Synonym Support <synonyms.html>`_
  68 -  `Value Ranges <valueranges.html>`_
  69
  70 For those wishing to do development work on the Xapian library itself,
  71 there is `documentation of Xapian's internals <internals.html>`_
  72 available.
  73
  74 We also have a `wiki <https://trac.xapian.org/wiki>`_ for documentation
  75 and examples contributed by the Xapian community.