NAME

Mediawiki::POD::HTML - a subclass to catch X keywords and =head lines

SYNOPSIS

use Mediawiki::POD::HTML;

my $parser = Mediawiki::POD::HTML->new();

my $html = $parser->parse_string_document($POD);

DESCRIPTION

Turns a given POD (Plain Old Documentation) into HTML code.

This subclass of Pod::Simple::HTML catches =head directives, and then allows you to assemble a TOC (table of contents) from the captured headlines.

METHODS

get_headlines()

Return all the captured headlines as an ARRAY ref.

keyword_search_url()

Get/set the URL that is used to link keywords defined with X<> to a search engine.

If the URL contains a text ##KEYWORD##, then this text will be replaced with the actual keyword. Otherwise, the keyword is simple appended to the URL.

The default search URL is:

http://cpan.uwinnipeg.ca/search?query=##KEYWORD##

Examples:

# External search engine
$parser->keyword_search_url('http://search.cpan.org/perldoc?');

# will generate URLs like "example", perfect for relative links
$parser->keyword_search_url('');

LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms of the GPL.

See the LICENSE file for information.

AUTHOR

(c) by Tels bloodgate.com 2007

SEE ALSO

http://bloodgate.com/wiki/.