Difference between revisions of "Extension:Template Parameter Index"

Revision as of 09:52, 7 December 2010

The Template Parameter Index is a Wiki extension designed to harvest information from any template present on wiki pages into an index or cache table. The result is similar to how mediawiki handles categories, links and other relations. The extension uses the mediawiki XML-API and has the ability to harvest other wikis in addition to its own datasource. The external wikis are defined in a special configuration page, linked through the SpecialPage:TemplateParameterIndex. In addition, in the local wiki, page updates will automatically update the TemplateParameterIndex.

The harvested information is exposed through an analysis functionality on the Special page, and through an xml-interface. The latter is used to ingest information into a FEDORA repository (see Definition_specs_for_Fedora_Ingestion_Service#Interaction_between_Ingest_and_Wiki_TemplateParameterIndex).

The xml export is accessible via user interface or via url.

Current Main menu of user interface:

   * Manage Index
         o Clear Index     [= deletes all data from the data table]
         o Update Index (Update for defined time period) [= queries api.php for recentchanges in articles, newly uploaded 
           files and file overrides in the given period, passes the found pages to harvest]
         o Rebuild Entire Index (Clear index and restart) [= deletes all data from the data table, queries api.php for 
           allpages, passes the found pages to harvest]
         o Rebuild Indices Selectively By Source (not yet implemented)
         o Update Page [= user chooses wiki via BaseUrl, user enters page name, both are passed to harvest]
         o Configure TemplateParameterIndex [= link to configuration page on which parameters are defined e.g. the URLs of the
           Wikis that are to be harvested]
   * Analyze Index
         o Show Templates - pages, parameters [shows all indexed templates, for each template the pages which use it, 
           and all parameters which it uses, for the parameters the pages and values]
   * Export Index
         o Export Index by Recent Changes and Parameters [= queries the data table with parameters entered by user, 
           exports result as XML]
         

Currently 3 special pages are created:

• Special:TemplateParameterIndex, which displays the complete menu with all functions
• Special:TemplateParameterAnalyzer, which offers only the Analyze Index functions
• Special:TemplateParameterExport, which offers xml export either via user interface or via url (http://.../index.php?title=Spezial:TemplateParameterExport&action=submit&do=export) with the following parameters:
  • selectwiki - article path of the selected wiki, in user interface all available are offered in a select box, if not set, all are returned
  • template - one template name, by default all are returned
  • pagename - one wiki page, by default all are returned
  • from - start date
  • to - end date
  • parname - name of a parameter for a restriction, currently only one possible
  • parvalue - value of that parameter for the desired restriction
  • returnpar - list of parameters that are to be returned, separated by ";"
  • outxml - set to "old" to get the output xml with elements not nested, default is nested

Installation

In your $IP/extensions folder create a TemplateParameterIndex folder, and decompress the files to this folder. Manually execute TemplateParameterIndex/template_parameter_usage.sql in your wiki database to create the table for the template harvesting. Also execute the file template_parameter_jobs.sql to create a job monitoring table. Install the extension by adding to LocalSettings.php:

 include_once("$IP/extensions/TemplateParameterIndex/TemplateParameterIndex.php");

If external wikis are to be harvested, create a page "MediaWiki:TemplateParameterIndex/configurations" (this is the default name, can be overwritten in LocalSettings.php) where parameters will be entered in the form: * parametername = parametervalue.

$wgGroupPermissions['sysop']['templateparameterindex'] = true; 
$wgGroupPermissions['user']['templateparameteranalyzer'] = true; 
$wgGroupPermissions['user']['templateparameterexport'] = true;

are set as default group Permissions. They can also be overwritten in LocalSettings.php.