.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MojoMojo::Formatter::TOC 3pm"
.TH MojoMojo::Formatter::TOC 3pm "2010-05-23" "perl v5.20.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
.SS "module_loaded"
.IX Subsection "module_loaded"
Return true if the module is loaded.
.SH "NAME"
MojoMojo::Formatter::TOC \- generate table of contents
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This formatter will replace \f(CW\*(C`{{toc}}\*(C'\fR with a table of contents, using
HTML::GenToc. If you don't want an element to be included in the \s-1TOC,\s0
make it have \f(CW\*(C`class="notoc"\*(C'\fR
.SH "METHODS"
.IX Header "METHODS"
.SS "format_content_order"
.IX Subsection "format_content_order"
The \s-1TOC\s0 formatter expects \s-1HTML\s0 input so it needs to run after the main
formatter. Since comment-type formatters (order 91) could add a heading
for the comment section, the \s-1TOC\s0 formatter will run with a priority of 95.
.SS "format_content"
.IX Subsection "format_content"
Calls the formatter. Takes a ref to the content as well as the context object.
The syntax for the \s-1TOC\s0 plugin invocation is:
.PP
.Vb 3
\&  {{toc M\- }}     # start from Header level M
\&  {{toc \-N }}     # stop at Header level N
\&  {{toc M\-N }}    # process only header levels M..N
.Ve
.PP
where M is the minimum heading level to include in the \s-1TOC,\s0 and N is the
maximum level (depth). For example, suppose you only have one H1 on the page
so it doesn't make sense to add it to the \s-1TOC\s0; also, assume you and don't want
to include any headers smaller than H3. The {{toc}} markup to achieve that would be:
.PP
.Vb 1
\&  {{toc 2\-3}}
.Ve
.PP
Defaults to 1\-6.
.SS "SEO-friendly anchors"
.IX Subsection "SEO-friendly anchors"
Anchors should be generated with \s-1SEO\- \s0(and human\-) friendly names, i.e. out of the entire
token text, instead of being numeric or reduced to the first word(s) of the token.
In the spirit of http://seo2.0.onreact.com/top\-10\-fatal\-url\-design\-mistakes, compare:
.PP
.Vb 3
\&  http://beachfashion.com/photos/Pamela_Anderson#In_red_swimsuit_in_Baywatch
\&    vs.
\&  http://beachfashion.com/photos/Pamela_Anderson#in
.Ve
.PP
\&\*(L"Which one speaks your language more, which one will you rather click?\*(R"
.PP
The anchor names generated are compliant with \s-1XHTML1.0\s0 Strict. Also, per the
\&\s-1HTML 4.01\s0 spec, anchor names should be restricted to \s-1ASCII\s0 characters and
anchors that differ only in case may not appear in the same document. In
particular, an anchor name may be defined only once in a document (logically,
because otherwise the user agent wouldn't know which #foo to scroll to).
This is currently a problem with HTML::Toc v1.11, which doesn't have
support for passing the already existing anchors to the \f(CW\*(C`templateAnchorName\*(C'\fR
sub.
.SS "assembleAnchorName"
.IX Subsection "assembleAnchorName"
.Vb 1
\& http://search.cpan.org/dist/HTML\-Toc/Toc.pod#templateAnchorName
.Ve
.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.