Open main menu

Extension:ActiveAbstract

MediaWiki extensions manual
OOjs UI icon advanced.svg
ActiveAbstract
Release status: stable
Implementation Extended syntax
Description Generate an XML feed for Yahoo's Active Abstracts project
Author(s) Brion Vibber
MediaWiki 1.25+
License GNU General Public License 2.0 or later
Download
Translate the ActiveAbstract extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

This extension is used with XML dumps to pull a formatted copy of an article's initial text and its organizational structure. It is one of the filters available for the backup system.

It will pull the first two sentences of the article along with each section heading and wrap them in XML tags and trim the entry to be no longer than 1024 characters.

InstallationEdit

  • Download and place the file(s) in a directory called ActiveAbstract in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'ActiveAbstract' );
    
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

ParametersEdit

ActiveAbstract is run as a plugin for dumpBackup.php:

 php dumpBackup.php \
   --plugin=AbstractFilter:extensions/ActiveAbstract/AbstractFilter.php \
   --current \
   --output=gzip:/dumps/abstract.xml.gz \
     --filter=namespace:NS_MAIN \
     --filter=noredirect \
     --filter=abstract

Where

  • current - pulls only the latest article revision
  • output - sets where the output stream will go
  • filters
    • namespace - only pull documents from this namespace
    • noredirect - don't show redirects
    • abstract - registers the abstracts filter and runs it from within dumpBackup.php
    • variants - if variants exist, pull all latest copies and output them to a separate abstracts file

It can optionally convert output text to a given language variant:

   --filter=abstract:variant=zh-cn

A possible way to run this in production would be

/usr/bin/php -q /apache/common/php-1.5/maintenance/dumpBackup.php   --wiki='quwiki' \
   --plugin=AbstractFilter:/apache/common/php-1.5/extensions/ActiveAbstract/AbstractFilter.php \
   --current   --report=1000   --force-normal   --server='x.x.x.x'  \
   --output=file:/mnt/dumps/public/quwiki/20090613/quwiki-20090613-abstract.xml  \
   --filter=namespace:NS_MAIN     --filter=noredirect     --filter=abstract
force-normal is added for better UTF-8 conversion.

FormattingEdit

The required tags for each entry are:

  • doc
  • title
  • url
  • abstract
  • links
  • sublink

Example ListingEdit

<doc>
	<title>Wikipedia: An American in Paris</title>
	<url>http://en.wikipedia.org/wiki/An_American_in_Paris</url>
	<abstract>An American in Paris is a symphonic composition by American composer George Gershwin, composed in 1928. Inspired .. </abstract>
	<links>
		<sublink linktype="nav"><anchor>Instrumentation</anchor><link>http://en.wikipedia.org/wiki/An_American_in_Paris#Instrumentation</link></sublink>
		<sublink linktype="nav"><anchor>Recordings</anchor><link>http://en.wikipedia.org/wiki/An_American_in_Paris#Recordings</link></sublink>
		<sublink linktype="nav"><anchor>Film</anchor><link>http://en.wikipedia.org/wiki/An_American_in_Paris#Film</link></sublink>
	</links>
</doc>
The <abstract> text is trimmed to not run off this wiki page.