local-lib5/man/man3/Template::Plugin::URL.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::URL 3"
 132 .TH Template::Plugin::URL 3 "2008-11-13" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Template::Plugin::URL \- Plugin to construct complex URLs
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&    [% USE url('/cgi\-bin/foo.pl') %]
 139 .Ve
 140 .PP
 141 .Vb 2
 142 \&    [% url(debug = 1, id = 123) %]
 143 \&       # ==> /cgi/bin/foo.pl?debug=1&amp;id=123
 144 .Ve
 145 .PP
 146 .Vb 1
 147 \&    [% USE mycgi = url('/cgi\-bin/bar.pl', mode='browse', debug=1) %]
 148 .Ve
 149 .PP
 150 .Vb 2
 151 \&    [% mycgi %]
 152 \&       # ==> /cgi/bin/bar.pl?mode=browse&amp;debug=1
 153 .Ve
 154 .PP
 155 .Vb 2
 156 \&    [% mycgi(mode='submit') %]
 157 \&       # ==> /cgi/bin/bar.pl?mode=submit&amp;debug=1
 158 .Ve
 159 .PP
 160 .Vb 2
 161 \&    [% mycgi(debug='d2 p0', id='D4\-2k[4]') %]
 162 \&       # ==> /cgi\-bin/bar.pl?mode=browse&amp;debug=d2%20p0&amp;id=D4\-2k%5B4%5D
 163 .Ve
 164 .SH "DESCRIPTION"
 165 .IX Header "DESCRIPTION"
 166 The \f(CW\*(C`URL\*(C'\fR plugin can be used to construct complex URLs from a base stem
 167 and a hash array of additional query parameters.
 168 .PP
 169 The constructor should be passed a base \s-1URL\s0 and optionally, a hash array
 170 reference of default parameters and values.  Used from with a template,
 171 it would look something like the following:
 172 .PP
 173 .Vb 3
 174 \&    [% USE url('http://www.somewhere.com/cgi\-bin/foo.pl') %]
 175 \&    [% USE url('/cgi\-bin/bar.pl', mode='browse') %]
 176 \&    [% USE url('/cgi\-bin/baz.pl', mode='browse', debug=1) %]
 177 .Ve
 178 .PP
 179 When the plugin is then called without any arguments, the default base
 180 and parameters are returned as a formatted query string.
 181 .PP
 182 .Vb 1
 183 \&    [% url %]
 184 .Ve
 185 .PP
 186 For the above three examples, these will produce the following outputs:
 187 .PP
 188 .Vb 3
 189 \&    http://www.somewhere.com/cgi\-bin/foo.pl
 190 \&    /cgi\-bin/bar.pl?mode=browse
 191 \&    /cgi\-bin/baz.pl?mode=browse&amp;debug=1
 192 .Ve
 193 .PP
 194 Note that additional parameters are separated by '\f(CW\*(C`&amp;\*(C'\fR' rather than
 195 simply '\f(CW\*(C`&\*(C'\fR'.  This is the correct behaviour for \s-1HTML\s0 pages but is,
 196 unfortunately, incorrect when creating URLs that do not need to be
 197 encoded safely for \s-1HTML\s0.  This is likely to be corrected in a future
 198 version of the plugin (most probably with \s-1TT3\s0).  In the mean time, you
 199 can set \f(CW$Template::Plugin::URL::JOINT\fR to \f(CW\*(C`&\*(C'\fR to get the correct
 200 behaviour.
 201 .PP
 202 Additional parameters may be also be specified to the \s-1URL:\s0
 203 .PP
 204 .Vb 1
 205 \&    [% url(mode='submit', id='wiz') %]
 206 .Ve
 207 .PP
 208 Which, for the same three examples, produces:
 209 .PP
 210 .Vb 3
 211 \&    http://www.somewhere.com/cgi\-bin/foo.pl?mode=submit&amp;id=wiz
 212 \&    /cgi\-bin/bar.pl?mode=browse&amp;id=wiz
 213 \&    /cgi\-bin/baz.pl?mode=browse&amp;debug=1&amp;id=wiz
 214 .Ve
 215 .PP
 216 A new base \s-1URL\s0 may also be specified as the first option:
 217 .PP
 218 .Vb 1
 219 \&    [% url('/cgi\-bin/waz.pl', test=1) %]
 220 .Ve
 221 .PP
 222 producing
 223 .PP
 224 .Vb 3
 225 \&    /cgi\-bin/waz.pl?test=1
 226 \&    /cgi\-bin/waz.pl?mode=browse&amp;test=1
 227 \&    /cgi\-bin/waz.pl?mode=browse&amp;debug=1&amp;test=1
 228 .Ve
 229 .PP
 230 The ordering of the parameters is non-deterministic due to fact that
 231 Perl's hashes themselves are unordered.  This isn't a problem as the
 232 ordering of \s-1CGI\s0 parameters is insignificant (to the best of my knowledge).
 233 All values will be properly escaped thanks to some code borrowed from
 234 Lincoln Stein's \f(CW\*(C`CGI\*(C'\fR module.  e.g.
 235 .PP
 236 .Vb 2
 237 \&    [% USE url('/cgi\-bin/woz.pl') %]
 238 \&    [% url(name="Elrich von Benjy d'Weiro") %]
 239 .Ve
 240 .PP
 241 Here the spaces and "\f(CW\*(C`'\*(C'\fR" character are escaped in the output:
 242 .PP
 243 .Vb 1
 244 \&    /cgi\-bin/woz.pl?name=Elrich%20von%20Benjy%20d%27Weiro
 245 .Ve
 246 .PP
 247 An alternate name may be provided for the plugin at construction time
 248 as per regular Template Toolkit syntax.
 249 .PP
 250 .Vb 2
 251 \&    [% USE mycgi = url('cgi\-bin/min.pl') %]
 252 \&    [% mycgi(debug=1) %]
 253 .Ve
 254 .SH "AUTHOR"
 255 .IX Header "AUTHOR"
 256 Andy Wardley <abw@wardley.org> <http://wardley.org/>
 257 .SH "COPYRIGHT"
 258 .IX Header "COPYRIGHT"
 259 Copyright (C) 1996\-2007 Andy Wardley.  All Rights Reserved.
 260 .PP
 261 This module is free software; you can redistribute it and/or
 262 modify it under the same terms as Perl itself.
 263 .SH "SEE ALSO"
 264 .IX Header "SEE ALSO"
 265 Template::Plugin