.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Pod::Simple::Wiki::Markdown 3pm"
.TH Pod::Simple::Wiki::Markdown 3pm "2015-11-09" "perl v5.20.2" "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"
Pod::Simple::Wiki::Markdown \- A class for creating Pod to Markdown wiki filters.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This module isn't used directly. Instead it is called via \f(CW\*(C`Pod::Simple::Wiki\*(C'\fR:
.PP
.Vb 1
\&    #!/usr/bin/perl \-w
\&
\&    use strict;
\&    use Pod::Simple::Wiki;
\&
\&
\&    my $parser = Pod::Simple::Wiki\->new(\*(Aqmarkdown\*(Aq);
\&
\&    ...
.Ve
.PP
Convert Pod to a markdown wiki format using the installed \f(CW\*(C`pod2wiki\*(C'\fR utility:
.PP
.Vb 1
\&    pod2wiki \-\-style markdown file.pod > file.wiki
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Pod::Simple::Wiki::Markdown\*(C'\fR module is used for converting Pod text to Markdown text.
.PP
Pod (Plain Old Documentation) is a simple markup language used for writing Perl documentation.
.PP
This module isn't generally invoked directly. Instead it is called via \f(CW\*(C`Pod::Simple::Wiki\*(C'\fR. See the Pod::Simple::Wiki and pod2wiki documentation for more information.
.SH "METHODS"
.IX Header "METHODS"
Pod::Simple::Wiki::Markdown inherits all of the methods of \f(CW\*(C`Pod::Simple\*(C'\fR and \f(CW\*(C`Pod::Simple::Wiki\*(C'\fR. See Pod::Simple and Pod::Simple::Wiki for more details.
.SH "Markdown Specific information"
.IX Header "Markdown Specific information"
Some format features of Pod are not present in base Markdown (and vice-versa).  In particular this module supports both code blocks and definition lists \- in a somewhat inconsistent fashion.  Code blocks are supported using GitHub Markdown syntax: three backticks at the start and end of the codeblock.  Definition lists are (crudely) supported in the \s-1PHP\s0 Markdown Extra syntax: A colon followed by three spaces starting the line with the definition.  \s-1PHP\s0 Markdown Extra works with the GitHub syntax, so this should not cause a problem.  (GitHub does not support definition lists.)  This module also creates nested definition lists \- which may or may not be supported.  (And may need extra newlines entered, which is beyond the technical limits of this module.)
.PP
Links are always output in the universal [link text](link source) format, even when it's redundant, or overlong.  Anything \s-1POD\s0 considers a link will be treated as one, even if it's not a valid link.  (In particular, automatic 'man page' links will not point to anything useful \- the user will be required to turn \f(CW\*(C`(Pod::Simple)\*(C'\fR into something useful, likely your favorite interface for \s-1CPAN.\s0)
.PP
Escapes are automatically applied to asterisks, underscores, backticks, and backslashes, and they are always required.  Markdown provides escapes for other characters (in particular braces and parenthesis), but they are not required in all cases.  I leave it up to the user to determine when they would be considered formatting and when they wouldn't.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module also installs a \f(CW\*(C`pod2wiki\*(C'\fR command line utility. See \f(CW\*(C`pod2wiki \-\-help\*(C'\fR for details.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
Thanks to Daniel T. Staal for patches, documentation or bugfixes.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
Please refer to the \s-1DISCLAIMER OF WARRANTY\s0 in Pod::Simple::Wiki.
.SH "AUTHORS"
.IX Header "AUTHORS"
John McNamara jmcnamara@cpan.org
.PP
Daniel T. Staal DStaal@usa.net
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
MMIII-MMXV, John McNamara, Daniel T. Staal
.PP
All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.