.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "MediaWiki::DumpFile::FastPages 3pm" .TH MediaWiki::DumpFile::FastPages 3pm "2021-01-09" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" MediaWiki::DumpFile::FastPages \- Fastest way to parse a page dump file .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use MediaWiki::DumpFile::FastPages; \& \& $pages = MediaWiki::DumpFile::FastPages\->new($file); \& $pages = MediaWiki::DumpFile::FastPages\->new(\e*FH); \& \& while(($title, $text) = $pages\->next) { \& print "Title: $title\en"; \& print "Text: $text\en"; \& } .Ve .SH "ABOUT" .IX Header "ABOUT" This is a subclass of MediaWiki::DumpFile::Pages that configures it to run in fast mode and uses a custom iterator that dispenses with the duck-typed MediaWiki::DumpFile::Pages::Page object that fast mode uses giving a slight processing speed boost. .PP See the MediaWiki::DumpFile::Pages documentation for information about fast mode. .SH "METHODS" .IX Header "METHODS" All of the methods of MediaWiki::DumpFile::Pages are also available on this subclass. .SS "new" .IX Subsection "new" This is the constructor for this package. It is called with a single parameter: the location of a MediaWiki pages dump file or a reference to an already open file handle. .SS "next" .IX Subsection "next" Returns a two element list where the first element is the article title and the second element is the article text. Returns an empty list when there are no more pages available. .SH "AUTHOR" .IX Header "AUTHOR" Tyler Riddle, \f(CW\*(C`\*(C'\fR .SH "BUGS" .IX Header "BUGS" Please see MediaWiki::DumpFile for information on how to report bugs in this software. .SH "HISTORY" .IX Header "HISTORY" This package originally started life as a very limited hack using only XML::LibXML::Reader and seeking to text and title nodes in the document. Implementing a parser for the full document was a daunting task and this package sat in the hopes that other people might find it useful. .PP Because XML::TreePuller can expose the underlying XML::LibXML::Reader object and sync itself back up after the cursor was moved out from underneath it, I was able to integrate the logic from this package into the main ::Pages parser. .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2009 \*(L"Tyler Riddle\*(R". .PP This program is free software; you can redistribute it and/or modify it under the terms of either: the \s-1GNU\s0 General Public License as published by the Free Software Foundation; or the Artistic License. .PP See http://dev.perl.org/licenses/ for more information.