.\" 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::Controller::Page 3pm"
.TH MojoMojo::Controller::Page 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::Controller::Page \- Page controller
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This controller is the main juice of MojoMojo. It handles all the
actions related to wiki pages. Actions are redispatched to this
controller based on MojoMojo's custom prepare_path method.
.PP
Every private action here expects to have a page path in args. They
can be called with urls like \*(L"/page1/page2.action\*(R".
.SH "ACTIONS"
.IX Header "ACTIONS"
.SS "view (.view)"
.IX Subsection "view (.view)"
This is probably the most common action in MojoMojo. A lot of the
other actions redispatch to this one. It will prepare the stash
for page view, and set the template to \f(CW\*(C`view.tt\*(C'\fR, unless another is
already set.
.PP
It also takes an optional 'rev' parameter, in which case it will
load the provided revision instead.
.SS "search (.search)"
.IX Subsection "search (.search)"
This action is called as \f(CW\*(C`.search\*(C'\fR on the current page when the user
performs a search.  The user can choose to search the entire site or a
subtree starting from the current page.
.SS "print"
.IX Subsection "print"
This action is the same as the \*(L"view\*(R" action, but with a printer-friendly
template.
.SS "inline"
.IX Subsection "inline"
Same as \*(L"view\*(R" action, but with a template that only outputs the barebones
body of the page. There are no headers, footers, or navigation bars. Useful
for transclusion (see MojoMojo::Formatter::Include).
.SS "inline_tags (.inline_tags)"
.IX Subsection "inline_tags (.inline_tags)"
Tag list for the bottom of page views.
.ie n .SS "pages_viewable($c, $user, @pages)"
.el .SS "pages_viewable($c, \f(CW$user\fP, \f(CW@pages\fP)"
.IX Subsection "pages_viewable($c, $user, @pages)"
Filters an array of pages, returning only those that the given user has
permission to view.
.SS "list (.list)"
.IX Subsection "list (.list)"
All nodes in this namespace. Computes tags, all pages, backlinks, wanted and
orphan pages.
.SS "subtree (.subtree)"
.IX Subsection "subtree (.subtree)"
Display all pages that are part of the subtree for the current node.
.SS "recent (.recent)"
.IX Subsection "recent (.recent)"
Recently changed pages in this namespace. Also computes the most used
tags.
.SS "feeds (.feeds)"
.IX Subsection "feeds (.feeds)"
Overview of available feeds for this node.
.SS "rss (.rss)"
.IX Subsection "rss (.rss)"
\&\s-1RSS\s0 feed with headlines of recent nodes in this namespace.
.SS "atom (.atom)"
.IX Subsection "atom (.atom)"
Full content \s-1ATOM\s0 feed of recent nodes in this namespace.
.SS "rss_full (.rss_full)"
.IX Subsection "rss_full (.rss_full)"
Full content \s-1RSS\s0 feed of recent nodes in this namespace.
.SS "export (.export)"
.IX Subsection "export (.export)"
Page showing available export options.
.SS "suggest (.suggest)"
.IX Subsection "suggest (.suggest)"
\&\*(L"Page not found\*(R" page, suggesting alternatives, and allowing creation of the page.
Root::auto detaches here for actions on nonexistent pages (e.g. c<bogus.export>).
.SS "search_inline (.search/inline)"
.IX Subsection "search_inline (.search/inline)"
Search results embeddable in another page (for use with \*(L"suggest\*(R").
.SS "info (.info)"
.IX Subsection "info (.info)"
Meta information about the current page: revision list, content size, number of
children and descendants, links to/from, attachments.
.SH "AUTHOR"
.IX Header "AUTHOR"
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.