Jump to content

Erweiterung:GoogleCustomWikiSearch

From mediawiki.org
This page is a translated version of the page Extension:GoogleCustomWikiSearch and the translation is 100% complete.
Diese Erweiterung wird vom WikiTeq-Team professionell gewartet.
WikiTeq provides official support for MediaWiki LTS releases only. It may work with other MediaWiki releases.
MediaWiki-Erweiterungen
GoogleCustomWikiSearch
Freigabestatus: stabil
Einbindung Spezialseite
Beschreibung Erlaubt MediaWiki-Integrierung mit Google Custom Search oder Google Site Search.
Autor(en) Ike Hecht (tosfosDiskussion)
Betreuer WikiTeq team
Letzte Version 0.6.0 (Juli 2021)
Kompatibilitätspolitik Für jede MediaWiki-Version, die ein Long Term Support Release ist, existiert ein entsprechender Zweig in der Erweiterung.
MediaWiki 1.31-1.35, 1.39
Datenbankänderungen Nein
Lizenz GNU General Public License 2.0
Herunterladen

  • $wgGoogleCustomWikiSearchId
  • $wgGoogleCustomWikiSearchReplaceSearch
  • $wgGoogleCustomWikiSearchAppendToSearch
  • $wgGoogleCustomWikiSearchTheme
  • $wgGoogleCustomWikiSearchCodeVersion
  • $wgGoogleCustomWikiSearchOptions
Quarterly downloads 7 (Ranked 133rd)
Übersetze die GoogleCustomWikiSearch-Erweiterung, wenn sie auf translatewiki.net verfügbar ist
Probleme Offene Aufgaben · Einen Fehler melden

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

Verwendung

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.

Herunterladen

Die Erweiterung kann direkt von Git bezogen werden [?]:

  • Den Code ansehen
  • Einige Erweiterungen haben Tags für stabile Versionen.
  • Jeder Zweig ist mit einer früheren MediaWiki-Freigabe verknüpft. Es gibt auch einen „Master“-Zweig, der die aktuellste Alpha-Version enthält (möglicherweise ist dafür eine Alpha-Version von MediaWiki erforderlich).

Extrahiere den Snapshot und kopiere ihn in das extensions/GoogleCustomWikiSearch/-Verzeichnis der MediaWiki-Installation.

Falls man sich mit git auskennt und einen Konsolen-Zugang zum Server hat, kann man die Erweiterung auch so bekommen:

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

Installation

  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens GoogleCustomWikiSearch im Ordner extensions/ ablegen.
    Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/GoogleCustomWikiSearch
  • Folgenden Code am Ende deiner LocalSettings.php -Datei einfügen:
    wfLoadExtension( 'GoogleCustomWikiSearch' );
    
  • Configure as required
  • Yes Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.

Für Benutzer, die MediaWiki in der Version 1.35 und früher betreiben:

Die oben stehenden Anweisungen beschreiben die neue Installationsanweisung für diese Erweiterung unter der Verwendung von wfLoadExtension(). Wird diese Erweiterung in einer dieser früheren Versionen (MediaWiki 1.35 und früher)  – an Stelle von wfLoadExtension( 'GoogleCustomWikiSearch' ); – installiert, benutze:

require_once "$IP/extensions/GoogleCustomWikiSearch/GoogleCustomWikiSearch.php";

Konfiguration

Important: The global names were changed in version 0.3!

Grundlegend

  • $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 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.

Erweitert

  • $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".

Siehe auch