Extension:GoogleCustomWikiSearch

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
GoogleCustomWikiSearch

Release status: beta

Implementation Special page
Description Allows MediaWiki integration with Google Custom Search or Google Site Search.
Author(s) Ike Hecht (tosfostalk)
Latest version 0.4 (August 2014)
MediaWiki 1.23+ (probably earlier too)
PHP 5.3+
Database changes No
License GPL
Download
Example theplantencyclopedia.org
Parameters
  • $wgGoogleCustomWikiSearchId
  • $wgGoogleCustomWikiSearchReplaceSearch
  • $wgGoogleCustomWikiSearchAppendToSearch
  • $wgGoogleCustomWikiSearchTheme
  • $wgGoogleCustomWikiSearchCodeVersion
  • $wgGoogleCustomWikiSearchOptions
Hooks used
SpecialSearchSetupEngine

SpecialPageAfterExecute

Translate the GoogleCustomWikiSearch extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

What can this extension do?[edit | edit source]

The Google Custom Wiki Search extension allows MediaWiki integration with Google Custom Search or Google Site Search.

Usage[edit | edit source]

Defines a special page (Special:GoogleCustomWikiSearch) that performs a Google search on the wiki. These results can also optionally be appended to the standard wiki search or can replace the built-in search functionality.

Download instructions[edit | edit source]

You can download the code, in .tgz format, here.

You can also download the code directly via Git from the MediaWiki source code repository. From a command line, you can call the following:

git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/GoogleCustomWikiSearch.git

To view the code online, including version history for each file, go here.

Installation[edit | edit source]

  • Download and place the file(s) in a directory called GoogleCustomWikiSearch in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/GoogleCustomWikiSearch/GoogleCustomWikiSearch.php";
  • YesY Done Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Configuration parameters[edit | edit source]

Important: The global names were changed in version 0.3!

Basic[edit | edit source]

  • $wgGoogleCustomWikiSearchId - Google Custom Search ID - requires account with Google. The ID can be found in your GCS control panel under "basic information". Note that if this is left blank (not set in LocalSettings), the result will be a Google site search.
  • $wgGoogleCustomWikiSearchReplaceSearch - Set to true to completely replace the MediaWiki search engine with a Google search. Defaults to false.
  • $wgGoogleCustomWikiSearchAppendToSearch - Append to standard search results? Only makes sense if $wgGoogleCustomWikiSearchReplaceSearch is false.

Advanced[edit | edit source]

  • $wgGoogleCustomWikiSearchTheme - This may be overwitten by Control Panel settings in Google script Version 2. Possible values are: 'DEFAULT', 'BUBBLEGUM', 'ESPRESSO', 'GREENSKY', 'MINIMALIST', 'SHINY'
  • $wgGoogleCustomWikiSearchCodeVersion - What version of Google's script we should use. This defaults to Version 2, which allows customization in your GCS Control Panel. Can also be set to 1, which was the default in version < 0.3.
  • $wgGoogleCustomWikiSearchOptions - For those who want additional customization, set this instead of $gcwsID (which will be ignored if this is set). Set this variable to equal the insertion code provided by Google. Support for this feature is somewhat experimental.
It should be set similar to this example:
$wgGoogleCustomWikiSearchOptions = <<<END
    var customSearchOptions = {};
    var orderByOptions = {};
/* lots of other Google code here */
END;
Note: The custom search options variable may leave out customSearchControl.draw, though options will only display then if the variable is named "options".

See also[edit | edit source]

Google Custom Search Engine (CSE) extensions