.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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::Dir 3pm"
.TH MojoMojo::Formatter::Dir 3pm "2017-03-27" "perl v5.24.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::Dir \- format local directory as XHTML
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This formatter will format the directory argument as \s-1XHTML.\s0
Usage:
.PP
.Vb 1
\&    {{dir directory exclude=exclude_regex}}
.Ve
.PP
For security reasons the directory must be include in 'whitelisting'. You can use path_to(\s-1DIR\s0) to describe directory in mojomojo.conf:
.PP
<Formatter::Dir>
    prefix_url /myfiles
    whitelisting _\|_path_to(uploads)_\|_
</Formatter::Dir>
.SH "METHODS"
.IX Header "METHODS"
.IP "format_content_order" 4
.IX Item "format_content_order"
Format order can be 1\-99. The File formatter runs on 92.
.IP "format_content" 4
.IX Item "format_content"
Calls the formatter. Takes a ref to the content as well as the
context object.
.IP "format" 4
.IX Item "format"
Return the content formatted
.IP "to_xhtml" 4
.IX Item "to_xhtml"
Return Directory and files lists in xhtml
.IP "checkdir" 4
.IX Item "checkdir"
Directory must be include in whitelisting
.SH "SEE ALSO"
.IX Header "SEE ALSO"
MojoMojo
.SH "AUTHORS"
.IX Header "AUTHORS"
Daniel Brosseau <dab@catapulse.org>
.SH "LICENSE"
.IX Header "LICENSE"
This module is licensed under the same terms as Perl itself.