Extension:MathSearch

MediaWiki extensions manual
Math Search
Release status: stable
Implementation Search, Special page
Description Integrates MathWeb Search engine
Author(s) Schubi87
Latest version 0.2.0
MediaWiki 1.34+
Database changes Yes
Tables mathindex
mathsearch
mathidentifier
mathlog
mathobservation
mathpagesimilarity
mathrevisionstat
mathsemantics
mathvarstat
math_mlp
math_review_list
math_wbs_entity_map
math_wbs_text_store
mathpage9
License GNU General Public License 2.0 or later
Download
Example FormulaSearchEngine
  • $wgMathAnalysisTableName
  • $wgMathDebug
  • $wgMathProfileQIdMap
  • $wgMathSearchPropertyScrUrl
  • $wgMathSearchPropertySwhid
  • $wgMathSearchMWSUrl
  • $wgMathWmcServer
  • $wgMathUpdateObservations
  • $wgMathSearchPropertyProfileType
  • $wgMathSearchWikidataUrl
  • $wgMathSearchBaseXBackendUrl
  • $wgMathWmcMaxResults
  • $wgMathUploadEnabled
  • $wgContentMathEnableWikibaseDataType
  • $wgMathSearchTranslationUrl
  • $wgMathProfileQueries
  • $wgMathSearchPropertyPointInTime
  • $wgMathSearchInfoPage
  • $wgMathSearchContentTexMaxLength
  • $wgMathOpenAlexQIdMap
MathDebug
Quarterly downloads 2 (Ranked 138th)
Translate the MathSearch extension if it is available at translatewiki.net
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.

Only MySQL is supported as database type.

For some features Extension:SyntaxHighlight is required.

Installation edit

  • Download and move the extracted MathSearch folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MathSearch
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'MathSearch' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  •   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.

Testing the Web Search edit

On MediaWiki with MathSearch extension installed, the Special:MathSearch page can be found. Here, Wikipages can be found by the tex or MathML expressions specified in the structured search-fields. Make sure, the indexing steps have been done before and MWS or BaseX is activated.

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.


From the mediawiki root, run:

php extensions/MathSearch/maintenance/UpdateMath.php

then run:

php extensions/MathSearch/maintenance/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