HTML::WikiConverter - Convert HTML to wiki markup
use HTML::WikiConverter; my $wc = new HTML::WikiConverter( dialect => 'MediaWiki' ); print $wc->html2wiki( $html );
HTML::WikiConverter is an HTML to wiki converter. It can convert HTML source into a variety of wiki markups, called wiki "dialects". The following dialects are supported:
HTML::WikiConverter
DokuWiki Kwiki MediaWiki MoinMoin Oddmuse PhpWiki PmWiki SlipSlap TikiWiki UseMod WakkaWiki WikkaWiki
Note that while dialects usually produce satisfactory wiki markup, not all features of all dialects are supported. Consult individual dialects' documentation for details of supported features. Suggestions for improvements, especially in the form of patches, are very much appreciated.
my $wc = new HTML::WikiConverter( dialect => $dialect, %attrs );
Returns a converter for the specified wiki dialect. Dies if $dialect is not provided or its dialect module is not installed on your system. Attributes may be specified in %attrs; see "ATTRIBUTES" for a list of recognized attributes.
$dialect
%attrs
$wiki = $wc->html2wiki( $html ); $wiki = $wc->html2wiki( html => $html ); $wiki = $wc->html2wiki( file => $file ); $wiki = $wc->html2wiki( file => $file, slurp => $slurp );
Converts HTML source to wiki markup for the current dialect. Accepts either an HTML string $html or an HTML file $file to read from.
$html
$file
You may optionally bypass HTML::Parser's incremental parsing of HTML files (thus slurping the file in all at once) by giving $slurp a true value.
HTML::Parser
$slurp
my $html = $wc->parsed_html;
Returns HTML::TreeBuilder's representation of the last-parsed syntax tree, showing how the input HTML was parsed internally. This is often useful for debugging.
my $dialect = $wc->dialect;
Returns the dialect passed to new.
new
You may configure HTML::WikiConverter using a number of attributes. These may be passed as arguments to the new constructor, or can be called as object methods on a HTML::WikiConverter object.
Some dialects allow other attributes in addition to those below. Consult individual dialect documentation for details.
Required. Dialect to use when converting
URI to use for converting relative URIs to absolute ones. This effectively ensures that the src and href attributes of image and anchor tags, respectively, are absolute before converting the HTML to wiki markup, which is necessary for wiki dialects that handle internal and external links separately. Relative URLs are only converted to absolute ones if the base_uri argument is present. Defaults to undef.
src
href
base_uri
undef
URI used in determining which links are wiki links. This assumes that URLs to wiki pages are created by joining the wiki_uri with the (possibly escaped) wiki page name. For example, the English Wikipedia would use "http://en.wikipedia.org/wiki/", while Ward's wiki would use "http://c2.com/cgi/wiki?". Defaults to undef.
wiki_uri
"http://en.wikipedia.org/wiki/"
"http://c2.com/cgi/wiki?"
Helps HTML::TreeBuilder parse HTML fragments by wrapping HTML in <html> and </html> before passing it through html2wiki. Boolean, enabled by default.
HTML::TreeBuilder
<html>
</html>
html2wiki
Specifies the encoding used by the HTML to be converted. Also determines the encoding of the wiki markup returned by the html2wiki method. Defaults to 'utf8'.
'utf8'
Removes HTML comments from the input before conversion to wiki markup. Boolean, enabled by default.
Removes the HTML head element from the input before converting. Boolean, enabled by default.
head
Removes all HTML script elements from the input before converting. Boolean, enabled by default.
script
Consult HTML::WikiConverter::Dialects for documentation on how to write your own dialect module for HTML::WikiConverter. Or if you're not up to the task, drop me an email and I'll have a go at it when I get a spare moment.
HTML::Tree, HTML::Element
David J. Iberri, <diberri at cpan.org>
<diberri at cpan.org>
Please report any bugs or feature requests to bug-html-wikiconverter at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=HTML-WikiConverter. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-html-wikiconverter at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc HTML::WikiConverter
You can also look for information at:
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/HTML-WikiConverter
CPAN Ratings
http://cpanratings.perl.org/d/HTML-WikiConverter
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=HTML-WikiConverter
Search CPAN
http://search.cpan.org/dist/HTML-WikiConverter
Copyright 2006 David J. Iberri, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install HTML::WikiConverter, copy and paste the appropriate command in to your terminal.
cpanm
cpanm HTML::WikiConverter
CPAN shell
perl -MCPAN -e shell install HTML::WikiConverter
For more information on module installation, please visit the detailed CPAN module installation guide.