Extension:ActiveAbstract

Purpose
This extension is used by the XML Dumps to pull a formatted copy of an articles 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 will trim the entry to be no longer then 1024.

Parameters
Abstract filter it run as a plugin to dumpBackup.php and can be invoked like

php dumpBackup.php \ --plugin=AbstractFilter:extensions/ActiveAbstract/AbstractFilter.php \ --current \ --output=gzip:/dumps/abstract.xml.gz \ --filter=namespace:NS_MAIN \ --filter=noredirect \ --filter=abstract Can optionally convert output text to a given language variant: --filter=abstract:variant=zh-cn

Where
 * current - pulls only the latest article revision
 * output - sets where our 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 copy and output it to a separate abstracts file

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

note: force-normal is added for better utf8 conversion

Formatting
The required tags for each entry are:


 * doc
 * title
 * url
 * abstract
 * links
 * sublink

Example Listing
Wikipedia: An American in Paris http://en.wikipedia.org/wiki/An_American_in_Paris An American in Paris is a symphonic composition by American composer George Gershwin, composed in 1928. Inspired .. Instrumentation http://en.wikipedia.org/wiki/An_American_in_Paris#Instrumentation Recordings http://en.wikipedia.org/wiki/An_American_in_Paris#Recordings Film http://en.wikipedia.org/wiki/An_American_in_Paris#Film

note: text trimmed to not run off the page for this wiki