local-lib5/man/man3/Template::Plugin::HTML.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Template::Plugin::HTML 3"
 132 .TH Template::Plugin::HTML 3 "2009-05-20" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Template::Plugin::HTML \- Plugin to create HTML elements
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&    [% USE HTML %]
 139 .Ve
 140 .PP
 141 .Vb 1
 142 \&    [% HTML.escape("if (a < b && c > d) ..." %]
 143 .Ve
 144 .PP
 145 .Vb 1
 146 \&    [% HTML.element(table => { border => 1, cellpadding => 2 }) %]
 147 .Ve
 148 .PP
 149 .Vb 1
 150 \&    [% HTML.attributes(border => 1, cellpadding => 2) %]
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 The \f(CW\*(C`HTML\*(C'\fR plugin is a very basic plugin, implementing a few useful
 155 methods for generating \s-1HTML\s0.
 156 .SH "METHODS"
 157 .IX Header "METHODS"
 158 .Sh "escape(text)"
 159 .IX Subsection "escape(text)"
 160 Returns the source text with any \s-1HTML\s0 reserved characters such as
 161 \&\f(CW\*(C`<\*(C'\fR, \f(CW\*(C`>\*(C'\fR, etc., correctly esacped to their entity equivalents.
 162 .Sh "attributes(hash)"
 163 .IX Subsection "attributes(hash)"
 164 Returns the elements of the hash array passed by reference correctly
 165 formatted (e.g. values quoted and correctly escaped) as attributes for
 166 an \s-1HTML\s0 element.
 167 .Sh "element(type, attributes)"
 168 .IX Subsection "element(type, attributes)"
 169 Generates an \s-1HTML\s0 element of the specified type and with the attributes
 170 provided as an optional hash array reference as the second argument or
 171 as named arguments.
 172 .PP
 173 .Vb 3
 174 \&    [% HTML.element(table => { border => 1, cellpadding => 2 }) %]
 175 \&    [% HTML.element('table', border=1, cellpadding=2) %]
 176 \&    [% HTML.element(table => attribs) %]
 177 .Ve
 178 .SH "DEBUGGING"
 179 .IX Header "DEBUGGING"
 180 The \s-1HTML\s0 plugin accepts a \f(CW\*(C`sorted\*(C'\fR option as a constructor argument
 181 which, when set to any true value, causes the attributes generated by
 182 the \f(CW\*(C`attributes()\*(C'\fR method (either directly or via \f(CW\*(C`element()\*(C'\fR) to be
 183 returned in sorted order.  Order of attributes isn't important in
 184 \&\s-1HTML\s0, but this is provided mainly for the purposes of debugging where
 185 it is useful to have attributes generated in a deterministic order
 186 rather than whatever order the hash happened to feel like returning
 187 the keys in.
 188 .PP
 189 .Vb 2
 190 \&    [% USE HTML(sorted=1) %]
 191 \&    [% HTML.element( foo => { charlie => 1, bravo => 2, alpha => 3 } ) %]
 192 .Ve
 193 .PP
 194 generates:
 195 .PP
 196 .Vb 1
 197 \&    <foo alpha="3" bravo="2" charlie="1">
 198 .Ve
 199 .SH "AUTHOR"
 200 .IX Header "AUTHOR"
 201 Andy Wardley <abw@wardley.org> <http://wardley.org/>
 202 .SH "COPYRIGHT"
 203 .IX Header "COPYRIGHT"
 204 Copyright (C) 1996\-2007 Andy Wardley.  All Rights Reserved.
 205 .PP
 206 This module is free software; you can redistribute it and/or
 207 modify it under the same terms as Perl itself.
 208 .SH "SEE ALSO"
 209 .IX Header "SEE ALSO"
 210 Template::Plugin