Scroll to navigation

HTML::WikiConverter::Markdown(3pm) User Contributed Perl Documentation HTML::WikiConverter::Markdown(3pm)

NAME

HTML::WikiConverter::Markdown - Convert HTML to Markdown markup

SYNOPSIS

  use HTML::WikiConverter;
  my $wc = new HTML::WikiConverter( dialect => 'Markdown' );
  print $wc->html2wiki( $html );

DESCRIPTION

This module contains rules for converting HTML into Markdown markup. You should not use this module directly; HTML::WikiConverter is the entry point for html->wiki conversion (eg, see synopsis above). See HTML::WikiConverter for additional usage details.

ATTRIBUTES

In addition to the regular set of attributes recognized by the HTML::WikiConverter constructor, this dialect also accepts the following attributes that can be passed into the "new()" constructor. See "ATTRIBUTES" in HTML::WikiConverter for usage details.
 
header_style
Possible values: 'setext', 'atx'. Determines how headers "h1"-"h6" will be formatted. See <http://daringfireball.net/projects/markdown/syntax#header> for more information. Default is 'atx'.
 
link_style
Possible values: 'inline', 'reference'. See <http://daringfireball.net/projects/markdown/syntax#link> for more information. Default is 'reference'.
 
force_inline_anchor_links
Possible values: 0, 1. If enabled, links to anchors within the same page (eg, "#some-anchor") will always produce inline Markdown links, even under reference link style. This might be useful for building tables of contents. Default is 0.
 
image_style
Possible values: 'inline', 'reference'. See <http://daringfireball.net/projects/markdown/syntax#img> for more information. Default is 'reference'.
 
image_tag_fallback
Possible values: 0, 1. Markdown's image markup does not support image dimensions. If "image_tag_fallback" is enabled, image tags containing dimensional information (ie, width or height) will not be converted into Markdown markup. Rather, they will be roughly preserved in their HTML form. Default is 1.
 
unordered_list_style
Possible values: 'asterisk', 'plus', 'dash'. See <http://daringfireball.net/projects/markdown/syntax#list> for more information. Default is 'asterisk'.
 
ordered_list_style
Possible values: 'sequential', 'one-dot'. Markdown supports two different markups for ordered lists. Sequential style gives each list element its own ordinal number (ie, '1.', '2.', '3.', etc.). One-dot style gives each list element the same ordinal number (ie, '1.'). See <http://daringfireball.net/projects/markdown/syntax#list> for more information. Default is 'sequential'.

AUTHOR

David J. Iberri, "<diberri at cpan.org>"

BUGS

Please report any bugs or feature requests to "bug-html-wikiconverter-markdown at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=HTML-WikiConverter-Markdown>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command. 
    perldoc HTML::WikiConverter::Markdown
You can also look for information at:
•
AnnoCPAN: Annotated CPAN documentation
 
<http://annocpan.org/dist/HTML-WikiConverter-Markdown>
•
CPAN Ratings
 
<http://cpanratings.perl.org/d/HTML-WikiConverter-Markdown>
•
RT: CPAN's request tracker
 
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=HTML-WikiConverter-Markdown>
•
Search CPAN
 
<http://search.cpan.org/dist/HTML-WikiConverter-Markdown>

COPYRIGHT & LICENSE

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.
2008-07-13 perl v5.10.0