.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Parse::MediaWikiDump::Links 3pm"
.TH Parse::MediaWikiDump::Links 3pm "2010-12-05" "perl v5.10.1" "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"
Parse::MediaWikiDump::Links \- Object capable of processing link dump files
.SH "ABOUT"
.IX Header "ABOUT"
This object is used to access content of the \s-1SQL\s0 based category dump files by providing an iterative interface
for extracting the indidivual article links to the same. Objects returned are an instance of Parse::MediaWikiDump::link.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  $pmwd = Parse::MediaWikiDump\->new;
\&  $links = $pmwd\->links(\*(Aqpagelinks.sql\*(Aq);
\&  $links = $pmwd\->links(\e*FILEHANDLE);
\&  
\&  #print the links between articles 
\&  while(defined($link = $links\->next)) {
\&    print \*(Aqfrom \*(Aq, $link\->from, \*(Aq to \*(Aq, $link\->namespace, \*(Aq:\*(Aq, $link\->to, "\en";
\&  }
.Ve
.SH "STATUS"
.IX Header "STATUS"
This software is being \s-1RETIRED\s0 \- MediaWiki::DumpFile is the official successor to
Parse::MediaWikiDump and includes a compatibility library called MediaWiki::DumpFile::Compat
that is 100% \s-1API\s0 compatible and is a near perfect standin for this module. It is faster
in all instances where it counts and is actively maintained. Any undocumented deviation
of MediaWiki::DumpFile::Compat from Parse::MediaWikiDump is considered a bug and will
be fixed.
.SH "METHODS"
.IX Header "METHODS"
.IP "Parse::MediaWikiDump::Links\->new" 4
.IX Item "Parse::MediaWikiDump::Links->new"
Create a new instance of a page links dump file parser
.ie n .IP "$links\->next" 4
.el .IP "\f(CW$links\fR\->next" 4
.IX Item "$links->next"
Return the next available Parse::MediaWikiDump::link object or undef if there is no more data left
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.SS "List all links between articles in a friendly way"
.IX Subsection "List all links between articles in a friendly way"
.Vb 1
\&  #!/usr/bin/perl
\&  
\&  use strict;
\&  use warnings;
\&  
\&  use Parse::MediaWikiDump;
\&  
\&  my $pmwd = Parse::MediaWikiDump\->new;
\&  my $links = $pmwd\->links(shift) or die "must specify a pagelinks dump file";
\&  my $dump = $pmwd\->pages(shift) or die "must specify an article dump file";
\&  my %id_to_namespace;
\&  my %id_to_pagename;
\&  
\&  binmode(STDOUT, \*(Aq:utf8\*(Aq);
\&  
\&  #build a map between namespace ids to namespace names
\&  foreach (@{$dump\->namespaces}) {
\&        my $id = $_\->[0];
\&        my $name = $_\->[1];     
\&  
\&        $id_to_namespace{$id} = $name;
\&  }
\&  
\&  #build a map between article ids and article titles
\&  while(my $page = $dump\->next) {
\&        my $id = $page\->id;
\&        my $title = $page\->title;
\&  
\&        $id_to_pagename{$id} = $title;
\&  }
\&  
\&  $dump = undef; #cleanup since we don\*(Aqt need it anymore
\&  
\&  while(my $link = $links\->next) {
\&        my $namespace = $link\->namespace;
\&        my $from = $link\->from;
\&        my $to = $link\->to;
\&        my $namespace_name = $id_to_namespace{$namespace};      
\&        my $fully_qualified;
\&        my $from_name = $id_to_pagename{$from};
\&  
\&        if ($namespace_name eq \*(Aq\*(Aq) {
\&                #default namespace
\&                $fully_qualified = $to;
\&        } else {
\&                $fully_qualified = "$namespace_name:$to";
\&        }
\&  
\&        print "Article \e"$from_name\e" links to \e"$fully_qualified\e"\en";
\&  }
.Ve