.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.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
.\" ========================================================================
.\"
.IX Title "Wiki::Toolkit::Formatter::Default 3pm"
.TH Wiki::Toolkit::Formatter::Default 3pm "2021-01-04" "perl v5.32.0" "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"
Wiki::Toolkit::Formatter::Default \- A formatter for Wiki::Toolkit.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A formatter backend for Wiki::Toolkit.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&  my $store     = Wiki::Toolkit::Store::SQLite\->new( ... );
\&  # See below for parameter details.
\&  my $formatter = Wiki::Toolkit::Formatter::Default\->new( %config );
\&  my $wiki      = Wiki::Toolkit\->new( store     => $store,
\&                                      formatter => $formatter );
.Ve
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew\fR" 4
.IX Item "new"
.Vb 6
\&  my $formatter = Wiki::Toolkit::Formatter::Default\->new(
\&                 extended_links  => 0,
\&                 implicit_links  => 1,
\&                 allowed_tags    => [qw(b i)],  # defaults to none
\&                 macros          => {},
\&                 node_prefix     => \*(Aqwiki.cgi?node=\*(Aq );
.Ve
.Sp
Parameters will default to the values shown above (apart from
\&\f(CW\*(C`allowed_tags\*(C'\fR, which defaults to allowing no tags).
.RS 4
.IP "\(bu" 4
macros \- be aware that macros are processed \fIafter\fR filtering
out disallowed \s-1HTML\s0 tags.  Currently macros are just strings, maybe later
we can add in subs if we think it might be useful.
.RE
.RS 4
.Sp
Macro example:
.Sp
.Vb 5
\&  macros => { qr/(^|\eb)\e@SEARCHBOX(\eb|$)/ =>
\&              qq(<form action="wiki.cgi" method="get">
\&                   <input type="hidden" name="action" value="search">
\&                   <input type="text" size="20" name="terms">
\&                   <input type="submit"></form>) }
.Ve
.RE
.IP "\fBformat\fR" 4
.IX Item "format"
.Vb 1
\&  my $html = $formatter\->format( $content );
.Ve
.Sp
Escapes any tags which weren't specified as allowed on creation, then
interpolates any macros, then calls Text::WikiFormat::format (with the
config set up when \fBnew\fR was called) to translate the raw Wiki
language supplied into \s-1HTML.\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Wiki::Toolkit::Formatter::WikiLinkFormatterParent
Wiki::Toolkit
.SH "AUTHOR"
.IX Header "AUTHOR"
Kake Pugh (kake@earth.li).
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 2
\&     Copyright (C) 2002\-2003 Kake Pugh.  All Rights Reserved.
\&     Copyright (C) 2006 the Wiki::Toolkit team. All Rights Reserved.
.Ve
.PP
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.