File: html.n

package info (click to toggle)
tcllib 2.0%2Bdfsg-4
  • links: PTS
  • area: main
  • in suites: trixie
  • size: 83,572 kB
  • sloc: tcl: 306,798; ansic: 14,272; sh: 3,035; xml: 1,766; yacc: 1,157; pascal: 881; makefile: 124; perl: 84; f90: 84; python: 33; ruby: 13; php: 11
file content (846 lines) | stat: -rw-r--r-- 27,692 bytes parent folder | download | duplicates (2)
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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
'\"
'\" Generated from file 'html\&.man' by tcllib/doctools with format 'nroff'
'\"
.TH "html" n 1\&.6 tcllib "HTML Generation"
.\" The -*- nroff -*- definitions below are for supplemental macros used
.\" in Tcl/Tk manual entries.
.\"
.\" .AP type name in/out ?indent?
.\"	Start paragraph describing an argument to a library procedure.
.\"	type is type of argument (int, etc.), in/out is either "in", "out",
.\"	or "in/out" to describe whether procedure reads or modifies arg,
.\"	and indent is equivalent to second arg of .IP (shouldn't ever be
.\"	needed;  use .AS below instead)
.\"
.\" .AS ?type? ?name?
.\"	Give maximum sizes of arguments for setting tab stops.  Type and
.\"	name are examples of largest possible arguments that will be passed
.\"	to .AP later.  If args are omitted, default tab stops are used.
.\"
.\" .BS
.\"	Start box enclosure.  From here until next .BE, everything will be
.\"	enclosed in one large box.
.\"
.\" .BE
.\"	End of box enclosure.
.\"
.\" .CS
.\"	Begin code excerpt.
.\"
.\" .CE
.\"	End code excerpt.
.\"
.\" .VS ?version? ?br?
.\"	Begin vertical sidebar, for use in marking newly-changed parts
.\"	of man pages.  The first argument is ignored and used for recording
.\"	the version when the .VS was added, so that the sidebars can be
.\"	found and removed when they reach a certain age.  If another argument
.\"	is present, then a line break is forced before starting the sidebar.
.\"
.\" .VE
.\"	End of vertical sidebar.
.\"
.\" .DS
.\"	Begin an indented unfilled display.
.\"
.\" .DE
.\"	End of indented unfilled display.
.\"
.\" .SO ?manpage?
.\"	Start of list of standard options for a Tk widget. The manpage
.\"	argument defines where to look up the standard options; if
.\"	omitted, defaults to "options". The options follow on successive
.\"	lines, in three columns separated by tabs.
.\"
.\" .SE
.\"	End of list of standard options for a Tk widget.
.\"
.\" .OP cmdName dbName dbClass
.\"	Start of description of a specific option.  cmdName gives the
.\"	option's name as specified in the class command, dbName gives
.\"	the option's name in the option database, and dbClass gives
.\"	the option's class in the option database.
.\"
.\" .UL arg1 arg2
.\"	Print arg1 underlined, then print arg2 normally.
.\"
.\" .QW arg1 ?arg2?
.\"	Print arg1 in quotes, then arg2 normally (for trailing punctuation).
.\"
.\" .PQ arg1 ?arg2?
.\"	Print an open parenthesis, arg1 in quotes, then arg2 normally
.\"	(for trailing punctuation) and then a closing parenthesis.
.\"
.\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
.\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1 \\fI\\$2\\fP (\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
.\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
.\"	# BS - start boxed text
.\"	# ^y = starting y location
.\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
.\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
.\"	# VS - start vertical sidebar
.\"	# ^Y = starting y location
.\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
.\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
.\"	# Special macro to handle page bottom:  finish off current
.\"	# box/sidebar if in box/sidebar mode, then invoked standard
.\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
.\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
.\"	# DE - end display
.de DE
.fi
.RE
.sp
..
.\"	# SO - start of list of standard options
.de SO
'ie '\\$1'' .ds So \\fBoptions\\fR
'el .ds So \\fB\\$1\\fR
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
.\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\*(So manual entry for details on the standard options.
..
.\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
.\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
.\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.\"	# UL - underline word
.de UL
\\$1\l'|0\(ul'\\$2
..
.\"	# QW - apply quotation marks to word
.de QW
.ie '\\*(lq'"' ``\\$1''\\$2
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\$2
..
.\"	# PQ - apply parens and quotation marks to word
.de PQ
.ie '\\*(lq'"' (``\\$1''\\$2)\\$3
.\"" fix emacs highlighting
.el (\\*(lq\\$1\\*(rq\\$2)\\$3
..
.\"	# QR - quoted range
.de QR
.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
..
.\"	# MT - "empty" string
.de MT
.QW ""
..
.BS
.SH NAME
html \- Procedures to generate HTML structures
.SH SYNOPSIS
package require \fBTcl 8\&.5 9\fR
.sp
package require \fBhtml ?1\&.6?\fR
.sp
\fB::html::author\fR \fIauthor\fR
.sp
\fB::html::bodyTag\fR \fIargs\fR
.sp
\fB::html::cell\fR \fIparam value\fR ?\fItag\fR?
.sp
\fB::html::checkbox\fR \fIname value\fR
.sp
\fB::html::checkSet\fR \fIkey sep list\fR
.sp
\fB::html::checkValue\fR \fIname\fR ?\fIvalue\fR?
.sp
\fB::html::closeTag\fR
.sp
\fB::html::default\fR \fIkey\fR ?\fIparam\fR?
.sp
\fB::html::description\fR \fIdescription\fR
.sp
\fB::html::end\fR
.sp
\fB::html::eval\fR \fIarg\fR ?\fIargs\fR?
.sp
\fB::html::extractParam\fR \fIparam key\fR ?\fIvarName\fR?
.sp
\fB::html::font\fR \fIargs\fR
.sp
\fB::html::for\fR \fIstart test next body\fR
.sp
\fB::html::foreach\fR \fIvarlist1 list1\fR ?\fIvarlist2 list2 \&.\&.\&.\fR? \fIbody\fR
.sp
\fB::html::formValue\fR \fIname\fR ?\fIdefvalue\fR?
.sp
\fB::html::getFormInfo\fR \fIargs\fR
.sp
\fB::html::getTitle\fR
.sp
\fB::html::h\fR \fIlevel string\fR ?\fIparam\fR?
.sp
\fB::html::h1\fR \fIstring\fR ?\fIparam\fR?
.sp
\fB::html::h2\fR \fIstring\fR ?\fIparam\fR?
.sp
\fB::html::h3\fR \fIstring\fR ?\fIparam\fR?
.sp
\fB::html::h4\fR \fIstring\fR ?\fIparam\fR?
.sp
\fB::html::h5\fR \fIstring\fR ?\fIparam\fR?
.sp
\fB::html::h6\fR \fIstring\fR ?\fIparam\fR?
.sp
\fB::html::hdrRow\fR \fIargs\fR
.sp
\fB::html::head\fR \fItitle\fR
.sp
\fB::html::headTag\fR \fIstring\fR
.sp
\fB::html::html_entities\fR \fIstring\fR
.sp
\fB::html::if\fR \fIexpr1 body1\fR ?\fBelseif\fR \fIexpr2 body2 \&.\&.\&.\fR? ?\fBelse\fR \fIbodyN\fR?
.sp
\fB::html::init\fR ?\fIlist\fR?
.sp
\fB::html::keywords\fR \fIargs\fR
.sp
\fB::html::mailto\fR \fIemail\fR ?\fIsubject\fR?
.sp
\fB::html::meta\fR \fIargs\fR
.sp
\fB::html::meta_name\fR \fIargs\fR
.sp
\fB::html::meta_equiv\fR \fIargs\fR
.sp
\fB::html::meta_charset\fR \fIcharset\fR
.sp
\fB::html::css\fR \fIhref\fR
.sp
\fB::html::css-clear\fR
.sp
\fB::html::js\fR \fIhref\fR
.sp
\fB::html::js-clear\fR
.sp
\fB::html::minorList\fR \fIlist\fR ?\fIordered\fR?
.sp
\fB::html::minorMenu\fR \fIlist\fR ?\fIsep\fR?
.sp
\fB::html::nl2br\fR \fIstring\fR
.sp
\fB::html::openTag\fR \fItag\fR ?\fIparam\fR?
.sp
\fB::html::paramRow\fR \fIlist\fR ?\fIrparam\fR? ?\fIcparam\fR?
.sp
\fB::html::passwordInput\fR ?\fIname\fR?
.sp
\fB::html::passwordInputRow\fR \fIlabel\fR ?\fIname\fR?
.sp
\fB::html::quoteFormValue\fR \fIvalue\fR
.sp
\fB::html::radioSet\fR \fIkey sep list\fR
.sp
\fB::html::radioValue\fR \fIname value\fR
.sp
\fB::html::refresh\fR \fIseconds url\fR
.sp
\fB::html::row\fR \fIargs\fR
.sp
\fB::html::select\fR \fIname param choices\fR ?\fIcurrent\fR?
.sp
\fB::html::selectPlain\fR \fIname param choices\fR ?\fIcurrent\fR?
.sp
\fB::html::set\fR \fIvar val\fR
.sp
\fB::html::submit\fR \fIlabel\fR ?\fIname\fR? ?\fItitle\fR?
.sp
\fB::html::tableFromArray\fR \fIarrname\fR ?\fIparam\fR? ?\fIpat\fR?
.sp
\fB::html::tableFromList\fR \fIquerylist\fR ?\fIparam\fR?
.sp
\fB::html::textarea\fR \fIname\fR ?\fIparam\fR? ?\fIcurrent\fR?
.sp
\fB::html::textInput\fR \fIname value args\fR
.sp
\fB::html::textInputRow\fR \fIlabel name value args\fR
.sp
\fB::html::varEmpty\fR \fIname\fR
.sp
\fB::html::while\fR \fItest body\fR
.sp
\fB::html::doctype\fR \fIid\fR
.sp
\fB::html::wrapTag\fR \fItag\fR ?\fItext\fR? ?\fIargs\fR?
.sp
.BE
.SH DESCRIPTION
.PP
The package \fBhtml\fR 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 command \fB::html::init\fR should be called early to initialize
the module\&.  You can also use this procedure to define default values
for HTML tag parameters\&.
.TP
\fB::html::author\fR \fIauthor\fR
\fISide effect only\fR\&.  Call this before \fB::html::head\fR to
define an author for the page\&.  The author is noted in a comment in
the HEAD section\&.
.TP
\fB::html::bodyTag\fR \fIargs\fR
Generate a \fIbody\fR tag\&.  The tag parameters are taken from \fIargs\fR or
from the body\&.* attributes define with \fB::html::init\fR\&.
.TP
\fB::html::cell\fR \fIparam value\fR ?\fItag\fR?
Generate a \fItd\fR (or \fIth\fR) tag, a value, and a closing
\fItd\fR (or \fIth\fR) tag\&. The
tag parameters come from \fIparam\fR or TD\&.* attributes defined with
\fB::html::init\fR\&.  This uses \fB::html::font\fR to insert a standard
\fIfont\fR tag into the table cell\&. The \fItag\fR argument defaults to "td"\&.
.TP
\fB::html::checkbox\fR \fIname value\fR
Generate a \fIcheckbox\fR form element with the specified name and value\&.
This uses \fB::html::checkValue\fR\&.
.TP
\fB::html::checkSet\fR \fIkey sep list\fR
Generate a set of \fIcheckbox\fR form elements and associated labels\&.  The
\fIlist\fR should contain an alternating list of labels and values\&.
This uses \fB::html::checkbox\fR\&. All the \fIcheckbox\fR buttons share the
same \fIkey\fR for their name\&. The \fIsep\fR is text used to separate
the elements\&.
.TP
\fB::html::checkValue\fR \fIname\fR ?\fIvalue\fR?
Generate the "name=\fIname\fR value=\fIvalue\fR" for a \fIcheckbox\fR form
element\&.  If the CGI variable \fIname\fR has the value \fIvalue\fR,
then SELECTED is added to the return value\&. \fIvalue\fR defaults to
"1"\&.
.TP
\fB::html::closeTag\fR
Pop a tag off the stack created by \fB::html::openTag\fR and generate
the corresponding close tag (e\&.g\&., </body>)\&.
.TP
\fB::html::default\fR \fIkey\fR ?\fIparam\fR?
This procedure is used by \fB::html::tagParam\fR to generate the name,
value list of parameters for a tag\&.  The \fB::html::default\fR
procedure is used to generate default values for those items not
already in \fIparam\fR\&.  If the value identified by \fIkey\fR matches
a value in \fIparam\fR then this procedure returns the empty string\&.
Otherwise, it returns a "parameter=value" string for a form element
identified by \fIkey\fR\&.  The \fIkey\fR has the form "tag\&.parameter"
(e\&.g\&., body\&.bgcolor)\&.  Use \fB::html::init\fR to register default
values\&. \fIparam\fR defaults to the empty string\&.
.TP
\fB::html::description\fR \fIdescription\fR
\fISide effect only\fR\&.  Call this before \fB::html::head\fR to
define a description \fImeta\fR tag for the page\&.  This tag is generated
later in the call to \fB::html::head\fR\&.
.TP
\fB::html::end\fR
Pop all open tags from the stack and generate the corresponding close
HTML tags, (e\&.g\&., </body></html>)\&.
.TP
\fB::html::eval\fR \fIarg\fR ?\fIargs\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
\fB::html::extractParam\fR \fIparam key\fR ?\fIvarName\fR?
This is a parsing procedure that extracts the value of \fIkey\fR from
\fIparam\fR, which is a HTML-style "name=quotedvalue" list\&.
\fIvarName\fR 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\fR, otherwise it returns 0\&.  If the
\fIvarName\fR is not specified, then \fIkey\fR is used as the variable
name\&.
.TP
\fB::html::font\fR \fIargs\fR
Generate a standard \fIfont\fR tag\&.  The parameters to the tag are taken
from \fIargs\fR and the HTML defaults defined with \fB::html::init\fR\&.
.TP
\fB::html::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
\fB::html::foreach\fR \fIvarlist1 list1\fR ?\fIvarlist2 list2 \&.\&.\&.\fR? \fIbody\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
\fB::html::formValue\fR \fIname\fR ?\fIdefvalue\fR?
Return a name and value pair, where the value is initialized from
existing CGI data, if any\&.  The result has this form:
.sp
.CS


  name="fred" value="freds value"

.CE
.TP
\fB::html::getFormInfo\fR \fIargs\fR
Generate hidden fields to capture form values\&.  If \fIargs\fR 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
\fB::html::getTitle\fR
Return the title string, with out the surrounding \fItitle\fR tag,
set with a previous call to \fB::html::title\fR\&.
.TP
\fB::html::h\fR \fIlevel string\fR ?\fIparam\fR?
Generate a heading (e\&.g\&., \fIh\fBlevel\fR\fR) tag\&.  The \fIstring\fR is nested in the
heading, and \fIparam\fR is used for the tag parameters\&.
.TP
\fB::html::h1\fR \fIstring\fR ?\fIparam\fR?
Generate an \fIh1\fR tag\&.  See \fB::html::h\fR\&.
.TP
\fB::html::h2\fR \fIstring\fR ?\fIparam\fR?
Generate an \fIh2\fR tag\&.  See \fB::html::h\fR\&.
.TP
\fB::html::h3\fR \fIstring\fR ?\fIparam\fR?
Generate an \fIh3\fR tag\&.  See \fB::html::h\fR\&.
.TP
\fB::html::h4\fR \fIstring\fR ?\fIparam\fR?
Generate an \fIh4\fR tag\&.  See \fB::html::h\fR\&.
.TP
\fB::html::h5\fR \fIstring\fR ?\fIparam\fR?
Generate an \fIh5\fR tag\&.  See \fB::html::h\fR\&.
.TP
\fB::html::h6\fR \fIstring\fR ?\fIparam\fR?
Generate an \fIh6\fR tag\&.  See \fB::html::h\fR\&.
.TP
\fB::html::hdrRow\fR \fIargs\fR
Generate a table row, including \fItr\fR and \fIth\fR tags\&.
Each value in \fIargs\fR is place into its own table cell\&.
This uses \fB::html::cell\fR\&.
.TP
\fB::html::head\fR \fItitle\fR
Generate the \fIhead\fR section that includes the page \fItitle\fR\&.
If previous calls have been made to
\fB::html::author\fR,
\fB::html::keywords\fR,
\fB::html::description\fR,
or
\fB::html::meta\fR
then additional tags are inserted into the \fIhead\fR section\&.
This leaves an open \fIhtml\fR tag pushed on the stack with
\fB::html::openTag\fR\&.
.TP
\fB::html::headTag\fR \fIstring\fR
Save a tag for inclusion in the \fIhead\fR section generated by
\fB::html::head\fR\&.  The \fIstring\fR is everything in the tag except
the enclosing angle brackets, < >\&.
.TP
\fB::html::html_entities\fR \fIstring\fR
This command replaces all special characters in the \fIstring\fR with
their HTML entities and returns the modified text\&.
.TP
\fB::html::if\fR \fIexpr1 body1\fR ?\fBelseif\fR \fIexpr2 body2 \&.\&.\&.\fR? ?\fBelse\fR \fIbodyN\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
\fB::html::init\fR ?\fIlist\fR?
\fB::html::init\fR accepts a Tcl-style name-value list that defines
values for items with a name of the form "tag\&.parameter"\&.  For
example, a default with key "body\&.bgcolor" defines the background
color for the \fIbody\fR tag\&.
.TP
\fB::html::keywords\fR \fIargs\fR
\fISide effect only\fR\&.  Call this before \fB::html::head\fR to
define a keyword \fImeta\fR tag for the page\&.  The \fImeta\fR tag
is included in the result of \fB::html::head\fR\&.
.TP
\fB::html::mailto\fR \fIemail\fR ?\fIsubject\fR?
Generate a hypertext link to a mailto: URL\&.
.TP
\fB::html::meta\fR \fIargs\fR
Compatibility name for \fBhtml::meta_name\fR\&.
.TP
\fB::html::meta_name\fR \fIargs\fR
\fISide effect only\fR\&.
Call this before \fB::html::head\fR to define a \fImeta\fR tag for
the page\&.
The arguments (\fIargs\fR) are a Tcl-style name, value list that is
used for the \fBname=\fR and \fBcontent=\fR attributes of the
\fImeta\fR tag\&.  The \fImeta\fR tag is included in the result of
\fB::html::head\fR\&.
.TP
\fB::html::meta_equiv\fR \fIargs\fR
\fISide effect only\fR\&.
Call this before \fB::html::head\fR to define a \fImeta\fR tag for
the page\&.
The arguments (\fIargs\fR) are a Tcl-style name, value list that is
used for the \fBhttp-equiv=\fR and \fBcontent=\fR attributes of
the \fImeta\fR tag\&.  The \fImeta\fR tag is included in the result of
\fB::html::head\fR\&.
.TP
\fB::html::meta_charset\fR \fIcharset\fR
\fISide effect only\fR\&.
Call this before \fB::html::head\fR to
define a \fImeta\fR tag for the page\&.
The \fIcharset\fR is used with the \fBcharset=\fR attribute of the
\fImeta\fR tag\&.  The \fImeta\fR tag is included in the result of
\fB::html::head\fR\&.
.TP
\fB::html::css\fR \fIhref\fR
\fISide effect only\fR\&.  Call this before \fB::html::head\fR to
define a \fIlink\fR tag for a linked CSS document\&.  The \fIhref\fR
value is a HTTP URL to a CSS document\&. The \fIlink\fR tag is included
in the result of \fB::html::head\fR\&.
.sp
Multiple calls of this command are allowed, enabling the use of
multiple CSS document references\&. In other words, the arguments
of multiple calls are accumulated, and do not overwrite each other\&.
.TP
\fB::html::css-clear\fR
\fISide effect only\fR\&.  Call this before \fB::html::head\fR to
clear all links to CSS documents\&.
.sp
Multiple calls of this command are allowed, doing nothing after the
first of a sequence with no intervening \fB::html::css\fR\&.
.TP
\fB::html::js\fR \fIhref\fR
\fISide effect only\fR\&.  Call this before \fB::html::head\fR to
define a \fIscript\fR tag for a linked JavaScript document\&.  The
\fIhref\fR is a HTTP URL to a JavaScript document\&. The \fIscript\fR
tag is included in the result of \fB::html::head\fR\&.
.sp
Multiple calls of this command are allowed, enabling the use of
multiple JavaScript document references\&. In other words, the arguments
of multiple calls are accumulated, and do not overwrite each other\&.
.TP
\fB::html::js-clear\fR
\fISide effect only\fR\&.  Call this before \fB::html::head\fR to
clear all links to JavaScript documents\&.
.sp
Multiple calls of this command are allowed, doing nothing after the
first of a sequence with no intervening \fB::html::js\fR\&.
.TP
\fB::html::minorList\fR \fIlist\fR ?\fIordered\fR?
Generate an ordered or unordered list of links\&.  The \fIlist\fR is a
Tcl-style name, value list of labels and urls for the links\&.
\fIordered\fR is a boolean used to choose between an ordered or
unordered list\&. It defaults to \fBfalse\fR\&.
.TP
\fB::html::minorMenu\fR \fIlist\fR ?\fIsep\fR?
Generate a series of hypertext links\&.  The \fIlist\fR is a Tcl-style
name, value list of labels and urls for the links\&.  The \fIsep\fR is
the text to put between each link\&. It defaults to " | "\&.
.TP
\fB::html::nl2br\fR \fIstring\fR
This command replaces all line-endings in the \fIstring\fR with a
\fIbr\fR tag and returns the modified text\&.
.TP
\fB::html::openTag\fR \fItag\fR ?\fIparam\fR?
Push \fItag\fR onto a stack and generate the opening tag for
\fItag\fR\&. Use \fB::html::closeTag\fR to pop the tag from the
stack\&. The second argument provides any tag arguments, as a
list whose elements are formatted to be in the form
"\fBkey\fR=\fBvalue\fR"\&.
.TP
\fB::html::paramRow\fR \fIlist\fR ?\fIrparam\fR? ?\fIcparam\fR?
Generate a table row, including \fItr\fR and \fItd\fR tags\&. Each value in
\fIlist\fR is placed into its own table cell\&. This uses
\fB::html::cell\fR\&. The value of \fIrparam\fR is used as parameter for
the \fItr\fR tag\&. The value of \fIcparam\fR is passed to \fB::html::cell\fR
as parameter for the \fItd\fR tags\&.
.TP
\fB::html::passwordInput\fR ?\fIname\fR?
Generate an \fIinput\fR tag of type \fIpassword\fR\&. The \fIname\fR defaults to
"password"\&.
.TP
\fB::html::passwordInputRow\fR \fIlabel\fR ?\fIname\fR?
Format a table row containing a label and an \fIinput\fR tag of type
\fIpassword\fR\&. The \fIname\fR defaults to "password"\&.
.TP
\fB::html::quoteFormValue\fR \fIvalue\fR
Quote special characters in \fIvalue\fR by replacing them with HTML
entities for quotes, ampersand, and angle brackets\&.
.TP
\fB::html::radioSet\fR \fIkey sep list\fR
Generate a set of \fIinput\fR tags of type \fIradio\fR and an associated text
label\&.  All the radio buttons share the same \fIkey\fR for their name\&.
The \fIsep\fR is text used to separate the elements\&.  The \fIlist\fR
is a Tcl-style label, value list\&.
.TP
\fB::html::radioValue\fR \fIname value\fR
Generate the "name=\fIname\fR value=\fIvalue\fR" for a \fIradio\fR form
element\&.  If the CGI variable \fIname\fR has the value \fIvalue\fR,
then SELECTED is added to the return value\&.
.TP
\fB::html::refresh\fR \fIseconds url\fR
Set up a refresh \fImeta\fR tag\&. Call this before \fB::html::head\fR and the
HEAD section will contain a \fImeta\fR tag that causes the document to
refresh in \fIseconds\fR seconds\&.  The \fIurl\fR is optional\&.  If
specified, it specifies a new page to load after the refresh interval\&.
.TP
\fB::html::row\fR \fIargs\fR
Generate a table row, including \fItr\fR and \fItd\fR tags\&.  Each value in
\fIargs\fR is place into its own table cell\&. This uses
\fB::html::cell\fR\&. Ignores any default information set up via
\fB::html::init\fR\&.
.TP
\fB::html::select\fR \fIname param choices\fR ?\fIcurrent\fR?
Generate a \fIselect\fR form element and nested \fIoption\fR tags\&. The \fIname\fR
and \fIparam\fR are used to generate the \fIselect\fR tag\&. The \fIchoices\fR
list is a Tcl-style name, value list\&.
.TP
\fB::html::selectPlain\fR \fIname param choices\fR ?\fIcurrent\fR?
Like \fB::html::select\fR except that \fIchoices\fR is a Tcl list of
values used for the \fIoption\fR tags\&.  The label and the value for each
\fIoption\fR are the same\&.
.TP
\fB::html::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
\fB::html::submit\fR \fIlabel\fR ?\fIname\fR? ?\fItitle\fR?
Generate an \fIinput\fR tag of type \fIsubmit\fR\&.
The \fIname\fR defaults to "submit"\&.
When a non-empty \fItitle\fR string is specified the button gains a
\fBtitle=\fR attribute with that value\&.
.TP
\fB::html::tableFromArray\fR \fIarrname\fR ?\fIparam\fR? ?\fIpat\fR?
Generate a two-column \fItable\fR and nested rows to display a Tcl array\&. The
table gets a heading that matches the array name, and each generated row
contains a name, value pair\&. The array names are sorted (\fBlsort\fR without
special options)\&. The argument \fIparam\fR is for the \fItable\fR tag and has
to contain a pre-formatted string\&. The \fIpat\fR is a \fBstring match\fR
pattern used to select the array elements to show in the table\&. It defaults to
\fB*\fR, i\&.e\&. the whole array is shown\&.
.TP
\fB::html::tableFromList\fR \fIquerylist\fR ?\fIparam\fR?
Generate a two-column \fItable\fR and nested rows to display \fIquerylist\fR,
which is a Tcl dictionary\&. Each generated row contains a name, value pair\&. The
information is shown in the same order as specified in the dictionary\&. The
argument \fIparam\fR is for the \fItable\fR tag  and has to contain a
pre-formatted string\&.
.TP
\fB::html::textarea\fR \fIname\fR ?\fIparam\fR? ?\fIcurrent\fR?
Generate a \fItextarea\fR tag wrapped around its current values\&.
.TP
\fB::html::textInput\fR \fIname value args\fR
Generate an \fIinput\fR form tag with type \fItext\fR\&.  This uses
\fB::html::formValue\fR\&.  The args is any additional tag attributes
you want to put into the \fIinput\fR tag\&.
.TP
\fB::html::textInputRow\fR \fIlabel name value args\fR
Generate an \fIinput\fR form tag with type \fItext\fR formatted into a table row
with an associated label\&.  The args is any additional tag attributes
you want to put into the \fIinput\fR tag\&.
.TP
\fB::html::varEmpty\fR \fIname\fR
This returns 1 if the named variable either does not exist or has the
empty string for its value\&.
.TP
\fB::html::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\&.
.TP
\fB::html::doctype\fR \fIid\fR
This procedure can be used to build the standard DOCTYPE
declaration string\&. It will return the standard declaration
string for the id, or throw an error if the id is not known\&.
The following id's are defined:
.RS
.IP [1]
HTML32
.IP [2]
HTML40
.IP [3]
HTML40T
.IP [4]
HTML40F
.IP [5]
HTML401
.IP [6]
HTML401T
.IP [7]
HTML401F
.IP [8]
XHTML10S
.IP [9]
XHTML10T
.IP [10]
XHTML10F
.IP [11]
XHTML11
.IP [12]
XHTMLB
.RE
.TP
\fB::html::wrapTag\fR \fItag\fR ?\fItext\fR? ?\fIargs\fR?
A helper to wrap a \fItext\fR in a pair of open/close \fItag\fRs\&.
The arguments (\fIargs\fR) are a Tcl-style name, value list that is
used to provide attributes and associated values to the opening tag\&.
The result is a string with the open \fItag\fR along with the optional
attributes, the optional text, and the closed tag\&.
.PP
.SH "BUGS, IDEAS, FEEDBACK"
This document, and the package it describes, will undoubtedly contain
bugs and other problems\&.
Please report such in the category \fIhtml\fR of the
\fITcllib Trackers\fR [http://core\&.tcl\&.tk/tcllib/reportlist]\&.
Please also report any ideas for enhancements you may have for either
package and/or documentation\&.
.PP
When proposing code changes, please provide \fIunified diffs\fR,
i\&.e the output of \fBdiff -u\fR\&.
.PP
Note further that \fIattachments\fR are strongly preferred over
inlined patches\&. Attachments can be made by going to the \fBEdit\fR
form of the ticket immediately after its creation, and then using the
left-most button in the secondary navigation bar\&.
.SH "SEE ALSO"
htmlparse, ncgi
.SH KEYWORDS
checkbox, checkbutton, form, html, radiobutton, table
.SH CATEGORY
CGI programming