Welcome to the Xapian Wiki

This wiki provides information of a more fluid or dynamic nature than the documentation included in the distribution. Information here may well be folded into the documentation.

If you're unfamiliar with the concept of a wiki, you can find out more in wikipedia.

You're welcome to improve the information here, though you'll need to create an account to make changes. We'd rather this wasn't necessary but wiki spamming is an increasing problem. Don't worry, we wouldn't dream of selling your email address or other information. Once you've created an account, and logged in, you'll be able to edit pages. The same login allows you to report bugs.

This is not the place for random discussion, nor for asking questions. Please use the mailing lists for that - you'll get an answer more quickly!

Contents

Understanding and using Xapian:

  • Official documentation
  • FAQ: Frequently asked questions
  • IssuesThatConfuseBeginners: Some issues which are common stumbling blocks for developers getting started with Xapian.
  • Glossary: Glossary of specialized terminology and acronyms
  • Phrasebook: Translation from terminology used in other systems to Xapian specific terminology
  • ReleaseNotes: Known problems and workarounds in the latest release
  • Articles: Links to articles, blogs and presentations about Xapian

Examples and contributed code:

  • SampleCode: Sample code using xapian, in various languages
  • ServiceScript: A service script to fire up xapian-tcpsrv automatically
  • HowtoSetTheDocId: How to set the document IDs in order to use an external sequence
  • NumberValueRangePhpExample: Some sample code showing how to use the NumberValueRangeProcessor to perform numeric range searches in PHP.
  • Many of the Articles also contain example code

Omega search application:

  • Omega: Additional documentation in progress
  • OmegaExample: A complete example tutorial on installing Xapian, Omega and generating an index

Development and internals of Xapian:

  • HelpWanted: Items which we would welcome help with
  • RoadMap: Plans for the future
  • ProfilingXapian: How to generate profiling data to help us optimise slow cases.
  • FlintBackend: Details of the Flint database backend (the default backend from 1.0.0 onwards)
  • Utf8Support: Details of Xapian's support for the UTF-8 character encoding
  • AutomatedBuilds: Keeping tabs on Xapian's automatic building and testing framework
  • ActiveBranches: Details of the currently active branches in SVN

Community:

These pages are in need of updating. If you want them to continue to exist, please update them!

Also specific to this wiki: