Extension:GoogleCustomWikiSearch
GoogleCustomWikiSearch Release status: stable |
|
---|---|
Implementation | Special page |
Description | Allows MediaWiki integration with Google Custom Search or Google Site Search. |
Author(s) | Ike Hecht (tosfostalk) |
Maintainer(s) | WikiTeq team |
Latest version | 0.6.0 (July 2021) |
Compatibility policy | For every MediaWiki release that is a Long Term Support release there is a corresponding branch in the extension. |
MediaWiki | 1.31-1.35, 1.39 |
Database changes | No |
License | GNU General Public License 2.0 |
Download | |
|
|
Quarterly downloads | 7 (Ranked 124th) |
Translate the GoogleCustomWikiSearch extension if it is available at translatewiki.net | |
Issues | Open tasks · Report a bug |
The Google Custom Wiki Search extension allows MediaWiki integration with Google Custom Search or Google Site Search.
Usage
editDefines 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
editThe extension can be retrieved directly from Git [?]:
- Browse code
- Some extensions have tags for stable releases.
- Browse tags
- Select the tag
- Click "snapshot"
- Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).
- Browse branches
- Select a branch name
- Click "Continue"
Extract the snapshot and place it in the extensions/GoogleCustomWikiSearch/ directory of your MediaWiki installation.
If you are familiar with Git and have shell access to your server, you can also obtain the extension as follows:
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/GoogleCustomWikiSearch.git
Installation
edit- Download and move the extracted
GoogleCustomWikiSearch
folder to yourextensions/
directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/GoogleCustomWikiSearch - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'GoogleCustomWikiSearch' );
- Configure as required
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
To users running MediaWiki 1.35 or earlier:
The instructions above describe the new way of installing this extension using wfLoadExtension()
.
If you need to install this extension on these earlier versions (MediaWiki 1.35 and earlier), instead of wfLoadExtension( 'GoogleCustomWikiSearch' );
, you need to use:
require_once "$IP/extensions/GoogleCustomWikiSearch/GoogleCustomWikiSearch.php";
Configuration
editImportant: The global names were changed in version 0.3!
Basic
edit$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. (Note: There is a bug in the current version. If this parameter is left blank, you must set$wgGoogleCustomWikiSearchCodeVersion = 1;
.)$wgGoogleCustomWikiSearchReplaceSearch
- Set totrue
to completely replace the MediaWiki search engine with a Google search. Defaults tofalse
.$wgGoogleCustomWikiSearchAppendToSearch
- Append to standard search results? Only makes sense if $wgGoogleCustomWikiSearchReplaceSearch is false.
Advanced
edit$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
editThis extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |