.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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 "HTML::Template::Compiled::Utils 3pm" .TH HTML::Template::Compiled::Utils 3pm "2022-11-19" "perl v5.36.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" HTML::Template::Compiled::Utils \- Utility functions for HTML::Template::Compiled .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& # import log() and stack() \& use HTML::Template::Compiled::Utils qw(:log); \& \& # import the escapign functions \& use HTML::Template::Compiled::Utils qw(:escape); .Ve .SH "DEBUGGING FUNCTIONS" .IX Header "DEBUGGING FUNCTIONS" .SS "stack" .IX Subsection "stack" .Vb 1 \& $self\->stack; .Ve .PP For HTML::Template:Compiled developers, prints a stack trace to \s-1STDERR.\s0 .SS "md5" .IX Subsection "md5" .Vb 1 \& md5($text) .Ve .PP If Digest::MD5 is installed, returns the md5_base64 for \f(CW$text\fR, otherwise returns the empty string. .SS "log" .IX Subsection "log" .Vb 1 \& $self\->log(@msg) .Ve .PP For HTML::Template::Compiled developers, print log from \f(CW@msg\fR to \s-1STDERR.\s0 .SH "ESCAPING FUNCTIONS" .IX Header "ESCAPING FUNCTIONS" .SS "escape_html" .IX Subsection "escape_html" .Vb 1 \& my $escaped_html = escape_html($raw_html); .Ve .PP HTML-escapes the input string (only &, ", single quotes, \f(CW\*(C`<\*(C'\fR and \f(CW\*(C`\*(C'\fR> and returns it; .SS "escape_html_all" .IX Subsection "escape_html_all" .Vb 1 \& my $escaped_html = escape_html_all($raw_html); .Ve .PP HTML-escapes the input string (with HTML::Entities) and returns it; .SS "escape_uri" .IX Subsection "escape_uri" .Vb 1 \& my $escaped_uri = escape_uri($raw_uri); .Ve .PP URI-escapes the input string and returns it; .SS "escape_js" .IX Subsection "escape_js" .Vb 1 \& my $escaped_js = escape_js($raw_js); .Ve .PP JavaScript-escapes the input string and returns it; .SS "escape_ijson" .IX Subsection "escape_ijson" .Vb 1 \& my $escaped_js = escape_ijson($raw_js); .Ve .PP JavaScript-escapes the input string except for the apostrophe and returns it, so it can be used within a \s-1JSON\s0 element.