.\" 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::File 3pm"
.TH MojoMojo::Formatter::File 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::File \- format file as XHTML
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This formatter will format the file argument as \s-1XHTML.\s0
.PP
Usage: {{file \s-1TYPE\s0 filename}}
.PP
.Vb 1
\&       {{file Text uploads/Files/test.txt}}
.Ve
.PP
\&\s-1TYPE\s0 is a plugin present in Formatter/File/ directory.
.PP
Currently there are only three: Pod, DocBook and Text
.PP
The plugin \s-1TYPE\s0 format only the file which the extension match with 'can_format' method. Respectively pod, xml and txt for existing plugins.
.PP
For security reasons the path of file must be include in 'whitelisting' directory. You can use path_to(\s-1DIR\s0) to describe directory in mojomojo.conf:
.PP
Just an example to view the test pod file t/var/files/test.pod :
.PP
Add this to mojomojo.conf :
.PP
<Formatter::Dir>
    prefix_url /myfiles
    whitelisting _\|_path_to(t/var/files)_\|_
</Formatter::Dir>
.PP
To see the pod content formatted in xhtml, write in the text area:
.PP
{{file Pod path_to(t/var/files)test.pod}}
.PP
To show recursively all files of directory see script/util/dir2mojomojo.pl script. To test it:
.PP
# start mojomojo
.PP
\&./script/mojomojo_server.pl
.PP
# run dir2mojomojo script
.PP
\&./script/util/dir2mojomojo.pl \-\-dir=~/dev/mojomojo/t/var/files/ \-\-url=/myfiles
.PP
Connect to http://server:3000/myfiles/
.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 "plugin" 4
.IX Item "plugin"
Return the plugin to use with file attachment
.IP "format" 4
.IX Item "format"
Return the content formatted
.IP "checkplugin" 4
.IX Item "checkplugin"
Return 0 if plugin exist
.IP "checkfile" 4
.IX Item "checkfile"
Directory must be include in whitelisting
.SH "SEE ALSO"
.IX Header "SEE ALSO"
MojoMojo,Module::Pluggable::Ordered
.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.