TeamWeaverWiki - User contributions [en]

Sandbox

2014-02-09T19:34:28Z

Happel:

[[Sandkasten]]

noch ein Sandkasten

noch mehr sand

c

Und walid's sand

xhajo
x

Sandbox

2014-02-09T19:33:23Z

Happel:

[[Sandkasten]]

noch ein Sandkasten

noch mehr sand

c

Und walid's sand

xhajo

Sandbox

2014-02-09T19:32:44Z

Happel:

[[Sandkasten]]

noch ein Sandkasten

noch mehr sand

c

Und walid's sand

x

Woogle4MediaWiki/Admin manual

2011-08-06T11:03:13Z

Happel: /* Instrumentation addon */

== Installation ==
Before starting, it is important to understand that Woogle4MediaWiki can be run in '''two different modes''':
* Woogle'''Native''' - which is purely PHP-based - you can only search and index your Wiki as such, but no data outside the Wiki
* Woogle'''Remote''' - which connects to an [[Integrated Search]] backend - you can search any kind of data indexed by the backend (including e.g. file systems, SVN ressources etc.)

If you are in a hurry, there is a less elaborate [[Woogle4MediaWiki/Quick install|quick install guide]] for WoogleNative.

=== Prerequisites ===
* Server
** Woogle4MediaWiki requires [http://www.mediawiki.org/wiki/MediaWiki MediaWiki] in a version >= 1.11.0 (see also [[Woogle4MediaWiki/Compability|compatibility notes]])
** '''Note''': If you are using PHP 5.3.0 and beyond, some [http://us.php.net/manual/en/migration53.incompatible.php compability issues] with older versions of [https://bugzilla.wikimedia.org/show_bug.cgi?id=15854 MediaWiki] (<1.14.1) and [http://octopus13.fzi.de:8080/browse/WOO-288 Woogle] (< 1.0-RC2) will arise. Make sure to work with a recent version.
** For using WoogleNative,
*** we strongly recommend the PCRE and mb_string extensions to be installed in your PHP runtime environment (although not strictly neccessary)
*** you will need a database user with <code>CREATE TABLE</code> privileges (or the database root account)
** For WoogleRemote you need an installed [[Integrated Search]] backend, and some configuration data (backend URL, repoId, pushIndexAuthKey; c.f. [[Integrated_Search/Configuration#Configuring_.22push.22_indexing|for push indexing]]). A network connection from the MediaWiki server to the Integrated Search backend is required.
* Client
** Woogle will most probably work with any browser which is supported by MediaWiki itself (see also [[Woogle4MediaWiki/Compability|compatibility notes]])
** Some advanced features of Woogle (autocomplete, red link popus, result annotation) make use of Ajax and might not work with old browsers. However, the Woogle core features should not be affected by this.

=== Installation steps ===
* Download the appropriate distribution file. There are distributions for WoogleRemote, WoogleNative and one including both.
* Extract the content of the Woogle distribution ZIP-file to <code>[Your MediaWiki directory]/extensions/Woogle</code>
* Grant write permissions for the executing user on <code>[Your MediaWiki directory]/extensions/Woogle/logs</code> and on <code>[Your MediaWiki directory]/extensions/Woogle/addons/Native/index</code>, if you are using the Native addon
** If you use the latest SVN HEAD Version (instead of 1.0-RC2), also grant write permissions to <code>[Your MediaWiki directory]/extensions/Woogle/resources/tpl/compiled</code>
* At the end of the file <code>[Your MediaWiki directory]/LocalSettings.php</code> add the following line: <code>require_once("$IP/extensions/Woogle/Woogle.php");</code>
* Proceed with configuration

== Configuration ==

=== General configuration ===
To configure Woogle, add a statement <code>WoogleConfig::set('parameter', 'value');</code> to LocalSettings.php for each configuration parameter you want to change. These statements have to be '''below''' the inclusion of Woogle.php.

The default values plus description of all parameters can be found in <code>[Your MediaWiki directory]/extensions/Woogle/includes/WoogleConfig.php</code>. Do not modify any values there. Alternatively, you can see all configuration values on the special page <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> (e.g. [[Special:WoogleConfig]]).

Open the file <code>[Your MediaWiki directory]/extensions/Woogle/includes/WoogleConfig.php</code> and scroll down to the <code>WoogleConfig</code> class to configure Woogle. You can call <code>[MediaWiki URL]/Special:WoogleConfig</code> (which requires a WikiSysop user) in your browser to see configured values at runtime.

Example snippet for LocalSettings.php with most important settings:
<pre>
require_once("$IP/extensions/Woogle/Woogle.php");

// Optional Woogle Configuration
//WoogleConfig::set('core', false); // set false to completely dectivate Woogle
//WoogleConfig::set('replace', false); // set false to use MediaWiki built-in search from MediaWiki search box (Woogle is only used when directly called from Special:Woogle then)
//WoogleConfig::set('advanced', false); // set false to disable Woogle:-Namespace and thus enable Special:Woogle only
//WoogleConfig::set('redLinkInfo', false); // set false to disable JavaScript popups for red links
//WoogleConfig::set('limitAccessToGroups', true); // set true to restrict Woogle usage to groups defined in $groups below
//WoogleConfig::set('groups', array('sysop')); // groups access is limited to if $limitAccessToGroups
//WoogleConfig::set('clickTracking', false); // set false to avoid tracking of user's result clicks (for statistical purposes)
</pre>

Woogle creates additional MediaWiki [http://www.mediawiki.org/wiki/Manual:$wgExtraNamespaces namespaces]. If you are using other MediaWiki extensions which define namespaces (such as Semantic MediaWiki), you have to set a starting index of free namespaces Ids for Woogle by setting <code>$wooNamespaceIndex = 110</code>. The implicit default value is 100.

See the documentation for each value on the right side. Typically, there is '''no need to change most of these values'''.

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

=== Specific settings for WoogleRemote ===
Default settings are documented in <code>[Your MediaWiki directory]/extensions/Woogle/addons/Remote.php</code>. As with the general settings, do not edit directly, but add statements to LocalSettings.php

Example snippet for LocalSettings.php with most important settings:
<pre>
require_once("$IP/extensions/Woogle/Woogle.php");

// Woogle Configuration
WoogleConfig::set('remoteBaseServiceUrl', 'http://octopus13.fzi.de:9999/teamweaverIS-backend/services/'); // set the respective backend URL here
WoogleConfig::set('remoteAuthKey', 'secret'); // key for querying, only required if the backend is set to securityEnabled = true;
WoogleConfig::set('indexGroups', array('group1', 'group2'));
WoogleConfig::set('indexRepository', 123); // numeric id for indexing (repoId) - as configured in the backend repo_config.xml
WoogleConfig::set('remotePushIndexAuthKey', 'secret2'); // key for indexing - as configured in the backend repo_config.xml
</pre>

As you can see, some parameters depend on configuration choices related to the [[Integrated Search|integrated search backend configuration]] (see also [[repo_config.xml]]).

=== Final steps ===
* Open MediaWiki and see if the system runs properly (if problems occur - see the [[Woogle4MediaWiki/Admin manual#Dealing_with_problems|"dealing with problems" section]] below!).
* Open <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> in your browser (which requires a WikiSysop user) and check the "status" section on top
** For WoogleNative, click the button "Create database tables". If Woogle tells "You need db root access to create tables", your MediaWiki database user does not seem to have <code>CREATE TABLE</code> privileges (see prerequisites). You may either grant these rights via the database interface, or do the "Database adminstration via script" (see Additional topics section below)
** If everything looks fine on the "status" section, you are ready to create the search index for the existing pages (afterwards, all page changes will update the index automatically)
*** Select "(Re-)Create Index (Direct)" to create the index immediately, within one HTTP session. For large Wikis, this will block your browser and probably even result in a script timeout (depending on your server configuration)
*** Thus you may '''alternatively''' select "(Re-)Create Index (Jobs)", which will create tasks in your MediaWiki job queue for indexing each page. The job queue usually (depending on your MediaWiki configuration) processes a handful jobs with each user request. Thus, for a large Wiki, it will take considerable time until all indexing jobs have been processed. If your Wiki has low traffic, it might even take longer. You can alread search during this process, but you might not receive full results. See "Run indexing jobs" under "Additional topcis" on how to do batch indexing.
*** For '''larger wikis''' (> 500 pages) we '''strongly recommend''' to used the command line script <code>php extensions/Woogle/maintenance/WoogleReIndexAll.php [options...]</code> for index creation! ([[Woogle4MediaWiki/Admin manual#Indexing_via_script|see below for details]])
* Enter <code>[MediaWiki URL]/index.php/Special:Woogle</code> to your browser to check if everything works

== Uninstalling Woogle ==
* Note that Woogle can be disabled by any user individually via his/her MediaWiki user preferences (Special:Preferences).
* Woogle can be deactivated by adding <code>WoogleConfig::set('core', false);</code> or by commenting out all Woogle statements in LocalSettings.php. This will do no harm - the MediaWiki system will immediately fall back to the built-in search.
* If you want to physically remove Woogle, do the following:
** For WoogleNative, visit <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> (which requires a WikiSysop user) and click the button "Remove database tables". If you do not have sufficenit permissions to do so, try the "Database adminstration via script" (see Additional topics section below)
** Comment out or remove all Woogle statements in LocalSettings.php
** Remove Woogle directory from <code>[Your MediaWiki directory]/extensions/</code>

== Additional topcis ==

=== Dealing with problems ===
If problems occur, you might first see [[Woogle4MediaWiki/FAQ#Administrator_questions|the FAQ]].

If you see a blank page after enabling Woogle, adding the following code to your <code>LocalSettings.php</code> might help to track down the problem:
<pre>
# Error reporting (only useful for debugging)
error_reporting( E_ALL );
ini_set( 'display_errors', 1 );
$wgShowExceptionDetails = true;
$wgShowSQLErrors = true;
</pre>

=== Database administration via script ===
If your MediaWiki database user does not have sufficient privileges to add/delete tables, you have to use the command line script instead of conveniently using the buttons at Special:WoogleConfig.

Therefore, you need to configure a database user with suitable privileges in the file <code>AdminSettings.php</code> in the root of your MediaWiki directory (c.f. [http://www.mediawiki.org/wiki/Manual:Maintenance_scripts] resp. [http://www.mediawiki.org/wiki/Manual:AdminSettings.php]).

Afterwards, you may call <code>php extensions/Woogle/addons/Native/maintenance/WoogleNativeDb_setup.php [options...]</code>, whereas options are:
* <code>--user <dbuser></code> Database user account to use for changing DB layout. If not set, the credentials in AdminSettings.php are used.
* <code>--password <dbpassword></code> Password for user account to use. (Instead of custom password.)
* <code>--delete</code> Delete Woogle database tables. If not selected, this script tries to create them.

=== Indexing via script ===
Especially for larger Wikis, it makes sense to run indexing tasks from the command line instead of the web browser. There are two scripts, that can support you with this task:
* <code>php extensions/Woogle/maintenance/WoogleReIndexAll.php [options...]</code> is our recommended approach, since it will rebuild the index without any further prerequisites. The following options can be set:
** <code>-f</code> to force indexing without 10 sec waiting delay
** <code>--server=http://www.mywikihost.org</code> - server name (e.g. http://www.mywikihost.org) - without trailing slashes - to avoid that Woogle stores Wiki page URLs with <code>http://localhost</code> in the index. Alternatively set $wgServer explicitly in LocalSettings.php (c.f. [http://www.mediawiki.org/wiki/Manual:LocalSettings.php#Server_name]).
** <code>--conf=../../../LocalSettings2.php</code> - this is only necessary, but particularly useful, if you would like to create an index without touching the productive Wiki system (which is configured in LocalSettings.php). You may just make a copy of LocalSettings.php and only include Woogle in this configuration.
* If you chose to "index as jobs" in <code>Special:WoogleConfig</code>, Woogle will add small indexing jobs (one job for each Wiki page) to the MediaWiki job system. In a large Wiki, this might produce a huge job queue which takes a while to fill the index, since in MediaWiki, a small fraction of jobs is processed with every user request. However, MediaWiki provides a script <code>/maintenance/runJobs.php</code> to process the job queue from the command line. Follow the [http://www.mediawiki.org/wiki/Manual:Job_queue MediaWiki manual] concerning this option.

=== Modify or translate UI text ===
Woogle user interface text is modularized to language files located in <code>/extensions/Woogle/languages/</code>. Edit these files to adapt texts. To create translations for other languages, copy an existing file (probably WoogleLangEnglish.php) and translate the content. Please contribute such translations back to us!

=== Modify the user interface ===
Woogle UI can be configured using several configuration parameters, which are documented in <code>WoogleConfig.php</code>.

Besides that, many visual aspects of Woogle are captured in CSS files which you may customize.

=== Instrumentation addon ===
Woogle provides an addon for scientific evaluation (called "instrumentation") which captures user activities in a log file. Also, the extension allows to modify certain Woogle (UI) settings for different groups of users and provides a confirmation screen that allows to gain user's explicit consent for logging data.

Instrumentation mode can be enabled by setting <code>$config['instrumentation']</code> in <code>extensions\Woogle\addons\Instrumentation\Instrumentation.php</code> to "true". Further settings can be changed there as well.

See [[Woogle4MediaWiki/Instrumentation addon]] for detailed information.

Woogle4MediaWiki/Instrumentation addon

2011-08-06T11:03:00Z

Happel: Created page with '== Purpose == The purpose of the instrumentation addon is to carry out (usability) experiments in MediaWiki. In a nutshell, different Wiki users receive different experimental tr…'

== Purpose ==
The purpose of the instrumentation addon is to carry out (usability) experiments in MediaWiki. In a nutshell, different Wiki users receive different experimental treatments (i.e., a different text or image) based on a certain hypothesis or design goal (i.e., improve clickthrough-rate). The addon logs their response/activity after receiving the treatment. Statistically analyzing the resulting data can help researchers or designers to judge their hypothesis resp. design goal (c.f. http://en.wikipedia.org/wiki/A/B_testing).

This addon provides a set of core features for this purpose (detailed description below):
* Configuring experimental groups & treatments
* Assignment of users to groups
* Instantiating experimental treatments at runtime
* Logging user activities
* Covering data protection and research ethics topics such as user pseudonymization & informed consent

=== Reusability ===
The instrumentation addon was designed as part of [http://www.mediawiki.org/wiki/Extension:Woogle4MediaWiki Extension:Woogle4MediaWiki] to help researching its usage.

However, its general mechanism can be easily adapted for other purposes/extensions as well.

Technically, one could therefore use the whole Woogle4MediaWiki extension and disable all its original features, to just use the instrumentation part. If useful for many users, one could also think about extracting the instrumentation functionality out of Woogle into an independent extension (interested developers should contact us).

== Features ==

=== Defining evaluation groups ===
The core of the instrumentation addon is the definition of the different experimental groups (see <code>instrumentationGroups</code> in the function woogleInstConfig in [https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/addons/Instrumentation/Instrumentation.php Instrumentation.php]). An '''arbitrary''' number of groups is possible. For evaluation purposes, the typical setup is to treat one ("control") group with a standard setting, and to treat further groups with modifications based on different experimental conditions. A simple example would be testing if a visual advertisement banner results in more clicks (compared to a standard text link). See also [http://en.wikipedia.org/wiki/A/B_testing A/B_testing].

The evaluation groups of the instrumentation addon allow for arbritrary modifications. In the context of Woogle, it makes use of Woogle's powerful configuration capabilities. Many options of the Woogle extension can be configured via [https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/includes/WoogleConfig.php WoogleConfig.php] and according user preferences.

The evaluation groups can be understood as pre-defined, grouped sets of user preferences which are assigned to different users. I.e., '''for each evaluation group defined in <code>instrumentationGroups</code>, all WoogleConfig.php-parameters can be set to a certain value for that group, resulting in a different user experience/different experimental treatments for each group'''.

While this is the current default setup, the instrumentation addon is only loosely couple to WoogleConfig.php. Arbitrary other ways of implementing different treatments are possible.

=== Assigning users to evaluation groups ===
The assignment of users to the configured evaluation groups (see above) takes place in the function assignInstrumentationGroup() (in [https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/addons/Instrumentation/Instrumentation.php Instrumentation.php]). Currently, only a ''random'' assignment is implemented, but the function can be easily modified.

For logged in users, the assignment will only be made once and remains stable across site visits.

=== Pseudonymization ===
For logging purposes, each user is assigned an anonymized id ([http://en.wikipedia.org/wiki/Pseudonymization psyeudonym]).

It is implemented in <code>WoogleUtil::getAnonUserID()</code> as follows:
* for anonymous users: their hashed IP address
* for logged in users their RandomUserID generated by Woogle or - if this is null - their hashed MediaWiki user name (RandomUserId = <code>md5(rand()</code>)

For logged in users, the pseudonym is stored in the MediaWiki database and will remain consistent unless the user resets it via user preferences. However, the idea si that the connection between user name and pseudonym is not visible for the evaluator - only the Wiki Sysop might make this connection.

=== Informed consent ===
Users can optionally be presented with a customizable information dialog which explains the goal of the study and requires them to explicitly decide on if to participate or not.

[http://en.wikipedia.org/wiki/Informed_consent#Research Informed consent] is only available for logged in users - not for anonymous accounts! It is realized by the [http://www.mediawiki.org/wiki/Manual:Special_pages Special Page] [https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/addons/Instrumentation/WoogleSpecialStudy.php WoogleSpecialStudy].

=== User preferences ===
User may also disable (or re-enable) their participation in [http://www.mediawiki.org/wiki/Preferences Preferences].

=== Logging user activities ===
By "logging targets" we mean user activities that should be logged by the instrumentation addon. In general, it can log arbitrary activities.

The usual workflow is like that:
# Think about user activity which should be logged
# Find a place in the MediaWiki/extension code which is suitable to determine if a user carries out an activity or not
# Add instrumentation logging code (i.e., call InstrumentationLogger; see below)
# Later: analyze logfiles written

Example:
# We want to log successful login activities
# The [http://www.mediawiki.org/wiki/Manual:Hooks/UserLoginComplete UserLoginComplete] seems to be a good place to determine user logins
# We register for this hook and call InstrumentationLogger (actual example [https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/addons/Instrumentation/Instrumentation.php in here]).

Due to their modular nature, [http://www.mediawiki.org/wiki/Manual:Hooks MediaWiki hooks] have turned out as a good choice to add logging code, but the instrumentation addon is not limited to this.

The instrumentation addon comes with a number of pre-defined logging targets (defined in [https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/addons/Instrumentation/Instrumentation.php Instrumentation.php], which can be easily extended:
* User logging in (code: user_login)
* User editing new page (redlink)
* User creating a watch (watch_created)
* User saving an article (article_save)
* User saves/changes preferences (pref_save)
* User receives search result with some results (mwsearch_results)
* User receives search result with no results (mwsearch_noresults)
* Woogle4MediaWiki-specific logging targets
** User executes Woogle search (woogle_search_query)
** User clicks Woogle search result (woogle_result_click)
** Icons displayed to the user on Woogle search results (woogle_search_icons)
** Icons displayed to the user on red links (woogle_redlink_icons)

A logging target should at least log its code (see values above) to allow analysis. Additional parameters may be concatenated to the log string, separated with ";".

The actual logging is implemented in [https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/addons/Instrumentation/WoogleInstrumentationLogger.php WoogleInstrumentationLogger]. In this implementation, the log is text-based ([http://en.wikipedia.org/wiki/Comma-separated_values CSV-formatted]). Each line contains a timestamp, the pseudonymized user id (see above) and an arbitrary string defined by each logging targets itself.

== Data analysis ==
The instrumentation framework does currently not include any automated data analysis. The usual worflow is to import the [http://en.wikipedia.org/wiki/Comma-separated_values CSV-formatted] log files to statistical analysis tools such as [http://en.wikipedia.org/wiki/R_%28programming_language%29 R], [http://en.wikipedia.org/wiki/Spss SPSS] or any spreadsheet calculator.

== Installation ==
The code for the instrumentation addon can be obtained from SVN (https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/addons/Instrumentation/).

Instrumentation mode can be enabled by setting <code>$config['instrumentation']</code> in <code>extensions\Woogle\addons\Instrumentation\Instrumentation.php</code> to "true".

Per default, only user logging in with an own account are targeted by the instrumentation. Setting <code>instrumentationAnon</code> true will also log anonymous users.

Woogle4MediaWiki

2011-08-05T09:14:18Z

Happel:

Woogle4MediaWiki comes as an Extension '''replacing MediaWiki's build in search''' (test it in this Wiki!). There is a native PHP implementation for searching the Wiki only ('''WoogleNative''') and an implementation for searching various source via an [[Integrated Search]] backend from within your MediaWiki ('''WoogleRemote''').

For additional information, you might want to see these [http://www.slideshare.net/hhappel/woogle-on-why-and-how-to-marry-wikis-with-enterprise-search presentation slides]. There is also a description of Woogle in the [http://www.mediawiki.org/wiki/Extension:Woogle4MediaWiki mediawiki.org extension directory].

== Online Demo ==
The whole TeamWeaver site (i.e. the search in this Wiki) is running Woogle and allows you to search this Wiki, our SVN and JIRA. For testing the Woogle interface, either use the Search box on top of this page, or go to [[Special:Woogle]]. You can access the same data with the [[Integrated Search]] standard Web frontend online demo.

We have also set up a separate Woogle demo wiki which is rebuildt every night and thus allows you to experiment with it. You can access it at: http://amazonas.fzi.de/wooglenative/

== Download ==
Woogle4MediaWiki is now available for download under GPL license in version 1.0.0 (RC2). We consider the basic functionality rather stable and capable to serve productive systems. Woogle has been successfully tested recently with MediaWiki versions 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248). Prior in development, Woogle was running fine with MW 1.11 and beyond. For details see our [http://www.teamweaver.org/wiki/index.php/Woogle4MediaWiki/Compability compability notes].

Download links:
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Native_v1.0.0-RC2.zip WoogleNative] (searches MediaWiki only)
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Remote_v1.0.0-RC2.zip WoogleRemote] (can search additional data sources; requires [[Integrated Search]])
* You can also directly check out the recent state of both versions from our SVN (see "Source code" below)
* see also [[Woogle4MediaWiki/Release Notes]]

You may want to subscribe the [[Mailinglists|announcement mailinglist]] to learn about future versions.

Note that Woogle is Open Source software developed in a research environment. We are thus constantly '''seeking interested organizations using MediaWiki''' who would like to [[Contact|collaborate with us]] evaluating Woogle and related extensions in their environment.

== Documentation ==
* [[Woogle4MediaWiki/Decider manual]] - for people considering to use Woogle
* [[Woogle4MediaWiki/Admin manual]] - for administrators installing and configuring Woogle
* [[Woogle4MediaWiki/User manual]] - for end users of Woogle
* [[Woogle4MediaWiki/Developer manual]] - for developers contributing to or extending Woogle

== Source code ==
The Woogle source code can be obtained from https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/ (user/pass: "anonymous"). To check out the recent development version from SVN execute this at your command line:
<pre>svn co https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/ --username anonymous --password anonymous</pre>

You can safely delete the content of <code>Woogle4MediaWiki/addons/Instrumentation</code> and '''one of''' <code>Woogle4MediaWiki/addons/Native</code> or <code>Woogle4MediaWiki/addons/Remote</code> (depending on if you prefer WoogleNative or WoogleRemote).

Woogle4MediaWiki/Admin manual

2011-08-05T08:40:27Z

Happel: /* Installation steps */

Sandbox

2011-04-28T15:53:05Z

Happel:

[[Sandkasten]]

noch ein Sandkasten

noch mehr sand

c

Semantic Need

2010-09-18T09:56:33Z

Happel: Created page with 'see http://www.mediawiki.org/wiki/Extension:Semantic_Need for the moment...'

see http://www.mediawiki.org/wiki/Extension:Semantic_Need for the moment...

Talk:Woogle4MediaWiki/Feedback

2010-09-13T16:11:02Z

Happel:

==Failure to initialise on MediaWiki 1.16.0==

===Environment===
*MediaWiki 1.16.0
*PHP 5.2.9-1 (apache2handler)
*MySQL 5.1.32-community

===Description===
After upgrading from MediaWiki 1.15.4 to 1.16.0 the following error is received on all pages:

Fatal error: Call to a member function getDBKey() on a non-object in
C:\WebSite\htdocs\Wiki\extensions\Woogle\includes\WoogleHooks.php on line 278

Failed with Woogle 1.0.0-RC2, updated from SVN to 3988 but still got the same issue.

-- [[User:Jbattersby|Jbattersby]] 16:25, 5 August 2010 (UTC)
:I have found the problem. My Wiki had $wgLanguageCode = "en-gb"; in its LocalSettings.php. Changing this to "en" fixed the problem.
:-- [[User:Jbattersby|Jbattersby]] 06:47, 6 August 2010 (UTC)
:: Thanks for pointing that out. The problem seems to occur for all languages which are not shipped yet with Woogle. The bug is now filed under http://octopus13.fzi.de:8080/browse/WOO-454
::-- --[[User:Happel|Happel]] 15:54, 9 August 2010 (UTC)
:::Changing line 28 in a language-file in extensions/woogle/languages/ to the actually used language-code resolves this issue. For example, in my case, my Wiki uses language "de-formal" (configured in LocalSettings.php), so I changed line 28 in the german woogle-language-pack from <code>return 'de';</code> to <code>return 'de-formal';</code>
:::Maybe it would help to define a default (fallback) language to load, when the appropriate language-file is not found.
:::[[User:Modmatt|Modmatt]] 14:23, 2 September 2010 (UTC)
:::: http://octopus13.fzi.de:8080/browse/WOO-454 is now fixed. A new release 1.0-RC3 will soon be available; until then you might use the code from SVN HEAD
:::: --[[User:Happel|Happel]] 16:11, 13 September 2010 (UTC)

Woogle4MediaWiki/Compability

2010-08-10T09:11:58Z

Happel: /* Compability with MediaWiki */

== Compability with MediaWiki ==
Due to required [http://www.mediawiki.org/wiki/Manual:Hooks Hooks], Woogle4MediaWiki requires [http://www.mediawiki.org/ MediaWiki] in a version >= 1.11.0. It should be theoretically possible to make (parts of) Woogle compatible with earlier versions of MediaWiki by modifying the sources.

Woogle is currently tested up to MediaWiki version 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248) (which are the recent version as of 2010-04-27). There is no fundamental reason, why it should not work with future versions of MediaWiki, although we can not gurantee that.

Other explicit version were are/were developing/testing with (incomplete list):
* MediaWiki 1.11.0
* MediaWiki 1.13.3
* MediaWiki 1.14.0
* MediaWiki 1.15.0

'''Note''': for Woogle 1.0.0 (RC2) there are smaller issues when using the recently released MediaWiki 1.16.0 with a language code different than "en" or "de". This, as well as some incompatiblities with older Browsers (IE7, Opera <9.5) will be fixed soon (c.f. http://octopus13.fzi.de:8080/browse/WOO-454).

== Compability with Web servers/PHP/mySQL ==
Woogle should work fine in any server environment in which the embedding MediaWiki works. In particular, we are using the following environments (incomplete list):
* CentOS Linux machine (Apache / PHP: 5.1.6 (apache2handler) / MySQL: 5.0.45)
* Windows 2000 Server (Apache / PHP 5.2.6 (apache2handler) / MySQL 5.0.45-community-nt)
* Windows Vista (ApacheFriends XAMPP version 1.7.0 / PHP 5.2.8 (apache2handler) / mySQL 5.1.30-community)

== Compatibility with Web browsers ==
Woogle core features have been successfully tested with:
* Firefox (3.6)
* Internet Explorer (8.0.6001.18904)
* Opera (10.10 Build 1893)
* Chrome (4.1.249.1045 (42898))
* Safari

Talk:Woogle4MediaWiki/Feedback

2010-08-09T15:54:44Z

Happel: /* Description */

Woogle4MediaWiki/Admin manual

2010-07-14T12:44:49Z

Happel: /* Specific settings for WoogleRemote */

== Installation ==
Before starting, it is important to understand that Woogle4MediaWiki can be run in '''two different modes''':
* Woogle'''Native''' - which is purely PHP-based - you can only search and index your Wiki as such, but no data outside the Wiki
* Woogle'''Remote''' - which connects to an [[Integrated Search]] backend - you can search any kind of data indexed by the backend (including e.g. file systems, SVN ressources etc.)

If you are in a hurry, there is a less elaborate [[Woogle4MediaWiki/Quick install|quick install guide]] for WoogleNative.

=== Prerequisites ===
* Server
** Woogle4MediaWiki requires [http://www.mediawiki.org/wiki/MediaWiki MediaWiki] in a version >= 1.11.0 (see also [[Woogle4MediaWiki/Compability|compatibility notes]])
** '''Note''': If you are using PHP 5.3.0 and beyond, some [http://us.php.net/manual/en/migration53.incompatible.php compability issues] with older versions of [https://bugzilla.wikimedia.org/show_bug.cgi?id=15854 MediaWiki] (<1.14.1) and [http://octopus13.fzi.de:8080/browse/WOO-288 Woogle] (< 1.0-RC2) will arise. Make sure to work with a recent version.
** For using WoogleNative,
*** we strongly recommend the PCRE and mb_string extensions to be installed in your PHP runtime environment (although not strictly neccessary)
*** you will need a database user with <code>CREATE TABLE</code> privileges (or the database root account)
** For WoogleRemote you need an installed [[Integrated Search]] backend, and some configuration data (backend URL, repoId, pushIndexAuthKey; c.f. [[Integrated_Search/Configuration#Configuring_.22push.22_indexing|for push indexing]]). A network connection from the MediaWiki server to the Integrated Search backend is required.
* Client
** Woogle will most probably work with any browser which is supported by MediaWiki itself (see also [[Woogle4MediaWiki/Compability|compatibility notes]])
** Some advanced features of Woogle (autocomplete, red link popus, result annotation) make use of Ajax and might not work with old browsers. However, the Woogle core features should not be affected by this.

=== Installation steps ===
* Download the appropriate distribution file. There are distributions for WoogleRemote, WoogleNative and one including both.
* Extract the content of the Woogle distribution ZIP-file to <code>[Your MediaWiki directory]/extensions/Woogle</code>
* Grant write permissions for the executing user on <code>[Your MediaWiki directory]/extensions/Woogle/logs</code> and on <code>[Your MediaWiki directory]/extensions/Woogle/addons/Native/index</code>, if you are using the Native addon
* At the end of the file <code>[Your MediaWiki directory]/LocalSettings.php</code> add the following line: <code>require_once("$IP/extensions/Woogle/Woogle.php");</code>
* Proceed with configuration

== Configuration ==

=== General configuration ===
To configure Woogle, add a statement <code>WoogleConfig::set('parameter', 'value');</code> to LocalSettings.php for each configuration parameter you want to change. These statements have to be '''below''' the inclusion of Woogle.php.

The default values plus description of all parameters can be found in <code>[Your MediaWiki directory]/extensions/Woogle/includes/WoogleConfig.php</code>. Do not modify any values there. Alternatively, you can see all configuration values on the special page <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> (e.g. [[Special:WoogleConfig]]).

Open the file <code>[Your MediaWiki directory]/extensions/Woogle/includes/WoogleConfig.php</code> and scroll down to the <code>WoogleConfig</code> class to configure Woogle. You can call <code>[MediaWiki URL]/Special:WoogleConfig</code> (which requires a WikiSysop user) in your browser to see configured values at runtime.

Example snippet for LocalSettings.php with most important settings:
<pre>
require_once("$IP/extensions/Woogle/Woogle.php");

// Optional Woogle Configuration
//WoogleConfig::set('core', false); // set false to completely dectivate Woogle
//WoogleConfig::set('replace', false); // set false to use MediaWiki built-in search from MediaWiki search box (Woogle is only used when directly called from Special:Woogle then)
//WoogleConfig::set('advanced', false); // set false to disable Woogle:-Namespace and thus enable Special:Woogle only
//WoogleConfig::set('redLinkInfo', false); // set false to disable JavaScript popups for red links
//WoogleConfig::set('limitAccessToGroups', true); // set true to restrict Woogle usage to groups defined in $groups below
//WoogleConfig::set('groups', array('sysop')); // groups access is limited to if $limitAccessToGroups
//WoogleConfig::set('clickTracking', false); // set false to avoid tracking of user's result clicks (for statistical purposes)
</pre>

Woogle creates additional MediaWiki [http://www.mediawiki.org/wiki/Manual:$wgExtraNamespaces namespaces]. If you are using other MediaWiki extensions which define namespaces (such as Semantic MediaWiki), you have to set a starting index of free namespaces Ids for Woogle by setting <code>$wooNamespaceIndex = 110</code>. The implicit default value is 100.

See the documentation for each value on the right side. Typically, there is '''no need to change most of these values'''.

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

=== Specific settings for WoogleRemote ===
Default settings are documented in <code>[Your MediaWiki directory]/extensions/Woogle/addons/Remote.php</code>. As with the general settings, do not edit directly, but add statements to LocalSettings.php

Example snippet for LocalSettings.php with most important settings:
<pre>
require_once("$IP/extensions/Woogle/Woogle.php");

// Woogle Configuration
WoogleConfig::set('remoteBaseServiceUrl', 'http://octopus13.fzi.de:9999/teamweaverIS-backend/services/'); // set the respective backend URL here
WoogleConfig::set('remoteAuthKey', 'secret'); // key for querying, only required if the backend is set to securityEnabled = true;
WoogleConfig::set('indexGroups', array('group1', 'group2'));
WoogleConfig::set('indexRepository', 123); // numeric id for indexing (repoId) - as configured in the backend repo_config.xml
WoogleConfig::set('remotePushIndexAuthKey', 'secret2'); // key for indexing - as configured in the backend repo_config.xml
</pre>

As you can see, some parameters depend on configuration choices related to the [[Integrated Search|integrated search backend configuration]] (see also [[repo_config.xml]]).

=== Final steps ===
* Open MediaWiki and see if the system runs properly (if problems occur - see the [[Woogle4MediaWiki/Admin manual#Dealing_with_problems|"dealing with problems" section]] below!).
* Open <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> in your browser (which requires a WikiSysop user) and check the "status" section on top
** For WoogleNative, click the button "Create database tables". If Woogle tells "You need db root access to create tables", your MediaWiki database user does not seem to have <code>CREATE TABLE</code> privileges (see prerequisites). You may either grant these rights via the database interface, or do the "Database adminstration via script" (see Additional topics section below)
** If everything looks fine on the "status" section, you are ready to create the search index for the existing pages (afterwards, all page changes will update the index automatically)
*** Select "(Re-)Create Index (Direct)" to create the index immediately, within one HTTP session. For large Wikis, this will block your browser and probably even result in a script timeout (depending on your server configuration)
*** Thus you may '''alternatively''' select "(Re-)Create Index (Jobs)", which will create tasks in your MediaWiki job queue for indexing each page. The job queue usually (depending on your MediaWiki configuration) processes a handful jobs with each user request. Thus, for a large Wiki, it will take considerable time until all indexing jobs have been processed. If your Wiki has low traffic, it might even take longer. You can alread search during this process, but you might not receive full results. See "Run indexing jobs" under "Additional topcis" on how to do batch indexing.
*** For '''larger wikis''' (> 500 pages) we '''strongly recommend''' to used the command line script <code>php extensions/Woogle/maintenance/WoogleReIndexAll.php [options...]</code> for index creation! ([[Woogle4MediaWiki/Admin manual#Indexing_via_script|see below for details]])
* Enter <code>[MediaWiki URL]/index.php/Special:Woogle</code> to your browser to check if everything works

== Uninstalling Woogle ==
* Note that Woogle can be disabled by any user individually via his/her MediaWiki user preferences (Special:Preferences).
* Woogle can be deactivated by adding <code>WoogleConfig::set('core', false);</code> or by commenting out all Woogle statements in LocalSettings.php. This will do no harm - the MediaWiki system will immediately fall back to the built-in search.
* If you want to physically remove Woogle, do the following:
** For WoogleNative, visit <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> (which requires a WikiSysop user) and click the button "Remove database tables". If you do not have sufficenit permissions to do so, try the "Database adminstration via script" (see Additional topics section below)
** Comment out or remove all Woogle statements in LocalSettings.php
** Remove Woogle directory from <code>[Your MediaWiki directory]/extensions/</code>

== Additional topcis ==

=== Dealing with problems ===
If problems occur, you might first see [[Woogle4MediaWiki/FAQ#Administrator_questions|the FAQ]].

If you see a blank page after enabling Woogle, adding the following code to your <code>LocalSettings.php</code> might help to track down the problem:
<pre>
# Error reporting (only useful for debugging)
error_reporting( E_ALL );
ini_set( 'display_errors', 1 );
$wgShowExceptionDetails = true;
$wgShowSQLErrors = true;
</pre>

=== Database administration via script ===
If your MediaWiki database user does not have sufficient privileges to add/delete tables, you have to use the command line script instead of conveniently using the buttons at Special:WoogleConfig.

Therefore, you need to configure a database user with suitable privileges in the file <code>AdminSettings.php</code> in the root of your MediaWiki directory (c.f. [http://www.mediawiki.org/wiki/Manual:Maintenance_scripts] resp. [http://www.mediawiki.org/wiki/Manual:AdminSettings.php]).

Afterwards, you may call <code>php extensions/Woogle/addons/Native/maintenance/WoogleNativeDb_setup.php [options...]</code>, whereas options are:
* <code>--user <dbuser></code> Database user account to use for changing DB layout. If not set, the credentials in AdminSettings.php are used.
* <code>--password <dbpassword></code> Password for user account to use. (Instead of custom password.)
* <code>--delete</code> Delete Woogle database tables. If not selected, this script tries to create them.

=== Indexing via script ===
Especially for larger Wikis, it makes sense to run indexing tasks from the command line instead of the web browser. There are two scripts, that can support you with this task:
* <code>php extensions/Woogle/maintenance/WoogleReIndexAll.php [options...]</code> is our recommended approach, since it will rebuild the index without any further prerequisites. The following options can be set:
** <code>-f</code> to force indexing without 10 sec waiting delay
** <code>--server=http://www.mywikihost.org</code> - server name (e.g. http://www.mywikihost.org) - without trailing slashes - to avoid that Woogle stores Wiki page URLs with <code>http://localhost</code> in the index. Alternatively set $wgServer explicitly in LocalSettings.php (c.f. [http://www.mediawiki.org/wiki/Manual:LocalSettings.php#Server_name]).
** <code>--conf=../../../LocalSettings2.php</code> - this is only necessary, but particularly useful, if you would like to create an index without touching the productive Wiki system (which is configured in LocalSettings.php). You may just make a copy of LocalSettings.php and only include Woogle in this configuration.
* If you chose to "index as jobs" in <code>Special:WoogleConfig</code>, Woogle will add small indexing jobs (one job for each Wiki page) to the MediaWiki job system. In a large Wiki, this might produce a huge job queue which takes a while to fill the index, since in MediaWiki, a small fraction of jobs is processed with every user request. However, MediaWiki provides a script <code>/maintenance/runJobs.php</code> to process the job queue from the command line. Follow the [http://www.mediawiki.org/wiki/Manual:Job_queue MediaWiki manual] concerning this option.

=== Modify or translate UI text ===
Woogle user interface text is modularized to language files located in <code>/extensions/Woogle/languages/</code>. Edit these files to adapt texts. To create translations for other languages, copy an existing file (probably WoogleLangEnglish.php) and translate the content. Please contribute such translations back to us!

=== Modify the user interface ===
Woogle UI can be configured using several configuration parameters, which are documented in <code>WoogleConfig.php</code>.

Besides that, many visual aspects of Woogle are captured in CSS files which you may customize.

=== Instrumentation addon ===
Woogle provides an addon for scientific evaluation (called "instrumentation") which captures user activities in a log file. Also, the extension allows to modify certain Woogle (UI) settings for different groups of users and provides a confirmation screen that allows to gain user's explicit consent for logging data.

Instrumentation mode can be enabled by setting <code>$config['instrumentation']</code> in <code>extensions\Woogle\addons\Instrumentation\Instrumentation.php</code> to "true". Further settings can be changed there as well.

Integrated Search/Configuration

2010-06-25T15:23:36Z

Happel: /* Configure data sources */

== Server Backend ==
The backend needs some basic configuration to configure data sources that should be crawled.

=== Configure data sources ===
* For configuration, make sure that the backend's WAR-archive is installed and unpacked in your application server (see [[Integrated Search/Installation]])
* You should then be able to find a directory called <code>\teamweaverIS-backend\WEB-INF\userdata\conf</code>
* In here, you find (among other) two configuration files, which you need to edit:
** <code>repo_config.xml</code> contains access data for the repositories you want to crawl (see [[repo_config.xml]] for details)
** <code>crawl_config.xml</code> helps you to group the repositories into "crawls" (see [[crawl_config.xml]] for details)

=== Crawl data sources ===
* Now that you configured everything, you might want to start your first crawl to fill the index with real that.
* Navigate in the new <code>teamweaverIS-backend</code> folder and execute <code>cc.bat</code> resp. <code>cc.sh</code>. This will generate some scripts required for crawling.
* Execute the crawl shell script (<code>crawl.bat</code> resp. <code>crawl.sh</code> with the Id of the crawl you want to execute (as defined in [[crawl_config.xml]]) - e.g. "<code>crawl 0</code>"
** Note 1: Crawling is incremental. So when you start the same crawl later again, it will only update new/changed/deleted files.
** Note 2: TeamWeaver does not provide means for automatically launching crawls. You need to schedule a task on your server machine which executes the crawl regularly (e.g. once a night) to keep the index up-to-date.

=== Configuring "push" indexing ===
Besides having the backend crawling the data sources as described above, the backend also allows data sources to proactively "push" new or changed data to the index. This makes the index more "fresh", but would typically require modifications on the side of the crawled data source. Therefore, "push" indexing is currently only supported for [[Polarion Enterprise|Polarion]] and for [[Woogle|MediaWiki]].

Push-indexing needs to be configured in the backend as well as in the data source system. In the backend, you need to enabled pushIndexing, define an Id and provide a <code>pushIndexAuthKey</code> (see [[repo_config.xml]]).

For configuring the data source system, you need the following information:
* the backend URL (e.g. <code>http://localhost:8080/teamweaverIS-backend/services/</code>)
* the repositoryId and
* the <code>pushIndexAuthKey</code> as defined in the backend

The actual way of configuration should be described in the documentation. See e.g. [[Woogle4MediaWiki/Configuration]].

Team

2010-05-18T16:08:45Z

Happel:

This page describes the team behind TeamWeaver

== Founders & Architects ==
[http://www.fzi.de/staff/happel Hans-Jörg Happel] is a researcher at the FZI Research Center for Information Technologies at the University of Karlsruhe (TH). He is involved in several projects dealing with knowledge management in engineering domains, esp. software engineering. Hans-Jörg has an interdisciplinary background in Information Systems, Software Engineering and Organizational Theory. His research interests are in the intersection of software engineering, knowledge management, information retrieval, social software and semantic technologies. Hans-Jörg served as a reviewer, organizer and moderator for several scientific and industry related events in these areas.

[http://romberg.be Tim Romberg] was among the initiators of the WAVES research project at FZI, part of the German Science Ministry's "Software Engineering 2006" initiative. He is currently an independent consultant on Enterprise 2.0 solutions and living in Brussels. Ask Tim if you are interested in [[Wiquila]], a Rich Wiki Client, or about integrating structured Enterprise Data with Wikis or the "emergent" structures of the Social Web.

[http://www1.in.tum.de/walidMaalej Walid Maalej] is a senior researcher at TUM. His interests include social software engineering, agile development, context-aware engineering infrastructures and ontology-based knowledge management. In the EU-funded project TEAM, he was leading the knowledge contextualization and personalization team. Walid successfully co-organized several scientific and industrial workshops and conferences on software engineering, knowledge management, integration and traceability and agile methods.

== Contributors ==
* Paul Hübner is working on TeamWeaver and related projects since 2007. He is the major developer of the [[Integrated Search]] backend and our [[Maven]] and [[OSGi]] expert. He holds a degree in computer science from the Karlsruhe University of Appliend Science. Currently he is working towards his master degree at the University of Ulm.
* Ben Romberg was working on the TeamWeaver project from 2007-2009. He is the major developer of the [[Integrated Search]] frontend, and a major developer of the [[Integrated Search]] backend and [[Woogle4MediaWiki]]. Ben working towards his computer science degree at the Karlsruhe University of Applied Science.
* Christian Röhr is supporting the Woogle4MediaWiki development since 2009 and especially concerned with performance testing, quality issues, documentation and all those little things that make a project run smootly. He recently graduated in physics at the Karlsruhe Institute of Technology.
* Sören Schlegel is working on Woogle4MediaWiki since 2009 with a focus on Ajax-based user interaction using [[jQuery]]. Sören working towards his computer science degree at the Karlsruhe University of Applied Science.

Woogle4MediaWiki/SMW integration

2010-05-07T21:33:27Z

Happel: Created page with 'This page is for capturing status and ideas of more tightly integrating Woogle4MediaWiki and Semantic MediaWiki tbd... for the moment, find some ideas at http://www.te…'

This page is for capturing status and ideas of more tightly integrating [[Woogle4MediaWiki]] and [[Semantic MediaWiki]]

tbd...

for the moment, find some ideas at http://www.teamweaver.org/wiki/index.php/Woogle4MediaWiki/Roadmap#Semantic_MediaWiki_integration

== See also ==
* [http://semanticweb.org/wiki/Special:ATWSpecialSearch AskTheWiki] (ATW) by Daniel Herzig
* [http://smwforum.ontoprise.com/smwforum/index.php/Features/Discover_and_process_knowledge SMW+ Extensions] from Ontoprise

Woogle4MediaWiki/Roadmap

2010-05-07T21:29:36Z

Happel: /* Semantic MediaWiki integration */

This is the end user oriented roadmap for Woogle4MediaWiki. There is a also a [[Woogle4MediaWiki/Roadmap (development)|version for developers]] with more detailed information.

This page summarizes major plans in mostly non-technical terms. Your [[Woogle4MediaWiki/Feedback|input and feedback]] is appreciated!

Note that this page might neither be complete nor binding. If you desparately want some feature, we might also offer [[support]].

== Planned improvements ==

=== Bug fixes ===
* Fix problems with Wikis using index.php?param - style URLs [http://octopus13.fzi.de:8080/browse/HTA-9]

=== Dealing with attachments (mostly in WoogleNative) ===
Woogle currently does support basic indexing for images and PDF files. However there are some small limitations (currently, file updates/deletes will not be monitored) and some other problems. We plan to
* extract a higher percentage of PDF files
* provide users with an overview/testing feature if their PDF can be extracted
* support more attachment types (documents, spreadsheets, presentations)

This applies mostly to WoogleNative, while it might also be beneficial for WoogleRemote (for which workarounds to the problems described exist however).

== Planned features ==

=== Dealing with redirects and synonyms ===
Currently, [http://www.mediawiki.org/wiki/Redirect redirect-Pages] are listed as separate search results. In the future, they should be shown in the context of the actual page redirected to and thus also used for searching.

=== Semantic MediaWiki integration ===
[[Semantic MediaWiki]] (SMW) is probably the most powerful extension for MediaWiki. It allows to store and query structured data in MediaWiki. There are various avenues for integrating SMW and Woogle
* leveraging semantic data for result display ("structured result snippets")
* levaraging semantic data for search (see also "dealing with redirects and synonyms")
* applying the Woogle principles to SMW
* ...

See also [[Woogle4MediaWiki/SMW integration]]

=== Social search/'''Result annotation''' ===
Wikis are collaborative - but their search feature is typically not. We want to allow users to add/re-rank or remove search results for a given query. See also [[Woogle4MediaWiki/Woogle Result Annotation Feature]]

=== Content request ===
Wiki users currently can express their information needs/desired content explicitly (e.g. by [[red links]]) or implicitly (e.g. by searching). We want to add more explicit means of requesting new content or improvements of existing content. See also [[Woogle4MediaWiki/Woogle Request Feature]]

=== Creating redirects from red links ===
We observed that many "[[red links]]" are due to misspellings or abbreviations and can thus be resolved by a simple [http://www.mediawiki.org/wiki/Redirect MediaWiki redirect]. We will extend our current red link popups in this way and plan to create a special page for resolving red links to redirects.

Main Page

2010-05-06T17:44:04Z

Happel: Reverted edits by Veronica06 (Talk) to last revision by Maalej

<big>'''Welcome to the TeamWeaver Web!'''</big>

In their daily work, software engineers need efficient support for accessing project information and sharing personal experiences. TeamWeaver is an Open Source framework, which embeds lightweight and efficient knowledge access and sharing into the working context of a developer – accessible via the Web, Wikis and the Eclipse IDE.

Core features of TeamWeaver are Information access (search and assistance), need-driven knowledge sharing, automatic creating of context knowledge by user observation, lightweight "wiki-style" authoring and metadata storage with semantic technologies.

== [[News and Events]] ==
* 2010-04-30 Meet us at [http://www.sbs.co.za/ICSE2010/ ICSE] in Cape Town, South Africa, where we are going to present our newest research results and released features. At [http://msr.uwaterloo.ca/msr2010/index.html MRS 2010] we will give a talk on "Can Development Work Describe itself" (May 3rd 16:15). At [http://sites.google.com/site/rsseresearch/rsse2010/program RSSE 2010 ] we will demonstrate Switch our Mac OS X tool for "assisting engineers in switching artifacts by using task semantics and interaction history" (May 4th 16:00).
* 2010-02-24 Meet us at the [http://www1.in.tum.de/static/sse10/ Workshop on Social Software Engineering] (which we co-organize) at the [http://www.se2010.upb.de/ Annual German Software Engineering conference] in Paderborn, Germany
* 2010-02-07 Woogle is presented at the [http://workshops.fxpal.com/cscw2010cis/ 2nd International Workshop on Collaborative Information Seeking] collocated with [http://www.cscw2010.org CSCW2010] in Savannah, GA
* 2009-10-29 [[Woogle|Woogle4MediaWiki]] will be released for download soon. There is a new announcement [[Mailinglists|mailingllist]] you can subscribe to.
* 2009-19-28 Have a look at the TeamWeaver poster at the Poster Reception on the [http://www.eclipsecon.org/summiteurope2009/ Eclipse Summit] in Ludwigsburg, Germany
* 2009-10-26 Woogle is presented at the [http://www.wikisym.org/ International Symposium on Wikis and Open Collaboration] in Orlando ([http://www.slideshare.net/hhappel/social-search-and-needdriven-knowledge-sharing-in-wikis-with-woogle slides])
* 2009-07-09 Meet us at the [http://www.wikisym.org/ International Symposium on Wikis and Open Collaboration] at the end of October in Orlando. A paper about [[Woogle]] is nominated for the Best Paper Award!
* 2009-06-18 [http://www.teamweaver.org/downloads/media/slides/2009-06-18-AtlassianUserConference-Duesseldorf-RombergHappel-3c.pdf TeamWeaver presented] at the [http://www.pixsoftware.de/UserGroupMeetings/atlassian-userconference-duesseldorf.html 1st Atlassian User Conference] in Düsseldorf, organized by Pix Software GmbH ([http://www.slideshare.net/hhappel/2009-06-18-atlassian-user-conference-duesseldorf-romberg-happel-mit-wiquila-screenshots slides], [http://www.pixsoftware.de/images/stories/movies/AUGMeetingDuesseldorf09/UGMDue-FZI.mov video])
* 2009-06-03 At least 3 TeamWeaver developers will take part at the [http://wiki.eclipse.org/Eclipse_DemoCamps_Galileo_2009/Munich Eclipse Galileo DemoCamp in Munich]
* 2009-05-18 A scientific study, which lays the work description feature (under development) was presented at the IEEE Inter. Conference on Mining Software repositories in Vancouver [http://msr.uwaterloo.ca/msr2009/msr09-schedule.pdf]
* 2009-03-26 The [[Woogle]] interface for TeamWeaver was presented at the 5th Conference on Professional Knowledge Management in Switzerland ([http://www.slideshare.net/hhappel/woogle-on-why-and-how-to-marry-wikis-with-enterprise-search slides])
* See [[News and Events|all news]]

== Downloads ==
* We are currently offering three pre-bundled packages of software to try out:
** TeamWeaver [[Integrated Search]] - providing a server based search backend with a web-based frontend (Tomcat required for installation)
** TeamWeaver [[Wiquila]] - Prototype of our Swing-based Wiki Rich Client
** TeamWeaver [[Eureka]] Plugin for Eclipse (via Eclipse Update)

== Communication ==
You may want to subscribe to one of our TeamWeaver [[Mailinglists]].

== Source code ==
* TeamWeaver source code is kindly hosted by [http://www.polarion.com Polarion Software] at http://community.polarion.org
* Currently, you can check out TeamWeaver [[Wiquila]] and TeamWeaver [[Integrated Search]]. Further code will be moved there within the next weeks

== Aknowledgements ==
TeamWeaver development is funded by the European Commission within the project "[http://www.team-project.eu/ TEAM]" (IST 35111), the German Federal Ministry of Education and Research within the project "[http://waves.fzi.de Waves]" and the Landesstiftung Baden-Württemberg Foundation within the project "[http://www.globalise-projekt.de GlobaliSE]".

Partners contributing to TeamWeaver involve [http://www.fzi.de FZI Karlsruhe], [http://wwwbruegge.informatik.tu-muenchen.de/ Technische Universität München], [http://www.iccs.gr ICCS Greece] and [http://www.epfl.ch EPFL Lausanne].

We kindly thank [http://www.polarion.com Polarion Software] for offering us support and hosting.

== Contact ==
If you are interested to use or contribute to TeamWeaver please send us an email at
[[File:Email.png]]

This page is hosted by [http://www.fzi.de/eng/contactform.html FZI Research Center for Information Technologies, Karlsruhe, Germany]. Contact for inquiries: Hans-Joerg Happel (lastname@fzi.de).

__NOTOC__

Team

2010-05-05T17:08:59Z

Happel: Created page with 'This page describes the team behind TeamWeaver == Founders & Architects == [http://www.fzi.de/staff/happel Hans-Jörg Happel] is a researcher at the FZI Research Center for Info…'

MediaWiki:Sidebar

2010-05-05T17:08:07Z

Happel:

Contact

2010-05-05T17:07:37Z

Happel:

teamweaver.org is maintained by FZI Forschungszentrum Informatik an der Universität Karlsruhe (TH) in Germany (General contact data: http://www.fzi.de/eng/contactform.html).

For specific inquiries please contact [http://www.fzi.de/staff/happel Hans-Joerg Happel] or [http://www1.in.tum.de/static/lehrstuhl/people/98-walid-maalej Walid Maalej] or send us an email at
[[File:Email.png]]

See also our [[team]] papge for more information on the people behind TeamWeaver.

Woogle4MediaWiki

2010-04-29T12:02:34Z

Happel: /* Source code */

Woogle4MediaWiki comes as an Extension '''replacing MediaWiki's build in search''' (test it in this Wiki!). There is a native PHP implementation for searching the Wiki only ('''WoogleNative''') and an implementation for searching various source via an [[Integrated Search]] backend from within your MediaWiki ('''WoogleRemote''').

For additional information, you might want to see these [http://www.slideshare.net/hhappel/woogle-on-why-and-how-to-marry-wikis-with-enterprise-search presentation slides]. There is also a description of Woogle in the [http://www.mediawiki.org/wiki/Extension:Woogle4MediaWiki mediawiki.org extension directory].

== Online Demo ==
The whole TeamWeaver site (i.e. the search in this Wiki) is running Woogle and allows you to search this Wiki, our SVN and JIRA. For testing the Woogle interface, either use the Search box on top of this page, or go to [[Special:Woogle]]. You can access the same data with the [[Integrated Search]] standard Web frontend online demo.

We have also set up a separate Woogle demo wiki which is rebuildt every night and thus allows you to experiment with it. You can access it at: http://amazonas.fzi.de/wooglenative/

== Download ==
Woogle4MediaWiki is now available for download under GPL license in version 1.0.0 (RC2). We consider the basic functionality rather stable and capable to serve productive systems. Woogle has been successfully tested recently with MediaWiki versions 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248). Prior in development, Woogle was running fine with MW 1.11 and beyond. For details see our [http://www.teamweaver.org/wiki/index.php/Woogle4MediaWiki/Compability compability notes].

Download links:
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Native_v1.0.0-RC2.zip WoogleNative] (searches MediaWiki only)
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Remote_v1.0.0-RC2.zip WoogleRemote] (can search additional data sources; requires [[Integrated Search]])
* see also [[Woogle4MediaWiki/Release Notes]]

You may want to subscribe the [[Mailinglists|announcement mailinglist]] to learn about future versions.

Note that Woogle is Open Source software developed in a research environment. We are thus constantly '''seeking interested organizations using MediaWiki''' who would like to [[Contact|collaborate with us]] evaluating Woogle and related extensions in their environment.

== Documentation ==
* [[Woogle4MediaWiki/Decider manual]] - for people considering to use Woogle
* [[Woogle4MediaWiki/Admin manual]] - for administrators installing and configuring Woogle
* [[Woogle4MediaWiki/User manual]] - for end users of Woogle
* [[Woogle4MediaWiki/Developer manual]] - for developers contributing to or extending Woogle

== Source code ==
The Woogle source code can be obtained from https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/ (user/pass: "anonymous"). To check out the recent development version from SVN execute this at your command line:
<pre>svn co https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/ --username anonymous --password anonymous</pre>

Woogle4MediaWiki/Feedback

2010-04-29T08:07:29Z

Happel: /* Please provide us with some context information about your system setup */

The Woogle team appreciates feedback that helps to improve Woogle and guide its future development. This page conveys some information to make the feedback process more enjoyable for you as a user and for us developers.

== How to send us your suggestions and error reports ==
We would like you to use our end-user issue tracking system, running at http://octopus13.fzi.de:8080/browse/WMW. Do not worry, when using this simple form-based interface, submitting feedback is just as simple as sending an E-Mail.

However, if you actually prefere sending as an E-Mail, please feel free to do so via [[File:Email.png]]. Alternatively, you may consider using the discussion tab of this Wiki page (you will need to create an account for this Wiki before).

== How to best report problems and errors ==
Before sending us your problem, make sure you checked the [[Woogle4MediaWiki/Admin manual|admin manual]] and the [[Woogle4MediaWiki/FAQ|FAQ]] (and probably even our development issue tracker), if the problem has been reported/recognized before.

If you want to help us unterstand and fix your errors, you can follow some simple guidelines (also see the instructions at [[Integrated Search/Feedback]] if you run WoogleRemote with an Integrated Search backend, and think your problem is related to that):

=== Please describe as precisely as possible ===
* The exact action you were pursuing before the problem occured
* The behaviour you would have expected from the system
* The (problematic) behaviour that actually occured
* If feasible, provide some screenshots the problem (if your are using Firefox, there is a [http://pearlcrescent.com/products/pagesaver/ nice plugin])

=== Please provide us with some context information about your system setup ===
* Operating System, PHP Version, MediaWiki version, Woogle version
* Most of this information is contained in the following files/screenshots, that might be helpful for us to investigate your case:
** A screen copy or HTML dump of the Special:WoogleConfig page in your Wiki
** A screen copy or HTML dump of the Special:Version page in your Wiki
** A copy of your MediaWiki LocalSettings.php file
** A zip file containing the log files located in \MediaWiki\extensions\Woogle\logs
* To find out details about your PHP environment (installed modules etc.) the easiest way is to create and subsequently open a file <code>info.php</code> in your webserver root directory with the following content:
<pre>
<?php
phpinfo();
?>
</pre>

__NOTOC__

Integrated Search

2010-04-29T08:04:09Z

Happel:

TeamWeaver Integrated Search provides an integrated crawling and search mechanism across multiple software-engineering related data such as repositories (SVN, CVS, SourceSafe, Filesystems) filetypes (Code, Office-Documents, PDF) and various systems (e.g. JIRA, Bugzilla, OTRS, Confluence, MediaWiki, XPlanner) (See also the [[Integrated Search/Supported data sources|complete list of supported data sources]]).

TeamWeaver Integrated Search can be accessed via a web-frontend, embedded into a MediaWiki instance, from within Eclipse, from a dedicated Mac application or from any other tools using our backend API.

== Online Demo ==
An online demo can be accessed at http://octopus18.fzi.de:8080/teamweaverIS/

The demo allows you to search within TeamWeaver project data (i.e. this Wiki, JIRA and SVN). An online demo of an alternative Wiki-Interace to the same index data is available on the [[Woogle]] page.

== Dowload ==
* TeamWeaverIS backend and JSF web frontend version 1.0.0 (RC2) [http://www.teamweaver.org/downloads/binaries/is/teamweaverIS_1.0.0-RC2.zip teamweaverIS_1.0.0-RC2.zip] (as of 2010-04-26)
* The optional Wiki search UI can be downloaded at [[Woogle4MediaWiki]]
* Older versions are available on the [[Integrated Search/Download|download page]].

You may want to subscribe the [[Mailinglists|announcement mailinglist]] to learn about future versions.

Note that TeamWeaver tools are Open Source software developed in a research environment. We are thus constantly '''seeking interested organizations''' (esp. in the Software Engineering domain) who would like to [[Contact|collaborate with us]] evaluating TeamWeaver and related tools and methods in their environment.

== Documentation ==
* [[Integrated Search/Decider manual]] - for people considering to use Integrated Search
* [[Integrated Search/Admin manual]] - for administrators installing and configuring Integrated Search
* [[Integrated Search/User manual]] - for end users of Integrated Search
* [[Integrated Search/Developer manual]] - for developers contributing to or extending Integrated Search
* [[Integrated Search/FAQ]]

== Source code ==
* In order to create your own build of the TeamWeaver sources you need to install the [[Maven]] build system on your machine and to checkout the following two projects
** http://svn.polarion.org/repos/community/Teamweaver/Teamweaver/trunk/org.teamweaver.dist.is.backend.war/
** http://svn.polarion.org/repos/community/Teamweaver/Teamweaver/trunk/org.teamweaver.is.frontend.eclipse/ (for the Eclipse client)
* Run "mvn install" in both directories after checkout, to generate the build artifacts in the \target folder

Woogle4MediaWiki

2010-04-29T08:03:50Z

Happel:

Woogle4MediaWiki comes as an Extension '''replacing MediaWiki's build in search''' (test it in this Wiki!). There is a native PHP implementation for searching the Wiki only ('''WoogleNative''') and an implementation for searching various source via an [[Integrated Search]] backend from within your MediaWiki ('''WoogleRemote''').

For additional information, you might want to see these [http://www.slideshare.net/hhappel/woogle-on-why-and-how-to-marry-wikis-with-enterprise-search presentation slides]. There is also a description of Woogle in the [http://www.mediawiki.org/wiki/Extension:Woogle4MediaWiki mediawiki.org extension directory].

== Online Demo ==
The whole TeamWeaver site (i.e. the search in this Wiki) is running Woogle and allows you to search this Wiki, our SVN and JIRA. For testing the Woogle interface, either use the Search box on top of this page, or go to [[Special:Woogle]]. You can access the same data with the [[Integrated Search]] standard Web frontend online demo.

We have also set up a separate Woogle demo wiki which is rebuildt every night and thus allows you to experiment with it. You can access it at: http://amazonas.fzi.de/wooglenative/

== Download ==
Woogle4MediaWiki is now available for download under GPL license in version 1.0.0 (RC2). We consider the basic functionality rather stable and capable to serve productive systems. Woogle has been successfully tested recently with MediaWiki versions 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248). Prior in development, Woogle was running fine with MW 1.11 and beyond. For details see our [http://www.teamweaver.org/wiki/index.php/Woogle4MediaWiki/Compability compability notes].

Download links:
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Native_v1.0.0-RC2.zip WoogleNative] (searches MediaWiki only)
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Remote_v1.0.0-RC2.zip WoogleRemote] (can search additional data sources; requires [[Integrated Search]])
* see also [[Woogle4MediaWiki/Release Notes]]

You may want to subscribe the [[Mailinglists|announcement mailinglist]] to learn about future versions.

Note that Woogle is Open Source software developed in a research environment. We are thus constantly '''seeking interested organizations using MediaWiki''' who would like to [[Contact|collaborate with us]] evaluating Woogle and related extensions in their environment.

== Documentation ==
* [[Woogle4MediaWiki/Decider manual]] - for people considering to use Woogle
* [[Woogle4MediaWiki/Admin manual]] - for administrators installing and configuring Woogle
* [[Woogle4MediaWiki/User manual]] - for end users of Woogle
* [[Woogle4MediaWiki/Developer manual]] - for developers contributing to or extending Woogle

== Source code ==
The Woogle source code can be obtained from https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/ (user/pass: "anonymous"). To check out the recent development version from SVN execute this at your command line:
<pre>svn co https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/</pre>

Woogle4MediaWiki/FAQ

2010-04-29T08:03:07Z

Happel:

This page provides a list of frequently asked querstions concerning [[Woogle4MediaWiki]] from the perspective of different roles.

If you have additional questions not yet satisfied here, edit the "talk" discussion page on top of this page, see our [[support]] page, use [[Special:WoogleFeedback]] or [[contact]] us directly.

== Decider questions ==

=== What can Woogle do? Is it suited for my particular problem setting? ===
see [[Woogle4MediaWiki/Decider manual|decider manual]]

=== How does Woogle relate/compare to existing search extensions in MediaWiki? ===
see [[Woogle4MediaWiki/Decider manual|decider manual]]

=== Where can I see a demo site running Woogle? ===
Besides using Woogle for searching [[Special:Woogle|this Wiki which you are currently browsing]], we have set up a dedicated demo system at http://amazonas.fzi.de/wooglenative/ which you can try.

=== Can I search multiple MediaWiki instances with Woogle? ===
Yes, with the WoogleRemote setup, you can search an arbitrary number of MediaWikis and even many more Wiki engines. See [[Woogle4MediaWiki/Decider manual|decider manual]] for details.

=== How much effort/expertise is required to set up Woogle in my environment? ===
see [[Woogle4MediaWiki/Decider manual|decider manual]]

=== How does Woogle perform/which data volumes are supported/which hardware is required? ===
see [[Woogle4MediaWiki/Decider manual|decider manual]]

=== Which languages are supported by Woogle? ===
The Woogle user interface dialogs are currently provided in English and German language. Adding translations for other lannguages is easy and requires to translate approximately 200 short text snippets.

=== Is there commercial support for Woogle4MediaWiki? ===
As a research instution, we currently do not offer explicit commercial support for our tools. However, depending on your problem setting, we might assist you on a project basis or direct you to one of our partner companies which might be able to offer long-term support. [[Contact]] us for further information.

=== Does Woogle have support for Semantic MediaWiki? ===
Not yet, but support is planned for the future. See [[Woogle4MediaWiki/Roadmap]].

== Administrator questions ==

=== How can I crawl/search multiple MediaWiki instance with Woogle? ===
Using WoogleRemote you can search an arbitray number of Wiki instances. Directly supported systems are currently MediaWiki, Confluence, JSPWiki and FosWiki. Any other Wiki can probably be crawled with our generic Web crawler.

=== Problem: Woogle results have a wrong URL prefix ===
If the search results start with a wrong URL (e.g. "http://localhost/index.php/Page" or "http://myhost.mynetwork/index.php/Page") instead of a desired "http://www.mydomain.com/index.php/Page", you probably should explicitly set the <code>$wgServer</code> parameter [http://www.mediawiki.org/wiki/$wgServer] in your MediaWiki <code>LocalSettings.php</code>. Make sure to re-create the Woogle index afterwards.

=== Problem: After installing Woogle, a white/blank page appears when opening the Wiki ===
* increase memory limit
* check webserver log (apache\logs\error.log for Apache)
* error logging

== User questions ==

=== What features does Woogle offer to users? ===
see [[Special:WoogleHelp]] and/or the [[Woogle4MediaWiki/User manual|user manual]]

=== What data does Woogle log about its users? ===
see [[Woogle4MediaWiki/Privacy]]

== Developer questions ==

=== How can I contribute to Woogle4MediaWiki development? ===
We have [[Woogle4MediaWiki/Roadmap|plenty of ideas]] for improving Woogle. If you would like to help us out or work on own ideas, please do not hesitate to [[contact]] us.

Integrated Search/Admin manual

2010-04-29T07:52:14Z

Happel: Created page with 'see * Installation guide * Configuration guide * Install a Patch'

see
* [[Integrated Search/Installation|Installation guide]]
* [[Integrated Search/Configuration|Configuration guide]]
* [[Integrated Search/InstallPatch|Install a Patch]]

Integrated Search/How to write a custom crawler

2010-04-29T07:46:22Z

Happel:

This short guide describes how to write crawlers to make additional data sources available for searching with TeamWeaver [[Integrated Search]].

A list of existing crawlers can be found at: [[Integrated_Search/Supported_data_sources|supported data sources]] resp. [[repo_config.xml]].

Note that for most web-based sources, the generic [[Repo_config.xml#Web_ressources_.28.22web.22.29|web crawler]] can be sufficient for a first shot solution. However, the web crawler does index complete HTML files and might thus result in a lower search quality (e.g. due to indexing navigation menues etc.).

== Pull vs. Push Crawlers ==
There are two general strategies for crawling data sources with TeamWeaverIS:
* "Pull"-Crawlers are implemented/deployed within TeamWeaverIS and allow to crawl/extract data by accessing external sources/system. '''Pull-crawlers are fairly easy to realize''', but have the disadvantage, that the index might not be accurate, since TeamWeaverIS does only learn about data changes when a crawl is executed. Typically, there is a script file to update the TeamWeaverIS index regularly (e.g. every night). Index accuracy thus depends on the frequency of crawls.
* "Push"-Crawlers are implemented on the side of the client system which includes the data to be indexed. They proactively update the index and thus need to have a direct (network) connection to the TeamWeaverIS backend. Accordingly, '''push-crawlers''' are more difficult to implement, but can '''reflect changes in the data more rapidly in the index'''.

== Writing a "Pull"-Crawler ==
At the basic level, creating a pull-crawler requires to implement two Java classes and changing two XML-files - a ''Crawler'' and a ''Processor'' each. Crawlers are classes which access a data source and extract/create single data items. Processors act upon these items to prepare them for feeding into the index.

=== Crawler ===
* You need to create a subclass of [http://aperture.sourceforge.net/doc/javadoc/org/semanticdesktop/aperture/crawler/base/CrawlerBase.html CrawlerBase] which basically means to implement a method <code>crawlObject</code>. See our [http://svn.polarion.org/repos/community/Teamweaver/Teamweaver/trunk/org.teamweaver.is.backend.crawl/src/main/java/org/teamweaver/is/backend/crawl/aperture/crawler/JiraCrawler.java JIRACrawler] for an example.
* Afterwards, register your new crawler in [http://svn.polarion.org/repos/community/Teamweaver/Teamweaver/trunk/org.teamweaver.is.backend.crawl/src/main/java/org/teamweaver/is/backend/crawl/aperture/crawler/defaultCrawlers.xml defaultCrawlers.xml]. You need to define a unique <code><repoType></code> key, which corresponds to the <code><srcType></code> in [[repo_config.xml]].

=== Processor ===
* You need to create a subclass of [http://svn.polarion.org/repos/community/Teamweaver/Teamweaver/trunk/org.teamweaver.is.backend.crawl/src/main/java/org/teamweaver/is/backend/crawl/processor/impl/ProcessorBase.java ProcessorBase]. See our [http://svn.polarion.org/repos/community/Teamweaver/Teamweaver/trunk/org.teamweaver.is.backend.crawl/src/main/java/org/teamweaver/is/backend/crawl/processor/impl/JiraProcessor.java JIRAProcessor] as an example.
* Afterwards, register your new processor in [http://svn.polarion.org/repos/community/Teamweaver/Teamweaver/trunk/org.teamweaver.is.backend.crawl/src/main/java/org/teamweaver/is/backend/crawl/processor/impl/defaults.xml defaults.xml] by wiring it with the corresponding crawler.

=== Advanced topics ===
* tbd. (generic JDBC crawler, Plain index vs. metadata)

== Writing a "Push"-Crawler ==
* tbd.
* Push-Crawlers have to call the TeamWeaver backend's [http://svn.polarion.org/repos/community/Teamweaver/Teamweaver/trunk/org.teamweaver.is.api/src/main/java/org/teamweaver/is/api/IndexService.java IndexService]
* You might want to look at our [[Woogle4MediaWiki]] code for an example implementation of a push-crawler. The particular place to look at is the "WoogleRemote" addon [https://waves1.fzi.de/svn/waves/trunk/Woogle4MediaWiki/addons/Remote/].

FAQs

2010-04-29T07:44:08Z

Happel:

No general frequently asked questions yet. Be the first!

For specific tools see
* [[Woogle4MediaWiki/FAQ]]
* [[Integrated Search/FAQ]]

Integrated Search/FAQ

2010-04-29T07:44:06Z

Happel: Created page with 'This page provides a list of frequently asked querstions concerning TeamWeaver Integrated Search (TeamWeaverIS) from the perspective of different roles. If you have addition…'

This page provides a list of frequently asked querstions concerning TeamWeaver [[Integrated Search]] (TeamWeaverIS) from the perspective of different roles.

If you have additional questions not yet satisfied here, edit the "talk" discussion page on top of this page, see our [[support]] page, use [[Special:WoogleFeedback]] or [[contact]] us directly.

== Decider questions ==

=== What can TeamWeaverIS do? Is it suited for my particular problem setting? ===
see [[Integrated Search/Decider manual|decider manual]]

=== How does TeamWeaverIS relate/compare to other search solutions (e.g. Lucene)? ===
see [[Integrated Search/Decider manual|decider manual]]

=== What user interfaces exist for TeamWeaverIS? ===
The TeamWeaverIS search backend comes with a plain browser-based frontend. Also, MediaWiki can be used as a search frontend if our extension [[Woogle4MediaWiki]] is used (WoogleRemote option). Addtional user interfaces have been implemented for the Eclipse IDE/Eclipse RCP and for Apple Macintosh.

Since the backend exposes its functionality as webservices, this allows you to build your own frontend resp. to integrate TeamWeaverIS in your application.

=== Where can I see a demo site running TeamWeaverIS? ===
The [[Special:Woogle|search in this Wiki]] is accessing a TeamWeaverIS backend via the [[Woogle4MediaWiki]] UI. A demo of the plain browser UI is running at http://octopus18.fzi.de:8080/teamweaverIS/

=== How much effort/expertise is required to set up TeamWeaverIS in my environment? ===
see [[Integrated Search/Decider manual|decider manual]]

=== How does TeamWeaverIS perform/which data volumes are supported/which hardware is required? ===
see [[Integrated Search/Decider manual|decider manual]]

=== Which data sources can be crawled by TeamWeaverIS? ===
see [[Integrated Search/Supported data sources]]

=== Is there commercial support for TeamWeaverIS? ===
As a research instution, we currently do not offer explicit commercial support for our tools. However, depending on your problem setting, we might assist you on a project basis or direct you to one of our partner companies which might be able to offer long-term support. [[Contact]] us for further information.

== Administrator questions ==
tbd.

== User questions ==
tbd.

== Developer questions ==

=== How can I crawl additional data sources not yet supported by TeamWeaverIS? ===
see [[Integrated Search/How to write a custom crawler]]

=== How can I contribute to TeamWeaver development? ===
If you would like to help us improving TeamWeaver or work on own ideas, please do not hesitate to [[contact]] us.

Integrated Search/Supported data sources

2010-04-29T07:42:35Z

Happel:

TeamWeaverIS supports to crawl/index various types of data sources listed on this page. For configuration of the data sources to index with TeamWeaver, see [[repo_config.xml]].

There is also a short guide on [[Integrated Search/How to write a custom crawler|how to write a crawler for additional data sources]].

== Data sources ==

=== General sources ===
* File systems and network shares
* Web ressources (web sites, but also other file formats (see below))
* SVN repositories
* CVS repositories
* Microsoft SourceSafe repositories

=== Specific sources ===
* Various Ticketing systems (Bugzilla, Atlassian JIRA, OTRS)
* Various Wiki systems (Mediawiki, JSPWiki, Atlassian Confluence, FosWiki)
* XPlanner
* E-Mail (IMAP, Microsoft Outlook)
* Cobra Adressmanager
* CAS genesisWorld
* JDBC-accisible databases (allows to easily write own crawlers for data stored in databases)
* tbc.

== File formats ==
* HTML
* Office (DOC, XLS, PPT, Visio)
* PDF
* Text-Files including Source Code
* tbc.

Woogle4MediaWiki/Roadmap

2010-04-28T13:19:02Z

Happel: Created page with 'This is the end user oriented roadmap for Woogle4MediaWiki. There is a also a version for developers with more detailed information. T…'

This is the end user oriented roadmap for Woogle4MediaWiki. There is a also a [[Woogle4MediaWiki/Roadmap (development)|version for developers]] with more detailed information.

This page summarizes major plans in mostly non-technical terms. Your [[Woogle4MediaWiki/Feedback|input and feedback]] is appreciated!

Note that this page might neither be complete nor binding. If you desparately want some feature, we might also offer [[support]].

== Planned improvements ==

=== Bug fixes ===
* Fix problems with Wikis using index.php?param - style URLs [http://octopus13.fzi.de:8080/browse/HTA-9]

=== Dealing with attachments (mostly in WoogleNative) ===
Woogle currently does support basic indexing for images and PDF files. However there are some small limitations (currently, file updates/deletes will not be monitored) and some other problems. We plan to
* extract a higher percentage of PDF files
* provide users with an overview/testing feature if their PDF can be extracted
* support more attachment types (documents, spreadsheets, presentations)

This applies mostly to WoogleNative, while it might also be beneficial for WoogleRemote (for which workarounds to the problems described exist however).

== Planned features ==

=== Dealing with redirects and synonyms ===
Currently, [http://www.mediawiki.org/wiki/Redirect redirect-Pages] are listed as separate search results. In the future, they should be shown in the context of the actual page redirected to and thus also used for searching.

=== Semantic MediaWiki integration ===
[[Semantic MediaWiki]] (SMW) is probably the most powerful extension for MediaWiki. It allows to store and query structured data in MediaWiki. There are various avenues for integrating SMW and Woogle
* leveraging semantic data for result display ("structured result snippets")
* levaraging semantic data for search (see also "dealing with redirects and synonyms")
* applying the Woogle principles to SMW
* ...

=== Social search/'''Result annotation''' ===
Wikis are collaborative - but their search feature is typically not. We want to allow users to add/re-rank or remove search results for a given query. See also [[Woogle4MediaWiki/Woogle Result Annotation Feature]]

=== Content request ===
Wiki users currently can express their information needs/desired content explicitly (e.g. by [[red links]]) or implicitly (e.g. by searching). We want to add more explicit means of requesting new content or improvements of existing content. See also [[Woogle4MediaWiki/Woogle Request Feature]]

=== Creating redirects from red links ===
We observed that many "[[red links]]" are due to misspellings or abbreviations and can thus be resolved by a simple [http://www.mediawiki.org/wiki/Redirect MediaWiki redirect]. We will extend our current red link popups in this way and plan to create a special page for resolving red links to redirects.

Woogle4MediaWiki/Decider manual

2010-04-28T11:18:22Z

Happel:

== Capabilities ==
See the [[Woogle4MediaWiki|start page]] for links to slidecasts and an online demo.

=== Features ===
* Searching the Wiki and external content
** Keyword-search with wildcards, phrases etc. (Lucene syntax)
** Search external data from within MediaWiki (in WoogleRemote using [[Integrated Search|Integrated search backend]])
** Autocomplete of search results
** Seamless integration in MediaWiki (replaces built-in search; can be disabled by individual users via MediaWiki preferences)
** Social search (Describe and discuss queries, (Social ranking))
** Searches all namespaces
* Need guidance
** Popups for "Red links" provide meta-information on need
** Statistics of unsatisfied queries
** ...
* Convenience features
** Supports different languages (en and de supplied by default, further languages can easily be supported)
** Native PHP extension (in WoogleNative mode)

=== Limitations ===
* Accesses all pages in all namespaces - currently no configuration possible (but can be relatively easy changed in the code)
* Does not respect any read restrictions/access rights on MediaWiki content (certain access control is possible in WoogleRemote using an [[Integrated Search|Integrated search backend]])
* For minor limitions of specific releace also consult the [[Woogle4MediaWiki/Release Notes]]

=== Comparisons ===
Options for search in MediaWiki are described on [http://www.mediawiki.org/wiki/Extension:Woogle4MediaWiki#See_also Woogle's MediaWiki.org page] and at http://www.wiki4enterprise.org/index.php/Suche_in_Wikis (in German).

== Performance ==
* WoogleRemote
** [[Integrated Search]] is the core determinant for indexing and query performance - it can typically handle large amounts of data
** Communication and even network latency between the PHP/MediaWiki frontend and the Java/TeamWeaverIS backend is not an issue to our experience
* WoogleNative
** On state-of-the-art hardware, we were able to work with a 50,000 pages subset of Wikipedia, serving queries well below one second
** However, we did not yet test this scale with massive requests
** We recommend to restrict search-term autocomplete to title matches only for Wikis larger than 10,000 pages for performance reasons

Woogle4MediaWiki/Admin manual

2010-04-28T10:10:37Z

Happel:

== Installation ==
Before starting, it is important to understand that Woogle4MediaWiki can be run in '''two different modes''':
* Woogle'''Native''' - which is purely PHP-based - you can only search and index your Wiki as such, but no data outside the Wiki
* Woogle'''Remote''' - which connects to an [[Integrated Search]] backend - you can search any kind of data indexed by the backend (including e.g. file systems, SVN ressources etc.)

If you are in a hurry, there is a less elaborate [[Woogle4MediaWiki/Quick install|quick install guide]] for WoogleNative.

=== Prerequisites ===
* Server
** Woogle4MediaWiki requires [http://www.mediawiki.org/wiki/MediaWiki MediaWiki] in a version >= 1.11.0 (see also [[Woogle4MediaWiki/Compability|compatibility notes]])
** '''Note''': If you are using PHP 5.3.0 and beyond, some [http://us.php.net/manual/en/migration53.incompatible.php compability issues] with older versions of [https://bugzilla.wikimedia.org/show_bug.cgi?id=15854 MediaWiki] (<1.14.1) and [http://octopus13.fzi.de:8080/browse/WOO-288 Woogle] (< 1.0-RC2) will arise. Make sure to work with a recent version.
** For using WoogleNative,
*** we strongly recommend the PCRE and mb_string extensions to be installed in your PHP runtime environment (although not strictly neccessary)
*** you will need a database user with <code>CREATE TABLE</code> privileges (or the database root account)
** For WoogleRemote you need an installed [[Integrated Search]] backend, and some configuration data (backend URL, repoId, pushIndexAuthKey; c.f. [[Integrated_Search/Configuration#Configuring_.22push.22_indexing|for push indexing]]). A network connection from the MediaWiki server to the Integrated Search backend is required.
* Client
** Woogle will most probably work with any browser which is supported by MediaWiki itself (see also [[Woogle4MediaWiki/Compability|compatibility notes]])
** Some advanced features of Woogle (autocomplete, red link popus, result annotation) make use of Ajax and might not work with old browsers. However, the Woogle core features should not be affected by this.

=== Installation steps ===
* Download the appropriate distribution file. There are distributions for WoogleRemote, WoogleNative and one including both.
* Extract the content of the Woogle distribution ZIP-file to <code>[Your MediaWiki directory]/extensions/Woogle</code>
* Grant write permissions for the executing user on <code>[Your MediaWiki directory]/extensions/Woogle/logs</code> and on <code>[Your MediaWiki directory]/extensions/Woogle/addons/Native/index</code>, if you are using the Native addon
* At the end of the file <code>[Your MediaWiki directory]/LocalSettings.php</code> add the following line: <code>require_once("$IP/extensions/Woogle/Woogle.php");</code>
* Proceed with configuration

== Configuration ==

=== General configuration ===
To configure Woogle, add a statement <code>WoogleConfig::set('parameter', 'value');</code> to LocalSettings.php for each configuration parameter you want to change. These statements have to be '''below''' the inclusion of Woogle.php.

The default values plus description of all parameters can be found in <code>[Your MediaWiki directory]/extensions/Woogle/includes/WoogleConfig.php</code>. Do not modify any values there. Alternatively, you can see all configuration values on the special page <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> (e.g. [[Special:WoogleConfig]]).

Open the file <code>[Your MediaWiki directory]/extensions/Woogle/WoogleConfig.php</code> and scroll down to the <code>WoogleConfig</code> class to configure Woogle. You can call <code>[MediaWiki URL]/Special:WoogleConfig</code> (which requires a WikiSysop user) in your browser to see configured values at runtime.

Example snippet for LocalSettings.php with most important settings:
<pre>
require_once("$IP/extensions/Woogle/Woogle.php");

// Optional Woogle Configuration
//WoogleConfig::set('core', false); // set false to completely dectivate Woogle
//WoogleConfig::set('replace', false); // set false to use MediaWiki built-in search from MediaWiki search box (Woogle is only used when directly called from Special:Woogle then)
//WoogleConfig::set('advanced', false); // set false to disable Woogle:-Namespace and thus enable Special:Woogle only
//WoogleConfig::set('redLinkInfo', false); // set false to disable JavaScript popups for red links
//WoogleConfig::set('limitAccessToGroups', true); // set true to restrict Woogle usage to groups defined in $groups below
//WoogleConfig::set('groups', array('sysop')); // groups access is limited to if $limitAccessToGroups
//WoogleConfig::set('clickTracking', false); // set false to avoid tracking of user's result clicks (for statistical purposes)
</pre>

Woogle creates additional MediaWiki [http://www.mediawiki.org/wiki/Manual:$wgExtraNamespaces namespaces]. If you are using other MediaWiki extensions which define namespaces (such as Semantic MediaWiki), you have to set a starting index of free namespaces Ids for Woogle by setting <code>$wooNamespaceIndex = 110</code>. The implicit default value is 100.

See the documentation for each value on the right side. Typically, there is '''no need to change most of these values'''.

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

=== Specific settings for WoogleRemote ===
Default settings are documented in <code>[Your MediaWiki directory]/extensions/Woogle/addons/Remote.php</code>. As with the general settings, do not edit directly, but add statements to LocalSettings.php

Example snippet for LocalSettings.php with most important settings:
<pre>
require_once("$IP/extensions/Woogle/Woogle.php");

// Woogle Configuration
WoogleConfig::set('remoteBaseServiceUrl', 'http://octopus13.fzi.de:9999/teamweaverIS-backend/services/'); // set the respective backend URL here
WoogleConfig::set('remoteAuthKey', 'secret'); // key for querying, only required if the backend is set to securityEnabled = true;
WoogleConfig::set('indexGroups', array('group1', 'group2'));
WoogleConfig::set('indexRepository', '123'); // numeric id for indexing (repoId) - as configured in the backend repo_config.xml
WoogleConfig::set('remotePushIndexAuthKey', 'secret2'); // key for indexing - as configured in the backend repo_config.xml
</pre>

As you can see, some parameters depend on configuration choices related to the [[Integrated Search|integrated search backend configuration]] (see also [[repo_config.xml]]).

=== Final steps ===
* Open MediaWiki and see if the system runs properly (if problems occur - see the [[Woogle4MediaWiki/Admin manual#Dealing_with_problems|"dealing with problems" section]] below!).
* Open <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> in your browser (which requires a WikiSysop user) and check the "status" section on top
** For WoogleNative, click the button "Create database tables". If Woogle tells "You need db root access to create tables", your MediaWiki database user does not seem to have <code>CREATE TABLE</code> privileges (see prerequisites). You may either grant these rights via the database interface, or do the "Database adminstration via script" (see Additional topics section below)
** If everything looks fine on the "status" section, you are ready to create the search index for the existing pages (afterwards, all page changes will update the index automatically)
*** Select "(Re-)Create Index (Direct)" to create the index immediately, within one HTTP session. For large Wikis, this will block your browser and probably even result in a script timeout (depending on your server configuration)
*** Thus you may '''alternatively''' select "(Re-)Create Index (Jobs)", which will create tasks in your MediaWiki job queue for indexing each page. The job queue usually (depending on your MediaWiki configuration) processes a handful jobs with each user request. Thus, for a large Wiki, it will take considerable time until all indexing jobs have been processed. If your Wiki has low traffic, it might even take longer. You can alread search during this process, but you might not receive full results. See "Run indexing jobs" under "Additional topcis" on how to do batch indexing.
*** For '''larger wikis''' (> 500 pages) we '''strongly recommend''' to used the command line script <code>php extensions/Woogle/maintenance/WoogleReIndexAll.php [options...]</code> for index creation! ([[Woogle4MediaWiki/Admin manual#Indexing_via_script|see below for details]])
* Enter <code>[MediaWiki URL]/index.php/Special:Woogle</code> to your browser to check if everything works

== Uninstalling Woogle ==
* Note that Woogle can be disabled by any user individually via his/her MediaWiki user preferences (Special:Preferences).
* Woogle can be deactivated by adding <code>WoogleConfig::set('core', false);</code> or by commenting out all Woogle statements in LocalSettings.php. This will do no harm - the MediaWiki system will immediately fall back to the built-in search.
* If you want to physically remove Woogle, do the following:
** For WoogleNative, visit <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> (which requires a WikiSysop user) and click the button "Remove database tables". If you do not have sufficenit permissions to do so, try the "Database adminstration via script" (see Additional topics section below)
** Comment out or remove all Woogle statements in LocalSettings.php
** Remove Woogle directory from <code>[Your MediaWiki directory]/extensions/</code>

== Additional topcis ==

=== Dealing with problems ===
If problems occur, you might first see [[Woogle4MediaWiki/FAQ#Administrator_questions|the FAQ]].

If you see a blank page after enabling Woogle, adding the following code to your <code>LocalSettings.php</code> might help to track down the problem:
<pre>
# Error reporting (only useful for debugging)
error_reporting( E_ALL );
ini_set( 'display_errors', 1 );
$wgShowExceptionDetails = true;
$wgShowSQLErrors = true;
</pre>

=== Database administration via script ===
If your MediaWiki database user does not have sufficient privileges to add/delete tables, you have to use the command line script instead of conveniently using the buttons at Special:WoogleConfig.

Therefore, you need to configure a database user with suitable privileges in the file <code>AdminSettings.php</code> in the root of your MediaWiki directory (c.f. [http://www.mediawiki.org/wiki/Manual:Maintenance_scripts] resp. [http://www.mediawiki.org/wiki/Manual:AdminSettings.php]).

Afterwards, you may call <code>php extensions/Woogle/addons/Native/maintenance/WoogleNativeDb_setup.php [options...]</code>, whereas options are:
* <code>--user <dbuser></code> Database user account to use for changing DB layout. If not set, the credentials in AdminSettings.php are used.
* <code>--password <dbpassword></code> Password for user account to use. (Instead of custom password.)
* <code>--delete</code> Delete Woogle database tables. If not selected, this script tries to create them.

=== Indexing via script ===
Especially for larger Wikis, it makes sense to run indexing tasks from the command line instead of the web browser. There are two scripts, that can support you with this task:
* <code>php extensions/Woogle/maintenance/WoogleReIndexAll.php [options...]</code> is our recommended approach, since it will rebuild the index without any further prerequisites. The following options can be set:
** <code>-f</code> to force indexing without 10 sec waiting delay
** <code>--server=http://www.mywikihost.org</code> - server name (e.g. http://www.mywikihost.org) - without trailing slashes - to avoid that Woogle stores Wiki page URLs with <code>http://localhost</code> in the index. Alternatively set $wgServer explicitly in LocalSettings.php (c.f. [http://www.mediawiki.org/wiki/Manual:LocalSettings.php#Server_name]).
** <code>--conf=../../../LocalSettings2.php</code> - this is only necessary, but particularly useful, if you would like to create an index without touching the productive Wiki system (which is configured in LocalSettings.php). You may just make a copy of LocalSettings.php and only include Woogle in this configuration.
* If you chose to "index as jobs" in <code>Special:WoogleConfig</code>, Woogle will add small indexing jobs (one job for each Wiki page) to the MediaWiki job system. In a large Wiki, this might produce a huge job queue which takes a while to fill the index, since in MediaWiki, a small fraction of jobs is processed with every user request. However, MediaWiki provides a script <code>/maintenance/runJobs.php</code> to process the job queue from the command line. Follow the [http://www.mediawiki.org/wiki/Manual:Job_queue MediaWiki manual] concerning this option.

=== Modify or translate UI text ===
Woogle user interface text is modularized to language files located in <code>/extensions/Woogle/languages/</code>. Edit these files to adapt texts. To create translations for other languages, copy an existing file (probably WoogleLangEnglish.php) and translate the content. Please contribute such translations back to us!

=== Modify the user interface ===
Woogle UI can be configured using several configuration parameters, which are documented in <code>WoogleConfig.php</code>.

Besides that, many visual aspects of Woogle are captured in CSS files which you may customize.

=== Instrumentation addon ===
Woogle provides an addon for scientific evaluation (called "instrumentation") which captures user activities in a log file. Also, the extension allows to modify certain Woogle (UI) settings for different groups of users and provides a confirmation screen that allows to gain user's explicit consent for logging data.

Instrumentation mode can be enabled by setting <code>$config['instrumentation']</code> in <code>extensions\Woogle\addons\Instrumentation\Instrumentation.php</code> to "true". Further settings can be changed there as well.

Woogle4MediaWiki/Admin manual

2010-04-28T09:49:46Z

Happel: /* General configuration */

== Installation ==
Before starting, it is important to understand that Woogle4MediaWiki can be run in '''two different modes''':
* Woogle'''Native''' - which is purely PHP-based - you can only search and index your Wiki as such, but no data outside the Wiki
* Woogle'''Remote''' - which connects to an [[Integrated Search]] backend - you can search any kind of data indexed by the backend (including e.g. file systems, SVN ressources etc.)

If you are in a hurry, there is a less elaborate [[Woogle4MediaWiki/Quick install|quick install guide]] for WoogleNative.

=== Prerequisites ===
* Server
** Woogle4MediaWiki requires [http://www.mediawiki.org/wiki/MediaWiki MediaWiki] in a version >= 1.11.0 (see also [[Woogle4MediaWiki/Compability|compatibility notes]])
** '''Note''': If you are using PHP 5.3.0 and beyond, some [http://us.php.net/manual/en/migration53.incompatible.php compability issues] with older versions of [https://bugzilla.wikimedia.org/show_bug.cgi?id=15854 MediaWiki] (<1.14.1) and [http://octopus13.fzi.de:8080/browse/WOO-288 Woogle] (< 1.0-RC2) will arise. Make sure to work with a recent version.
** For using WoogleNative,
*** we strongly recommend the PCRE and mb_string extensions to be installed in your PHP runtime environment (although not strictly neccessary)
*** you will need a database user with <code>CREATE TABLE</code> privileges (or the database root account)
** For WoogleRemote you need an installed [[Integrated Search]] backend, and some configuration data (backend URL, repoId, pushIndexAuthKey; c.f. [[Integrated_Search/Configuration#Configuring_.22push.22_indexing|for push indexing]]). A network connection from the MediaWiki server to the Integrated Search backend is required.
* Client
** Woogle will most probably work with any browser which is supported by MediaWiki itself (see also [[Woogle4MediaWiki/Compability|compatibility notes]])
** Some advanced features of Woogle (autocomplete, red link popus, result annotation) make use of Ajax and might not work with old browsers. However, the Woogle core features should not be affected by this.

=== Installation steps ===
* Download the appropriate distribution file. There are distributions for WoogleRemote, WoogleNative and one including both.
* Extract the content of the Woogle distribution ZIP-file to <code>[Your MediaWiki directory]/extensions/Woogle</code>
* Grant write permissions for the executing user on <code>[Your MediaWiki directory]/extensions/Woogle/logs</code> and on <code>[Your MediaWiki directory]/extensions/Woogle/addons/Native/index</code>, if you are using the Native addon
* At the end of the file <code>[Your MediaWiki directory]/LocalSettings.php</code> add the following line: <code>require_once("$IP/extensions/Woogle/Woogle.php");</code>
* Proceed with configuration

== Configuration ==

=== General configuration ===
To configure Woogle, add a statement <code>WoogleConfig::set('parameter', 'value');</code> to LocalSettings.php for each configuration parameter you want to change. These statements have to be '''below''' the inclusion of Woogle.php.

The default values plus description of all parameters can be found in <code>[Your MediaWiki directory]/extensions/Woogle/includes/WoogleConfig.php</code>. Do not modify any values there. Alternatively, you can see all configuration values on the special page <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> (e.g. [[Special:WoogleConfig]]).

Open the file <code>[Your MediaWiki directory]/extensions/Woogle/WoogleConfig.php</code> and scroll down to the <code>WoogleConfig</code> class to configure Woogle. You can call <code>[MediaWiki URL]/Special:WoogleConfig</code> (which requires a WikiSysop user) in your browser to see configured values at runtime.

Example snippet for LocalSettings.php with most important settings:
<pre>
require_once("$IP/extensions/Woogle/Woogle.php");

// Optional Woogle Configuration
//WoogleConfig::set('core', false); // set false to completely dectivate Woogle
//WoogleConfig::set('replace', false); // set false to use MediaWiki built-in search from MediaWiki search box (Woogle is only used when directly called from Special:Woogle then)
//WoogleConfig::set('advanced', false); // set false to disable Woogle:-Namespace and thus enable Special:Woogle only
//WoogleConfig::set('redLinkInfo', false); // set false to disable JavaScript popups for red links
//WoogleConfig::set('limitAccessToGroups', true); // set true to restrict Woogle usage to groups defined in $groups below
//WoogleConfig::set('groups', array('sysop')); // groups access is limited to if $limitAccessToGroups
//WoogleConfig::set('clickTracking', false); // set false to avoid tracking of user's result clicks (for statistical purposes)
</pre>

Woogle creates additional MediaWiki [http://www.mediawiki.org/wiki/Manual:$wgExtraNamespaces namespaces]. If you are using other MediaWiki extensions which define namespaces (such as Semantic MediaWiki), you have to set a starting index of free namespaces Ids for Woogle by setting <code>$wooNamespaceIndex = 110</code>. The implicit default value is 100.

See the documentation for each value on the right side. Typically, there is '''no need to change most of these values'''.

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

=== Specific settings for WoogleRemote ===
Default settings are documented in <code>[Your MediaWiki directory]/extensions/Woogle/addons/Remote.php</code>. As with the general settings, do not edit directly, but add statements to LocalSettings.php

Example snippet for LocalSettings.php with most important settings:
<pre>
require_once("$IP/extensions/Woogle/Woogle.php");

// Woogle Configuration
WoogleConfig::set('remoteBaseServiceUrl', 'http://octopus13.fzi.de:9999/teamweaverIS-backend/services/'); // set the respective backend URL here
WoogleConfig::set('remoteAuthKey', 'secret'); // key for querying, only required if the backend is set to securityEnabled = true;
WoogleConfig::set('indexGroups', array('group1', 'group2'));
WoogleConfig::set('indexRepository', '123'); // numeric id for indexing (repoId) - as configured in the backend repo_config.xml
WoogleConfig::set('remotePushIndexAuthKey', 'secret2'); // key for indexing - as configured in the backend repo_config.xml
</pre>

As you can see, some parameters depend on configuration choices related to the [[Integrated Search|integrated search backend configuration]] (see also [[repo_config.xml]]).

=== Final steps ===
* Open MediaWiki and see if the system runs properly
* Open <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> in your browser (which requires a WikiSysop user) and check the "status" section on top
** For WoogleNative, click the button "Create database tables". If Woogle tells "You need db root access to create tables", your MediaWiki database user does not seem to have <code>CREATE TABLE</code> privileges (see prerequisites). You may either grant these rights via the database interface, or do the "Database adminstration via script" (see Additional topics section below)
** If everything looks fine on the "status" section, you are ready to create the search index for the existing pages (afterwards, all page changes will update the index automatically)
*** Select "(Re-)Create Index (Direct)" to create the index immediately, within one HTTP session. For large Wikis, this will block your browser and probably even result in a script timeout (depending on your server configuration)
*** Thus you may '''alternatively''' select "(Re-)Create Index (Jobs)", which will create tasks in your MediaWiki job queue for indexing each page. The job queue usually (depending on your MediaWiki configuration) processes a handful jobs with each user request. Thus, for a large Wiki, it will take considerable time until all indexing jobs have been processed. If your Wiki has low traffic, it might even take longer. You can alread search during this process, but you might not receive full results. See "Run indexing jobs" under "Additional topcis" on how to do batch indexing.
*** For '''larger wikis''' (> 500 pages) we '''strongly recommend''' to used the command line script <code>php extensions/Woogle/maintenance/WoogleReIndexAll.php [options...]</code> for index creation!
* Enter <code>[MediaWiki URL]/index.php/Special:Woogle</code> to your browser to check if everything works

== Uninstalling Woogle ==
* Note that Woogle can be disabled by any user individually via his/her MediaWiki user preferences (Special:Preferences).
* Woogle can be deactivated by adding <code>WoogleConfig::set('core', false);</code> or by commenting out all Woogle statements in LocalSettings.php. This will do no harm - the MediaWiki system will immediately fall back to the built-in search.
* If you want to physically remove Woogle, do the following:
** For WoogleNative, visit <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> (which requires a WikiSysop user) and click the button "Remove database tables". If you do not have sufficenit permissions to do so, try the "Database adminstration via script" (see Additional topics section below)
** Comment out or remove all Woogle statements in LocalSettings.php
** Remove Woogle directory from <code>[Your MediaWiki directory]/extensions/</code>

== Additional topcis ==

=== Database adminstration via script ===
If your MediaWiki database user does not have sufficient privileges to add/delete tables, you have to use the command line script instead of conveniently using the buttons at Special:WoogleConfig.

Therefore, you need to configure a database user with suitable privileges in the file <code>AdminSettings.php</code> in the root of your MediaWiki directory (c.f. [http://www.mediawiki.org/wiki/Manual:Maintenance_scripts] resp. [http://www.mediawiki.org/wiki/Manual:AdminSettings.php]).

Afterwards, you may call <code>php extensions/Woogle/addons/Native/maintenance/WoogleNativeDb_setup.php [options...]</code>, whereas options are:
* <code>--user <dbuser></code> Database user account to use for changing DB layout. If not set, the credentials in AdminSettings.php are used.
* <code>--password <dbpassword></code> Password for user account to use. (Instead of custom password.)
* <code>--delete</code> Delete Woogle database tables. If not selected, this script tries to create them.

=== Run indexing jobs ===
If you chose to "index as jobs" in a large Wiki, this might produce a huge job queue which takes a while to fill the index, since in MediaWiki, a small fraction of jobs is processed with every user request. However, MediaWiki provides a script <code>/maintenance/runJobs.php</code> to process the job queue from the command line. Follow the [http://www.mediawiki.org/wiki/Manual:Job_queue MediaWiki manual] concerning this option.

=== Modify or translate UI text ===
Woogle user interface text is modularized to language files located in <code>/extensions/Woogle/languages/</code>. Edit these files to adapt texts. To create translations for other languages, copy an existing file (probably WoogleLangEnglish.php) and translate the content. Please contribute such translations back to us!

=== Modify the user interface ===
Woogle UI can be configured using several configuration parameters, which are documented in <code>WoogleConfig.php</code>.

Besides that, many visual aspects of Woogle are captured in CSS files which you may customize.

=== Instrumentation addon ===
Woogle provides an addon for scientific evaluation (called "instrumentation") which captures user activities in a log file. Also, the extension allows to modify certain Woogle (UI) settings for different groups of users and provides a confirmation screen that allows to gain user's explicit consent for logging data.

Instrumentation mode can be enabled by setting <code>$config['instrumentation']</code> in <code>extensions\Woogle\addons\Instrumentation\Instrumentation.php</code> to "true". Further settings can be changed there as well.

Woogle4MediaWiki/instrumentation.log

2010-04-28T09:45:36Z

Happel:

This page describes the structure of the file <code>instrumention.log</code> which will be written by the Woogle4MediaWiki [[Woogle4MediaWiki/Instrumentation|instrumentation addon]].

Instrumentation.log is kept in \extensions\Woogle\logs. It will only be written if the global configuration value "instrumentation" is enabled in Instrumentation.php.

Log statements resulting from the actions of a user will only be logged after the user has explictly chosen to participate in the evaluation (participation_choice=accept) - i.e. "participation_choice" will always be the first entry logged for any user. If participation was declined, only this fact will be logged for the user. For anonymous users, logging can be controled using the global configuration variable "instrumentationAnon" defined in Instrumentation.php.

{| {{table}}
| align="center" style="background:#f0f0f0;"|'''log_key'''
| align="center" style="background:#f0f0f0;"|'''category'''
| align="center" style="background:#f0f0f0;"|'''mediawiki or woogle'''
| align="center" style="background:#f0f0f0;"|'''description'''
| align="center" style="background:#f0f0f0;"|'''log_values'''
| align="center" style="background:#f0f0f0;"|'''example(s)'''
| align="center" style="background:#f0f0f0;"|'''remarks'''
|-
| none||all||||prefix for all log entries||date, time, anonUserId||tbd.||
|-
| mwsearch_results||search||mw||log mediawiki search||query; #title matches, #text matches||Mature;2;5||
|-
| mwsearch_noresults||search||mw||log mediawiki search||query||proposel||
|-
| woogle_search_icons||search||woo||logs woogle icon values on woogle search||S_#searchers, Q_#queries, RQ_#recentQueries, METRIC_val where METRIC is one or more of: VLFW if ($val_few > 0.2) DFFC if ($val_diff > 1.2) MBRW if ($val_much > 0.2)||S_2/Q_2/RQ_1/VLFW_0.5||
|-
| woogle_search_query (GO)||search||woo||logs woogle query yielding \"GO\"||query (=page title), GO_, REF_referer||Diplomarbeit/GO_/REF_||
|-
| woogle_search_query (QUERY)||search||woo||logs woogle query||query, HIT_#hits, RES_#count, STR_#start, REF_referer, AMT_mimetypes, ARP_repositories, UGT_useragent||Svn/RES_10/STR_0/REF_mw/AMT_Array()/ARP_Array([0]=>33)||called either by \"go\" or by query execution in WQS
|-
| woogle_result_click||search||woo||logs woogle result click||url, position||file:///u:/Uni/Vorlesungen/lecture.ppt;2 https://myhost.com/projects/wiki/index.php/index.php/Mike;5||Misses opera right clicks (WOO-230)
|-
| edit_newpage||edit||mw||logs article editing||page title, via red link (1=true)||Calibra;1 Talk:Calibra;0||Edit!=Save
|-
| article_save||edit||mw||logs article saving||page title, strlen(article), isRedirect (1=true)||Calibra;200;0||
|-
| woogle_redlink_icons||misc||woo||logs woogle red link popup info||page title, WAT_#watchers, INL_#inlinks, QUE_#queries, RQL_#relQueries, DQR_#directQueries, MXS_#maxSearchers, RCT_#recentQueries||SAP//WAT_0/INL_20/QUE_2/RQL_1/DQR_0/MXS_1/RCT_1||SAP=link text
|-
| woogle_redlink_hover||misc||woo||logs if user watches red link popup||lpage title, mouseover time||SAP;1200||time is in msec
|-
| watch_created||misc||mw||logs mediawiki watch features||page title||Calibra||remove watch?
|-
| participation_choice||eval||woo||logs woogle instrumentation question||user choice (accept/reject)||accept||
|-
| instrumentation_group||eval||woo||logs instrumentation group assigned to user||instrumentation groups||November||
|-
| edit_count||user||mw||logs number of edits by user||number of edits||230||fuzzified (mod10)
|-
| account_created||user||mw||logs account creation date||date||200710||fuzzified (year/month)
|-
| user_login||user||mw||logs if user logs in to mediawiki||none||||does not seem to cover cookie login
|-
| pref_save||user||mw||logs changed user preferences||preference value; activated (1=true)||WoogleGeneralReplaceMWS;1||
|-
|
|}

Note:
* the log file uses ";" as separators (CSV) such that it can be easily opend in a spreadsheet application
* if you encounter umlaut problems when working with the log file try to view as UTF-8 (and use appropriate text editor!)

Full log excerpt:
<pre>
tbd.
</pre>

Woogle4MediaWiki/Instrumentation

2010-04-28T09:43:30Z

Happel:

Woogle4Media can optionally equipped with an addon for scientifc instrumentation. The purpose of this addon is to log user activities within the Wiki during scientific studies. The extension allows to modify certain Woogle (UI) settings for different groups of users and provides a confirmation screen that allows to gain user's explicit consent for logging data.

== Features ==
The instrumentation addon has four core features:
* Configuring different runtime behaviour of the Woogle extension for different user groups (all variables in WoogleConfig can be used for this)
* Automatically generating an anonymous user id and randomly assigning an experimental group for users
* Transparent evaluation for users (initial participation dialog for informed consent; watching and changing evaluation settings in MediaWiki preferences)
* Powerful logging of user behaviour in the Wiki resulting in a CSV log file (see below for details)

While the instrumentation addon was designed for evaluating Woogle, it should be easy to adapt the concept and the code for other evaluation tasks.

== Privacy ==
Note that the addon was designed to protect user's privacy as much as possible:
* The instrumentation addon is '''disabled by default''' and needs to be explicitly configured by the Wiki adminstrator
* Once enabled, each Wiki user will be shown an information dialog before the next search. This dialog contains information about the scientific study and offers the user to either accept or to decline the participation by clicking a button.
** '''Only if the user explicitly accepts, data will be logged'''
** If the user declines participation, only the fact that "a user declined paticipation" will be logged. No further log data will be collected for such users.
** See also http://en.wikipedia.org/wiki/Informed_consent#Research
* At any time, users may visit the "Woogle"-Tab in MediaWiki Special:Preferences to see or modify his or her evaluation status
* Evaluation logs do not contain a MediaWiki UserId or User name. Instead, Woogle automatically generates an '''anonymous user id''' for each user. No one except of your Wiki adminstrator knows which anonymous user id maps to which user. The anonymous user id can be modifyed in Special:Preferences ("Woogle"-Tab).
** See [[Woogle4MediaWiki/instrumentation.log]] for a complete list of logged user action

== See also ==
* [[Woogle4MediaWiki/Privacy]] for more general informaton on privacy in Woogle.
* [[Woogle4MediaWiki/Admin_manual#Instrumentation_addon|Woogle4MediaWiki/Admin_manual]] for information on enabling the instrumentation addon

Woogle4MediaWiki/Quick install

2010-04-27T17:30:32Z

Happel:

This is a quick install guide for Woogle4MediaWiki. For detailed instructions see [[Woogle4MediaWiki/Admin manual]].

Quick install steps:
# Download the latest Woogle Native release from [[Woogle4MediaWiki]]
## Extract the ZIP archive to your MediaWiki extensions directory. On Unix or Mac machines make sure the webserver can write <code>..\Woogle\logs</code> and <code>..\Woogle\addons\Native\index</code>
## Add the line <code>include_once('extensions/Woogle/Woogle.php');</code> to your MediaWiki <code>LocalSettings.php</code>
# Check Woogle status at <code>Special:WoogleConfig</code>
## Click the "Create database tables" button
## Click the "(Re-) Index all (direct)" button on that page (for Wikis > 500 pages) or run <code>php maintenance/WoogleReIndexAll.php</code> from the command line to initialize the search index
# DONE! Check <code>Special:Woogle</code> to search your Wiki!

Woogle4MediaWiki/Quick install

2010-04-27T17:29:19Z

Happel:

This is a quick install guide for Woogle4MediaWiki. For detailed instructions see [[Woogle4MediaWiki/Admin manual]].

Quick install steps:
# Download the latest Woogle Native release from [[Woogle4MediaWiki]]
# Extract the ZIP archive to your MediaWiki extensions directory
# On Unix or Mac machines make sure the webserver can write <code>..\Woogle\logs</code> and <code>..\Woogle\addons\Native\index</code>
# Add the line <code>include_once('extensions/Woogle/Woogle.php');</code> to your MediaWiki <code>LocalSettings.php</code>
# Check Woogle status at <code>Special:WoogleConfig</code>
# Click the "Create database tables" button
# Click the "(Re-) Index all (direct)" button on that page (for Wikis > 500 pages) or run <code>php maintenance/WoogleReIndexAll.php</code> from the command line to initialize the search index
# DONE! Check <code>Special:Woogle</code> to search your Wiki!

Woogle4MediaWiki/Admin manual

2010-04-27T17:28:50Z

Happel: /* Installation */

== Installation ==
Before starting, it is important to understand that Woogle4MediaWiki can be run in '''two different modes''':
* Woogle'''Native''' - which is purely PHP-based - you can only search and index your Wiki as such, but no data outside the Wiki
* Woogle'''Remote''' - which connects to an [[Integrated Search]] backend - you can search any kind of data indexed by the backend (including e.g. file systems, SVN ressources etc.)

If you are in a hurry, there is a less elaborate [[Woogle4MediaWiki/Quick install|quick install guide]] for WoogleNative.

=== Prerequisites ===
* Server
** Woogle4MediaWiki requires [http://www.mediawiki.org/wiki/MediaWiki MediaWiki] in a version >= 1.11.0 (see also [[Woogle4MediaWiki/Compability|compatibility notes]])
** '''Note''': If you are using PHP 5.3.0 and beyond, some [http://us.php.net/manual/en/migration53.incompatible.php compability issues] with older versions of [https://bugzilla.wikimedia.org/show_bug.cgi?id=15854 MediaWiki] (<1.14.1) and [http://octopus13.fzi.de:8080/browse/WOO-288 Woogle] (< 1.0-RC2) will arise. Make sure to work with a recent version.
** For using WoogleNative,
*** we strongly recommend the PCRE and mb_string extensions to be installed in your PHP runtime environment (although not strictly neccessary)
*** you will need a database user with <code>CREATE TABLE</code> privileges (or the database root account)
** For WoogleRemote you need an installed [[Integrated Search]] backend, and some configuration data (backend URL, repoId, pushIndexAuthKey; c.f. [[Integrated_Search/Configuration#Configuring_.22push.22_indexing|for push indexing]]). A network connection from the MediaWiki server to the Integrated Search backend is required.
* Client
** Woogle will most probably work with any browser which is supported by MediaWiki itself (see also [[Woogle4MediaWiki/Compability|compatibility notes]])
** Some advanced features of Woogle (autocomplete, red link popus, result annotation) make use of Ajax and might not work with old browsers. However, the Woogle core features should not be affected by this.

=== Installation steps ===
* Download the appropriate distribution file. There are distributions for WoogleRemote, WoogleNative and one including both.
* Extract the content of the Woogle distribution ZIP-file to <code>[Your MediaWiki directory]/extensions/Woogle</code>
* Grant write permissions for the executing user on <code>[Your MediaWiki directory]/extensions/Woogle/logs</code> and on <code>[Your MediaWiki directory]/extensions/Woogle/addons/Native/index</code>, if you are using the Native addon
* At the end of the file <code>[Your MediaWiki directory]/LocalSettings.php</code> add the following line: <code>require_once("$IP/extensions/Woogle/Woogle.php");</code>
* Proceed with configuration

== Configuration ==

=== General configuration ===
To configure Woogle, add a statement <code>WoogleConfig::set('parameter', 'value');</code> to LocalSettings.php for each configuration parameter you want to change. These statements have to be '''below''' the inclusion of Woogle.php.

The default values plus description of all parameters can be found in <code>[Your MediaWiki directory]/extensions/Woogle/includes/WoogleConfig.php</code>. Do not modify any values there. Alternatively, you can see all configuration values on the special page <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> (e.g. [[Special:WoogleConfig]]).

Open the file <code>[Your MediaWiki directory]/extensions/Woogle/WoogleConfig.php</code> and scroll down to the <code>WoogleConfig</code> class to configure Woogle. You can call <code>[MediaWiki URL]/Special:WoogleConfig</code> (which requires a WikiSysop user) in your browser to see configured values at runtime.

Example snippet for LocalSettings.php with most important settings:
<pre>
require_once("$IP/extensions/Woogle/Woogle.php");

// Woogle Configuration
WoogleConfig::set('core', false); // set false to completely dectivate Woogle
WoogleConfig::set('replace', false); // set false to use MediaWiki built-in search from MediaWiki search box (Woogle is only used when directly called from Special:Woogle then)
WoogleConfig::set('advanced', false); // set false to disable Woogle:-Namespace and thus enable Special:Woogle only
WoogleConfig::set('redLinkInfo', false); // set false to disable JavaScript popups for red links
WoogleConfig::set('limitAccessToGroups', true); // set true to restrict Woogle usage to groups defined in $groups below
WoogleConfig::set('groups', array('sysop')); // groups access is limited to if $limitAccessToGroups
WoogleConfig::set('clickTracking', false); // set false to avoid tracking of user's result clicks (for statistical purposes)
</pre>

Woogle creates additional MediaWiki [http://www.mediawiki.org/wiki/Manual:$wgExtraNamespaces namespaces]. If you are using other MediaWiki extensions which define namespaces (such as Semantic MediaWiki), you have to set a starting index of free namespaces Ids for Woogle by setting <code>$wooNamespaceIndex = 110</code>. The implicit default value is 100.

See the documentation for each value on the right side. Typically, there is '''no need to change most of these values'''.

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

=== Specific settings for WoogleRemote ===
Default settings are documented in <code>[Your MediaWiki directory]/extensions/Woogle/addons/Remote.php</code>. As with the general settings, do not edit directly, but add statements to LocalSettings.php

Example snippet for LocalSettings.php with most important settings:
<pre>
require_once("$IP/extensions/Woogle/Woogle.php");

// Woogle Configuration
WoogleConfig::set('remoteBaseServiceUrl', 'http://octopus13.fzi.de:9999/teamweaverIS-backend/services/'); // set the respective backend URL here
WoogleConfig::set('remoteAuthKey', 'secret'); // key for querying, only required if the backend is set to securityEnabled = true;
WoogleConfig::set('indexGroups', array('group1', 'group2'));
WoogleConfig::set('indexRepository', '123'); // numeric id for indexing (repoId) - as configured in the backend repo_config.xml
WoogleConfig::set('remotePushIndexAuthKey', 'secret2'); // key for indexing - as configured in the backend repo_config.xml
</pre>

As you can see, some parameters depend on configuration choices related to the [[Integrated Search|integrated search backend configuration]] (see also [[repo_config.xml]]).

=== Final steps ===
* Open MediaWiki and see if the system runs properly
* Open <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> in your browser (which requires a WikiSysop user) and check the "status" section on top
** For WoogleNative, click the button "Create database tables". If Woogle tells "You need db root access to create tables", your MediaWiki database user does not seem to have <code>CREATE TABLE</code> privileges (see prerequisites). You may either grant these rights via the database interface, or do the "Database adminstration via script" (see Additional topics section below)
** If everything looks fine on the "status" section, you are ready to create the search index for the existing pages (afterwards, all page changes will update the index automatically)
*** Select "(Re-)Create Index (Direct)" to create the index immediately, within one HTTP session. For large Wikis, this will block your browser and probably even result in a script timeout (depending on your server configuration)
*** Thus you may '''alternatively''' select "(Re-)Create Index (Jobs)", which will create tasks in your MediaWiki job queue for indexing each page. The job queue usually (depending on your MediaWiki configuration) processes a handful jobs with each user request. Thus, for a large Wiki, it will take considerable time until all indexing jobs have been processed. If your Wiki has low traffic, it might even take longer. You can alread search during this process, but you might not receive full results. See "Run indexing jobs" under "Additional topcis" on how to do batch indexing.
*** For '''larger wikis''' (> 500 pages) we '''strongly recommend''' to used the command line script <code>php extensions/Woogle/maintenance/WoogleReIndexAll.php [options...]</code> for index creation!
* Enter <code>[MediaWiki URL]/index.php/Special:Woogle</code> to your browser to check if everything works

== Uninstalling Woogle ==
* Note that Woogle can be disabled by any user individually via his/her MediaWiki user preferences (Special:Preferences).
* Woogle can be deactivated by adding <code>WoogleConfig::set('core', false);</code> or by commenting out all Woogle statements in LocalSettings.php. This will do no harm - the MediaWiki system will immediately fall back to the built-in search.
* If you want to physically remove Woogle, do the following:
** For WoogleNative, visit <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> (which requires a WikiSysop user) and click the button "Remove database tables". If you do not have sufficenit permissions to do so, try the "Database adminstration via script" (see Additional topics section below)
** Comment out or remove all Woogle statements in LocalSettings.php
** Remove Woogle directory from <code>[Your MediaWiki directory]/extensions/</code>

== Additional topcis ==

=== Database adminstration via script ===
If your MediaWiki database user does not have sufficient privileges to add/delete tables, you have to use the command line script instead of conveniently using the buttons at Special:WoogleConfig.

Therefore, you need to configure a database user with suitable privileges in the file <code>AdminSettings.php</code> in the root of your MediaWiki directory (c.f. [http://www.mediawiki.org/wiki/Manual:Maintenance_scripts] resp. [http://www.mediawiki.org/wiki/Manual:AdminSettings.php]).

Afterwards, you may call <code>php extensions/Woogle/addons/Native/maintenance/WoogleNativeDb_setup.php [options...]</code>, whereas options are:
* <code>--user <dbuser></code> Database user account to use for changing DB layout. If not set, the credentials in AdminSettings.php are used.
* <code>--password <dbpassword></code> Password for user account to use. (Instead of custom password.)
* <code>--delete</code> Delete Woogle database tables. If not selected, this script tries to create them.

=== Run indexing jobs ===
If you chose to "index as jobs" in a large Wiki, this might produce a huge job queue which takes a while to fill the index, since in MediaWiki, a small fraction of jobs is processed with every user request. However, MediaWiki provides a script <code>/maintenance/runJobs.php</code> to process the job queue from the command line. Follow the [http://www.mediawiki.org/wiki/Manual:Job_queue MediaWiki manual] concerning this option.

=== Modify or translate UI text ===
Woogle user interface text is modularized to language files located in <code>/extensions/Woogle/languages/</code>. Edit these files to adapt texts. To create translations for other languages, copy an existing file (probably WoogleLangEnglish.php) and translate the content. Please contribute such translations back to us!

=== Modify the user interface ===
Woogle UI can be configured using several configuration parameters, which are documented in <code>WoogleConfig.php</code>.

Besides that, many visual aspects of Woogle are captured in CSS files which you may customize.

=== Instrumentation addon ===
Woogle provides an addon for scientific evaluation (called "instrumentation") which captures user activities in a log file. Also, the extension allows to modify certain Woogle (UI) settings for different groups of users and provides a confirmation screen that allows to gain user's explicit consent for logging data.

Instrumentation mode can be enabled by setting <code>$config['instrumentation']</code> in <code>extensions\Woogle\addons\Instrumentation\Instrumentation.php</code> to "true". Further settings can be changed there as well.

Woogle4MediaWiki/Quick install

2010-04-27T17:28:34Z

Happel: Created page with 'This is a quick install guide for Woogle4MediaWiki. For detailed instructions see Woogle4MediaWiki/Admin manual. Quick install steps: # Download the latest Woogle Native rel…'

This is a quick install guide for Woogle4MediaWiki. For detailed instructions see [[Woogle4MediaWiki/Admin manual]].

Quick install steps:
# Download the latest Woogle Native release from [[Woogle4MediaWiki]]
# Extract the ZIP archive to your MediaWiki extensions directory
# On Unix or Mac machines make sure the webserver can write <code>..\Woogle\logs</code> and <code>..\Woogle\addons\Native\index</code>
# Add the line <code>include_once('extensions/Woogle/Woogle.php');</code> to your MediaWiki <code>LocalSettings.php</code>
# Check Woogle status at <code>Special:WoogleConfig</code>
# Click the "(Re-) Index all (direct)" button on that page (for Wikis > 500 pages) or run <code>php maintenance/WoogleReIndexAll.php</code> from the command line to initialize the search index
# DONE! Check <code>Special:Woogle</code> to search your Wiki!

Woogle4MediaWiki

2010-04-27T17:20:10Z

Happel:

Woogle4MediaWiki comes as an Extension replacing MediaWiki's build in search (test it in this Wiki!). There is a native PHP implementation for searching the Wiki only ('''WoogleNative''') and an implementation for searching various source via an [[Integrated Search]] backend from within your MediaWiki ('''WoogleRemote''').

For additional information, you might want to see these [http://www.slideshare.net/hhappel/woogle-on-why-and-how-to-marry-wikis-with-enterprise-search presentation slides]. There is also a description of Woogle in the [http://www.mediawiki.org/wiki/Extension:Woogle4MediaWiki mediawiki.org extension directory].

== Online Demo ==
The whole TeamWeaver site (i.e. the search in this Wiki) is running Woogle and allows you to search this Wiki, our SVN and JIRA. For testing the Woogle interface, either use the Search box on top of this page, or go to [[Special:Woogle]]. You can access the same data with the [[Integrated Search]] standard Web frontend online demo.

We have also set up a separate Woogle demo wiki which is rebuildt every night and thus allows you to experiment with it. You can access it at: http://amazonas.fzi.de/wooglenative/

== Download ==
Woogle4MediaWiki is now available for download under GPL license in version 1.0.0 (RC2). We consider the basic functionality rather stable and capable to serve productive systems. Woogle has been successfully tested recently with MediaWiki versions 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248). Prior in development, Woogle was running fine with MW 1.11 and beyond. For details see our [http://www.teamweaver.org/wiki/index.php/Woogle4MediaWiki/Compability compability notes].

Download links:
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Native_v1.0.0-RC2.zip WoogleNative] (searches MediaWiki only)
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Remote_v1.0.0-RC2.zip WoogleRemote] (can search additional data sources; requires [[Integrated Search]])
* see also [[Woogle4MediaWiki/Release Notes]]

You may want to subscribe the [[Mailinglists|announcement mailinglist]] to learn about future versions.

Note that Woogle is Open Source software developed in a research environment. We are thus constantly '''seeking interested organizations using MediaWiki''' who would like to [[Contact|collaborate with us]] evaluating Woogle and related extensions in their environment.

== Documentation ==
* [[Woogle4MediaWiki/Decider manual]] - for people considering to use Woogle
* [[Woogle4MediaWiki/Admin manual]] - for administrators installing and configuring Woogle
* [[Woogle4MediaWiki/User manual]] - for end users of Woogle
* [[Woogle4MediaWiki/Developer manual]] - for developers contributing to or extending Woogle

Woogle4MediaWiki

2010-04-27T17:19:22Z

Happel:

Woogle4MediaWiki comes as an Extension replacing MediaWiki's build in search (test it in this Wiki!). There is a native PHP implementation for searching the Wiki only ('''WoogleNative''') and an implementation for searching various source via an [[Integrated Search]] backend from within your MediaWiki ('''WoogleRemote''').

For additional information, you might want to see these [http://www.slideshare.net/hhappel/woogle-on-why-and-how-to-marry-wikis-with-enterprise-search presentation slides].

== Online Demo ==
The whole TeamWeaver site (i.e. the search in this Wiki) is running Woogle and allows you to search this Wiki, our SVN and JIRA. For testing the Woogle interface, either use the Search box on top of this page, or go to [[Special:Woogle]]. You can access the same data with the [[Integrated Search]] standard Web frontend online demo.

We have also set up a separate Woogle demo wiki which is rebuildt every night and thus allows you to experiment with it. You can access it at: http://amazonas.fzi.de/wooglenative/

== Download ==
Woogle4MediaWiki is now available for download under GPL license in version 1.0.0 (RC2). We consider the basic functionality rather stable and capable to serve productive systems. Woogle has been successfully tested recently with MediaWiki versions 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248). Prior in development, Woogle was running fine with MW 1.11 and beyond. For details see our [http://www.teamweaver.org/wiki/index.php/Woogle4MediaWiki/Compability compability notes].

Download links:
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Native_v1.0.0-RC2.zip WoogleNative] (searches MediaWiki only)
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Remote_v1.0.0-RC2.zip WoogleRemote] (can search additional data sources; requires [[Integrated Search]])
* see also [[Woogle4MediaWiki/Release Notes]]

You may want to subscribe the [[Mailinglists|announcement mailinglist]] to learn about future versions.

Note that Woogle is Open Source software developed in a research environment. We are thus constantly '''seeking interested organizations using MediaWiki''' who would like to [[Contact|collaborate with us]] evaluating Woogle and related extensions in their environment.

== Documentation ==
* [[Woogle4MediaWiki/Decider manual]] - for people considering to use Woogle
* [[Woogle4MediaWiki/Admin manual]] - for administrators installing and configuring Woogle
* [[Woogle4MediaWiki/User manual]] - for end users of Woogle
* [[Woogle4MediaWiki/Developer manual]] - for developers contributing to or extending Woogle

Woogle4MediaWiki/Release Notes

2010-04-27T17:18:54Z

Happel: /* W4M 1.0-RC2 */

== W4M 1.0-RC2 ==
* Woogle RC2 has been successfully tested recently with MediaWiki versions 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248). Prior in development, Woogle was running fine with MW 1.11 and beyond. For details see our [[Woogle4MediaWiki/Compability|compability notes]]
* Woogle RC2 does not yet fully support if your MediaWiki is using CGI with <code>http://example.com/w/index.php?title=Page_title</code> style URLs [http://www.mediawiki.org/wiki/Manual:Short_URL#Defaults]
* This is the first public beta of Woogle. We consider the basic functionality rather stable, since we are using Woogle internally for around 6 months now.
* Beware that some cleanup and especially a detailed check for security issues is still todo, while intial checks have been done already. However, be careful when exposing Woogle on public sites at this time. Use of Woogle on your own risk.

Woogle4MediaWiki/Release Notes

2010-04-27T17:18:30Z

Happel:

== W4M 1.0-RC2 ==
* Woogle RC2 has been successfully tested recently with MediaWiki versions 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248). Prior in development, Woogle was running fine with MW 1.11 and beyond. For details see our [[Compability compability notes]]
* Woogle RC2 does not yet fully support if your MediaWiki is using CGI with <code>http://example.com/w/index.php?title=Page_title</code> style URLs [http://www.mediawiki.org/wiki/Manual:Short_URL#Defaults]
* This is the first public beta of Woogle. We consider the basic functionality rather stable, since we are using Woogle internally for around 6 months now.
* Beware that some cleanup and especially a detailed check for security issues is still todo, while intial checks have been done already. However, be careful when exposing Woogle on public sites at this time. Use of Woogle on your own risk.

Woogle4MediaWiki

2010-04-27T17:15:49Z

Happel: /* Download */

Woogle4MediaWiki comes as an Extension replacing MediaWiki's build in search (test it in this Wiki!). There is a native PHP implementation for searching the Wiki only (WoogleNative) and an implementation for searching various source via an [[Integrated Search]] backend from within your MediaWiki (WoogleRemote).

For additional information, you might want to see these [http://www.slideshare.net/hhappel/woogle-on-why-and-how-to-marry-wikis-with-enterprise-search presentation slides].

== Online Demo ==
The whole TeamWeaver site (i.e. the search in this Wiki) is running Woogle and allows you to search this Wiki, our SVN and JIRA. For testing the Woogle interface, either use the Search box on top of this page, or go to [[Special:Woogle]]. You can access the same data with the [[Integrated Search]] standard Web frontend online demo.

We have also set up a separate Woogle demo wiki which is rebuildt every night and thus allows you to experiment with it. You can access it at: http://amazonas.fzi.de/wooglenative/

== Download ==
Woogle4MediaWiki is now available for download under GPL license in version 1.0.0 (RC2). We consider the basic functionality rather stable and capable to serve productive systems. Woogle has been successfully tested recently with MediaWiki versions 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248). Prior in development, Woogle was running fine with MW 1.11 and beyond. For details see our [http://www.teamweaver.org/wiki/index.php/Woogle4MediaWiki/Compability compability notes].

Download links:
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Native_v1.0.0-RC2.zip WoogleNative] (searches MediaWiki only)
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Remote_v1.0.0-RC2.zip WoogleRemote] (can search additional data sources; requires [[Integrated Search]])
* see also [[Woogle4MediaWiki/Release Notes]]

You may want to subscribe the [[Mailinglists|announcement mailinglist]] to learn about future versions.

Note that Woogle is Open Source software developed in a research environment. We are thus constantly '''seeking interested organizations using MediaWiki''' who would like to [[Contact|collaborate with us]] evaluating Woogle and related extensions in their environment.

== Documentation ==
* [[Woogle4MediaWiki/Decider manual]] - for people considering to use Woogle
* [[Woogle4MediaWiki/Admin manual]] - for administrators installing and configuring Woogle
* [[Woogle4MediaWiki/User manual]] - for end users of Woogle
* [[Woogle4MediaWiki/Developer manual]] - for developers contributing to or extending Woogle

Woogle4MediaWiki

2010-04-27T17:15:06Z

Happel: /* Online Demo */

Woogle4MediaWiki comes as an Extension replacing MediaWiki's build in search (test it in this Wiki!). There is a native PHP implementation for searching the Wiki only (WoogleNative) and an implementation for searching various source via an [[Integrated Search]] backend from within your MediaWiki (WoogleRemote).

For additional information, you might want to see these [http://www.slideshare.net/hhappel/woogle-on-why-and-how-to-marry-wikis-with-enterprise-search presentation slides].

== Online Demo ==
The whole TeamWeaver site (i.e. the search in this Wiki) is running Woogle and allows you to search this Wiki, our SVN and JIRA. For testing the Woogle interface, either use the Search box on top of this page, or go to [[Special:Woogle]]. You can access the same data with the [[Integrated Search]] standard Web frontend online demo.

We have also set up a separate Woogle demo wiki which is rebuildt every night and thus allows you to experiment with it. You can access it at: http://amazonas.fzi.de/wooglenative/

== Download ==
Woogle4MediaWiki is now available for download under GPL license in version 1.0.0 (RC2). We consider the basic functionality rather stable and capable to serve productive systems. Woogle has been successfully tested recently with MediaWiki versions 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248). Prior in development, Woogle was running fine with MW 1.11 and beyond. For details see our [http://www.teamweaver.org/wiki/index.php/Woogle4MediaWiki/Compability compability notes].

Download links:
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Native_v1.0.0-RC2.zip WoogleNative]
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Remote_v1.0.0-RC2.zip WoogleRemote] (requires [[Integrated Search]])
* see also [[Woogle4MediaWiki/Release Notes]]

You may want to subscribe the [[Mailinglists|announcement mailinglist]] to learn about future versions.

Note that Woogle is Open Source software developed in a research environment. We are thus constantly '''seeking interested organizations using MediaWiki''' who would like to [[Contact|collaborate with us]] evaluating Woogle and related extensions in their environment.

== Documentation ==
* [[Woogle4MediaWiki/Decider manual]] - for people considering to use Woogle
* [[Woogle4MediaWiki/Admin manual]] - for administrators installing and configuring Woogle
* [[Woogle4MediaWiki/User manual]] - for end users of Woogle
* [[Woogle4MediaWiki/Developer manual]] - for developers contributing to or extending Woogle

Woogle4MediaWiki

2010-04-27T17:13:24Z

Happel: /* Online Demo */

Woogle4MediaWiki comes as an Extension replacing MediaWiki's build in search (test it in this Wiki!). There is a native PHP implementation for searching the Wiki only (WoogleNative) and an implementation for searching various source via an [[Integrated Search]] backend from within your MediaWiki (WoogleRemote).

For additional information, you might want to see these [http://www.slideshare.net/hhappel/woogle-on-why-and-how-to-marry-wikis-with-enterprise-search presentation slides].

== Online Demo ==
The Demo is actually based on live data from the TeamWeaver project (including this Wiki, our SVN and JIRA). You can access the same data with the [[Integrated Search]] standard Web frontend online demo.

For testing the Woogle interface, either use the Search box on top of this page, or go to [[Special:Woogle]].

We have also set up a separate Woogle demo wiki which is rebuildt every night and thus allows you to experiment with it. You can access it at: http://amazonas.fzi.de/wooglenative/

== Download ==
Woogle4MediaWiki is now available for download under GPL license in version 1.0.0 (RC2). We consider the basic functionality rather stable and capable to serve productive systems. Woogle has been successfully tested recently with MediaWiki versions 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248). Prior in development, Woogle was running fine with MW 1.11 and beyond. For details see our [http://www.teamweaver.org/wiki/index.php/Woogle4MediaWiki/Compability compability notes].

Download links:
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Native_v1.0.0-RC2.zip WoogleNative]
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Remote_v1.0.0-RC2.zip WoogleRemote] (requires [[Integrated Search]])
* see also [[Woogle4MediaWiki/Release Notes]]

You may want to subscribe the [[Mailinglists|announcement mailinglist]] to learn about future versions.

Note that Woogle is Open Source software developed in a research environment. We are thus constantly '''seeking interested organizations using MediaWiki''' who would like to [[Contact|collaborate with us]] evaluating Woogle and related extensions in their environment.

== Documentation ==
* [[Woogle4MediaWiki/Decider manual]] - for people considering to use Woogle
* [[Woogle4MediaWiki/Admin manual]] - for administrators installing and configuring Woogle
* [[Woogle4MediaWiki/User manual]] - for end users of Woogle
* [[Woogle4MediaWiki/Developer manual]] - for developers contributing to or extending Woogle

Woogle4MediaWiki

2010-04-27T17:12:18Z

Happel: /* Download */

Woogle4MediaWiki comes as an Extension replacing MediaWiki's build in search (test it in this Wiki!). There is a native PHP implementation for searching the Wiki only (WoogleNative) and an implementation for searching various source via an [[Integrated Search]] backend from within your MediaWiki (WoogleRemote).

For additional information, you might want to see these [http://www.slideshare.net/hhappel/woogle-on-why-and-how-to-marry-wikis-with-enterprise-search presentation slides].

== Online Demo ==
The Demo is actually based on live data from the TeamWeaver project (including this Wiki, our SVN and JIRA). You can access the same data with the [[Integrated Search]] standard Web frontend online demo.

For testing the Woogle interface, either use the Search box on top of this page, or go to [[Special:Woogle]].

== Download ==
Woogle4MediaWiki is now available for download under GPL license in version 1.0.0 (RC2). We consider the basic functionality rather stable and capable to serve productive systems. Woogle has been successfully tested recently with MediaWiki versions 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248). Prior in development, Woogle was running fine with MW 1.11 and beyond. For details see our [http://www.teamweaver.org/wiki/index.php/Woogle4MediaWiki/Compability compability notes].

Download links:
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Native_v1.0.0-RC2.zip WoogleNative]
* [http://www.teamweaver.org/downloads/binaries/woogle/Woogle4MediaWiki_Remote_v1.0.0-RC2.zip WoogleRemote] (requires [[Integrated Search]])
* see also [[Woogle4MediaWiki/Release Notes]]

You may want to subscribe the [[Mailinglists|announcement mailinglist]] to learn about future versions.

Note that Woogle is Open Source software developed in a research environment. We are thus constantly '''seeking interested organizations using MediaWiki''' who would like to [[Contact|collaborate with us]] evaluating Woogle and related extensions in their environment.

== Documentation ==
* [[Woogle4MediaWiki/Decider manual]] - for people considering to use Woogle
* [[Woogle4MediaWiki/Admin manual]] - for administrators installing and configuring Woogle
* [[Woogle4MediaWiki/User manual]] - for end users of Woogle
* [[Woogle4MediaWiki/Developer manual]] - for developers contributing to or extending Woogle

Integrated Search/Download

2010-04-27T17:05:42Z

Happel:

== Binary downloads ==
* TeamWeaver [[Integrated Search]]
** version 0.9.8 [http://www.teamweaver.org/downloads/binaries/is/wavesIS_0.9.8.zip wavesIS_0.9.8.zip] (as of 2008-10-14)
** version 0.9.9 [http://www.teamweaver.org/downloads/binaries/is/teamweaverIS_0.9.9.zip teamweaverIS_0.9.9.zip] (as of 2009-04-08)
** version 1.0.0 (RC1) [http://www.teamweaver.org/downloads/binaries/is/teamweaverIS_1.0.0-RC1.zip teamweaverIS_1.0.0-RC1.zip] (as of 2009-06-17)
** version 1.0.0 (RC2 - PRERELEASE) [http://www.teamweaver.org/downloads/binaries/is/teamweaverIS_1.0.0.RC2-PRERELEASE.zip teamweaverIS_1.0.0.RC2-PRERELEASE.zip] (as of 2010-03-17)
** version 1.0.0 (RC2) [http://www.teamweaver.org/downloads/binaries/is/teamweaverIS_1.0.0-RC2.zip teamweaverIS_1.0.0-RC2.zip] (as of 2010-04-26)

* The Wiki search UI can be downloaded at [[Woogle4MediaWiki]]

Note: even if later versions might be denoted "beta" or "release candidate" ("RC") we recommend you to prefer those, unless you have a good reason for not doing so.

== Source code download ==
See http://svn.polarion.org/repos/community/Teamweaver/Teamweaver/trunk/

Woogle4MediaWiki/Compability

2010-04-27T12:46:59Z

Happel:

== Compability with MediaWiki ==
Due to required [http://www.mediawiki.org/wiki/Manual:Hooks Hooks], Woogle4MediaWiki requires [http://www.mediawiki.org/ MediaWiki] in a version >= 1.11.0. It should be theoretically possible to make (parts of) Woogle compatible with earlier versions of MediaWiki by modifying the sources.

Woogle is currently tested up to MediaWiki version 1.15.3, 1.16.0b2 and 1.17.0alpha (r63248) (which are the recent version as of 2010-04-27). There is no fundamental reason, why it should not work with future versions of MediaWiki, although we can not gurantee that.

Other explicit version were are/were developing/testing with (incomplete list):
* MediaWiki 1.11.0
* MediaWiki 1.13.3
* MediaWiki 1.14.0
* MediaWiki 1.15.0

== Compability with Web servers/PHP/mySQL ==
Woogle should work fine in any server environment in which the embedding MediaWiki works. In particular, we are using the following environments (incomplete list):
* CentOS Linux machine (Apache / PHP: 5.1.6 (apache2handler) / MySQL: 5.0.45)
* Windows 2000 Server (Apache / PHP 5.2.6 (apache2handler) / MySQL 5.0.45-community-nt)
* Windows Vista (ApacheFriends XAMPP version 1.7.0 / PHP 5.2.8 (apache2handler) / mySQL 5.1.30-community)

== Compatibility with Web browsers ==
Woogle core features have been successfully tested with:
* Firefox (3.6)
* Internet Explorer (8.0.6001.18904)
* Opera (10.10 Build 1893)
* Chrome (4.1.249.1045 (42898))
* Safari