README
1HTML::WikiConverter readme
2==========================
3
4HTML::WikiConverter is an HTML to wiki converter capable of converting
5HTML source into a variety of wiki dialects. It's aimed at folks who
6are converting vanilla HTML websites into wikis.
7
8The following dialects (and more) are supported:
9
10 DokuWiki
11 GoogleCode
12 Kwiki
13 Markdown
14 MediaWiki
15 MoinMoin
16 Oddmuse
17 PbWiki
18 PhpWiki
19 PmWiki
20 SnipSnap
21 Socialtext
22 TikiWiki
23 UseMod
24 WakkaWiki
25 WikkaWiki
26
27INSTALLATION
28
29The HTML::WikiConverter module is just an interface; you must select
30the wiki dialects you would like to use. You may install dialect
31modules individually (see below) or install Bundle::HTMLWikiConverter
32to get most of the dialect modules in one shot:
33
34 % perl -MCPAN -e 'install Bundle::HTMLWikiConverter'
35
36For just the HTML::WikiConverter interface:
37
38 % perl -MCPAN -e 'install HTML::WikiConverter'
39
40Individual dialects can be installed separately; for example:
41
42 % perl -MCPAN -e 'install HTML::WikiConverter::MediaWiki'
43 % perl -MCPAN -e 'install HTML::WikiConverter::PhpWiki'
44
45SYNOPSIS
46
47Converting HTML to wiki markup is easy:
48
49 use HTML::WikiConverter;
50 my $wc = new HTML::WikiConverter( dialect => 'MediaWiki' );
51 print $wc->html2wiki( $html );
52
53The included html2wiki utility converts on the command line:
54
55 % html2wiki --dialect MediaWiki \
56 --base-uri http://en.wikipedia.org \
57 --wiki-uri /wiki/ \
58 input.html > output.mw
59
60A web application is also provided with this distribution, called
61HTML::WikiConverter::WebApp. It provides a web interface to this
62module and any installed dialects. Detailed instructions on
63installation and usage are provided in the INSTALL file.
64
65PREREQUISITES
66
67The following are required for a basic installation:
68
69 * Test::More
70 * Pod::Usage
71 * Class::Data::Inheritable
72 * Params::Validate
73 * URI and URI::Escape
74 * HTML::TreeBuilder
75 * HTML::Tagset
76 * HTML::Entities
77 * HTML::Element
78 * CSS
79
80CGI::Application and XML::Writer are required if you will be using the
81installed web application, HTML::WikiConverter::WebApp. (My apologies;
82I'll make them optional in a future release.)
83
84BUGS
85
86This module is far from perfect. Please report bugs to rt.cpan.org.
87
88THANKS TO
89
90 * Tatsuhiko Miyagawa for suggestions and code
91 * Dave Schaefer for the PbWiki dialect and for the idea behind the
92 new C<attributes()> implementation.
93 * Martin Kudlvasr for fixing a bug in how 'wrap_in_html' was applied to
94 HTML read from files
95
96COPYRIGHT
97
98Copyright (c) David J. Iberri <diberri@cpan.org>
99
100This library is free software; you can redistribute it and/or modify
101it under the same terms as Perl itself.
102
103See http://www.perl.com/perl/misc/Artistic.html
104