Brian Cassidy > WWW-Wikipedia-2.00 > WWW::Wikipedia::Entry

Download:
WWW-Wikipedia-2.00.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  1
View/Report Bugs
Source   Latest Release: WWW-Wikipedia-2.01

NAME ^

WWW::Wikipedia::Entry - A class for representing a Wikipedia Entry

SYNOPSIS ^

    my $wiki = WWW::Wikipedia->new();
    my $entry = $wiki->search( 'Perl' );
    print $entry->text();

    my $entry_es = $entry->language( 'es' );
    print $entry_es->text();

DESCRIPTION ^

WWW::Wikipedia::Entry objects are usually created using the search() method on a WWW::Wikipedia object to search for a term. Once you've got an entry object you can then extract pieces of information from the entry using the following methods.

METHODS ^

new()

You probably won't use this one, it's the constructor that is called behind the scenes with the correct arguments by WWW::Wikipedia::search().

text()

The brief text for the entry. This will provide the first paragraph of text; basically everything up to the first heading. Ordinarily this will be what you want to use. When there doesn't appear to be summary text you will be returned the fulltext instead.

If text() returns nothing then you probably are looking at a disambiguation entry, and should use related() to lookup more specific entries.

text_basic()

The same as text(), but not run through Text::Autoformat.

fulltext()

Returns the full text for the entry, which can be extensive.

fulltext_basic()

The same as fulltext(), but not run through Text::Autoformat.

title()

Returns a title of the entry.

related()

Returns a list of terms in the wikipedia that are mentioned in the entry text.

categories()

Returns a list of categories which the entry is part of. So Perl is part of the Programming languages category.

headings()

Returns a list of headings used in the entry.

raw()

Returns the raw wikitext for the entry.

language()

With no parameters, it will return the current language of the entry. By specifying a two-letter language code, it will return the same entry in that language, if available.

languages()

Returns an array of two letter language codes denoting the languages in which this entry is available.

AUTHORS ^

Ed Summers <ehs@pobox.com>

Brian Cassidy <bricas@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright 2003-2011 by Ed Summers

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

syntax highlighting: