Extension:ActiveAbstract
Appearance
ActiveAbstract Release status: stable |
|
---|---|
Implementation | Extended syntax |
Description | Generate an XML feed for Yahoo's Active Abstracts project |
Author(s) | Brooke Vibbertalk |
Compatibility policy | Snapshots releases along with MediaWiki. Master is not backward compatible. |
MediaWiki | 1.25+ |
License | GNU General Public License 2.0 or later |
Download | |
Quarterly downloads | 9 (Ranked 127th) |
Translate the ActiveAbstract extension if it is available at translatewiki.net | |
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.
Installation
- Download and move the extracted
ActiveAbstract
folder to yourextensions/
directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ActiveAbstract - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'ActiveAbstract' );
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Parameters
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.
Formatting
The required tags for each entry are:
- doc
- title
- url
- abstract
- links
- sublink
Example Listing
<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.This extension is currently being used to generate part of the Wikimedia Xml Database Dumps. It is not meant to be used exclusively within MediaWiki but instead allows for content to be exported from your wiki installation into a specific format. |
This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page. |