.\" 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::CPANHyperlink 3pm"
.TH MojoMojo::Formatter::CPANHyperlink 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::CPANHyperlink \- automatically hyperlink CPAN modules when
using the syntax {{cpan Some::Module}}
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Normally, to hyperlink to a \s-1CPAN\s0 module, you'd write:
.PP
.Vb 1
\&    [MojoMojo::Formatter::CPANHyperlink](http://search.cpan.org/perldoc?MojoMojo::Formatter::CPANHyperlink)
.Ve
.PP
This plugin lets you write just
.PP
.Vb 1
\&    {{cpan MojoMojo::Formatter::CPANHyperlink}}
.Ve
.PP
Just like \s-1POD,\s0 it supports adding a section after the module name:
.PP
.Vb 1
\&    {{cpan Catalyst::Manual::Cookbook/Deployment}}
.Ve
.PP
will create a link to
.PP
.Vb 1
\&    http://search.cpan.org/perldoc?Catalyst::Manual::Cookbook#Deployment
.Ve
.PP
Sections can contain any characters, except two consecutive closed braces:
.PP
.Vb 1
\&    {{cpan Catalyst::Test/($res, $c) = ctx request( ... ); }}
.Ve
.PP
will link to
.PP
.Vb 1
\&    http://search.cpan.org/perldoc?Catalyst::Test#($res,_$c)_=_ctx_request(_..._);
.Ve
.PP
In anticipation of future plugin syntax, you can optionally add a trailing slash
.PP
.Vb 1
\&    {{cpan Some::Module/Section /}}
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "format_content_order"
.IX Subsection "format_content_order"
The CPANHyperlink formatter has no special requirements in terms of the order
it gets run in, so it has a priority of 10.
.SS "format_content"
.IX Subsection "format_content"
Calls the formatter. Takes a ref to the content as well as the context object.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
MojoMojo and Module::Pluggable::Ordered.
.SH "AUTHORS"
.IX Header "AUTHORS"
Dan Dascalescu, <http://dandascalescu.com>
.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.