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
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN">
<html>
<head>
<title>Template::Library::Splash</title>
<link rel="stylesheet" type="text/css" href="../../css/blue.css" title="Blue Glass">
<link rel="alternate stylesheet" type="text/css" href="../../css/green.css" title="Green Glass">
<link rel="stylesheet" type="text/css" href="/css/print.css" media="print">
<script type="text/javascript" src="../../js/tt2.js"></script>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<meta name="author" content="Andy Wardley">
</head>
<body>
<div id="body">
<div id="page">
<div id="sidebar">
<a href="/index.html" id="logo"></a>
<div id="menu">
<ul class="menu">
<li class="l0 first"><a href="../../manual/index.html">Manual</a></li>
<li class="l0"><a href="../../modules/index.html">Modules</a></li>
<li class="l0"><a href="../../tools/index.html">Tools</a></li>
<li class="l0 last"><a href="../../tutorial/index.html">Tutorial</a></li>
</ul>
<div class="foot"></div>
</div>
</div>
<div id="header">
<div id="nav">
<ul id="trail">
<li><a href="../.."></a></li>
<li><a href="../.."></a></li>
<li class="last"><a href="../../misc/Library/Splash.html">Splash</a></li>
</ul><div class="pager">
<a href="../../misc/Library/PostScript.html" title="Template::Library::PostScript" class="go back">Back<span class="about"><b>Back:</b> Template::Library::PostScript</span></a>
<span class="go up">Up</span>
<span class="go next">Next</span>
</div>
</div>
<h1 class="headline">Template::Library::Splash</h1>
<h2 class="subhead">Template library for building stylish HTML user interfaces</h1>
</div>
<div id="content">
<div class="section">
<div class="head">
<h1 id="contents" onclick="switch_section(this)" title="Click title to show/hide section content.">Contents</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<ul class="toc">
<li class=""><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li class="sub"><a href="#section_Introduction">Introduction</a></li>
<li class="sub"><a href="#section_Configuration">Configuration</a></li>
<li class="sub"><a href="#section_Colours">Colours</a></li>
<li class="sub"><a href="#section_Style">Style</a></li>
<li class=""><a href="#COMPONENT_TEMPLATES">COMPONENT TEMPLATES</a></li>
<li class="sub"><a href="#section_splash_text">splash/text</a></li>
<li class="sub"><a href="#section_splash_table">splash/table</a></li>
<li class="sub"><a href="#section_splash_row">splash/row</a></li>
<li class="sub"><a href="#section_splash_cell">splash/cell</a></li>
<li class="sub"><a href="#section_splash_box">splash/box</a></li>
<li class="sub"><a href="#section_splash_button">splash/button</a></li>
<li class="sub"><a href="#section_splash_bar">splash/bar</a></li>
<li class="sub"><a href="#section_splash_hair">splash/hair</a></li>
<li class="sub"><a href="#section_splash_menu">splash/menu</a></li>
<li class="sub"><a href="#section_splash_menubar">splash/menubar</a></li>
<li class="sub"><a href="#section_splash_panel">splash/panel</a></li>
<li class="sub"><a href="#section_splash_pane">splash/pane</a></li>
<li class="sub"><a href="#section_splash_tab">splash/tab</a></li>
<li class="sub"><a href="#section_splash_tabset">splash/tabset</a></li>
<li class="sub"><a href="#section_splash_tabbox">splash/tabbox</a></li>
<li class="sub"><a href="#section_splash_tabsbox">splash/tabsbox</a></li>
<li class="sub"><a href="#section_splash_tabspanel">splash/tabspanel</a></li>
<li class=""><a href="#EXAMPLES">EXAMPLES</a></li>
<li class=""><a href="#AUTHOR">AUTHOR</a></li>
<li class=""><a href="#VERSION">VERSION</a></li>
<li class=""><a href="#COPYRIGHT">COPYRIGHT</a></li>
<li class=""><a href="#SEE_ALSO">SEE ALSO</a></li>
</ul>
</div>
</div>
<div class="pod">
<div class="section">
<div class="head">
<h1 id="DESCRIPTION" onclick="switch_section(this)" title="Click title to show/hide section content.">DESCRIPTION</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
<b>NOTE:</b> This documentation is incomplete, incorrect and outdated.
The Splash! library is still evolving and subject to change. See the
examples for a much more recent and accurate demonstration of use.
</p>
<div class="subsection">
<div class="head">
<h2 id="section_Introduction" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Introduction</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The 'Splash' template library is distributed as part of the Template
Toolkit. It can be found in the 'templates' sub-directory of the
installation directory.
</p>
<pre>/your/tt2/installation
|
+-- docs
| ...
|
+-- images
| ...
|
+-- examples
| ...
|
+-- templates
|
+-- html
| ...
+-- pod
| ...
+-- splash <<<< YOU ARE HERE
...</pre>
<p>
To use the Splash library, you first need to tell the Template Toolkit
where to find the template files.
</p>
<pre>use Template;</pre>
<pre>my $tt2 = Template->new({
INCLUDE_PATH => '/usr/local/tt2/templates',
});</pre>
<p>
For a portable way to determine the installation 'templates' directory,
you can use the <code>Template::Config->instdir()</code> class method.
</p>
<pre>use Template;</pre>
<pre>my $tt2 = Template->new({
INCLUDE_PATH => Template::Config->instdir('templates'),
});</pre>
<p>
Note that you should set the INCLUDE_PATH to the 'templates' directory as
shown here and don't be tempted to set the INCLUDE_PATH to
'templates/splash'. Many of the Splash! components use elements in the
'html' directory and contain directives of the form:
</p>
<pre>[% INCLUDE html/something %].</pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Configuration" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Configuration</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The 'splash/config' template defines a 'splash' hash array which contains
numerous configuration items for the Splash library. You must PROCESS
this template to ensure that the hash definition is imported into your
calling template. An INCLUDE is not sufficient as it localises variables
and prevents the 'splash' hash array from existing outside the
splash/config template.
</p>
<pre>[% PROCESS splash/config %]</pre>
<p>
Alternately, you can define the splash/config template as a PRE_PROCESS
item when you create the Template processor.
</p>
<pre>use Template;</pre>
<pre>my $tt2 = Template->new({
INCLUDE_PATH => Template::Config->instdir('templates'),
PRE_PROCESS => 'splash/config',
});</pre>
<p>
You can modify the default configuration by creating your own PRE_PROCESS
config file which loads the 'splash/config' and then tweaks the settings
to your own preferences.
</p>
<pre>my $tt2 = Template->new({
INCLUDE_PATH => [ '/home/abw/tt2/templates',
Template::Config->instdir('templates') ],
PRE_PROCESS => 'config'
});</pre>
<p>
/home/abw/tt2/templates/config:
</p>
<pre>[% # load the 'splash' configuration
PROCESS splash/config;
# tweak values to personal preferences
splash.images = '/~abw/tt2/images/splash'
splash.select.col = 'leaf'
splash.unselect.col = 'bud'
%]</pre>
<p>
The splash/config file includes some instructional comments on things you
might like to tweak.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Colours" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Colours</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The Splash! library uses the colours defined in the html/rgb template.
The 'rgb' hash defined therein is imported as the 'splash.rgb' hash.
</p>
<pre>[% INCLUDE splash/box col='grey75' %]</pre>
<p>
See the examples for further enlightenment on using colour.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Style" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Style</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
There are two very primitive "styles" implemented called "select" and
"unselect". These are used to indicate which item on a menu is selected,
for example. Each style defines characteristics like background colour,
font face, size and colour, text alignment, and so on.
</p>
<p>
The styles are implemented as hashes within the 'splash' hash. Many of
the components respond to a 'style' variable being set and you can pass a
direct reference to splash.select or splash.unselect (or your own
styles). e.g.
</p>
<pre>[% INCLUDE splash/button
content = "Unselected"
style = splash.unselect
%]
[% INCLUDE splash/button
content ="Selected"
style = splash.select
%]</pre>
<p>
Alternately, you can use the 'select' variable to indicate either of the
inbuilt styles: splash.select or splash.unselect.
</p>
<pre>[% INCLUDE splash/button
content = "Unselected"
select = 0
%]
[% INCLUDE splash/button
content = "Selected"
select = 1
%]</pre>
</div>
</div>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="COMPONENT_TEMPLATES" onclick="switch_section(this)" title="Click title to show/hide section content.">COMPONENT TEMPLATES</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
This section describes some of the component templates in the Splash!
library. This documentation is incomplete and may also be inaccurate in
places. The examples in the 'examples' directory are likely to be a much
better reference.
</p>
<div class="subsection">
<div class="head">
<h2 id="section_splash_text" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/text</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Simple template to format text according to a selected/unselected style,
adding links, etc.
</p>
<pre>[% INCLUDE splash/text
content = 'Template Toolkit'
link = 'http://www.template-toolkit.org'
select = 0
bold = 1
%]</pre>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_content">content</b>
<p>
Text content.
</p>
</li>
<li><b id="item_link">link</b>
<p>
URL which can be defined to make the text a link.
</p>
</li>
<li><b id="item_style">style</b>
<p>
Reference to a style hash.
</p>
</li>
<li><b id="item_select">select</b>
<p>
Flag to default the style to splash.select (select == true value) or
splash.unselect (select == false value).
</p>
</li>
</ul>
<p>
The following items default to the relevant style values:
</p>
<ul>
<li><b id="item_col_style_col_text_">col (style.col.text)</b>
</li>
<li><b id="item_font_style_font_face_">font (style.font.face)</b>
</li>
<li><b id="item_bold_style_font_bold_">bold (style.font.bold)</b>
</li>
<li><b id="item_size_style_font_size_">size (style.font.size)</b>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_table" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/table</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
A thin wrapper around html/table, allowing a colour to be specified by
name.
</p>
<pre>[% WRAPPER splash/table
col = 'aqua'
pad = 4
width = '100%'
%]
<tr>
<td>Foo</td>
<td>Bar</td>
</tr>
[% END %]</pre>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_content">content</b>
<p>
Table content.
</p>
</li>
<li><b id="item_col">col</b>
<p>
Background colour.
</p>
</li>
<li><b id="item_border">border</b>
<p>
Border width (default: 0)
</p>
</li>
<li><b id="item_width">width</b>
<p>
Width in absolute pixels (e.g. '100') or as a percentage (e.g. '50%').
</p>
</li>
<li><b id="item_pad">pad</b>
<p>
Cell padding.
</p>
</li>
<li><b id="item_space">space</b>
<p>
Cell padding.
</p>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_row" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/row</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Creates a row for an HTML table.
</p>
<pre>[% WRAPPER splash/table %]</pre>
<pre>[% WRAPPER splash/row col='marine' %]
<td>Foo</td><td>Bar</td>
[% END %]</pre>
<pre>[% WRAPPER splash/row col='aqua' %]
<td>Foo</td><td>Bar</td>
[% END %]</pre>
<pre>[% END %]</pre>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_content">content</b>
<p>
Row content.
</p>
</li>
<li><b id="item_col">col</b>
<p>
Background colour.
</p>
</li>
<li><b id="item_valign">valign</b>
<p>
Vertical alignment
</p>
</li>
<li><b id="item_rowspan">rowspan</b>
<p>
Number of rows to span.
</p>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_cell" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/cell</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Creates a cell for an HTML table.
</p>
<pre>[% WRAPPER splash/table + splash/row + splash/cell col='grey75' %]
Hello World
[% END %]</pre>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_content">content</b>
<p>
Cell content.
</p>
</li>
<li><b id="item_col">col</b>
<p>
Background colour.
</p>
</li>
<li><b id="item_align">align</b>
<p>
Horizontal alignment
</p>
</li>
<li><b id="item_colspan">colspan</b>
<p>
Number of columns to span.
</p>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_box" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/box</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
A box created from a union of splash/table, splash/row and splash/cell.
The following is equivalent to the previous example.
</p>
<pre>[% WRAPPER splash/box col='grey75' %]
Hello World
[% END %]</pre>
<p>
Configuration items are as per the individual templates.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_button" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/button</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Creates a small button with rounded corners.
</p>
<pre>[% INCLUDE splash/button
content = 'Template Toolkit'
select = 1
width = '50%'
%]</pre>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_content">content</b>
<p>
Button content.
</p>
</li>
<li><b id="item_style">style</b>
<p>
Reference to a style hash.
</p>
</li>
<li><b id="item_select">select</b>
<p>
Flag to default the style to splash.select (select == true value) or
splash.unselect (select == false value).
</p>
</li>
<li><b id="item_width">width</b>
<p>
Width in absolute pixels (e.g. '100') or as a percentage (e.g. '50%').
</p>
</li>
</ul>
<p>
The following items default to the relevant style values:
</p>
<ul>
<li><b id="item_col_style_col_text_">col (style.col.text)</b>
</li>
<li><b id="item_textcol_style_col_text_">textcol (style.col.text)</b>
</li>
<li><b id="item_font_style_font_face_">font (style.font.face)</b>
</li>
<li><b id="item_size_style_font_size_">size (style.font.size)</b>
</li>
<li><b id="item_bold_style_font_bold_">bold (style.font.bold)</b>
</li>
<li><b id="item_width_style_button_width_">width (style.button.width)</b>
</li>
<li><b id="item_align_style_button_align_">align (style.button.align)</b>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_bar" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/bar</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Creates a bar with rounded corners at either the top or bottom, and
square corners on the other. Default has rounded at the top, set 'invert'
to select bottom.
</p>
<pre>[% INCLUDE splash/bar
content = 'Hello World',
select = 1
%] </pre>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_content">content</b>
<p>
Bar content.
</p>
</li>
<li><b id="item_style">style</b>
<p>
Reference to a style hash.
</p>
</li>
<li><b id="item_select">select</b>
<p>
Flag to default the style to splash.select (select == true value) or
splash.unselect (select == false value).
</p>
</li>
<li><b id="item_width">width</b>
<p>
Width in absolute pixels (e.g. '100') or as a percentage (e.g. '50%').
</p>
</li>
<li><b id="item_invert">invert</b>
<p>
Flag to invert bar to hang down instead of sitting upright.
</p>
</li>
</ul>
<p>
The following items default to the relevant style values:
</p>
<ul>
<li><b id="item_col_style_col_text_">col (style.col.text)</b>
</li>
<li><b id="item_textcol_style_col_text_">textcol (style.col.text)</b>
</li>
<li><b id="item_font_style_font_face_">font (style.font.face)</b>
</li>
<li><b id="item_size_style_font_size_">size (style.font.size)</b>
</li>
<li><b id="item_bold_style_font_bold_">bold (style.font.bold)</b>
</li>
<li><b id="item_width_style_button_width_">width (style.button.width)</b>
</li>
<li><b id="item_align_style_button_align_">align (style.button.align)</b>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_hair" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/hair</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Generates a frame enclosing the content within crosshair corners.
</p>
<pre>[% INCLUDE splash/hair
content = 'Template Toolkit'
%]</pre>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_content">content</b>
<p>
Hair content.
</p>
</li>
<li><b id="item_style">style</b>
<p>
Reference to a style hash.
</p>
</li>
</ul>
<p>
The following items default to the relevant style values:
</p>
<ul>
<li><b id="item_col_style_col_text_">col (style.col.text)</b>
</li>
<li><b id="item_bgcol_style_col_back_">bgcol (style.col.back)</b>
</li>
<li><b id="item_align_style_button_align_">align (style.button.align)</b>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_menu" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/menu</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Creates a menu as a series of splash/button elements.
</p>
<pre>[% buttons = [
{ text => 'One', link => 'one.html' }
{ text => 'Two', link => 'two.html' }
]
%]</pre>
<pre>[% INCLUDE splash/menu
select = 2 # Two
%]</pre>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_buttons">buttons</b>
<p>
A reference to a list of hash arrays containing 'text' and 'link' items.
</p>
</li>
<li><b id="item_select_n_or_0_">select (n or 0)</b>
<p>
Indicates which button should be selected. First item is 1. 0 indicates
no button selected.
</p>
</li>
<li><b id="item_width">width</b>
<p>
Width in absolute pixels (e.g. '100') or as a percentage (e.g. '50%').
</p>
</li>
<li><b id="item_align">align</b>
<p>
Horizontal alignment
</p>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_menubar" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/menubar</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
As above, but incorporated into a wider bar.
</p>
<pre>[% WRAPPER splash/menubar %]
Section Title
[% END %]</pre>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_buttons">buttons</b>
<p>
A reference to a list of hash arrays containing 'text' and 'link' items.
</p>
</li>
<li><b id="item_select_n_or_0_">select (n or 0)</b>
<p>
Indicates which button should be selected. First item is 1. 0 indicates
no button selected.
</p>
</li>
<li><b id="item_width">width</b>
<p>
Width in absolute pixels (e.g. '100') or as a percentage (e.g. '50%').
</p>
</li>
<li><b id="item_align">align</b>
<p>
Horizontal alignment
</p>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_panel" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/panel</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
A table with a coloured edge.
</p>
<pre>[% WRAPPER splash/panel edge='black' fill='grey75' border=2 %]
<tr>
<td>Hello World</td>
</tr>
[% END %]</pre>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_content">content</b>
<p>
Panel content.
</p>
</li>
<li><b id="item_style">style</b>
<p>
Reference to a style hash.
</p>
</li>
<li><b id="item_select">select</b>
<p>
Flag to default the style to splash.select (select == true value) or
splash.unselect (select == false value).
</p>
</li>
<li><b id="item_width">width</b>
<p>
Width in absolute pixels (e.g. '100') or as a percentage (e.g. '50%').
</p>
</li>
<li><b id="item_align">align</b>
<p>
Horizontal alignment
</p>
</li>
<li><b id="item_border">border</b>
<p>
Border width (default: 0)
</p>
</li>
</ul>
<p>
The following items default to the relevant style values:
</p>
<ul>
<li><b id="item_edge_style_col_edge_">edge (style.col.edge)</b>
</li>
<li><b id="item_fill_style_col_fill_">fill (style.col.fill)</b>
</li>
<li><b id="item_pad_style_pad_">pad (style.pad)</b>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_pane" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/pane</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
A union of splash/row + splash/cell.
</p>
<pre>[% WRAPPER splash/panel select=1 %]
[% WRAPPER splash/pane col='grey75' %]
Hello World
[% END %]</pre>
<pre> [% WRAPPER splash/pane col='grey50' %]
Hello Again
[% END %]
[% END %]</pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_tab" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/tab</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
A simple button looking like a page tab.
</p>
<pre>[% INCLUDE splash/tab
content = 'Option 1'
col = 'aqua'
%]</pre>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_content">content</b>
<p>
Tab content.
</p>
</li>
<li><b id="item_style">style</b>
<p>
Reference to a style hash.
</p>
</li>
<li><b id="item_select">select</b>
<p>
Flag to default the style to splash.select (select == true value) or
splash.unselect (select == false value).
</p>
</li>
<li><b id="item_width">width</b>
<p>
Width in absolute pixels (e.g. '100') or as a percentage (e.g. '50%').
</p>
</li>
<li><b id="item_align">align</b>
<p>
Horizontal alignment
</p>
</li>
</ul>
<p>
The following items default to the relevant style values:
</p>
<ul>
<li><b id="item_col_style_col_text_">col (style.col.text)</b>
</li>
<li><b id="item_textcol_style_col_text_">textcol (style.col.text)</b>
</li>
<li><b id="item_font_style_font_face_">font (style.font.face)</b>
</li>
<li><b id="item_size_style_font_size_">size (style.font.size)</b>
</li>
<li><b id="item_bold_style_font_bold_">bold (style.font.bold)</b>
</li>
<li><b id="item_tabalign_style_tab_align_">tabalign (style.tab.align)</b>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_tabset" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/tabset</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
A set of splash/tab components, similar to a menu.
</p>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_tabs">tabs</b>
<p>
List of hash references containing text/link entries, as per menu
buttons.
</p>
</li>
<li><b id="item_select">select</b>
<p>
Flag to default the style to splash.select (select == true value) or
splash.unselect (select == false value).
</p>
</li>
<li><b id="item_invert">invert</b>
<p>
Flag to invert tab to hang down instead of sitting upright.
</p>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_tabbox" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/tabbox</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Add a splash/tab to the top of a splash/box.
</p>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_title">title</b>
<pre>title.</pre>
</li>
<li><b id="item_content">content</b>
<pre>content.</pre>
</li>
<li><b id="item_width">width</b>
<p>
Width in absolute pixels (e.g. '100') or as a percentage (e.g. '50%').
</p>
</li>
<li><b id="item_tabwidth">tabwidth</b>
<p>
Width of tabs.
</p>
</li>
<li><b id="item_select">select</b>
<p>
Flag to default the style to splash.select (select == true value) or
splash.unselect (select == false value).
</p>
</li>
<li><b id="item_border">border</b>
<p>
Border width (default: 0)
</p>
</li>
</ul>
<p>
The following items default to the relevant style values:
</p>
<ul>
<li><b id="item_col_style_col_text_">col (style.col.text)</b>
</li>
<li><b id="item_fill_style_col_fill_">fill (style.col.fill)</b>
</li>
<li><b id="item_tabalign_style_tab_align_">tabalign (style.tab.align)</b>
</li>
<li><b id="item_tablocate_style_tab_locate_">tablocate (style.tab.locate)</b>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_tabsbox" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/tabsbox</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Add a splash/tabset to the top of a splash/box.
</p>
<p>
Configuration items:
</p>
<ul>
<li><b id="item_tabs">tabs</b>
<p>
List of hash references containing text/link entries, as per menu
buttons.
</p>
</li>
<li><b id="item_select">select</b>
<p>
Flag to default the style to splash.select (select == true value) or
splash.unselect (select == false value).
</p>
</li>
<li><b id="item_content">content</b>
<pre>content.</pre>
</li>
<li><b id="item_width">width</b>
<p>
Width in absolute pixels (e.g. '100') or as a percentage (e.g. '50%').
</p>
</li>
<li><b id="item_border">border</b>
<p>
Border width (default: 0)
</p>
</li>
<li><b id="item_invert">invert</b>
<p>
Flag to invert to hang down instead of sitting upright.
</p>
</li>
</ul>
<p>
The following items default to the relevant style values:
</p>
<ul>
<li><b id="item_col_style_col_text_">col (style.col.text)</b>
</li>
<li><b id="item_fill_style_col_fill_">fill (style.col.fill)</b>
</li>
<li><b id="item_tabalign_style_tab_align_">tabalign (style.tab.align)</b>
</li>
<li><b id="item_tablocate_style_tab_locate_">tablocate (style.tab.locate)</b>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_splash_tabspanel" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">splash/tabspanel</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
As per splash/tabsbox, but attached to a splash/panel instead of a
splash/box.
</p>
</div>
</div>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="EXAMPLES" onclick="switch_section(this)" title="Click title to show/hide section content.">EXAMPLES</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
See the examples in the 'examples' sub-directory of the installation for
comprehensive examples showing use of the Splash! library.
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="AUTHOR" onclick="switch_section(this)" title="Click title to show/hide section content.">AUTHOR</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Andy Wardley <abw@wardley.org>
</p>
<p>
<a href="http://wardley.org/">http://wardley.org/</a>|<a
href="http://wardley.org/">http://wardley.org/</a>
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="VERSION" onclick="switch_section(this)" title="Click title to show/hide section content.">VERSION</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
2.68, distributed as part of the Template Toolkit version 2.19, released
on 27 April 2007.
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="COPYRIGHT" onclick="switch_section(this)" title="Click title to show/hide section content.">COPYRIGHT</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<pre>Copyright (C) 1996-2007 Andy Wardley. All Rights Reserved.</pre>
<p>
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="SEE_ALSO" onclick="switch_section(this)" title="Click title to show/hide section content.">SEE ALSO</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
<a href="../../misc/Library/HTML.html">Template::Library::HTML</a>
</p>
</div>
</div>
</div></div> <br clear="both">
</div>
<div id="footer">
<div id="br">
<div class="pager">
<a href="../../misc/Library/PostScript.html" title="Template::Library::PostScript" class="go back">Back<span class="about"><b>Back:</b> Template::Library::PostScript</span></a>
<span class="go up">Up</span>
<span class="go next">Next</span>
</div>
</div>
<a href="http://opensource.org/" class="osi"></a>
<div class="copyright">
Copyright © 1996-2007 <a href="http://wardley.org/">Andy Wardley</a>. All Rights Reserved.
</div>
<div class="licence">
The <a href="http://template-toolkit.org/">Template Toolkit</a> is <a href="http://opensource.org/">Open Source</a> software.
You can redistribute and/or modify it under the terms of the <a href="http://www.opensource.org/licenses/gpl-license.php">GNU Public Licence</a>
or the <a href="http://www.opensource.org/licenses/artistic-license.php">Perl Artistic Licence</a>.
</div>
</div></div> </body>
</html>
|
