Template Parameter Index

From Biowikifarm Metawiki
Revision as of 09:46, 25 January 2010 by GiselaWeber (Talk | contribs) (Created page with '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 ho...')

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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).


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 two special pages are created: Special:TemplateParameterIndex, which displays the complete menu with all functions, and Special:TemplateParameterAnalyzer, which offers only the Analyze Index functions so that $wgGroupPermissions can be set differently for the two.