Difference between revisions of "Info: SphinxSearch" - New World Encyclopedia

From New World Encyclopedia
(Starting the search extension documentation)
 
m (Update version)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Introduction==
+
{{Infobox MediaWiki extension
 +
| name    = SphinxSearch
 +
| purpose  = Replaces default MediaWiki search with [http://www.sphinxsearch.com/ Sphinx]
 +
| version  = 0.7
 +
| author  = Svemir Brkic and Paul Grinberg
 +
| download = [http://www.mediawiki.org/wiki/Extension:SphinxSearch Extension page at MediaWiki.org]<br/>
 +
[http://sourceforge.net/projects/sphinxsearch/ Files hosted at at SourceForge]
 +
}}
  
This site uses [http://www.sphinxsearch.com/ Sphinx full-text search engine] as a replacement for standard [http://www.mediawiki.org/ MediaWiki] search. Our code is based on [http://www.mediawiki.org/wiki/Extension:SphinxSearch SphinxSearch extension] by Paul Grinberg. The changes we made include:
+
===Introduction===
  
* Changed the overall model based on [http://www.mediawiki.org/wiki/Extension:LuceneSearch LuceneSearch extension] to make Sphinx the main (and only) search engine on this wiki.
+
This site uses [http://www.sphinxsearch.com/ Sphinx full-text search engine] as a replacement for standard [http://www.mediawiki.org/ MediaWiki] search. Our initial code was based on [http://www.mediawiki.org/wiki/Extension:SphinxSearch SphinxSearch extension] by Paul Grinberg and changes we made were later merged with the official version.
  
* Added support for the Go button so user is redirected to an exact title match automatically.
+
===Installation===
  
* Changed the main data fetch query for the indexer to make it somewhat faster. Added page_id attribute to the index to make fetching of search results faster as well.
+
See [http://www.mediawiki.org/wiki/Extension:SphinxSearch official extension page] for detailed installation instructions for both [http://www.sphinxsearch.com/ Sphinx] and the extension itself. If you already tried to install [http://www.mediawiki.org/wiki/Extension:LuceneSearch LuceneSearch] and found it too complicated, you will probably be pleasantly surprised by Sphinx.
  
* Added an incremental index. We index entire wiki every night and update the incremental index with articles changed since then several times a day.
+
===Development===
  
* Tweaked handling of namespaces, so initial search uses namespaces from user's preferences.
+
We are still working to improve this extension to make it use more of the Sphinx capabilities and to make it better in the wiki context. We will be adding more options, better title matching, and image thumbnails in search results.
  
==Installation==
+
===Feedback===
  
To install our version of this extension, first [http://www.sphinxsearch.com/downloads.html download] and  [http://www.sphinxsearch.com/doc.html#installation install] Sphinx.
+
This wiki uses a [[Info:Feedback|separate system]] for public feedback. Click the feedback tab and register (it is an integrated Wordpress blog.) You may also send an email directly to ''svemir at thirdblessing dot net''. Best way to communicate regarding this extension is the [http://www.mediawiki.org/wiki/Extension_talk:SphinxSearch extension talk page] at MediaWiki.org.
 
 
Now create a sphinx.conf file. Sphinx comes with well-commented sample file, but if you want to use our code, you need to start with [http://www.newworldencyclopedia.org/src/SphinxSearch/sphinx.conf our sphinx.conf] and modify it further if necessary:
 
 
 
* You will need to update the file paths and table names (if you use some prefix.)
 
* If your wiki is very large, you may want to consider specifying a [http://www.sphinxsearch.com/doc.html#ranged-queries query range] in the conf file.
 
* If your wiki is not in English, you will need to change (or remove) the morphology attribute.
 
 
 
''To be continued...''
 
 
 
* [http://www.newworldencyclopedia.org/src/SphinxSearch/sphinx.conf sphinx.conf]
 
* [http://www.newworldencyclopedia.org/src/SphinxSearch/SphinxSearch.php SphinxSearch.php]
 
* [http://www.newworldencyclopedia.org/src/SphinxSearch/SphinxSearch_body.php SphinxSearch_body.php]
 

Latest revision as of 18:32, 25 February 2010

SphinxSearch
Purpose Replaces default MediaWiki search with Sphinx
Author Svemir Brkic and Paul Grinberg
Version 0.7
Extension files
Extension page at MediaWiki.org

Files hosted at at SourceForge

Introduction

This site uses Sphinx full-text search engine as a replacement for standard MediaWiki search. Our initial code was based on SphinxSearch extension by Paul Grinberg and changes we made were later merged with the official version.

Installation

See official extension page for detailed installation instructions for both Sphinx and the extension itself. If you already tried to install LuceneSearch and found it too complicated, you will probably be pleasantly surprised by Sphinx.

Development

We are still working to improve this extension to make it use more of the Sphinx capabilities and to make it better in the wiki context. We will be adding more options, better title matching, and image thumbnails in search results.

Feedback

This wiki uses a separate system for public feedback. Click the feedback tab and register (it is an integrated Wordpress blog.) You may also send an email directly to svemir at thirdblessing dot net. Best way to communicate regarding this extension is the extension talk page at MediaWiki.org.