Woogle4MediaWiki/Configuration

From TeamWeaverWiki

English

General configuration

Open the file [Your MediaWiki directory]/extensions/Woogle/WoogleConfig.php and scroll down to the WoogleConfig class to configure Woogle. You can call [MediaWiki URL]/Special:WoogleConfig in your browser to see configured values at runtime.

	private static $config = array(
								         // edit values here	// comment
		// general configuration
		'core'					=> array(true,					'enable or disable woogle at all'),
		'replace'				=> array(true,					'replace built-in MediaWiki search'),
		'advanced'				=> array(true,					'use Woogle "advanced" mode: redirection to an own wiki page for each search result'),
		'advancedBox'			=> array(true,					'show the box for the "advanced" mode with the corresponding wiki content in it'),
		'advancedWikiLink'		=> array(true,					'show a button to create a wiki page with the same name as the search string'),
		'advancedWatch'			=> array(true,					'show a button to watch a search result for changes in the corresponding wiki page'),
		'advancedDiscussion'	=> array(true,					'show a button including a link on the result\'s discussion page'),
		'advancedNamespaceGrab'	=> array(true,					'if the (usually) Woogle:Namespace should be grabbed and redirected to the nonAdvanced url if advanced is turned off'),
		'redLinkInfo'			=> array(false,					'show meta-info popups next to red links'),
		'limitAccessToGroups'	=> array(false,					'access limited to mediawiki groups specified in $groups'),
		'groups'				=> array(array('fzi'),			'groups access is limited to if $limitAccessToGroups'),
		'defaultCount'			=> array(10,					'default number of results shown per page'),
		'helpPage'				=> array('Woogle',				'wiki-page shown as help page'),
		'resultWidth'			=> array(650,					'pixel-width of the result list'),
		'searchOptions'			=> array('source=mediawiki',	'additional search options when using the built-in mediawiki search'),
		'timeout'				=> array(0,						'timeout if the QueryService is down (in seconds)'),
		'clickTracking'			=> array(true,					'if clicks are being tracked'),
		'indexAddon'			=> array('Native',				'addon used for the Woogle index'),
		'indexRepository'		=> array(17,					'repository id this wiki should use in the index')
	);

See the documentation for each value on the right side. Typically, there is no need to change most of these values. Values that required consideration are:

