.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "HTML::WikiConverter::Markdown 3pm"
.TH HTML::WikiConverter::Markdown 3pm "2022-12-13" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
HTML::WikiConverter::Markdown \- Convert HTML to Markdown markup
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  use HTML::WikiConverter;
\&  my $wc = new HTML::WikiConverter( dialect => \*(AqMarkdown\*(Aq );
\&  print $wc\->html2wiki( $html );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module contains rules for converting \s-1HTML\s0 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.
.SH "ATTRIBUTES"
.IX Header "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 \f(CW\*(C`new()\*(C'\fR
constructor. See \*(L"\s-1ATTRIBUTES\*(R"\s0 in HTML::WikiConverter for usage details.
.SS "header_style"
.IX Subsection "header_style"
Possible values: \f(CW\*(Aqsetext\*(Aq\fR, \f(CW\*(Aqatx\*(Aq\fR. Determines how headers
\&\f(CW\*(C`h1\*(C'\fR\-\f(CW\*(C`h6\*(C'\fR will be formatted. See
<http://daringfireball.net/projects/markdown/syntax#header> for more
information. Default is \f(CW\*(Aqatx\*(Aq\fR.
.SS "link_style"
.IX Subsection "link_style"
Possible values: \f(CW\*(Aqinline\*(Aq\fR, \f(CW\*(Aqreference\*(Aq\fR. See
<http://daringfireball.net/projects/markdown/syntax#link> for more
information. Default is \f(CW\*(Aqreference\*(Aq\fR.
.SS "force_inline_anchor_links"
.IX Subsection "force_inline_anchor_links"
Possible values: \f(CW0\fR, \f(CW1\fR. If enabled, links to anchors within the
same page (eg, \f(CW\*(C`#some\-anchor\*(C'\fR) will always produce inline Markdown
links, even under reference link style. This might be useful for
building tables of contents. Default is \f(CW0\fR.
.SS "image_style"
.IX Subsection "image_style"
Possible values: \f(CW\*(Aqinline\*(Aq\fR, \f(CW\*(Aqreference\*(Aq\fR. See
<http://daringfireball.net/projects/markdown/syntax#img> for more
information. Default is \f(CW\*(Aqreference\*(Aq\fR.
.SS "image_tag_fallback"
.IX Subsection "image_tag_fallback"
Possible values: \f(CW0\fR, \f(CW1\fR. Markdown's image markup does not
support image dimensions. If \f(CW\*(C`image_tag_fallback\*(C'\fR 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 \s-1HTML\s0 form. Default is \f(CW1\fR.
.SS "unordered_list_style"
.IX Subsection "unordered_list_style"
Possible values: \f(CW\*(Aqasterisk\*(Aq\fR, \f(CW\*(Aqplus\*(Aq\fR, \f(CW\*(Aqdash\*(Aq\fR. See
<http://daringfireball.net/projects/markdown/syntax#list> for more
information. Default is \f(CW\*(Aqasterisk\*(Aq\fR.
.SS "ordered_list_style"
.IX Subsection "ordered_list_style"
Possible values: \f(CW\*(Aqsequential\*(Aq\fR, \f(CW\*(Aqone\-dot\*(Aq\fR. Markdown supports two
different markups for ordered lists. Sequential style gives each list
element its own ordinal number (ie, \f(CW\*(Aq1.\*(Aq\fR, \f(CW\*(Aq2.\*(Aq\fR, \f(CW\*(Aq3.\*(Aq\fR,
etc.). One-dot style gives each list element the same ordinal number
(ie, \f(CW\*(Aq1.\*(Aq\fR). See
<http://daringfireball.net/projects/markdown/syntax#list> for more
information. Default is \f(CW\*(Aqsequential\*(Aq\fR.
.SS "md_extra"
.IX Subsection "md_extra"
Possible values: \f(CW0\fR, \f(CW1\fR. Support MarkDown Extra
<https://github.com/jmcmanus/pagedown\-extra> extensions. Default is \f(CW0\fR.
.PP
This support is incomplete.
.PP
.Vb 8
\&    # Tables                            Supported
\&    # Fenced Code Blocks
\&    # Definition Lists          Supported
\&    # Footnotes
\&    # Special Attributes
\&    # SmartyPants
\&    # Newlines
\&    # Strikethrough
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
David J. Iberri, \f(CW\*(C`<diberri at cpan.org>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-html\-wikiconverter\-markdown at rt.cpan.org\*(C'\fR, 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.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc HTML::WikiConverter::Markdown
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/HTML\-WikiConverter\-Markdown>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/d/HTML\-WikiConverter\-Markdown>
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=HTML\-WikiConverter\-Markdown>
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/HTML\-WikiConverter\-Markdown>
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2006 David J. Iberri, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.