Tk Library Source Code

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506

'\" '\" Copyright (c) 1998-2000 by Ajuba Solutions. '\" All rights reserved. '\" '\" RCS: @(#) $Id: html.n,v 1.13 2001/10/17 17:27:26 andreas_kupries Exp $ '\" .so man.macros .TH html n 1.0 Html "HTML Generation" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME ::html \- Procedures to generate HTML structures. .SH SYNOPSIS .BS .sp \fBpackage require Tcl 8.2\fR .sp \fBpackage require html ?1.1.1?\fR .sp \fBhtml::author\fR \fIauthor\fR .sp \fBhtml::bodyTag\fR \fIargs\fR .sp \fBhtml::cell\fR \fIparam value {tag td}\fR .sp \fBhtml::checkbox\fR \fIname value\fR .sp \fBhtml::checkSet\fR \fIkey sep list\fR .sp \fBhtml::checkValue\fR \fIname {value 1}\fR .sp \fBhtml::closeTag\fR \fI\fR .sp \fBhtml::default\fR \fIkey {param {}}\fR .sp \fBhtml::description\fR \fIdescription\fR .sp \fBhtml::end\fR \fI\fR .sp \fBhtml::eval\fR \fIarg ?args?\fR .sp \fBhtml::extractParam\fR \fIparam key {val ""}\fR .sp \fBhtml::font\fR \fIargs\fR .sp \fBhtml::for\fR \fIstart test next body\fR .sp \fBhtml::foreach\fR \fIvarlist1 list1 ?varlist2 list2 ...? body\fR .sp \fBhtml::formatCode\fR \fIcode\fR .sp \fBhtml::formValue\fR \fIname {defvalue {}}\fR .sp \fBhtml::getFormInfo\fR \fIargs\fR .sp \fBhtml::getTitle\fR \fI\fR .sp \fBhtml::h\fR \fIlevel string {param {}}\fR .sp \fBhtml::h1\fR \fIstring {param {}}\fR .sp \fBhtml::h2\fR \fIstring {param {}}\fR .sp \fBhtml::h3\fR \fIstring {param {}}\fR .sp \fBhtml::h4\fR \fIstring {param {}}\fR .sp \fBhtml::h5\fR \fIstring {param {}}\fR .sp \fBhtml::h6\fR \fIstring {param {}}\fR .sp \fBhtml::hdrRow\fR \fIargs\fR .sp \fBhtml::head\fR \fItitle\fR .sp \fBhtml::headTag\fR \fIstring\fR .sp \fBhtml::if\fR \fIexpr1 body1 ?\fBelseif\fR expr2 body2 ...? ?\fBelse\fR bodyN?\fR .sp \fBhtml::keywords\fR \fIargs\fR .sp \fBhtml::mailto\fR \fIemail {subject {}}\fR .sp \fBhtml::meta\fR \fIargs\fR .sp \fBhtml::minorMenu\fR \fIlist {sep { | }}\fR .sp \fBhtml::minorList\fR \fIlist {ordered { 0 }}\fR .sp \fBhtml::openTag\fR \fItag args\fR .sp \fBhtml::passwordInput\fR \fI{name password}\fR .sp \fBhtml::passwordInputRow\fR \fIlabel {name password}\fR .sp \fBhtml::quoteFormValue\fR \fIvalue\fR .sp \fBhtml::radioSet\fR \fIkey sep list\fR .sp \fBhtml::radioValue\fR \fIname value\fR .sp \fBhtml::refresh\fR \fIseconds {url {}}\fR .sp \fBhtml::init\fR \fI{nvlist {}}\fR .sp \fBhtml::row\fR \fIargs\fR .sp \fBhtml::paramRow\fR \fIlist {rparam {}} {cparam {}}\fR .sp \fBhtml::select\fR \fIname param choices {current {}}\fR .sp \fBhtml::selectPlain\fR \fIname param choices {current {}}\fR .sp \fBhtml::set\fR \fIvar val\fR .sp \fBhtml::submit\fR \fIlabel {name submit}\fR .sp \fBhtml::tableFromArray\fR \fIarrname {param {}} {pat *}\fR .sp \fBhtml::tableFromList\fR \fIquerylist {param {}}\fR .sp \fBhtml::textarea\fR \fIname {param {}} {current {}}\fR .sp \fBhtml::textInput\fR \fIname args\fR .sp \fBhtml::textInputRow\fR \fIlabel name args\fR .sp \fBhtml::title\fR \fItitle\fR .sp \fBhtml::varEmpty\fR \fIname\fR .sp \fBhtml::while\fR \fItest body\fR .BE .SH DESCRIPTION .PP The \fB::html\fR package provides commands that generate HTML. These commands typically return an HTML string as their result. In particular, they do not output their result to \fBstdout\fR. .PP The \fBhtml::init\fP procedure should be called early to initialize the module. You can also use this procedure to define default values for HTML tag parameters. .TP \fBhtml::author\fR \fIauthor\fR \fISide effect only\fP. Call this before \fBhtml::head\fR to define an author for the page. The author is noted in a comment in the HEAD section. .TP \fBhtml::bodyTag\fR \fIargs\fR Generate a BODY tag. The tag parameters are taken from \fIargs\fP or from the body.* attributes define with \fBhtml::init\fR .TP \fBhtml::cell\fR \fIparam value {tag td}\fR Generate a TD (or TH) tag, a value, and a closing TD (or TH) tag. The tag parameters come from \fIparam\fP or TD.* attributes defined with \fBhtml::init\fR. This uses \fBhtml::font\fP to insert a standard FONT tag into the table cell. .TP \fBhtml::checkbox\fR \fIname value\fR Generate a CHECKBOX form element with the specified name and value. This uses \fBhtml::checkValue\fR. .TP \fBhtml::checkSet\fR \fIkey sep list\fR Generate a set of CHECKBOX form elements and associated labels. The \fIlist\fP should contain an alternating list of labels and values. This uses \fBhtml::checkbox\fR. .TP \fBhtml::checkValue\fR \fIname {value 1}\fR Generate the "name=\fIname\fP value=\fIval\fP for a CHECKBOX form element. If the CGI variable \fIname\fP has the value \fIval\fP, then SELECTED is added to the return value. .TP \fBhtml::closeTag\fR \fI\fR Pop a tag off the stack created by \fBhtml::openTag\fR and generate the corresponding close tag (e.g., /BODY) .TP \fBhtml::default\fR \fIkey {param {}}\fR This procedure is used by \fBhtml::tagParam\fP to generate the name, value list of parameters for a tag. The \fBhtml::default\fR procedure is used to generate default values for those items not already in \fIparam\fP. If the value identified by \fIkey\fP matches a value in \fIparam\fP then this procedure returns the empty string. Otherwise, it returns a \fIparameter=value\fR string for a form element identified by \fIkey\fP. The \fIkey\fP has the form \fItag.parameter\fR (e.g., body.bgcolor). Use \fBhtml::init\fP to register default values. .TP \fBhtml::description\fR \fIdescription\fR \fISide effect only\fP. Call this before \fBhtml::head\fR to define a description META tag for the page. This tag is generated later in the call to \fBhtml::head\fR. .TP \fBhtml::end\fR \fI\fR Pop all open tags from the stack and generate the corresponding close HTML tags, (e.g., </body></html>). .TP \fBhtml::eval\fR \fIarg ?args?\fR This procedure is similar to the built-in Tcl \fBeval\fR command. The only difference is that it returns "" so it can be called from an HTML template file without appending unwanted results. .TP \fBhtml::extractParam\fR \fIparam key {varName ""}\fR This is a parsing procedure that extracts the value of \fIkey\fP from \fIparam\fP, which is a HTML-style \fIname=quotedvalue\fP list. \fIvarName\fP is used as the name of a Tcl variable that is changed to have the value found in the parameters. The function returns 1 if the parameter was found in \fIparam\fP, otherwise it returns 0. If the \fIvarName\fP is not specified, then \fIkey\fP is used as the variable name. .TP \fBhtml::font\fR \fIargs\fR Generate a standard FONT tag. The parameters to the tag are taken from \fIargs\fP and the HTML defaults defined with \fBhtml::init\fP. .TP \fBhtml::for\fR \fIstart test next body\fR This procedure is similar to the built-in Tcl \fBfor\fR control structure. Rather than evaluating the body, it returns the subst'ed \fIbody\fR. Each iteration of the loop causes another string to be concatenated to the result value. .TP \fBhtml::foreach\fR \fIvarlist1 list1 ?varlist2 list2 ...? body\fR This procedure is similar to the built-in Tcl \fBforeach\fR control structure. Rather than evaluating the body, it returns the subst'ed \fIbody\fR. Each iteration of the loop causes another string to be concatenated to the result value. .TP \fBhtml::formValue\fR \fIname {defvalue {}}\fR Return a name and value pair, where the value is initialized from existing CGI data, if any. The result has this form: .DS name="fred" value="freds value" .DE .TP \fBhtml::getFormInfo\fR \fIargs\fR Generate hidden fields to capture form values. If \fIargs\fP is empty, then hidden fields are generated for all CGI values. Otherwise args is a list of string match patterns for form element names. .TP \fBhtml::getTitle\fR \fI\fR Return the title string, with out the surrounding TITLE tag, set with a previous call to \fBhtml::title\fP. .TP \fBhtml::h\fR \fIlevel string {param {}}\fR Generate a heading (e.g., H1) tag. The \fIstring\fP is nested in the heading, and \fIparam\fP is used for the tag parameters. .TP \fBhtml::h1\fR \fIstring {param {}}\fR Generate an H1 tag. See \fBhtml::h\fR .TP \fBhtml::h2\fR \fIstring {param {}}\fR Generate an H2 tag. See \fBhtml::h\fR .TP \fBhtml::h3\fR \fIstring {param {}}\fR Generate an H3 tag. See \fBhtml::h\fR .TP \fBhtml::h4\fR \fIstring {param {}}\fR Generate an H4 tag. See \fBhtml::h\fR .TP \fBhtml::h5\fR \fIstring {param {}}\fR Generate an H5 tag. See \fBhtml::h\fR .TP \fBhtml::h6\fR \fIstring {param {}}\fR Generate an H6 tag. See \fBhtml::h\fR .TP \fBhtml::hdrRow\fR \fIargs\fR Generate a table row, including TR and TH tags. Each value in \fIargs\fP is place into its own table cell. This uses \fIhtml::cell\fP. .TP \fBhtml::head\fR \fItitle\fR Generate the HEAD section that includes the page TITLE. If previous calls have been made to \fBhtml::author\fP, \fBhtml::keywords\fP, \fBhtml::description\fP, of \fBhtml::meta\fP then additional tags are inserted into the HEAD section. This leaves an open HTML tag pushed on the stack with \fBopenTag\fP. .TP \fBhtml::headTag\fR \fIstring\fR Save a tag for inclusion in the HEAD section generated by \fBhtml::head\fR. The \fIstring\fP is everything in the tag except the enclosing angle brackets, < >. .TP \fBhtml::if\fR \fIexpr1 body1 ?\fBelseif\fR expr2 body2 ...? ?\fBelse\fR bodyN?\fR This procedure is similar to the built-in Tcl \fBif\fR control structure. Rather than evaluating the body of the branch that is taken, it returns the subst'ed \fIbody\fR. Note that the syntax is slightly more restrictive than that of the built-in Tcl \fBif\fR control structure. .TP \fBhtml::keywords\fR \fIargs\fR \fISide effect only\fP. Call this before \fBhtml::head\fR to define a keyword META tag for the page. The META tag is included in the result of \fBhtml::head\fP. .TP \fBhtml::mailto\fR \fIemail {subject {}}\fR Generate a hypertext link to a mailto: URL. .TP \fBhtml::meta\fR \fIargs\fR \fISide effect only\fP. Call this before \fBhtml::head\fR to define a META tag for the page. The \fIargs\fP is a Tcl-style name, value list that is used for the name= and value= parameters for the META tag. The META tag is included in the result of \fBhtml::head\fP. .TP \fBhtml::minorMenu\fR \fIlist {sep { | }}\fR Generate a series of hypertext links. The \fIlist\fP is a Tcl-style name, value list of labels and urls for the links. The \fIsep\fP is the text to put between each link. .TP \fBhtml::minorList\fR \fIlist {ordered { 0 }}\fR Generate an ordered or unordered list of links. The \fIlist\fP is a Tcl-style name, value list of labels and urls for the links. \fIordered\fP is a boolean used to choose between an ordered or unordered list. .TP \fBhtml::openTag\fR \fItag args\fR Push \fItag\fP onto a stack and generate the opening tag for \fItag\fP. Use \fBhtml::closeTag\fP to pop the tag from the stack. .TP \fBhtml::passwordInput\fR \fI{name password}\fR Generate an INPUT tag of type PASSWORD. .TP \fBhtml::passwordInputRow\fR \fIlabel {name password}\fR Format a table row containing a label and an INPUT tag of type PASSWORD. .TP \fBhtml::quoteFormValue\fR \fIvalue\fR Quote special characters in \fIvalue\fP by replacing them with HTML entities for quotes, ampersand, and angle brackets. .TP \fBhtml::radioSet\fR \fIkey sep list\fR Generate a set of INPUT tags of type RADIO and an associated text label. All the radio buttons share the same \fIkey\fP for their name. The \fIsep\fP is text used to separate the elements. The \fIlist\fP is a Tcl-style label, value list. .TP \fBhtml::radioValue\fR \fIname value\fR Generate the "name=\fIname\fP value=\fIval\fP for a RADIO form element. If the CGI variable \fIname\fP has the value \fIval\fP, then SELECTED is added to the return value. .TP \fBhtml::refresh\fR \fIseconds url\fR Set up a refresh META tag. Call this before \fBhtml::head\fP and the HEAD section will contain a META tag that causes the document to refresh in \fIseconds\fP seconds. The \fIurl\fP is optional. If specified, it specifies a new page to load after the refresh interval. .TP \fBhtml::init\fR \fI{list {}}\fR \fBhtml::init\fP accepts a Tcl-style name-value list that defines values for items with a name of the form \fItag\fP.\fIparameter\fP. For example, a default with key \fBbody.bgcolor\fP defines the background color for the BODY tag. .TP \fBhtml::row\fR \fIargs\fR Generate a table row, including TR and TD tags. Each value in \fIargs\fP is place into its own table cell. This uses \fIhtml::cell\fP. .TP \fBhtml::paramRow\fR \fIlist {rparam {}} {cparam {}}\fR Generate a table row, including TR and TD tags. Each value in \fIlist\fP is place into its own table cell. This uses \fIhtml::cell\fP. The value of \fIrparam\fP is used as parameter for the TR tag. The value of \fIcparam\fP is passed to \fIhtml::cell\fP as parameter for the TD tags. .TP \fBhtml::select\fR \fIname param choices {current {}}\fR Generate a SELECT form element and nested OPTION tags. The \fIname\fP and \fIparam\fP are used to generate the SELECT tag. The \fIchoice\fP list is a Tcl-style name, value list. .TP \fBhtml::selectPlain\fR \fIname param choices {current {}}\fR Like \fBhtml::select\fP except that \fIchoices\fP is a Tcl list of values used for the OPTION tags. The label and the value for each OPTION are the same. .TP \fBhtml::submit\fR \fIlabel {name submit}\fR Generate an INPUT tag of type SUBMIT. .TP \fBhtml::set\fR \fIvar val\fR This procedure is similar to the built-in Tcl \fBset\fR command. The main difference is that it returns "" so it can be called from an HTML template file without appending unwanted results. The other difference is that it must take two arguments. .TP \fBhtml::tableFromArray\fR \fIarrname {param {}} {pat *}\fR Generate a TABLE and nested rows to display a Tcl array. The \fIparam\fP are for the TABLE tag. The \fIpat\fP is a string match pattern used to select array elements. .TP \fBhtml::tableFromList\fR \fIquerylist {param {}}\fR Generate a TABLE and nested rows to display \fIquerylist\fP, which is a Tcl-style name, value list. The \fIparam\fP are for the TABLE tag. .TP \fBhtml::textarea\fR \fIname {param {}} {current {}}\fR Generate a TEXTAREA tag wrapped around its current values. .TP \fBhtml::textInput\fR \fIname args\fR Generate an INPUT form tag with type TEXT. This uses \fBhtml::formValue\fP. The args is any additional tag attributes you want to put into the INPUT tag. .TP \fBhtml::textInputRow\fR \fIlabel name args\fR Generate an INPUT form tag with type TEXT formatted into a table row with an associated label. The args is any additional tag attributes you want to put into the INPUT tag. .TP \fBhtml::title\fR \fItitle\fR \fISide effect only\fP. Call this before \fBhtml::head\fR to define the TITLE for a page. .TP \fBhtml::varEmpty\fR \fIname\fR This returns 1 if the named variable either does not exist or has the empty string for its value. .TP \fBhtml::while\fR \fItest body\fR This procedure is similar to the built-in Tcl \fBwhile\fR control structure. Rather than evaluating the body, it returns the subst'ed \fIbody\fR. Each iteration of the loop causes another string to be concatenated to the result value. .SH SEE ALSO ncgi .SH KEYWORDS html, form, table, checkbox, radiobutton, checkbutton