• indexAddon - put in 'Native' or 'Remote' depending on your choice of the backend!
• indexRepository - put in a numeric id. For WoogleNative it is arbitrary, for WoogleRemote you need to use the repoId configured in the backend (c.f. repo_config.xml

For WoogleRemote, you need to make additional settings (see below).

Specific settings for WoogleRemote

Edit [Your MediaWiki directory]/extensions/Woogle/addons/Remote.php.

function woogleRemoteConfig(&$config) {
	$config['remoteAuthKey']			= array("anonymous",	'authKey being passed to the remote Backend');
	$config['remoteQueryServiceUrl']	= array('http://octopus13.fzi.de:9999/teamweaverIS-backend/services/phpQuery',
																'remote query service url');
	$config['remoteUpdateServiceUrl']	= array('http://octopus13.fzi.de:9999/teamweaverIS-backend/services/phpUpdate',
																'remote update service url');
	$config['remoteIndexServiceUrl']	= array('http://octopus13.fzi.de:9999/teamweaverIS-backend/services/phpIndex',
																'remote update service url');
	$config['remoteOptions']			= array(array('username' => 'waves', 'password' => 'trrwd'),
																'options being passed to the HessianClient');
	$config['remoteServiceName']		= array('Woogle',		'service name being passed to the wavesIS backend');
	$config['remoteServiceVersion']		= array('0.99',			'service version being passed to the wavesIS backend');
	$config['remotePushIndexAuthKey']	= array('dummyKey',		'key the push index is called with to authenticate');
	return true;
}

Values you need to configure:

• remote...ServiceUrl - set the respective backend URLs here
• remotePushIndexAuthKey - for indexing - as configured in the backend repo_config.xml
• remoteAuthKey - only required for querying, if the backend is set to securityEnabled = true;

Deutsch (German) (nicht auf dem neuesten Stand)

Allgemeine Konfiguration

Die folgenden Einstellungen können in der Datei [MediaWiki Installationverzeichnis]/extensions/Woogle/WoogleConfig.php vorgenommen werden. Wenn Sie die Seite [MediaWiki URL]/Special:WoogleConfig in Ihrem Web-Broweser öffnen, können Sie die Konfigurationswerte zur Laufzeit sehen.

private static $config = array(
				 // edit values here		// comment
	'advanced'		=> array(true,			'use Woogle "advanced" mode'),
	'advancedBox'		=> array(true,			'show the box for the "advanced" mode with the corresponding wiki content in it'),
	'advancedWikiLink'	=> array(true,			'show a button to create a wiki page with the same name as the search string'),
	'advancedWatch'		=> array(true,			'show a button to watch a search result for changes in the corresponding wiki page'),
	'advancedNamespaceGrab'	=> array(true,			'if the (usually) Woogle:Namespace should be grabbed and redirected to the nonAdvanced url if advanced is turned off'),
	'limitAccessToGroups'	=> array(false,			'access limited to mediawiki groups specified in $groups'),
	'groups'		=> array(array('fzi'),		'groups access is limited to if $limitAccessToGroups'),
	'defaultCount'		=> array(10,			'default number of results shown per page'),
	'helpPage'		=> array('Woogle',		'wiki-page shown as help page'),
	'resultWidth'		=> array(650,			'pixel-width of the result list'),
	'secure'		=> array(false,			'mediawiki being accessed with SSL'),
	'searchOptions'		=> array('source=mediawiki',	'additional search options when using the built-in mediawiki search'),
	'remoteQueryService'	=> array(false,			'query service remote or native - if set to false you can skip the rest of the configuration, but make sure to setup the native index with Special:WoogleNative'),
	'authKey'		=> array("anonymous",		'authKey being passed to the remote Backend'),
	'queryServiceUrl'	=> array('http://server:8080/teamweaverIS-backend/services/phpQuery',
								'remote query service url, only relevant for the remote query service'),
	'updateServiceUrl'	=> array('http://server:8080/teamweaverIS-backend/services/phpUpdate',
								'remote update service url, only relevant for the remote query service'),
	'indexServiceUrl'	=> array('http://server:8080/teamweaverIS-backend/services/phpIndex',
								'remote update service url, only relevant for the remote query service'),
	'options'		=> array(array('username' => 'waves', 'password' => 'trrwd'),
								'options being passed to the HessianClient, only relevant for the remote query service'),
	'clickTracking'		=> array(false,			'if clicks are being tracked, only relevant for the remote query service'),
	'serviceName'		=> array('Woogle',		'service name being passed to the wavesIS backend, only relevant for the remote query service'),
	'serviceVersion'	=> array('0.2 beta',		'service version being passed to the wavesIS backend, only relevant for the remote query service'),
);

    * $groups: Array der erlaubten Mediawiki Benutzergruppen (wenn $limitAccessToGroups true ist)
    * $limitAccessToGroups: limitiert den Zugriff auf die Woogle-Suche auf die Gruppen in $groups
    * $clickTracking: ob click tracking aktiviert ist oder nicht
    * $queryServiceUrl: die URL zum teamweaverIS Backend QueryService
    * $updateServiceUrl: die URL zum teamweaverIS Backend UpdateService
    * $options: Array mit Optionen fuer den Backend Service - z.B. wenn auf dem Tomcat die HTTP Authentifizierung aktiviert ist (Felder username und password)
    * $serviceName: mit welchem Namen sich Woogle beim Backend authentifizieren soll
    * $serviceVersion: mit welcher Version sich Woogle beim Backend authentifizieren soll
    * $helpPage: auf welcher Wiki-Seite sich die Woogle-Hilfe befindet - gibt es keine einfach leer lassen
    * $secure: ob Woogle hinter einer SSL-Verbindung ist
    * $searchOptions: QueryString, der hinter Wikisuchen gehaengt wird (z.B. Parameter fuer die erweiterte Suche, sodass gleich nur in einer Quelle gesucht wird) 

Woogle über die MediaWiki Suchmaske aufrufen

• in der [MediaWiki Installationverzeichnis]/index.php folgende Zeile nach require_once( './includes/WebStart.php' ); einfügen, falls die Woogle-Suche mit der Standard-Searchbox funktionieren soll:
  • WoogleConfig::initSearch();