Extension:GoogleSiteSearch
From MediaWiki.org
 Release status: beta |
|||
|---|---|---|---|
| Implementation | Search | ||
| Description | Replaces built-in MediaWiki search with Google Site Search results | ||
| Author(s) | Ryan Finnie | ||
| Last Version | 1.2 (26 May 2007) | ||
| MediaWiki | 1.5-current (as of 1.13alpha) | ||
| License | No license specified | ||
| Download | zip | ||
|
|||
|
check usage (experimental) |
|||
This extension replaces the built-in MediaWiki search functionality with Google Site Search results for your site. Results are nearly seamless; go/search logic works as expected. ("Go" goes directly to an article if it exists, searches otherwise. "Search" always searches.) Warning: This extension requires a small modification of core MediaWiki files (2-line addition).
For an example, please see http://www.finnix.org/Special:Search?search=Debian&go=Go
Contents |
[edit] Installation
1. Download the zip file and extract so files are in extensions/GoogleSiteSearch.
2. Add the following to LocalSettings.php:
require_once("extensions/GoogleSiteSearch/GoogleSiteSearch.php");
3. Edit includes/SpecialSearch.php (or includes/specials/SpecialSearch.php in the MW 1.13 series, or see the latest directions) and look for the following code block:
function showResults( $term ) {
$fname = 'SpecialSearch::showResults';
wfProfileIn( $fname );
...
Unfortunately there's never a good hook around when you need it, so a code call must be inserted:
wfshowResultsGoogle( $term ); return;
You should be left with something like this:
function showResults( $term ) {
wfshowResultsGoogle( $term );
return;
$fname = 'SpecialSearch::showResults';
wfProfileIn( $fname );
...
4. Go to your MediaWiki installation, type something into the Search box. You should now see results from your site via Google Site Search.
[edit] Configuration
All configuration for GoogleSiteSearch is optional, and is performed in the LocalSettings.php file. All Google-specific variables can be configured via the $wgGoogleSiteSearchVars array. At the moment, there are no extension-specific variables.
[edit] $wgGoogleSiteSearchVars
The following example lists all defaults.
$wgGoogleSiteSearchVars = array(); # Unless you have an odd MediaWiki setup, the same host as the search # should be fine. $wgGoogleSiteSearchVars['domains'] = $_SERVER['HTTP_HOST']; # Ditto. $wgGoogleSiteSearchVars['sitesearch'] = $_SERVER['HTTP_HOST']; # A valid Google AdSense or CoOp account. If this is not set, it defaults # to the author's AdSense account, so hey, no rush. $wgGoogleSiteSearchVars['client'] = 'pub-9372650377977516'; # If a Google AdSense account is specified, this can be set to a specific # channel. Enter the channel's ID not its name to ensure reporting works $wgGoogleSiteSearchVars['channel'] = ''; # Can probably be changed to UTF-8, but hasn't been tested yet. $wgGoogleSiteSearchVars['ie'] = 'ISO-8859-1'; # Can probably be changed to UTF-8, but hasn't been tested yet. $wgGoogleSiteSearchVars['oe'] = 'ISO-8859-1'; # The language to be displayed. $wgGoogleSiteSearchVars['hl'] = 'en'; # The default color scheme compliments MediaWiki well, but can be # customized here. $wgGoogleSiteSearchVars['cof'] = 'GALT:#008000;GL:1;DIV:#336699;VLC:663399;' . 'AH:center;BGC:FFFFFF;LBGC:336699;ALC:0000FF;LC:0000FF;T:000000;' . 'GFNT:0000FF;GIMP:0000FF;FORID:9'; # Do not change. $wgGoogleSiteSearchVars['sa'] = 'Google Search'; # Do not change. $wgGoogleSiteSearchVars['forid'] = '1';
[edit] Sites that use this extension
- TrailBrain.com example in use: http://www.trailbrain.com/wiki/index.php?search=Logan+River&go=Go
- DS-xtra.com DS Homebrew Wiki.
- Wikitel A Wiki devoted to telecommunications regulation
- WikiLetras.org Brazilian Lyrics wiki
- NotaCult.com A World of Warcraft guild
- [1] Google Search Result
- Asterisk Australia Australian Asterisk Site
- Discoogle.com Huge discography, lyrics and chart wiki.
- Debatrix.org A wiki centered on debate. (not very developed yet)
