.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "MojoMojo::Formatter::Wiki 3pm"
.TH MojoMojo::Formatter::Wiki 3pm "2018-01-13" "perl v5.26.1" "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"
MojoMojo::Formatter::Wiki \- Handle interpage linking.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This formatter handles intra-Wiki links specified between double square brackets
or parentheses: [[wiki link]] or ((another wiki link)). It will also indicate
missing links with a question mark and a link to the edit page. Links can be
implicit (like the two above), where the path is derived from the link text
by replacing spaces with underscores (<a href=\*(L"wiki_link\*(R">wiki link</a>), or
explicit, where the path is specified before a '|' sign:
.PP
.Vb 1
\&    [[/explicit/path|Link text goes here]]
.Ve
.PP
Note that external links have a different syntax: [Link text](http://foo.com).
.SH "METHODS"
.IX Header "METHODS"
.SS "format_content_order"
.IX Subsection "format_content_order"
Format order can be 1\-99. The Wiki formatter runs on 10.
.SS "strip_pre"
.IX Subsection "strip_pre"
Replace <pre ... with a placeholder
.SS "reinsert_pre"
.IX Subsection "reinsert_pre"
Put pre and lang back into place.
.SS "format_content"
.IX Subsection "format_content"
Calls the formatter. Takes a ref to the content as well as the
context object.
.SS "format_link <c> <wikilink> <base> [<link_text>]"
.IX Subsection "format_link <c> <wikilink> <base> [<link_text>]"
Format a wikilink as an \s-1HTML\s0 hyperlink with the given link_text. If the wikilink
doesn't exist, it will be rendered as a hyperlink to an .edit page ready to be
created.
.PP
Since there is no difference in syntax between new and existing links, some
abiguities my occur when it comes to characters that are invalid in URLs. For
example,
.PP
* [[say \*(L"\s-1NO\*(R"\s0 to #8]] should be rendered as \f(CW\*(C`<a href="say_%22NO%22_to_%238">say "NO" to #8</a>\*(C'\fR
* [[100% match]] should be rendered as \f(CW\*(C`<a href="100%25_match>100% match</a>\*(C'\fR, URL-escaping the '%'
* but what about a user pasting an existing link, \f(CW\*(C`[[say_%22NO%22_to_%238]]\*(C'\fR? We shouldn't URL-escape the '%' or '#' here.
* for links with explicit link text, we should definitiely not URL-escape the link: \f(CW\*(C`[[say_%22NO%22_to_%238|say "NO" to #8]]\*(C'\fR
.PP
This is complicated by the fact that '#' can delimit the start of the anchor portion of a link.
.PP
* \f(CW\*(C`[[Mambo #5]]\*(C'\fR \- URL-escape '#' => Mambo_%235
* \f(CW\*(C`[[Mambo#origins]]\*(C'\fR \- do not URL-escape
* \f(CW\*(C`[[existing/link#Introduction|See the Introduction]]\*(C'\fR \- definitely do not URL-escape
.PP
Since escaping is somewhat magic and therefore potentially counter-intuitive,
we will:
* only URL-escape '#' if it follows a whitespace directly
* always URL-escape '%' unless it is followed by two uppercase hex digits
* always escape other characters that are invalid in URLs
.SS "expand_wikilink <wikilink>"
.IX Subsection "expand_wikilink <wikilink>"
Replace \f(CW\*(C`_\*(C'\fR with spaces and unescape URL-encoded characters
.SS "find_links <content> <page>"
.IX Subsection "find_links <content> <page>"
Find wiki links in content.
.PP
Return a listref of linked (existing) and wanted pages.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
MojoMojo, Module::Pluggable::Ordered
.SH "AUTHORS"
.IX Header "AUTHORS"
Marcus Ramberg <mramberg@cpan.org>
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software. You can redistribute it and/or modify
it under the same terms as Perl itself.