Merge branch 'dirtyhack/strip_underline_blank'
[perl-HTML-WikiConverter-DokuWiki.git] / README-modified-module.html
blob011e6b34e76b3af7c33dc3d0fb0f2d3a3fa70884
1 <p>DokuWiki dialect module for HTML::WikiConverter with my improvements, as compared to the version found at CPAN.</p>
3 <p>The improvements were needed for a practical application of the conversion to cumbersome generated HTML.</p>
5 <p>You can get it from
6 https://gitorious.org/html-to-dokuwiki/perl-html-wikiconverter-dokuwiki
7 or
8 http://repo.or.cz/w/perl-HTML-WikiConverter-DokuWiki.git
9 .</p>
11 <h5>A simple way to use it:</h5>
13 <p>If you have HTML::WikiConverter installed (from a distro package
14 like perl-HTML-WikiConverter-0.68-alt1 in my case or from CPAN),
15 you can put the modified module inside a directory, say MY_PERL, as MY_PERL/HTML/WikiConverter/DokuWiki.pm and then run the converter like this:</p>
17 <pre>PERLLIB=MY_PERL html2wiki --dialect=DokuWiki --no-wrap-in-html mydoc.htm > mydoc.txt</pre>
19 <p>(Remember, MY_PERL is your directory for Perl code; in my case, it's simply a subdir in the directory where the documents are.)</p>
21 <h6>how to get HTML::WikiConverter</h6>
23 <p>A prerequisite is HTML::WikiConverter. You must be able to install it
24 from your distro; in RHEL, Fedora, CentOS, try:</p>
26 <pre>yum install perl-HTML-WikiConverter</pre>
28 <p>in ALTLinux:</p>
30 <pre>apt-get install perl-HTML-WikiConverter</pre>
32 Or get it from CPAN (which is less preferred, because there might be
33 problems with dependencies/compatibility):
35 <pre>cpan HTML::WikiConverter</pre>
37 <h5>New features</h5>
38 <p>For the design of the code of the new features, and other their
39 general usefulness (for other dialects), see the other README-*
40 files.</p>