Extension:MathSearch

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
Math Search
Release status: experimental
Implementation Search, Special page
Description Integrates MathWeb Search engine
Author(s) Schubi87
Latest version 0.1.0 (July 2012(2012-07))
MediaWiki 1.20+
Database changes Yes
Tables mathindex
mathsearch
License GPLv2
Download
Example FormulaSearchEngine
Parameters
  • $wgMathSearchDB2ConnStr
  • $wgMathSearchMWSUrl
  • $wgMathSearchDB2Table
Added rights
MathDebug
Hooks used
LoadExtensionSchemaUpdates
MathFormulaRendered
UnitTestsList
Translate the MathSearch extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

The MathSearch extension integrates the MathWeb Search engine as well as the BaseX search engine to MediaWiki.

Prerequisites[edit]

This extension requires some preconfiguration effort. You should plan 15 to 20 minutes for the installation of the prerequisites.

  • Math Extension in LaTeXML mode see here
  • A local installation of the MathWeb Search daemon as described in here is recommended.
  • A local installation of the BaseX REST search as described here.

At the current stage of development only MySQL is supported as database type.

For some features Extension:Geshi is required.

Installation[edit]

  • Download and place the file(s) in a directory called MathSearch in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/MathSearch/MathSearch.php";
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters[edit]

$wgMWSUrl: The link to your (local) MathWeb Search installation e.g. "http://localhost:8090";

$wgMathSearchBaseX: The link to your (local) BaseX installation e.g. "http://localhost:10043";

Text search[edit]

Text search works best with CirrusSearch, but the default MySQL search works as well.

Indexing[edit]

In order to use the MathSearch capabilities you have to create indexes for the formulas in your wiki. At the moment updates are not supported. So you have to re-index every time the equations change. If you have frequent changes it might be good to install a cron-job.

Change to

cd /your/path/to/mediawiki/extensions/MathSearch/maintenance

run

php UpdateMath.php

run

php CreateMWSHarvest.php /srv/mathsearch/mws-dump/ 30000 --mwsns="mws:"

This is the default (MWS_HARVEST_PATH="../data/wiki") path. If you have changed the path in /your/path/to/mediawiki/extensions/MathSearch/mws/config/mws_services.conf you have to specify another part