.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Template::Plugin::HTML::Strip 3"
.TH Template::Plugin::HTML::Strip 3 2023-07-21 "perl v5.38.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
Template::Plugin::HTML::Strip \- HTML::Strip filter for Template Toolkit
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  [% USE HTML.Strip %]
\&
\&  [% FILTER html_strip %]
\&  <title>People for the Preservation of Presentational Markup</title>
\&  <h1>HTML::Strip \- A cause for concern?</h1>
\&  [% END %]
\&
\&  [% USE HTML.Strip \*(Aqstrip\*(Aq
\&      striptags   = [ \*(Aqscript\*(Aq \*(Aqiframe\*(Aq ]
\&      emit_spaces = 0
\&  %]
\&
\&  [% FILTER strip %]
\&  <p>A call to arms against the removal of our elements!</p>
\&  [% END %]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is a Template Toolkit dynamic filter, which uses HTML::Strip
to remove markup (primarily HTML, but also SGML, XML, etc) from filtered
content during template processing.
.PP
By default, the installed filter's name is 'html_strip'.  This can be
changed by specifying a new name as the first positional argument
during plugin usage:
.PP
.Vb 1
\&  [% USE HTML.Strip \*(Aqstrip\*(Aq %]
\&
\&  [% \*(Aq<div>Our very existence is under threat.</div>\*(Aq | strip %]
.Ve
.PP
The filter can optionally take configuration options, which will be
passed to HTML::Strip's constructor method:
.PP
.Vb 4
\&  [% USE HTML.Strip
\&      striptags   = [ \*(Aqapplet\*(Aq \*(Aqstrong\*(Aq ]
\&      emit_spaces = 0
\&  %]
\&
\&  [% FILTER html_strip %]
\&  <strong>Are we next!?</strong>
\&  [% END %]
.Ve
.PP
For more details on available configuration options, please refer to
HTML::Strip.
.SH METHODS
.IX Header "METHODS"
.SS init
.IX Subsection "init"
Creates a dynamic filter and installs the filter under the value provided
for the first positional argument, otherwise uses 'html_strip'.
.SS filter
.IX Subsection "filter"
Receives a reference to the plugin object, along with the text to be
filtered and configuration options.  Using HTML::Strip, returns the filtered
(stripped) text.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Template, HTML::Strip
.SH AUTHOR
.IX Header "AUTHOR"
Geoff Simmons <gsimmons@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2005 Geoff Simmons
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.