~ubuntu-branches/ubuntu/vivid/libhtml-wikiconverter-perl/vivid

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Jonas Genannt
  • Date: 2005-12-26 23:42:31 UTC
  • Revision ID: james.westby@ubuntu.com-20051226234231-66czoq4xko7s5p96
Tags: upstream-0.30
ImportĀ upstreamĀ versionĀ 0.30

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
HTML::WikiConverter version 0.30
 
2
================================
 
3
 
 
4
HTML::WikiConverter is an HTML to wiki converter capable of
 
5
converting HTML source into a variety of wiki dialects. Supported
 
6
dialects include:
 
7
 
 
8
  DocuWiki    Kwiki
 
9
  MediaWiki   MoinMoin
 
10
  Oddmuse     PhpWiki
 
11
  PmWiki      SnipSnap
 
12
  TikiWiki    UseMod
 
13
  WakkaWiki
 
14
 
 
15
Converting HTML to wiki markup is easy:
 
16
 
 
17
  use HTML::WikiConverter;
 
18
  my $wc = new HTML::WikiConverter( dialect => 'MediaWiki' );
 
19
  print $wc->html2wiki( $html );
 
20
 
 
21
You can even use the convenient command line interface:
 
22
 
 
23
  % html2wiki --dialect MediaWiki input.html > output.mw
 
24
 
 
25
COMMITTMENT ISSUES?
 
26
 
 
27
Try before you buy:
 
28
 
 
29
  http://diberri.dyndns.org/html2wiki.html
 
30
 
 
31
INSTALLATION
 
32
 
 
33
The easiest way to install this module is via the CPAN shell:
 
34
 
 
35
  % cpan HTML::WikiConverter
 
36
 
 
37
Or if you'd prefer:
 
38
 
 
39
  % perl Makefile.PL
 
40
  % make
 
41
  % make test
 
42
  % make install
 
43
 
 
44
DEPENDENCIES
 
45
 
 
46
  * HTML::Tree for building and manipulating HTML trees
 
47
  * HTML::Entities for encoding HTML entities
 
48
  * URI for handling URIs in links
 
49
  * Getopt::Long for html2wiki's command line interface
 
50
 
 
51
CHANGES IN VERSION 0.30
 
52
 
 
53
  * add support for WakkaWiki, SnipSnap, Oddmuse, and TikiWiki (see http://c2.com/cgi/wiki?TopTenWikiEngines)
 
54
  * add DocuWiki support for links, blockquotes, images, and tables
 
55
  * add 'strip_scripts', 'strip_head', and 'strip_comments' options, on by default
 
56
  * allow reading from HTML files using "html2wiki( file => ... )"
 
57
  * (bug 12944, 12303) preserve HTML entities in text nodes
 
58
  * (bug 13017) MediaWiki should allow <i> and <b> to be preserved rather than converting to '' and '''
 
59
  * backend API changes; dialect modules now subclass HTML::WikiConverter
 
60
  * more complete tests using larger input HTML file
 
61
  * document individual dialects
 
62
  * lots of documentation fixes
 
63
 
 
64
COPYRIGHT
 
65
 
 
66
Copyright (c) 2004-2005 David J. Iberri
 
67
 
 
68
This library is free software; you can redistribute it and/or modify
 
69
it under the same terms as Perl itself.
 
70
 
 
71
See http://www.perl.com/perl/misc/Artistic.html