Tyler Riddle > Parse-MediaWikiDump > Parse::MediaWikiDump

Download:
Parse-MediaWikiDump-1.0.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View Bugs
Report a bug
Module Version: 1.0.2   Source  

NAME ^

Parse::MediaWikiDump - Tools to process MediaWiki dump files

SYNOPSIS ^

  use Parse::MediaWikiDump;
  
  $pmwd = Parse::MediaWikiDump->new;

  $pages = $pmwd->pages('pages-articles.xml');
  $revisions = $pmwd->revisions('pages-articles.xml');
  $links = $pmwd->links('links.sql');

DESCRIPTION ^

This software suite provides the tools needed to process the contents of the XML page dump files and the SQL based links dump file.

STATUS ^

This software module is stable - there will not be any more API changes nor will there be additional features added. Bugs will be fixed but further development effort will be centered around a replacement for this module.

USAGE ^

This module is a factory class that allows you to create instances of the individual parser objects.

$pmwd->pages

Returns a Parse::MediaWikiDump::Pages object capable of parsing an article XML dump file with one revision per each article.

$pmwd->revisions

Returns a Parse::MediaWikiDump::Revisions object capable of parsing an article XML dump file with multiple revisions per each article.

$pmwd->links

Returns a Parse::MediaWikiDump::Links object capable of parsing an article links SQL dump file.

General

All parser creation invocations require a location of source data to parse; this argument can be either a filename or a reference to an already open filehandle. This entire software suite will die() upon errors in the file or if internal inconsistencies have been detected. If this concerns you then you can wrap the portion of your code that uses these calls with eval().

AUTHOR ^

This module was created, documented, and is maintained by Tyler Riddle <triddle@gmail.com>.

Fix for bug 36255 "Parse::MediaWikiDump::page::namespace may return a string which is not really a namespace" provided by Amir E. Aharoni.

BUGS ^

Please report any bugs or feature requests to bug-parse-mediawikidump@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Parse-MediaWikiDump. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

Known Bugs

No known bugs at this time.

COPYRIGHT & LICENSE ^

Copyright 2005 Tyler Riddle, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.