Deployed 59ff7f1 to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / latest / migration / wcf21 / templates / index.html
1
2 <!doctype html>
3 <html lang="en" class="no-js">
4 <head>
5
6 <meta charset="utf-8">
7 <meta name="viewport" content="width=device-width,initial-scale=1">
8
9
10
11
12 <link rel="icon" href="../../../assets/default.favicon.ico">
13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0">
14
15
16
17 <title>Templates - WoltLab Suite Documentation</title>
18
19
20
21 <link rel="stylesheet" href="../../../assets/stylesheets/main.33e2939f.min.css">
22
23
24 <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
34
35
36
37
38 <link rel="stylesheet" href="../../../stylesheets/extra.css">
39
40
41
42
43
44 </head>
45
46
47
48
49
50
51
52 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
53
54
55 <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
56
57 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
58 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
59 <label class="md-overlay" for="__drawer"></label>
60 <div data-md-component="skip">
61
62
63 <a href="#wcf-21x-templates" class="md-skip">
64 Skip to content
65 </a>
66
67 </div>
68 <div data-md-component="announce">
69
70 <aside class="md-announce">
71 <div class="md-announce__inner md-grid md-typeset">
72
73 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
74
75 </div>
76 </aside>
77
78 </div>
79
80 <header class="md-header" data-md-component="header">
81 <nav class="md-header__inner md-grid" aria-label="Header">
82 <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
83
84 <img src="../../../assets/logo.png" alt="logo">
85
86 </a>
87 <label class="md-header__button md-icon" for="__drawer">
88 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
89 </label>
90 <div class="md-header__title" data-md-component="header-title">
91 <div class="md-header__ellipsis">
92 <div class="md-header__topic">
93 <span class="md-ellipsis">
94 WoltLab Suite Documentation
95 </span>
96 </div>
97 <div class="md-header__topic" data-md-component="header-topic">
98 <span class="md-ellipsis">
99
100 Templates
101
102 </span>
103 </div>
104 </div>
105 </div>
106
107
108
109 <label class="md-header__button md-icon" for="__search">
110 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
111 </label>
112
113 <div class="md-search" data-md-component="search" role="dialog">
114 <label class="md-search__overlay" for="__search"></label>
115 <div class="md-search__inner" role="search">
116 <form class="md-search__form" name="search">
117 <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
118 <label class="md-search__icon md-icon" for="__search">
119 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
120 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
121 </label>
122 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
123 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
124 </button>
125 </form>
126 <div class="md-search__output">
127 <div class="md-search__scrollwrap" data-md-scrollfix>
128 <div class="md-search-result" data-md-component="search-result">
129 <div class="md-search-result__meta">
130 Initializing search
131 </div>
132 <ol class="md-search-result__list"></ol>
133 </div>
134 </div>
135 </div>
136 </div>
137 </div>
138
139
140 <div class="md-header__source">
141
142 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
143 <div class="md-source__icon md-icon">
144
145 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
146 </div>
147 <div class="md-source__repository">
148 GitHub
149 </div>
150 </a>
151 </div>
152
153 </nav>
154 </header>
155
156 <div class="md-container" data-md-component="container">
157
158
159
160
161 <main class="md-main" data-md-component="main">
162 <div class="md-main__inner md-grid">
163
164
165
166 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
167 <div class="md-sidebar__scrollwrap">
168 <div class="md-sidebar__inner">
169
170
171
172 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
173 <label class="md-nav__title" for="__drawer">
174 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
175
176 <img src="../../../assets/logo.png" alt="logo">
177
178 </a>
179 WoltLab Suite Documentation
180 </label>
181
182 <div class="md-nav__source">
183
184 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
185 <div class="md-source__icon md-icon">
186
187 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
188 </div>
189 <div class="md-source__repository">
190 GitHub
191 </div>
192 </a>
193 </div>
194
195 <ul class="md-nav__list" data-md-scrollfix>
196
197
198
199
200
201
202
203
204 <li class="md-nav__item">
205 <a href="../../../getting-started/" class="md-nav__link">
206 Getting Started
207 </a>
208 </li>
209
210
211
212
213
214
215
216
217
218
219
220 <li class="md-nav__item md-nav__item--nested">
221
222
223 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
224
225 <label class="md-nav__link" for="__nav_2">
226 PHP API
227 <span class="md-nav__icon md-icon"></span>
228 </label>
229 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
230 <label class="md-nav__title" for="__nav_2">
231 <span class="md-nav__icon md-icon"></span>
232 PHP API
233 </label>
234 <ul class="md-nav__list" data-md-scrollfix>
235
236
237
238
239
240 <li class="md-nav__item">
241 <a href="../../../php/pages/" class="md-nav__link">
242 Pages
243 </a>
244 </li>
245
246
247
248
249
250
251
252 <li class="md-nav__item">
253 <a href="../../../php/database-objects/" class="md-nav__link">
254 Database Objects
255 </a>
256 </li>
257
258
259
260
261
262
263
264 <li class="md-nav__item">
265 <a href="../../../php/database-access/" class="md-nav__link">
266 Database Access
267 </a>
268 </li>
269
270
271
272
273
274
275
276 <li class="md-nav__item">
277 <a href="../../../php/exceptions/" class="md-nav__link">
278 Exceptions
279 </a>
280 </li>
281
282
283
284
285
286
287
288
289 <li class="md-nav__item md-nav__item--nested">
290
291
292 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
293
294 <label class="md-nav__link" for="__nav_2_5">
295 API
296 <span class="md-nav__icon md-icon"></span>
297 </label>
298 <nav class="md-nav" aria-label="API" data-md-level="2">
299 <label class="md-nav__title" for="__nav_2_5">
300 <span class="md-nav__icon md-icon"></span>
301 API
302 </label>
303 <ul class="md-nav__list" data-md-scrollfix>
304
305
306
307
308
309
310 <li class="md-nav__item md-nav__item--nested">
311
312
313 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
314
315 <label class="md-nav__link" for="__nav_2_5_1">
316 Caches
317 <span class="md-nav__icon md-icon"></span>
318 </label>
319 <nav class="md-nav" aria-label="Caches" data-md-level="3">
320 <label class="md-nav__title" for="__nav_2_5_1">
321 <span class="md-nav__icon md-icon"></span>
322 Caches
323 </label>
324 <ul class="md-nav__list" data-md-scrollfix>
325
326
327
328
329
330 <li class="md-nav__item">
331 <a href="../../../php/api/caches/" class="md-nav__link">
332 Overview
333 </a>
334 </li>
335
336
337
338
339
340
341
342 <li class="md-nav__item">
343 <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
344 Persistent Caches
345 </a>
346 </li>
347
348
349
350
351
352
353
354 <li class="md-nav__item">
355 <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
356 Runtime Caches
357 </a>
358 </li>
359
360
361
362 </ul>
363 </nav>
364 </li>
365
366
367
368
369
370
371
372 <li class="md-nav__item">
373 <a href="../../../php/api/comments/" class="md-nav__link">
374 Comments
375 </a>
376 </li>
377
378
379
380
381
382
383
384 <li class="md-nav__item">
385 <a href="../../../php/api/cronjobs/" class="md-nav__link">
386 Cronjobs
387 </a>
388 </li>
389
390
391
392
393
394
395
396 <li class="md-nav__item">
397 <a href="../../../php/api/events/" class="md-nav__link">
398 Events
399 </a>
400 </li>
401
402
403
404
405
406
407
408
409 <li class="md-nav__item md-nav__item--nested">
410
411
412 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
413
414 <label class="md-nav__link" for="__nav_2_5_5">
415 Form Builder
416 <span class="md-nav__icon md-icon"></span>
417 </label>
418 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
419 <label class="md-nav__title" for="__nav_2_5_5">
420 <span class="md-nav__icon md-icon"></span>
421 Form Builder
422 </label>
423 <ul class="md-nav__list" data-md-scrollfix>
424
425
426
427
428
429 <li class="md-nav__item">
430 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
431 Overview
432 </a>
433 </li>
434
435
436
437
438
439
440
441 <li class="md-nav__item">
442 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
443 Structure
444 </a>
445 </li>
446
447
448
449
450
451
452
453 <li class="md-nav__item">
454 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
455 Fields
456 </a>
457 </li>
458
459
460
461
462
463
464
465 <li class="md-nav__item">
466 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
467 Validation and Data
468 </a>
469 </li>
470
471
472
473
474
475
476
477 <li class="md-nav__item">
478 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
479 Dependencies
480 </a>
481 </li>
482
483
484
485 </ul>
486 </nav>
487 </li>
488
489
490
491
492
493
494
495 <li class="md-nav__item">
496 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
497 Package Installation Plugins
498 </a>
499 </li>
500
501
502
503
504
505
506
507 <li class="md-nav__item">
508 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
509 User Activity Points
510 </a>
511 </li>
512
513
514
515
516
517
518
519 <li class="md-nav__item">
520 <a href="../../../php/api/user_notifications/" class="md-nav__link">
521 User Notifications
522 </a>
523 </li>
524
525
526
527
528
529
530
531 <li class="md-nav__item">
532 <a href="../../../php/api/sitemaps/" class="md-nav__link">
533 Sitemaps
534 </a>
535 </li>
536
537
538
539 </ul>
540 </nav>
541 </li>
542
543
544
545
546
547
548
549 <li class="md-nav__item">
550 <a href="../../../php/code-style/" class="md-nav__link">
551 Code Style
552 </a>
553 </li>
554
555
556
557
558
559
560
561 <li class="md-nav__item">
562 <a href="../../../php/apps/" class="md-nav__link">
563 Apps
564 </a>
565 </li>
566
567
568
569
570
571
572
573 <li class="md-nav__item">
574 <a href="../../../php/gdpr/" class="md-nav__link">
575 GDPR
576 </a>
577 </li>
578
579
580
581 </ul>
582 </nav>
583 </li>
584
585
586
587
588
589
590
591
592
593
594
595 <li class="md-nav__item md-nav__item--nested">
596
597
598 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
599
600 <label class="md-nav__link" for="__nav_3">
601 Languages, Templates & CSS
602 <span class="md-nav__icon md-icon"></span>
603 </label>
604 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
605 <label class="md-nav__title" for="__nav_3">
606 <span class="md-nav__icon md-icon"></span>
607 Languages, Templates & CSS
608 </label>
609 <ul class="md-nav__list" data-md-scrollfix>
610
611
612
613
614
615 <li class="md-nav__item">
616 <a href="../../../view/languages/" class="md-nav__link">
617 Languages
618 </a>
619 </li>
620
621
622
623
624
625
626
627 <li class="md-nav__item">
628 <a href="../../../view/templates/" class="md-nav__link">
629 Templates
630 </a>
631 </li>
632
633
634
635
636
637
638
639 <li class="md-nav__item">
640 <a href="../../../view/template-plugins/" class="md-nav__link">
641 Template Plugins
642 </a>
643 </li>
644
645
646
647
648
649
650
651 <li class="md-nav__item">
652 <a href="../../../view/css/" class="md-nav__link">
653 CSS
654 </a>
655 </li>
656
657
658
659 </ul>
660 </nav>
661 </li>
662
663
664
665
666
667
668
669
670
671
672
673 <li class="md-nav__item md-nav__item--nested">
674
675
676 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
677
678 <label class="md-nav__link" for="__nav_4">
679 TypeScript and JavaScript API
680 <span class="md-nav__icon md-icon"></span>
681 </label>
682 <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
683 <label class="md-nav__title" for="__nav_4">
684 <span class="md-nav__icon md-icon"></span>
685 TypeScript and JavaScript API
686 </label>
687 <ul class="md-nav__list" data-md-scrollfix>
688
689
690
691
692
693 <li class="md-nav__item">
694 <a href="../../../javascript/general-usage/" class="md-nav__link">
695 General Usage
696 </a>
697 </li>
698
699
700
701
702
703
704
705 <li class="md-nav__item">
706 <a href="../../../javascript/typescript/" class="md-nav__link">
707 TypeScript
708 </a>
709 </li>
710
711
712
713
714
715
716
717
718 <li class="md-nav__item md-nav__item--nested">
719
720
721 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
722
723 <label class="md-nav__link" for="__nav_4_3">
724 New API
725 <span class="md-nav__icon md-icon"></span>
726 </label>
727 <nav class="md-nav" aria-label="New API" data-md-level="2">
728 <label class="md-nav__title" for="__nav_4_3">
729 <span class="md-nav__icon md-icon"></span>
730 New API
731 </label>
732 <ul class="md-nav__list" data-md-scrollfix>
733
734
735
736
737
738 <li class="md-nav__item">
739 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
740 Writing a module
741 </a>
742 </li>
743
744
745
746
747
748
749
750 <li class="md-nav__item">
751 <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
752 Data Structures
753 </a>
754 </li>
755
756
757
758
759
760
761
762 <li class="md-nav__item">
763 <a href="../../../javascript/new-api_core/" class="md-nav__link">
764 Core Functions
765 </a>
766 </li>
767
768
769
770
771
772
773
774 <li class="md-nav__item">
775 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
776 DOM
777 </a>
778 </li>
779
780
781
782
783
784
785
786 <li class="md-nav__item">
787 <a href="../../../javascript/new-api_events/" class="md-nav__link">
788 Event Handling
789 </a>
790 </li>
791
792
793
794
795
796
797
798 <li class="md-nav__item">
799 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
800 Ajax
801 </a>
802 </li>
803
804
805
806
807
808
809
810 <li class="md-nav__item">
811 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
812 Dialogs
813 </a>
814 </li>
815
816
817
818
819
820
821
822 <li class="md-nav__item">
823 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
824 Browser and Screen Sizes
825 </a>
826 </li>
827
828
829
830
831
832
833
834 <li class="md-nav__item">
835 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
836 User Interface
837 </a>
838 </li>
839
840
841
842 </ul>
843 </nav>
844 </li>
845
846
847
848
849
850
851
852 <li class="md-nav__item">
853 <a href="../../../javascript/legacy-api/" class="md-nav__link">
854 Legacy API
855 </a>
856 </li>
857
858
859
860
861
862
863
864 <li class="md-nav__item">
865 <a href="../../../javascript/helper-functions/" class="md-nav__link">
866 Helper Functions
867 </a>
868 </li>
869
870
871
872
873
874
875
876 <li class="md-nav__item">
877 <a href="../../../javascript/code-snippets/" class="md-nav__link">
878 Code Snippets
879 </a>
880 </li>
881
882
883
884 </ul>
885 </nav>
886 </li>
887
888
889
890
891
892
893
894
895
896
897
898 <li class="md-nav__item md-nav__item--nested">
899
900
901 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
902
903 <label class="md-nav__link" for="__nav_5">
904 Package Components
905 <span class="md-nav__icon md-icon"></span>
906 </label>
907 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
908 <label class="md-nav__title" for="__nav_5">
909 <span class="md-nav__icon md-icon"></span>
910 Package Components
911 </label>
912 <ul class="md-nav__list" data-md-scrollfix>
913
914
915
916
917
918 <li class="md-nav__item">
919 <a href="../../../package/package-xml/" class="md-nav__link">
920 package.xml
921 </a>
922 </li>
923
924
925
926
927
928
929
930
931 <li class="md-nav__item md-nav__item--nested">
932
933
934 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
935
936 <label class="md-nav__link" for="__nav_5_2">
937 PIPs
938 <span class="md-nav__icon md-icon"></span>
939 </label>
940 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
941 <label class="md-nav__title" for="__nav_5_2">
942 <span class="md-nav__icon md-icon"></span>
943 PIPs
944 </label>
945 <ul class="md-nav__list" data-md-scrollfix>
946
947
948
949
950
951 <li class="md-nav__item">
952 <a href="../../../package/pip/" class="md-nav__link">
953 Overview
954 </a>
955 </li>
956
957
958
959
960
961
962
963 <li class="md-nav__item">
964 <a href="../../../package/pip/acl-option/" class="md-nav__link">
965 aclOption
966 </a>
967 </li>
968
969
970
971
972
973
974
975 <li class="md-nav__item">
976 <a href="../../../package/pip/acp-menu/" class="md-nav__link">
977 acpMenu
978 </a>
979 </li>
980
981
982
983
984
985
986
987 <li class="md-nav__item">
988 <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
989 acpSearchProvider
990 </a>
991 </li>
992
993
994
995
996
997
998
999 <li class="md-nav__item">
1000 <a href="../../../package/pip/acp-template/" class="md-nav__link">
1001 acpTemplate
1002 </a>
1003 </li>
1004
1005
1006
1007
1008
1009
1010
1011 <li class="md-nav__item">
1012 <a href="../../../package/pip/bbcode/" class="md-nav__link">
1013 bbcode
1014 </a>
1015 </li>
1016
1017
1018
1019
1020
1021
1022
1023 <li class="md-nav__item">
1024 <a href="../../../package/pip/box/" class="md-nav__link">
1025 box
1026 </a>
1027 </li>
1028
1029
1030
1031
1032
1033
1034
1035 <li class="md-nav__item">
1036 <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1037 clipboardAction
1038 </a>
1039 </li>
1040
1041
1042
1043
1044
1045
1046
1047 <li class="md-nav__item">
1048 <a href="../../../package/pip/core-object/" class="md-nav__link">
1049 coreObject
1050 </a>
1051 </li>
1052
1053
1054
1055
1056
1057
1058
1059 <li class="md-nav__item">
1060 <a href="../../../package/pip/cronjob/" class="md-nav__link">
1061 cronjob
1062 </a>
1063 </li>
1064
1065
1066
1067
1068
1069
1070
1071 <li class="md-nav__item">
1072 <a href="../../../package/pip/database/" class="md-nav__link">
1073 database
1074 </a>
1075 </li>
1076
1077
1078
1079
1080
1081
1082
1083 <li class="md-nav__item">
1084 <a href="../../../package/pip/event-listener/" class="md-nav__link">
1085 eventListener
1086 </a>
1087 </li>
1088
1089
1090
1091
1092
1093
1094
1095 <li class="md-nav__item">
1096 <a href="../../../package/pip/file/" class="md-nav__link">
1097 file
1098 </a>
1099 </li>
1100
1101
1102
1103
1104
1105
1106
1107 <li class="md-nav__item">
1108 <a href="../../../package/pip/language/" class="md-nav__link">
1109 language
1110 </a>
1111 </li>
1112
1113
1114
1115
1116
1117
1118
1119 <li class="md-nav__item">
1120 <a href="../../../package/pip/media-provider/" class="md-nav__link">
1121 mediaProvider
1122 </a>
1123 </li>
1124
1125
1126
1127
1128
1129
1130
1131 <li class="md-nav__item">
1132 <a href="../../../package/pip/menu/" class="md-nav__link">
1133 menu
1134 </a>
1135 </li>
1136
1137
1138
1139
1140
1141
1142
1143 <li class="md-nav__item">
1144 <a href="../../../package/pip/menu-item/" class="md-nav__link">
1145 menuItem
1146 </a>
1147 </li>
1148
1149
1150
1151
1152
1153
1154
1155 <li class="md-nav__item">
1156 <a href="../../../package/pip/object-type/" class="md-nav__link">
1157 objectType
1158 </a>
1159 </li>
1160
1161
1162
1163
1164
1165
1166
1167 <li class="md-nav__item">
1168 <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1169 objectTypeDefinition
1170 </a>
1171 </li>
1172
1173
1174
1175
1176
1177
1178
1179 <li class="md-nav__item">
1180 <a href="../../../package/pip/option/" class="md-nav__link">
1181 option
1182 </a>
1183 </li>
1184
1185
1186
1187
1188
1189
1190
1191 <li class="md-nav__item">
1192 <a href="../../../package/pip/page/" class="md-nav__link">
1193 page
1194 </a>
1195 </li>
1196
1197
1198
1199
1200
1201
1202
1203 <li class="md-nav__item">
1204 <a href="../../../package/pip/pip/" class="md-nav__link">
1205 pip
1206 </a>
1207 </li>
1208
1209
1210
1211
1212
1213
1214
1215 <li class="md-nav__item">
1216 <a href="../../../package/pip/script/" class="md-nav__link">
1217 script
1218 </a>
1219 </li>
1220
1221
1222
1223
1224
1225
1226
1227 <li class="md-nav__item">
1228 <a href="../../../package/pip/smiley/" class="md-nav__link">
1229 smiley
1230 </a>
1231 </li>
1232
1233
1234
1235
1236
1237
1238
1239 <li class="md-nav__item">
1240 <a href="../../../package/pip/sql/" class="md-nav__link">
1241 sql
1242 </a>
1243 </li>
1244
1245
1246
1247
1248
1249
1250
1251 <li class="md-nav__item">
1252 <a href="../../../package/pip/style/" class="md-nav__link">
1253 style
1254 </a>
1255 </li>
1256
1257
1258
1259
1260
1261
1262
1263 <li class="md-nav__item">
1264 <a href="../../../package/pip/template/" class="md-nav__link">
1265 template
1266 </a>
1267 </li>
1268
1269
1270
1271
1272
1273
1274
1275 <li class="md-nav__item">
1276 <a href="../../../package/pip/template-listener/" class="md-nav__link">
1277 templateListener
1278 </a>
1279 </li>
1280
1281
1282
1283
1284
1285
1286
1287 <li class="md-nav__item">
1288 <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1289 userGroupOption
1290 </a>
1291 </li>
1292
1293
1294
1295
1296
1297
1298
1299 <li class="md-nav__item">
1300 <a href="../../../package/pip/user-menu/" class="md-nav__link">
1301 userMenu
1302 </a>
1303 </li>
1304
1305
1306
1307
1308
1309
1310
1311 <li class="md-nav__item">
1312 <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1313 userNotificationEvent
1314 </a>
1315 </li>
1316
1317
1318
1319
1320
1321
1322
1323 <li class="md-nav__item">
1324 <a href="../../../package/pip/user-option/" class="md-nav__link">
1325 userOption
1326 </a>
1327 </li>
1328
1329
1330
1331
1332
1333
1334
1335 <li class="md-nav__item">
1336 <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1337 userProfileMenu
1338 </a>
1339 </li>
1340
1341
1342
1343 </ul>
1344 </nav>
1345 </li>
1346
1347
1348
1349
1350
1351
1352
1353 <li class="md-nav__item">
1354 <a href="../../../package/database-php-api/" class="md-nav__link">
1355 Database PHP API
1356 </a>
1357 </li>
1358
1359
1360
1361 </ul>
1362 </nav>
1363 </li>
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1378
1379
1380 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
1381
1382 <label class="md-nav__link" for="__nav_6">
1383 Migration
1384 <span class="md-nav__icon md-icon"></span>
1385 </label>
1386 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1387 <label class="md-nav__title" for="__nav_6">
1388 <span class="md-nav__icon md-icon"></span>
1389 Migration
1390 </label>
1391 <ul class="md-nav__list" data-md-scrollfix>
1392
1393
1394
1395
1396
1397
1398 <li class="md-nav__item md-nav__item--nested">
1399
1400
1401 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1402
1403 <label class="md-nav__link" for="__nav_6_1">
1404 Migrating from WSC 5.3
1405 <span class="md-nav__icon md-icon"></span>
1406 </label>
1407 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1408 <label class="md-nav__title" for="__nav_6_1">
1409 <span class="md-nav__icon md-icon"></span>
1410 Migrating from WSC 5.3
1411 </label>
1412 <ul class="md-nav__list" data-md-scrollfix>
1413
1414
1415
1416
1417
1418 <li class="md-nav__item">
1419 <a href="../../wsc53/php/" class="md-nav__link">
1420 PHP API
1421 </a>
1422 </li>
1423
1424
1425
1426
1427
1428
1429
1430 <li class="md-nav__item">
1431 <a href="../../wsc53/session/" class="md-nav__link">
1432 Session Handling and Authentication
1433 </a>
1434 </li>
1435
1436
1437
1438
1439
1440
1441
1442 <li class="md-nav__item">
1443 <a href="../../wsc53/javascript/" class="md-nav__link">
1444 TypeScript and JavaScript
1445 </a>
1446 </li>
1447
1448
1449
1450
1451
1452
1453
1454 <li class="md-nav__item">
1455 <a href="../../wsc53/templates/" class="md-nav__link">
1456 Templates
1457 </a>
1458 </li>
1459
1460
1461
1462
1463
1464
1465
1466 <li class="md-nav__item">
1467 <a href="../../wsc53/libraries/" class="md-nav__link">
1468 Third Party Libraries
1469 </a>
1470 </li>
1471
1472
1473
1474 </ul>
1475 </nav>
1476 </li>
1477
1478
1479
1480
1481
1482
1483
1484
1485 <li class="md-nav__item md-nav__item--nested">
1486
1487
1488 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1489
1490 <label class="md-nav__link" for="__nav_6_2">
1491 Migrating from WSC 5.2
1492 <span class="md-nav__icon md-icon"></span>
1493 </label>
1494 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1495 <label class="md-nav__title" for="__nav_6_2">
1496 <span class="md-nav__icon md-icon"></span>
1497 Migrating from WSC 5.2
1498 </label>
1499 <ul class="md-nav__list" data-md-scrollfix>
1500
1501
1502
1503
1504
1505 <li class="md-nav__item">
1506 <a href="../../wsc52/php/" class="md-nav__link">
1507 PHP API
1508 </a>
1509 </li>
1510
1511
1512
1513
1514
1515
1516
1517 <li class="md-nav__item">
1518 <a href="../../wsc52/templates/" class="md-nav__link">
1519 Templates and Languages
1520 </a>
1521 </li>
1522
1523
1524
1525
1526
1527
1528
1529 <li class="md-nav__item">
1530 <a href="../../wsc52/libraries/" class="md-nav__link">
1531 Third Party Libraries
1532 </a>
1533 </li>
1534
1535
1536
1537 </ul>
1538 </nav>
1539 </li>
1540
1541
1542
1543
1544
1545
1546
1547
1548 <li class="md-nav__item md-nav__item--nested">
1549
1550
1551 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1552
1553 <label class="md-nav__link" for="__nav_6_3">
1554 Migrating from WSC 3.1
1555 <span class="md-nav__icon md-icon"></span>
1556 </label>
1557 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1558 <label class="md-nav__title" for="__nav_6_3">
1559 <span class="md-nav__icon md-icon"></span>
1560 Migrating from WSC 3.1
1561 </label>
1562 <ul class="md-nav__list" data-md-scrollfix>
1563
1564
1565
1566
1567
1568 <li class="md-nav__item">
1569 <a href="../../wsc31/php/" class="md-nav__link">
1570 PHP API
1571 </a>
1572 </li>
1573
1574
1575
1576 </ul>
1577 </nav>
1578 </li>
1579
1580
1581
1582
1583
1584
1585
1586
1587 <li class="md-nav__item md-nav__item--nested">
1588
1589
1590 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1591
1592 <label class="md-nav__link" for="__nav_6_4">
1593 Migrating from WSC 3.0
1594 <span class="md-nav__icon md-icon"></span>
1595 </label>
1596 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1597 <label class="md-nav__title" for="__nav_6_4">
1598 <span class="md-nav__icon md-icon"></span>
1599 Migrating from WSC 3.0
1600 </label>
1601 <ul class="md-nav__list" data-md-scrollfix>
1602
1603
1604
1605
1606
1607 <li class="md-nav__item">
1608 <a href="../../wsc30/php/" class="md-nav__link">
1609 PHP API
1610 </a>
1611 </li>
1612
1613
1614
1615
1616
1617
1618
1619 <li class="md-nav__item">
1620 <a href="../../wsc30/javascript/" class="md-nav__link">
1621 JavaScript API
1622 </a>
1623 </li>
1624
1625
1626
1627
1628
1629
1630
1631 <li class="md-nav__item">
1632 <a href="../../wsc30/templates/" class="md-nav__link">
1633 Templates
1634 </a>
1635 </li>
1636
1637
1638
1639
1640
1641
1642
1643 <li class="md-nav__item">
1644 <a href="../../wsc30/css/" class="md-nav__link">
1645 CSS
1646 </a>
1647 </li>
1648
1649
1650
1651
1652
1653
1654
1655 <li class="md-nav__item">
1656 <a href="../../wsc30/package/" class="md-nav__link">
1657 Package Components
1658 </a>
1659 </li>
1660
1661
1662
1663 </ul>
1664 </nav>
1665 </li>
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1677
1678
1679 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" checked>
1680
1681 <label class="md-nav__link" for="__nav_6_5">
1682 Migrating from WCF 2.1
1683 <span class="md-nav__icon md-icon"></span>
1684 </label>
1685 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1686 <label class="md-nav__title" for="__nav_6_5">
1687 <span class="md-nav__icon md-icon"></span>
1688 Migrating from WCF 2.1
1689 </label>
1690 <ul class="md-nav__list" data-md-scrollfix>
1691
1692
1693
1694
1695
1696 <li class="md-nav__item">
1697 <a href="../php/" class="md-nav__link">
1698 PHP API
1699 </a>
1700 </li>
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710 <li class="md-nav__item md-nav__item--active">
1711
1712 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1713
1714
1715
1716
1717 <label class="md-nav__link md-nav__link--active" for="__toc">
1718 Templates
1719 <span class="md-nav__icon md-icon"></span>
1720 </label>
1721
1722 <a href="./" class="md-nav__link md-nav__link--active">
1723 Templates
1724 </a>
1725
1726
1727 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1728
1729
1730
1731
1732
1733 <label class="md-nav__title" for="__toc">
1734 <span class="md-nav__icon md-icon"></span>
1735 Table of contents
1736 </label>
1737 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1738
1739 <li class="md-nav__item">
1740 <a href="#page-layout" class="md-nav__link">
1741 Page Layout
1742 </a>
1743
1744 </li>
1745
1746 <li class="md-nav__item">
1747 <a href="#sidebars" class="md-nav__link">
1748 Sidebars
1749 </a>
1750
1751 </li>
1752
1753 <li class="md-nav__item">
1754 <a href="#forms" class="md-nav__link">
1755 Forms
1756 </a>
1757
1758 </li>
1759
1760 <li class="md-nav__item">
1761 <a href="#icons" class="md-nav__link">
1762 Icons
1763 </a>
1764
1765 <nav class="md-nav" aria-label="Icons">
1766 <ul class="md-nav__list">
1767
1768 <li class="md-nav__item">
1769 <a href="#changed-icon-names" class="md-nav__link">
1770 Changed Icon Names
1771 </a>
1772
1773 </li>
1774
1775 </ul>
1776 </nav>
1777
1778 </li>
1779
1780 <li class="md-nav__item">
1781 <a href="#changed-classes" class="md-nav__link">
1782 Changed Classes
1783 </a>
1784
1785 </li>
1786
1787 <li class="md-nav__item">
1788 <a href="#removed-elements-and-classes" class="md-nav__link">
1789 Removed Elements and Classes
1790 </a>
1791
1792 </li>
1793
1794 <li class="md-nav__item">
1795 <a href="#simple-example" class="md-nav__link">
1796 Simple Example
1797 </a>
1798
1799 </li>
1800
1801 <li class="md-nav__item">
1802 <a href="#full-example" class="md-nav__link">
1803 Full Example
1804 </a>
1805
1806 <nav class="md-nav" aria-label="Full Example">
1807 <ul class="md-nav__list">
1808
1809 <li class="md-nav__item">
1810 <a href="#content-header" class="md-nav__link">
1811 Content Header
1812 </a>
1813
1814 <nav class="md-nav" aria-label="Content Header">
1815 <ul class="md-nav__list">
1816
1817 <li class="md-nav__item">
1818 <a href="#recommended-approach" class="md-nav__link">
1819 Recommended Approach
1820 </a>
1821
1822 </li>
1823
1824 <li class="md-nav__item">
1825 <a href="#alternative" class="md-nav__link">
1826 Alternative
1827 </a>
1828
1829 </li>
1830
1831 </ul>
1832 </nav>
1833
1834 </li>
1835
1836 </ul>
1837 </nav>
1838
1839 </li>
1840
1841 </ul>
1842
1843 </nav>
1844
1845 </li>
1846
1847
1848
1849
1850
1851
1852
1853 <li class="md-nav__item">
1854 <a href="../css/" class="md-nav__link">
1855 CSS
1856 </a>
1857 </li>
1858
1859
1860
1861
1862
1863
1864
1865 <li class="md-nav__item">
1866 <a href="../package/" class="md-nav__link">
1867 Package Components
1868 </a>
1869 </li>
1870
1871
1872
1873 </ul>
1874 </nav>
1875 </li>
1876
1877
1878
1879 </ul>
1880 </nav>
1881 </li>
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893 <li class="md-nav__item md-nav__item--nested">
1894
1895
1896 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1897
1898 <label class="md-nav__link" for="__nav_7">
1899 Tutorials
1900 <span class="md-nav__icon md-icon"></span>
1901 </label>
1902 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1903 <label class="md-nav__title" for="__nav_7">
1904 <span class="md-nav__icon md-icon"></span>
1905 Tutorials
1906 </label>
1907 <ul class="md-nav__list" data-md-scrollfix>
1908
1909
1910
1911
1912
1913
1914 <li class="md-nav__item md-nav__item--nested">
1915
1916
1917 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1918
1919 <label class="md-nav__link" for="__nav_7_1">
1920 Tutorial Series
1921 <span class="md-nav__icon md-icon"></span>
1922 </label>
1923 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1924 <label class="md-nav__title" for="__nav_7_1">
1925 <span class="md-nav__icon md-icon"></span>
1926 Tutorial Series
1927 </label>
1928 <ul class="md-nav__list" data-md-scrollfix>
1929
1930
1931
1932
1933
1934 <li class="md-nav__item">
1935 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1936 Overview
1937 </a>
1938 </li>
1939
1940
1941
1942
1943
1944
1945
1946 <li class="md-nav__item">
1947 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1948 Part 1
1949 </a>
1950 </li>
1951
1952
1953
1954
1955
1956
1957
1958 <li class="md-nav__item">
1959 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1960 Part 2
1961 </a>
1962 </li>
1963
1964
1965
1966
1967
1968
1969
1970 <li class="md-nav__item">
1971 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1972 Part 3
1973 </a>
1974 </li>
1975
1976
1977
1978 </ul>
1979 </nav>
1980 </li>
1981
1982
1983
1984 </ul>
1985 </nav>
1986 </li>
1987
1988
1989
1990 </ul>
1991 </nav>
1992 </div>
1993 </div>
1994 </div>
1995
1996
1997
1998 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1999 <div class="md-sidebar__scrollwrap">
2000 <div class="md-sidebar__inner">
2001
2002 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2003
2004
2005
2006
2007
2008 <label class="md-nav__title" for="__toc">
2009 <span class="md-nav__icon md-icon"></span>
2010 Table of contents
2011 </label>
2012 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2013
2014 <li class="md-nav__item">
2015 <a href="#page-layout" class="md-nav__link">
2016 Page Layout
2017 </a>
2018
2019 </li>
2020
2021 <li class="md-nav__item">
2022 <a href="#sidebars" class="md-nav__link">
2023 Sidebars
2024 </a>
2025
2026 </li>
2027
2028 <li class="md-nav__item">
2029 <a href="#forms" class="md-nav__link">
2030 Forms
2031 </a>
2032
2033 </li>
2034
2035 <li class="md-nav__item">
2036 <a href="#icons" class="md-nav__link">
2037 Icons
2038 </a>
2039
2040 <nav class="md-nav" aria-label="Icons">
2041 <ul class="md-nav__list">
2042
2043 <li class="md-nav__item">
2044 <a href="#changed-icon-names" class="md-nav__link">
2045 Changed Icon Names
2046 </a>
2047
2048 </li>
2049
2050 </ul>
2051 </nav>
2052
2053 </li>
2054
2055 <li class="md-nav__item">
2056 <a href="#changed-classes" class="md-nav__link">
2057 Changed Classes
2058 </a>
2059
2060 </li>
2061
2062 <li class="md-nav__item">
2063 <a href="#removed-elements-and-classes" class="md-nav__link">
2064 Removed Elements and Classes
2065 </a>
2066
2067 </li>
2068
2069 <li class="md-nav__item">
2070 <a href="#simple-example" class="md-nav__link">
2071 Simple Example
2072 </a>
2073
2074 </li>
2075
2076 <li class="md-nav__item">
2077 <a href="#full-example" class="md-nav__link">
2078 Full Example
2079 </a>
2080
2081 <nav class="md-nav" aria-label="Full Example">
2082 <ul class="md-nav__list">
2083
2084 <li class="md-nav__item">
2085 <a href="#content-header" class="md-nav__link">
2086 Content Header
2087 </a>
2088
2089 <nav class="md-nav" aria-label="Content Header">
2090 <ul class="md-nav__list">
2091
2092 <li class="md-nav__item">
2093 <a href="#recommended-approach" class="md-nav__link">
2094 Recommended Approach
2095 </a>
2096
2097 </li>
2098
2099 <li class="md-nav__item">
2100 <a href="#alternative" class="md-nav__link">
2101 Alternative
2102 </a>
2103
2104 </li>
2105
2106 </ul>
2107 </nav>
2108
2109 </li>
2110
2111 </ul>
2112 </nav>
2113
2114 </li>
2115
2116 </ul>
2117
2118 </nav>
2119 </div>
2120 </div>
2121 </div>
2122
2123
2124 <div class="md-content" data-md-component="content">
2125 <article class="md-content__inner md-typeset">
2126
2127
2128 <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/migration/wcf21/templates.md" title="Edit this page" class="md-content__button md-icon">
2129 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
2130 </a>
2131
2132
2133 <h1 id="wcf-21x-templates">WCF 2.1.x - Templates<a class="headerlink" href="#wcf-21x-templates" title="Permanent link">#</a></h1>
2134 <h2 id="page-layout">Page Layout<a class="headerlink" href="#page-layout" title="Permanent link">#</a></h2>
2135 <p>The template structure has been overhauled and it is no longer required nor recommended to include internal templates, such as <code>documentHeader</code>, <code>headInclude</code> or <code>userNotice</code>. Instead use a simple <code>{include file='header'}</code> that now takes care of of the entire application frame.</p>
2136 <ul>
2137 <li>Templates must not include a trailing <code>&lt;/body&gt;&lt;/html&gt;</code> after including the <code>footer</code> template.</li>
2138 <li>The <code>documentHeader</code>, <code>headInclude</code> and <code>userNotice</code> template should no longer be included manually, the same goes with the <code>&lt;body&gt;</code> element, please use <code>{include file='header'}</code> instead.</li>
2139 <li>The <code>sidebarOrientation</code> variable for the <code>header</code> template has been removed and no longer works.</li>
2140 <li><code>header.boxHeadline</code> has been unified and now reads <code>header.contentHeader</code></li>
2141 </ul>
2142 <p>Please see the full example at the end of this page for more information.</p>
2143 <h2 id="sidebars">Sidebars<a class="headerlink" href="#sidebars" title="Permanent link">#</a></h2>
2144 <p>Sidebars are now dynamically populated by the box system, this requires a small change to unify the markup. Additionally the usage of <code>&lt;fieldset&gt;</code> has been deprecated due to browser inconsistencies and bugs and should be replaced with <code>section.box</code>.</p>
2145 <p>Previous markup used in WoltLab Community Framework 2.1 and earlier:</p>
2146 <div class="highlight"><pre><span></span><code><span class="p">&lt;</span><span class="nt">fieldset</span><span class="p">&gt;</span>
2147 <span class="p">&lt;</span><span class="nt">legend</span><span class="p">&gt;</span><span class="c">&lt;!-- Title --&gt;</span><span class="p">&lt;/</span><span class="nt">legend</span><span class="p">&gt;</span>
2148
2149 <span class="p">&lt;</span><span class="nt">div</span><span class="p">&gt;</span>
2150 <span class="c">&lt;!-- Content --&gt;</span>
2151 <span class="p">&lt;/</span><span class="nt">div</span><span class="p">&gt;</span>
2152 <span class="p">&lt;/</span><span class="nt">fieldset</span><span class="p">&gt;</span>
2153 </code></pre></div>
2154 <p>The new markup since WoltLab Suite 3.0:</p>
2155 <div class="highlight"><pre><span></span><code><span class="p">&lt;</span><span class="nt">section</span> <span class="na">class</span><span class="o">=</span><span class="s">&quot;box&quot;</span><span class="p">&gt;</span>
2156 <span class="p">&lt;</span><span class="nt">h2</span> <span class="na">class</span><span class="o">=</span><span class="s">&quot;boxTitle&quot;</span><span class="p">&gt;</span><span class="c">&lt;!-- Title --&gt;</span><span class="p">&lt;/</span><span class="nt">h2</span><span class="p">&gt;</span>
2157
2158 <span class="p">&lt;</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">&quot;boxContent&quot;</span><span class="p">&gt;</span>
2159 <span class="c">&lt;!-- Content --&gt;</span>
2160 <span class="p">&lt;/</span><span class="nt">div</span><span class="p">&gt;</span>
2161 <span class="p">&lt;/</span><span class="nt">section</span><span class="p">&gt;</span>
2162 </code></pre></div>
2163 <h2 id="forms">Forms<a class="headerlink" href="#forms" title="Permanent link">#</a></h2>
2164 <p>The input tag for session ids <code>SID_INPUT_TAG</code> has been deprecated and no longer yields any content, it can be safely removed. In previous versions forms have been wrapped in <code>&lt;div class="container containerPadding marginTop"&gt;&lt;/div&gt;</code> which no longer has any effect and should be removed.</p>
2165 <p>If you're using the preview feature for WYSIWYG-powered input fields, you need to alter the preview button include instruction:</p>
2166 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;messageFormPreviewButton&#39;</span> <span class="na">previewMessageObjectType</span><span class="o">=</span><span class="s1">&#39;com.example.foo.bar&#39;</span> <span class="na">previewMessageObjectID</span><span class="o">=</span><span class="m">0</span><span class="cp">}</span><span class="x"></span>
2167 </code></pre></div>
2168 <p><em>The message object id should be non-zero when editing.</em></p>
2169 <h2 id="icons">Icons<a class="headerlink" href="#icons" title="Permanent link">#</a></h2>
2170 <p>The old <code>.icon-&lt;iconName&gt;</code> classes have been removed, you are required to use the official <code>.fa-&lt;iconName&gt;</code> class names from FontAwesome. This does not affect the generic classes <code>.icon</code> (indicates an icon) and <code>.icon&lt;size&gt;</code> (e.g. <code>.icon16</code> that sets the dimensions), these are still required and have not been deprecated.</p>
2171 <p>Before:</p>
2172 <div class="highlight"><pre><span></span><code><span class="p">&lt;</span><span class="nt">span</span> <span class="na">class</span><span class="o">=</span><span class="s">&quot;icon icon16 icon-list&quot;</span><span class="p">&gt;</span>
2173 </code></pre></div>
2174 <p>Now:</p>
2175 <div class="highlight"><pre><span></span><code><span class="p">&lt;</span><span class="nt">span</span> <span class="na">class</span><span class="o">=</span><span class="s">&quot;icon icon16 fa-list&quot;</span><span class="p">&gt;</span>
2176 </code></pre></div>
2177 <h3 id="changed-icon-names">Changed Icon Names<a class="headerlink" href="#changed-icon-names" title="Permanent link">#</a></h3>
2178 <p>Quite a few icon names have been renamed, the official wiki lists the <a href="https://github.com/FortAwesome/Font-Awesome/wiki/Upgrading-from-3.2.1-to-4">new icon names</a> in FontAwesome 4.</p>
2179 <h2 id="changed-classes">Changed Classes<a class="headerlink" href="#changed-classes" title="Permanent link">#</a></h2>
2180 <ul>
2181 <li><code>.dataList</code> has been replaced and should now read <code>&lt;ol class="inlineList commaSeparated"&gt;</code> (same applies to <code>&lt;ul&gt;</code>)</li>
2182 <li><code>.framedIconList</code> has been changed into <code>.userAvatarList</code></li>
2183 </ul>
2184 <h2 id="removed-elements-and-classes">Removed Elements and Classes<a class="headerlink" href="#removed-elements-and-classes" title="Permanent link">#</a></h2>
2185 <ul>
2186 <li><code>&lt;nav class="jsClipboardEditor"&gt;</code> and <code>&lt;div class="jsClipboardContainer"&gt;</code> have been replaced with a floating button.</li>
2187 <li>The anchors <code>a.toTopLink</code> have been replaced with a floating button.</li>
2188 <li>Avatars should no longer receive the class <code>framed</code></li>
2189 <li>The <code>dl.condensed</code> class, as seen in the editor tab menu, is no longer required.</li>
2190 <li>Anything related to <code>sidebarCollapsed</code> has been removed as sidebars are no longer collapsible.</li>
2191 </ul>
2192 <h2 id="simple-example">Simple Example<a class="headerlink" href="#simple-example" title="Permanent link">#</a></h2>
2193 <p>The code below includes only the absolute minimum required to display a page, the content title is already included in the output.</p>
2194 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;header&#39;</span><span class="cp">}</span><span class="x"></span>
2195
2196 <span class="x">&lt;div class=&quot;section&quot;&gt;</span>
2197 <span class="x"> Hello World!</span>
2198 <span class="x">&lt;/div&gt;</span>
2199
2200 <span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;footer&#39;</span><span class="cp">}</span><span class="x"></span>
2201 </code></pre></div>
2202 <h2 id="full-example">Full Example<a class="headerlink" href="#full-example" title="Permanent link">#</a></h2>
2203 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="c">*</span>
2204 <span class="c"> The page title is automatically set using the page definition, avoid setting it if you can!</span>
2205 <span class="c"> If you really need to modify the title, you can still reference the original title with:</span>
2206 <span class="c"> {$__wcf-&gt;getActivePage()-&gt;getTitle()}</span>
2207 <span class="c">*</span><span class="cp">}</span><span class="x"></span>
2208 <span class="cp">{</span><span class="nf">capture</span> <span class="na">assign</span><span class="o">=</span><span class="s1">&#39;pageTitle&#39;</span><span class="cp">}</span><span class="x">Custom Page Title</span><span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2209
2210 <span class="cp">{</span><span class="c">*</span>
2211 <span class="c"> NOTICE: The content header goes here, see the section after this to learn more.</span>
2212 <span class="c">*</span><span class="cp">}</span><span class="x"></span>
2213
2214 <span class="cp">{</span><span class="c">* you must not use `headContent` for JavaScript *</span><span class="cp">}</span><span class="x"></span>
2215 <span class="cp">{</span><span class="nf">capture</span> <span class="na">assign</span><span class="o">=</span><span class="s1">&#39;headContent&#39;</span><span class="cp">}</span><span class="x"></span>
2216 <span class="x"> &lt;link rel=&quot;alternate&quot; type=&quot;application/rss+xml&quot; title=&quot;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.global.button.rss</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&quot; href=&quot;&quot;&gt;</span>
2217 <span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2218
2219 <span class="cp">{</span><span class="c">* optional, content will be added to the top of the left sidebar *</span><span class="cp">}</span><span class="x"></span>
2220 <span class="cp">{</span><span class="nf">capture</span> <span class="na">assign</span><span class="o">=</span><span class="s1">&#39;sidebarLeft&#39;</span><span class="cp">}</span><span class="x"></span>
2221 <span class="x"></span>
2222
2223 <span class="x"> </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;boxes&#39;</span><span class="cp">}</span><span class="x"></span>
2224 <span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2225
2226 <span class="cp">{</span><span class="c">* optional, content will be added to the top of the right sidebar *</span><span class="cp">}</span><span class="x"></span>
2227 <span class="cp">{</span><span class="nf">capture</span> <span class="na">assign</span><span class="o">=</span><span class="s1">&#39;sidebarRight&#39;</span><span class="cp">}</span><span class="x"></span>
2228 <span class="x"></span>
2229
2230 <span class="x"> </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;boxes&#39;</span><span class="cp">}</span><span class="x"></span>
2231 <span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2232
2233 <span class="cp">{</span><span class="nf">capture</span> <span class="na">assign</span><span class="o">=</span><span class="s1">&#39;headerNavigation&#39;</span><span class="cp">}</span><span class="x"></span>
2234 <span class="x"> &lt;li&gt;&lt;a href=&quot;#&quot; title=&quot;Custom Button&quot; class=&quot;jsTooltip&quot;&gt;&lt;span class=&quot;icon icon16 fa-check&quot;&gt;&lt;/span&gt; &lt;span class=&quot;invisible&quot;&gt;Custom Button&lt;/span&gt;&lt;/a&gt;&lt;/li&gt;</span>
2235 <span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2236
2237 <span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;header&#39;</span><span class="cp">}</span><span class="x"></span>
2238
2239 <span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span><span class="x"></span>
2240 <span class="x"> &lt;div class=&quot;paginationTop&quot;&gt;</span>
2241 <span class="x"> </span><span class="cp">{</span><span class="nf">content</span><span class="cp">}</span><span class="x"></span>
2242 <span class="x"> </span><span class="cp">{</span><span class="nf">pages</span> <span class="err"></span><span class="cp">}</span><span class="x"></span>
2243 <span class="x"> </span><span class="cp">{</span><span class="nf">/content</span><span class="cp">}</span><span class="x"></span>
2244 <span class="x"> &lt;/div&gt;</span>
2245 <span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span><span class="x"></span>
2246
2247 <span class="cp">{</span><span class="c">* the actual content *</span><span class="cp">}</span><span class="x"></span>
2248 <span class="x">&lt;div class=&quot;section&quot;&gt;</span>
2249 <span class="x"></span>
2250 <span class="x">&lt;/div&gt;</span>
2251
2252 <span class="x">&lt;footer class=&quot;contentFooter&quot;&gt;</span>
2253 <span class="x"> </span><span class="cp">{</span><span class="c">* skip this if you&#39;re not using any pagination *</span><span class="cp">}</span><span class="x"></span>
2254 <span class="x"> </span><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span><span class="x"></span>
2255 <span class="x"> &lt;div class=&quot;paginationBottom&quot;&gt;</span>
2256 <span class="x"> </span><span class="cp">{</span><span class="nf">content</span><span class="cp">}{</span><span class="o">@</span><span class="nv">$pagesLinks</span><span class="cp">}{</span><span class="nf">/content</span><span class="cp">}</span><span class="x"></span>
2257 <span class="x"> &lt;/div&gt;</span>
2258 <span class="x"> </span><span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span><span class="x"></span>
2259
2260 <span class="x"> &lt;nav class=&quot;contentFooterNavigation&quot;&gt;</span>
2261 <span class="x"> &lt;ul&gt;</span>
2262 <span class="x"> &lt;li&gt;&lt;a href=&quot;&quot; class=&quot;button&quot;&gt;&lt;span class=&quot;icon icon16 fa-plus&quot;&gt;&lt;/span&gt; &lt;span&gt;Custom Button&lt;/span&gt;&lt;/a&gt;&lt;/li&gt;</span>
2263 <span class="x"> </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;contentFooterNavigation&#39;</span><span class="cp">}</span><span class="x"></span>
2264 <span class="x"> &lt;/ul&gt;</span>
2265 <span class="x"> &lt;/nav&gt;</span>
2266 <span class="x">&lt;/footer&gt;</span>
2267
2268 <span class="x">&lt;script data-relocate=&quot;true&quot;&gt;</span>
2269 <span class="x"> /* any JavaScript code you need */</span>
2270 <span class="x">&lt;/script&gt;</span>
2271
2272 <span class="cp">{</span><span class="c">* do not include `&lt;/body&gt;&lt;/html&gt;` here, the footer template is the last bit of code! *</span><span class="cp">}</span><span class="x"></span>
2273 <span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;footer&#39;</span><span class="cp">}</span><span class="x"></span>
2274 </code></pre></div>
2275 <h3 id="content-header">Content Header<a class="headerlink" href="#content-header" title="Permanent link">#</a></h3>
2276 <p>There are two different methods to set the content header, one sets only the actual values, but leaves the outer HTML untouched, that is generated by the <code>header</code> template. This is the recommended approach and you should avoid using the alternative method whenever possible.</p>
2277 <h4 id="recommended-approach">Recommended Approach<a class="headerlink" href="#recommended-approach" title="Permanent link">#</a></h4>
2278 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="c">* This is automatically set using the page data and should not be set manually! *</span><span class="cp">}</span><span class="x"></span>
2279 <span class="cp">{</span><span class="nf">capture</span> <span class="na">assign</span><span class="o">=</span><span class="s1">&#39;contentTitle&#39;</span><span class="cp">}</span><span class="x">Custom Content Title</span><span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2280
2281 <span class="cp">{</span><span class="nf">capture</span> <span class="na">assign</span><span class="o">=</span><span class="s1">&#39;contentDescription&#39;</span><span class="cp">}</span><span class="x">Optional description that is displayed right after the title.</span><span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2282
2283 <span class="cp">{</span><span class="nf">capture</span> <span class="na">assign</span><span class="o">=</span><span class="s1">&#39;contentHeaderNavigation&#39;</span><span class="cp">}</span><span class="x">List of navigation buttons displayed right next to the title.</span><span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2284 </code></pre></div>
2285 <h4 id="alternative">Alternative<a class="headerlink" href="#alternative" title="Permanent link">#</a></h4>
2286 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">capture</span> <span class="na">assign</span><span class="o">=</span><span class="s1">&#39;contentHeader&#39;</span><span class="cp">}</span><span class="x"></span>
2287 <span class="x"> &lt;header class=&quot;contentHeader&quot;&gt;</span>
2288 <span class="x"> &lt;div class=&quot;contentHeaderTitle&quot;&gt;</span>
2289 <span class="x"> &lt;h1 class=&quot;contentTitle&quot;&gt;Custom Content Title&lt;/h1&gt;</span>
2290 <span class="x"> &lt;p class=&quot;contentHeaderDescription&quot;&gt;Custom Content Description&lt;/p&gt;</span>
2291 <span class="x"> &lt;/div&gt;</span>
2292
2293 <span class="x"> &lt;nav class=&quot;contentHeaderNavigation&quot;&gt;</span>
2294 <span class="x"> &lt;ul&gt;</span>
2295 <span class="x"> &lt;li&gt;&lt;a href=&quot;</span><span class="cp">{</span><span class="nf">link</span> <span class="na">controller</span><span class="o">=</span><span class="s1">&#39;CustomController&#39;</span><span class="cp">}{</span><span class="nf">/link</span><span class="cp">}</span><span class="x">&quot; class=&quot;button&quot;&gt;&lt;span class=&quot;icon icon16 fa-plus&quot;&gt;&lt;/span&gt; &lt;span&gt;Custom Button&lt;/span&gt;&lt;/a&gt;&lt;/li&gt;</span>
2296 <span class="x"> </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;contentHeaderNavigation&#39;</span><span class="cp">}</span><span class="x"></span>
2297 <span class="x"> &lt;/ul&gt;</span>
2298 <span class="x"> &lt;/nav&gt;</span>
2299 <span class="x"> &lt;/header&gt;</span>
2300 <span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2301 </code></pre></div>
2302
2303
2304
2305
2306 <hr>
2307 <div class="md-source-date">
2308 <small>
2309
2310 Last update: 2021-01-08
2311
2312 </small>
2313 </div>
2314
2315
2316
2317
2318
2319
2320
2321
2322 </article>
2323 </div>
2324 </div>
2325
2326 </main>
2327
2328
2329 <footer class="md-footer">
2330
2331 <nav class="md-footer__inner md-grid" aria-label="Footer">
2332
2333 <a href="../php/" class="md-footer__link md-footer__link--prev" rel="prev">
2334 <div class="md-footer__button md-icon">
2335 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
2336 </div>
2337 <div class="md-footer__title">
2338 <div class="md-ellipsis">
2339 <span class="md-footer__direction">
2340 Previous
2341 </span>
2342 PHP API
2343 </div>
2344 </div>
2345 </a>
2346
2347
2348 <a href="../css/" class="md-footer__link md-footer__link--next" rel="next">
2349 <div class="md-footer__title">
2350 <div class="md-ellipsis">
2351 <span class="md-footer__direction">
2352 Next
2353 </span>
2354 CSS
2355 </div>
2356 </div>
2357 <div class="md-footer__button md-icon">
2358 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2359 </div>
2360 </a>
2361
2362 </nav>
2363
2364 <div class="md-footer-meta md-typeset">
2365 <div class="md-footer-meta__inner md-grid">
2366 <div class="md-footer-copyright">
2367
2368 <div class="md-footer-copyright__highlight">
2369 Copyright © 2020 WoltLab GmbH
2370 </div>
2371
2372 Made with
2373 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2374 Material for MkDocs
2375 </a>
2376
2377 </div>
2378 <div class="md-footer-copyright">
2379 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2380 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2381 </div>
2382 </div>
2383 </div>
2384 </footer>
2385
2386 </div>
2387 <div class="md-dialog" data-md-component="dialog">
2388 <div class="md-dialog__inner md-typeset"></div>
2389 </div>
2390 <script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
2391
2392
2393 <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2394
2395
2396 </body>
2397 </html>