Deployed 3165ca1 to 5.4 with MkDocs 1.1.2 and mike 1.0.0
[GitHub/WoltLab/woltlab.github.io.git] / 5.4 / package / pip / template / 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="canonical" href="https://docs.woltlab.com/5.4/package/pip/template/">
13
14 <link rel="icon" href="../../../assets/default.favicon.ico">
15 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.3">
16
17
18
19 <title>template - WoltLab Suite Documentation</title>
20
21
22
23 <link rel="stylesheet" href="../../../assets/stylesheets/main.e35208c4.min.css">
24
25
26 <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
27
28
29
30 <meta name="theme-color" content="#009485">
31
32
33
34
35
36
37
38
39
40 <link rel="stylesheet" href="../../../stylesheets/extra.css">
41
42
43
44
45
46 </head>
47
48
49
50
51
52
53
54 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
55
56
57 <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
58
59 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
60 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
61 <label class="md-overlay" for="__drawer"></label>
62 <div data-md-component="skip">
63
64
65 <a href="#template-package-installation-plugin" class="md-skip">
66 Skip to content
67 </a>
68
69 </div>
70 <div data-md-component="announce">
71
72 <aside class="md-announce">
73 <div class="md-announce__inner md-grid md-typeset">
74
75 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
76
77 </div>
78 </aside>
79
80 </div>
81
82 <header class="md-header" data-md-component="header">
83 <nav class="md-header__inner md-grid" aria-label="Header">
84 <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
85
86 <img src="../../../assets/logo.png" alt="logo">
87
88 </a>
89 <label class="md-header__button md-icon" for="__drawer">
90 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
91 </label>
92 <div class="md-header__title" data-md-component="header-title">
93 <div class="md-header__ellipsis">
94 <div class="md-header__topic">
95 <span class="md-ellipsis">
96 WoltLab Suite Documentation
97 </span>
98 </div>
99 <div class="md-header__topic" data-md-component="header-topic">
100 <span class="md-ellipsis">
101
102 template
103
104 </span>
105 </div>
106 </div>
107 </div>
108
109
110
111 <label class="md-header__button md-icon" for="__search">
112 <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>
113 </label>
114
115 <div class="md-search" data-md-component="search" role="dialog">
116 <label class="md-search__overlay" for="__search"></label>
117 <div class="md-search__inner" role="search">
118 <form class="md-search__form" name="search">
119 <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>
120 <label class="md-search__icon md-icon" for="__search">
121 <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>
122 <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>
123 </label>
124 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
125 <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>
126 </button>
127 </form>
128 <div class="md-search__output">
129 <div class="md-search__scrollwrap" data-md-scrollfix>
130 <div class="md-search-result" data-md-component="search-result">
131 <div class="md-search-result__meta">
132 Initializing search
133 </div>
134 <ol class="md-search-result__list"></ol>
135 </div>
136 </div>
137 </div>
138 </div>
139 </div>
140
141
142 <div class="md-header__source">
143
144 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
145 <div class="md-source__icon md-icon">
146
147 <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>
148 </div>
149 <div class="md-source__repository">
150 GitHub
151 </div>
152 </a>
153 </div>
154
155 </nav>
156 </header>
157
158 <div class="md-container" data-md-component="container">
159
160
161
162
163 <main class="md-main" data-md-component="main">
164 <div class="md-main__inner md-grid">
165
166
167
168 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
169 <div class="md-sidebar__scrollwrap">
170 <div class="md-sidebar__inner">
171
172
173
174 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
175 <label class="md-nav__title" for="__drawer">
176 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
177
178 <img src="../../../assets/logo.png" alt="logo">
179
180 </a>
181 WoltLab Suite Documentation
182 </label>
183
184 <div class="md-nav__source">
185
186 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
187 <div class="md-source__icon md-icon">
188
189 <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>
190 </div>
191 <div class="md-source__repository">
192 GitHub
193 </div>
194 </a>
195 </div>
196
197 <ul class="md-nav__list" data-md-scrollfix>
198
199
200
201
202
203
204
205
206 <li class="md-nav__item">
207 <a href="../../../getting-started/" class="md-nav__link">
208 Getting Started
209 </a>
210 </li>
211
212
213
214
215
216
217
218
219
220
221
222 <li class="md-nav__item md-nav__item--nested">
223
224
225 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
226
227 <label class="md-nav__link" for="__nav_2">
228 PHP API
229 <span class="md-nav__icon md-icon"></span>
230 </label>
231 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
232 <label class="md-nav__title" for="__nav_2">
233 <span class="md-nav__icon md-icon"></span>
234 PHP API
235 </label>
236 <ul class="md-nav__list" data-md-scrollfix>
237
238
239
240
241
242 <li class="md-nav__item">
243 <a href="../../../php/pages/" class="md-nav__link">
244 Pages
245 </a>
246 </li>
247
248
249
250
251
252
253
254 <li class="md-nav__item">
255 <a href="../../../php/database-objects/" class="md-nav__link">
256 Database Objects
257 </a>
258 </li>
259
260
261
262
263
264
265
266 <li class="md-nav__item">
267 <a href="../../../php/database-access/" class="md-nav__link">
268 Database Access
269 </a>
270 </li>
271
272
273
274
275
276
277
278 <li class="md-nav__item">
279 <a href="../../../php/exceptions/" class="md-nav__link">
280 Exceptions
281 </a>
282 </li>
283
284
285
286
287
288
289
290
291 <li class="md-nav__item md-nav__item--nested">
292
293
294 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
295
296 <label class="md-nav__link" for="__nav_2_5">
297 API
298 <span class="md-nav__icon md-icon"></span>
299 </label>
300 <nav class="md-nav" aria-label="API" data-md-level="2">
301 <label class="md-nav__title" for="__nav_2_5">
302 <span class="md-nav__icon md-icon"></span>
303 API
304 </label>
305 <ul class="md-nav__list" data-md-scrollfix>
306
307
308
309
310
311
312 <li class="md-nav__item md-nav__item--nested">
313
314
315 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
316
317 <label class="md-nav__link" for="__nav_2_5_1">
318 Caches
319 <span class="md-nav__icon md-icon"></span>
320 </label>
321 <nav class="md-nav" aria-label="Caches" data-md-level="3">
322 <label class="md-nav__title" for="__nav_2_5_1">
323 <span class="md-nav__icon md-icon"></span>
324 Caches
325 </label>
326 <ul class="md-nav__list" data-md-scrollfix>
327
328
329
330
331
332 <li class="md-nav__item">
333 <a href="../../../php/api/caches/" class="md-nav__link">
334 Overview
335 </a>
336 </li>
337
338
339
340
341
342
343
344 <li class="md-nav__item">
345 <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
346 Persistent Caches
347 </a>
348 </li>
349
350
351
352
353
354
355
356 <li class="md-nav__item">
357 <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
358 Runtime Caches
359 </a>
360 </li>
361
362
363
364 </ul>
365 </nav>
366 </li>
367
368
369
370
371
372
373
374 <li class="md-nav__item">
375 <a href="../../../php/api/comments/" class="md-nav__link">
376 Comments
377 </a>
378 </li>
379
380
381
382
383
384
385
386 <li class="md-nav__item">
387 <a href="../../../php/api/cronjobs/" class="md-nav__link">
388 Cronjobs
389 </a>
390 </li>
391
392
393
394
395
396
397
398 <li class="md-nav__item">
399 <a href="../../../php/api/events/" class="md-nav__link">
400 Events
401 </a>
402 </li>
403
404
405
406
407
408
409
410
411 <li class="md-nav__item md-nav__item--nested">
412
413
414 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
415
416 <label class="md-nav__link" for="__nav_2_5_5">
417 Form Builder
418 <span class="md-nav__icon md-icon"></span>
419 </label>
420 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
421 <label class="md-nav__title" for="__nav_2_5_5">
422 <span class="md-nav__icon md-icon"></span>
423 Form Builder
424 </label>
425 <ul class="md-nav__list" data-md-scrollfix>
426
427
428
429
430
431 <li class="md-nav__item">
432 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
433 Overview
434 </a>
435 </li>
436
437
438
439
440
441
442
443 <li class="md-nav__item">
444 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
445 Structure
446 </a>
447 </li>
448
449
450
451
452
453
454
455 <li class="md-nav__item">
456 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
457 Fields
458 </a>
459 </li>
460
461
462
463
464
465
466
467 <li class="md-nav__item">
468 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
469 Validation and Data
470 </a>
471 </li>
472
473
474
475
476
477
478
479 <li class="md-nav__item">
480 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
481 Dependencies
482 </a>
483 </li>
484
485
486
487 </ul>
488 </nav>
489 </li>
490
491
492
493
494
495
496
497 <li class="md-nav__item">
498 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
499 Package Installation Plugins
500 </a>
501 </li>
502
503
504
505
506
507
508
509 <li class="md-nav__item">
510 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
511 User Activity Points
512 </a>
513 </li>
514
515
516
517
518
519
520
521 <li class="md-nav__item">
522 <a href="../../../php/api/user_notifications/" class="md-nav__link">
523 User Notifications
524 </a>
525 </li>
526
527
528
529
530
531
532
533 <li class="md-nav__item">
534 <a href="../../../php/api/sitemaps/" class="md-nav__link">
535 Sitemaps
536 </a>
537 </li>
538
539
540
541 </ul>
542 </nav>
543 </li>
544
545
546
547
548
549
550
551 <li class="md-nav__item">
552 <a href="../../../php/code-style/" class="md-nav__link">
553 Code Style
554 </a>
555 </li>
556
557
558
559
560
561
562
563 <li class="md-nav__item">
564 <a href="../../../php/apps/" class="md-nav__link">
565 Apps
566 </a>
567 </li>
568
569
570
571
572
573
574
575 <li class="md-nav__item">
576 <a href="../../../php/gdpr/" class="md-nav__link">
577 GDPR
578 </a>
579 </li>
580
581
582
583 </ul>
584 </nav>
585 </li>
586
587
588
589
590
591
592
593
594
595
596
597 <li class="md-nav__item md-nav__item--nested">
598
599
600 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
601
602 <label class="md-nav__link" for="__nav_3">
603 Languages, Templates & CSS
604 <span class="md-nav__icon md-icon"></span>
605 </label>
606 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
607 <label class="md-nav__title" for="__nav_3">
608 <span class="md-nav__icon md-icon"></span>
609 Languages, Templates & CSS
610 </label>
611 <ul class="md-nav__list" data-md-scrollfix>
612
613
614
615
616
617 <li class="md-nav__item">
618 <a href="../../../view/languages/" class="md-nav__link">
619 Languages
620 </a>
621 </li>
622
623
624
625
626
627
628
629 <li class="md-nav__item">
630 <a href="../../../view/templates/" class="md-nav__link">
631 Templates
632 </a>
633 </li>
634
635
636
637
638
639
640
641 <li class="md-nav__item">
642 <a href="../../../view/template-plugins/" class="md-nav__link">
643 Template Plugins
644 </a>
645 </li>
646
647
648
649
650
651
652
653 <li class="md-nav__item">
654 <a href="../../../view/css/" class="md-nav__link">
655 CSS
656 </a>
657 </li>
658
659
660
661 </ul>
662 </nav>
663 </li>
664
665
666
667
668
669
670
671
672
673
674
675 <li class="md-nav__item md-nav__item--nested">
676
677
678 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
679
680 <label class="md-nav__link" for="__nav_4">
681 TypeScript and JavaScript API
682 <span class="md-nav__icon md-icon"></span>
683 </label>
684 <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
685 <label class="md-nav__title" for="__nav_4">
686 <span class="md-nav__icon md-icon"></span>
687 TypeScript and JavaScript API
688 </label>
689 <ul class="md-nav__list" data-md-scrollfix>
690
691
692
693
694
695 <li class="md-nav__item">
696 <a href="../../../javascript/general-usage/" class="md-nav__link">
697 General Usage
698 </a>
699 </li>
700
701
702
703
704
705
706
707 <li class="md-nav__item">
708 <a href="../../../javascript/typescript/" class="md-nav__link">
709 TypeScript
710 </a>
711 </li>
712
713
714
715
716
717
718
719
720 <li class="md-nav__item md-nav__item--nested">
721
722
723 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
724
725 <label class="md-nav__link" for="__nav_4_3">
726 New API
727 <span class="md-nav__icon md-icon"></span>
728 </label>
729 <nav class="md-nav" aria-label="New API" data-md-level="2">
730 <label class="md-nav__title" for="__nav_4_3">
731 <span class="md-nav__icon md-icon"></span>
732 New API
733 </label>
734 <ul class="md-nav__list" data-md-scrollfix>
735
736
737
738
739
740 <li class="md-nav__item">
741 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
742 Writing a module
743 </a>
744 </li>
745
746
747
748
749
750
751
752 <li class="md-nav__item">
753 <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
754 Data Structures
755 </a>
756 </li>
757
758
759
760
761
762
763
764 <li class="md-nav__item">
765 <a href="../../../javascript/new-api_core/" class="md-nav__link">
766 Core Functions
767 </a>
768 </li>
769
770
771
772
773
774
775
776 <li class="md-nav__item">
777 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
778 DOM
779 </a>
780 </li>
781
782
783
784
785
786
787
788 <li class="md-nav__item">
789 <a href="../../../javascript/new-api_events/" class="md-nav__link">
790 Event Handling
791 </a>
792 </li>
793
794
795
796
797
798
799
800 <li class="md-nav__item">
801 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
802 Ajax
803 </a>
804 </li>
805
806
807
808
809
810
811
812 <li class="md-nav__item">
813 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
814 Dialogs
815 </a>
816 </li>
817
818
819
820
821
822
823
824 <li class="md-nav__item">
825 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
826 Browser and Screen Sizes
827 </a>
828 </li>
829
830
831
832
833
834
835
836 <li class="md-nav__item">
837 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
838 User Interface
839 </a>
840 </li>
841
842
843
844 </ul>
845 </nav>
846 </li>
847
848
849
850
851
852
853
854 <li class="md-nav__item">
855 <a href="../../../javascript/legacy-api/" class="md-nav__link">
856 Legacy API
857 </a>
858 </li>
859
860
861
862
863
864
865
866 <li class="md-nav__item">
867 <a href="../../../javascript/helper-functions/" class="md-nav__link">
868 Helper Functions
869 </a>
870 </li>
871
872
873
874
875
876
877
878 <li class="md-nav__item">
879 <a href="../../../javascript/code-snippets/" class="md-nav__link">
880 Code Snippets
881 </a>
882 </li>
883
884
885
886 </ul>
887 </nav>
888 </li>
889
890
891
892
893
894
895
896
897
898
899
900
901
902 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
903
904
905 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
906
907 <label class="md-nav__link" for="__nav_5">
908 Package Components
909 <span class="md-nav__icon md-icon"></span>
910 </label>
911 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
912 <label class="md-nav__title" for="__nav_5">
913 <span class="md-nav__icon md-icon"></span>
914 Package Components
915 </label>
916 <ul class="md-nav__list" data-md-scrollfix>
917
918
919
920
921
922 <li class="md-nav__item">
923 <a href="../../package-xml/" class="md-nav__link">
924 package.xml
925 </a>
926 </li>
927
928
929
930
931
932
933
934
935
936
937 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
938
939
940 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
941
942 <label class="md-nav__link" for="__nav_5_2">
943 PIPs
944 <span class="md-nav__icon md-icon"></span>
945 </label>
946 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
947 <label class="md-nav__title" for="__nav_5_2">
948 <span class="md-nav__icon md-icon"></span>
949 PIPs
950 </label>
951 <ul class="md-nav__list" data-md-scrollfix>
952
953
954
955
956
957 <li class="md-nav__item">
958 <a href="../" class="md-nav__link">
959 Overview
960 </a>
961 </li>
962
963
964
965
966
967
968
969 <li class="md-nav__item">
970 <a href="../acl-option/" class="md-nav__link">
971 aclOption
972 </a>
973 </li>
974
975
976
977
978
979
980
981 <li class="md-nav__item">
982 <a href="../acp-menu/" class="md-nav__link">
983 acpMenu
984 </a>
985 </li>
986
987
988
989
990
991
992
993 <li class="md-nav__item">
994 <a href="../acp-search-provider/" class="md-nav__link">
995 acpSearchProvider
996 </a>
997 </li>
998
999
1000
1001
1002
1003
1004
1005 <li class="md-nav__item">
1006 <a href="../acp-template/" class="md-nav__link">
1007 acpTemplate
1008 </a>
1009 </li>
1010
1011
1012
1013
1014
1015
1016
1017 <li class="md-nav__item">
1018 <a href="../bbcode/" class="md-nav__link">
1019 bbcode
1020 </a>
1021 </li>
1022
1023
1024
1025
1026
1027
1028
1029 <li class="md-nav__item">
1030 <a href="../box/" class="md-nav__link">
1031 box
1032 </a>
1033 </li>
1034
1035
1036
1037
1038
1039
1040
1041 <li class="md-nav__item">
1042 <a href="../clipboard-action/" class="md-nav__link">
1043 clipboardAction
1044 </a>
1045 </li>
1046
1047
1048
1049
1050
1051
1052
1053 <li class="md-nav__item">
1054 <a href="../core-object/" class="md-nav__link">
1055 coreObject
1056 </a>
1057 </li>
1058
1059
1060
1061
1062
1063
1064
1065 <li class="md-nav__item">
1066 <a href="../cronjob/" class="md-nav__link">
1067 cronjob
1068 </a>
1069 </li>
1070
1071
1072
1073
1074
1075
1076
1077 <li class="md-nav__item">
1078 <a href="../database/" class="md-nav__link">
1079 database
1080 </a>
1081 </li>
1082
1083
1084
1085
1086
1087
1088
1089 <li class="md-nav__item">
1090 <a href="../event-listener/" class="md-nav__link">
1091 eventListener
1092 </a>
1093 </li>
1094
1095
1096
1097
1098
1099
1100
1101 <li class="md-nav__item">
1102 <a href="../file/" class="md-nav__link">
1103 file
1104 </a>
1105 </li>
1106
1107
1108
1109
1110
1111
1112
1113 <li class="md-nav__item">
1114 <a href="../language/" class="md-nav__link">
1115 language
1116 </a>
1117 </li>
1118
1119
1120
1121
1122
1123
1124
1125 <li class="md-nav__item">
1126 <a href="../media-provider/" class="md-nav__link">
1127 mediaProvider
1128 </a>
1129 </li>
1130
1131
1132
1133
1134
1135
1136
1137 <li class="md-nav__item">
1138 <a href="../menu/" class="md-nav__link">
1139 menu
1140 </a>
1141 </li>
1142
1143
1144
1145
1146
1147
1148
1149 <li class="md-nav__item">
1150 <a href="../menu-item/" class="md-nav__link">
1151 menuItem
1152 </a>
1153 </li>
1154
1155
1156
1157
1158
1159
1160
1161 <li class="md-nav__item">
1162 <a href="../object-type/" class="md-nav__link">
1163 objectType
1164 </a>
1165 </li>
1166
1167
1168
1169
1170
1171
1172
1173 <li class="md-nav__item">
1174 <a href="../object-type-definition/" class="md-nav__link">
1175 objectTypeDefinition
1176 </a>
1177 </li>
1178
1179
1180
1181
1182
1183
1184
1185 <li class="md-nav__item">
1186 <a href="../option/" class="md-nav__link">
1187 option
1188 </a>
1189 </li>
1190
1191
1192
1193
1194
1195
1196
1197 <li class="md-nav__item">
1198 <a href="../page/" class="md-nav__link">
1199 page
1200 </a>
1201 </li>
1202
1203
1204
1205
1206
1207
1208
1209 <li class="md-nav__item">
1210 <a href="../pip/" class="md-nav__link">
1211 pip
1212 </a>
1213 </li>
1214
1215
1216
1217
1218
1219
1220
1221 <li class="md-nav__item">
1222 <a href="../script/" class="md-nav__link">
1223 script
1224 </a>
1225 </li>
1226
1227
1228
1229
1230
1231
1232
1233 <li class="md-nav__item">
1234 <a href="../smiley/" class="md-nav__link">
1235 smiley
1236 </a>
1237 </li>
1238
1239
1240
1241
1242
1243
1244
1245 <li class="md-nav__item">
1246 <a href="../sql/" class="md-nav__link">
1247 sql
1248 </a>
1249 </li>
1250
1251
1252
1253
1254
1255
1256
1257 <li class="md-nav__item">
1258 <a href="../style/" class="md-nav__link">
1259 style
1260 </a>
1261 </li>
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271 <li class="md-nav__item md-nav__item--active">
1272
1273 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1274
1275
1276
1277
1278
1279 <a href="./" class="md-nav__link md-nav__link--active">
1280 template
1281 </a>
1282
1283 </li>
1284
1285
1286
1287
1288
1289
1290
1291 <li class="md-nav__item">
1292 <a href="../template-listener/" class="md-nav__link">
1293 templateListener
1294 </a>
1295 </li>
1296
1297
1298
1299
1300
1301
1302
1303 <li class="md-nav__item">
1304 <a href="../user-group-option/" class="md-nav__link">
1305 userGroupOption
1306 </a>
1307 </li>
1308
1309
1310
1311
1312
1313
1314
1315 <li class="md-nav__item">
1316 <a href="../user-menu/" class="md-nav__link">
1317 userMenu
1318 </a>
1319 </li>
1320
1321
1322
1323
1324
1325
1326
1327 <li class="md-nav__item">
1328 <a href="../user-notification-event/" class="md-nav__link">
1329 userNotificationEvent
1330 </a>
1331 </li>
1332
1333
1334
1335
1336
1337
1338
1339 <li class="md-nav__item">
1340 <a href="../user-option/" class="md-nav__link">
1341 userOption
1342 </a>
1343 </li>
1344
1345
1346
1347
1348
1349
1350
1351 <li class="md-nav__item">
1352 <a href="../user-profile-menu/" class="md-nav__link">
1353 userProfileMenu
1354 </a>
1355 </li>
1356
1357
1358
1359 </ul>
1360 </nav>
1361 </li>
1362
1363
1364
1365
1366
1367
1368
1369 <li class="md-nav__item">
1370 <a href="../../database-php-api/" class="md-nav__link">
1371 Database PHP API
1372 </a>
1373 </li>
1374
1375
1376
1377 </ul>
1378 </nav>
1379 </li>
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391 <li class="md-nav__item md-nav__item--nested">
1392
1393
1394 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1395
1396 <label class="md-nav__link" for="__nav_6">
1397 Migration
1398 <span class="md-nav__icon md-icon"></span>
1399 </label>
1400 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1401 <label class="md-nav__title" for="__nav_6">
1402 <span class="md-nav__icon md-icon"></span>
1403 Migration
1404 </label>
1405 <ul class="md-nav__list" data-md-scrollfix>
1406
1407
1408
1409
1410
1411
1412 <li class="md-nav__item md-nav__item--nested">
1413
1414
1415 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1416
1417 <label class="md-nav__link" for="__nav_6_1">
1418 Migrating from WSC 5.3
1419 <span class="md-nav__icon md-icon"></span>
1420 </label>
1421 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1422 <label class="md-nav__title" for="__nav_6_1">
1423 <span class="md-nav__icon md-icon"></span>
1424 Migrating from WSC 5.3
1425 </label>
1426 <ul class="md-nav__list" data-md-scrollfix>
1427
1428
1429
1430
1431
1432 <li class="md-nav__item">
1433 <a href="../../../migration/wsc53/php/" class="md-nav__link">
1434 PHP API
1435 </a>
1436 </li>
1437
1438
1439
1440
1441
1442
1443
1444 <li class="md-nav__item">
1445 <a href="../../../migration/wsc53/session/" class="md-nav__link">
1446 Session Handling and Authentication
1447 </a>
1448 </li>
1449
1450
1451
1452
1453
1454
1455
1456 <li class="md-nav__item">
1457 <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1458 TypeScript and JavaScript
1459 </a>
1460 </li>
1461
1462
1463
1464
1465
1466
1467
1468 <li class="md-nav__item">
1469 <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1470 Templates
1471 </a>
1472 </li>
1473
1474
1475
1476
1477
1478
1479
1480 <li class="md-nav__item">
1481 <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1482 Third Party Libraries
1483 </a>
1484 </li>
1485
1486
1487
1488 </ul>
1489 </nav>
1490 </li>
1491
1492
1493
1494
1495
1496
1497
1498
1499 <li class="md-nav__item md-nav__item--nested">
1500
1501
1502 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1503
1504 <label class="md-nav__link" for="__nav_6_2">
1505 Migrating from WSC 5.2
1506 <span class="md-nav__icon md-icon"></span>
1507 </label>
1508 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1509 <label class="md-nav__title" for="__nav_6_2">
1510 <span class="md-nav__icon md-icon"></span>
1511 Migrating from WSC 5.2
1512 </label>
1513 <ul class="md-nav__list" data-md-scrollfix>
1514
1515
1516
1517
1518
1519 <li class="md-nav__item">
1520 <a href="../../../migration/wsc52/php/" class="md-nav__link">
1521 PHP API
1522 </a>
1523 </li>
1524
1525
1526
1527
1528
1529
1530
1531 <li class="md-nav__item">
1532 <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1533 Templates and Languages
1534 </a>
1535 </li>
1536
1537
1538
1539
1540
1541
1542
1543 <li class="md-nav__item">
1544 <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1545 Third Party Libraries
1546 </a>
1547 </li>
1548
1549
1550
1551 </ul>
1552 </nav>
1553 </li>
1554
1555
1556
1557
1558
1559
1560
1561
1562 <li class="md-nav__item md-nav__item--nested">
1563
1564
1565 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1566
1567 <label class="md-nav__link" for="__nav_6_3">
1568 Migrating from WSC 3.1
1569 <span class="md-nav__icon md-icon"></span>
1570 </label>
1571 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1572 <label class="md-nav__title" for="__nav_6_3">
1573 <span class="md-nav__icon md-icon"></span>
1574 Migrating from WSC 3.1
1575 </label>
1576 <ul class="md-nav__list" data-md-scrollfix>
1577
1578
1579
1580
1581
1582 <li class="md-nav__item">
1583 <a href="../../../migration/wsc31/php/" class="md-nav__link">
1584 PHP API
1585 </a>
1586 </li>
1587
1588
1589
1590 </ul>
1591 </nav>
1592 </li>
1593
1594
1595
1596
1597
1598
1599
1600
1601 <li class="md-nav__item md-nav__item--nested">
1602
1603
1604 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1605
1606 <label class="md-nav__link" for="__nav_6_4">
1607 Migrating from WSC 3.0
1608 <span class="md-nav__icon md-icon"></span>
1609 </label>
1610 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1611 <label class="md-nav__title" for="__nav_6_4">
1612 <span class="md-nav__icon md-icon"></span>
1613 Migrating from WSC 3.0
1614 </label>
1615 <ul class="md-nav__list" data-md-scrollfix>
1616
1617
1618
1619
1620
1621 <li class="md-nav__item">
1622 <a href="../../../migration/wsc30/php/" class="md-nav__link">
1623 PHP API
1624 </a>
1625 </li>
1626
1627
1628
1629
1630
1631
1632
1633 <li class="md-nav__item">
1634 <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1635 JavaScript API
1636 </a>
1637 </li>
1638
1639
1640
1641
1642
1643
1644
1645 <li class="md-nav__item">
1646 <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1647 Templates
1648 </a>
1649 </li>
1650
1651
1652
1653
1654
1655
1656
1657 <li class="md-nav__item">
1658 <a href="../../../migration/wsc30/css/" class="md-nav__link">
1659 CSS
1660 </a>
1661 </li>
1662
1663
1664
1665
1666
1667
1668
1669 <li class="md-nav__item">
1670 <a href="../../../migration/wsc30/package/" class="md-nav__link">
1671 Package Components
1672 </a>
1673 </li>
1674
1675
1676
1677 </ul>
1678 </nav>
1679 </li>
1680
1681
1682
1683
1684
1685
1686
1687
1688 <li class="md-nav__item md-nav__item--nested">
1689
1690
1691 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1692
1693 <label class="md-nav__link" for="__nav_6_5">
1694 Migrating from WCF 2.1
1695 <span class="md-nav__icon md-icon"></span>
1696 </label>
1697 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1698 <label class="md-nav__title" for="__nav_6_5">
1699 <span class="md-nav__icon md-icon"></span>
1700 Migrating from WCF 2.1
1701 </label>
1702 <ul class="md-nav__list" data-md-scrollfix>
1703
1704
1705
1706
1707
1708 <li class="md-nav__item">
1709 <a href="../../../migration/wcf21/php/" class="md-nav__link">
1710 PHP API
1711 </a>
1712 </li>
1713
1714
1715
1716
1717
1718
1719
1720 <li class="md-nav__item">
1721 <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1722 Templates
1723 </a>
1724 </li>
1725
1726
1727
1728
1729
1730
1731
1732 <li class="md-nav__item">
1733 <a href="../../../migration/wcf21/css/" class="md-nav__link">
1734 CSS
1735 </a>
1736 </li>
1737
1738
1739
1740
1741
1742
1743
1744 <li class="md-nav__item">
1745 <a href="../../../migration/wcf21/package/" class="md-nav__link">
1746 Package Components
1747 </a>
1748 </li>
1749
1750
1751
1752 </ul>
1753 </nav>
1754 </li>
1755
1756
1757
1758 </ul>
1759 </nav>
1760 </li>
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772 <li class="md-nav__item md-nav__item--nested">
1773
1774
1775 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1776
1777 <label class="md-nav__link" for="__nav_7">
1778 Tutorials
1779 <span class="md-nav__icon md-icon"></span>
1780 </label>
1781 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1782 <label class="md-nav__title" for="__nav_7">
1783 <span class="md-nav__icon md-icon"></span>
1784 Tutorials
1785 </label>
1786 <ul class="md-nav__list" data-md-scrollfix>
1787
1788
1789
1790
1791
1792
1793 <li class="md-nav__item md-nav__item--nested">
1794
1795
1796 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1797
1798 <label class="md-nav__link" for="__nav_7_1">
1799 Tutorial Series
1800 <span class="md-nav__icon md-icon"></span>
1801 </label>
1802 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1803 <label class="md-nav__title" for="__nav_7_1">
1804 <span class="md-nav__icon md-icon"></span>
1805 Tutorial Series
1806 </label>
1807 <ul class="md-nav__list" data-md-scrollfix>
1808
1809
1810
1811
1812
1813 <li class="md-nav__item">
1814 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1815 Overview
1816 </a>
1817 </li>
1818
1819
1820
1821
1822
1823
1824
1825 <li class="md-nav__item">
1826 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1827 Part 1
1828 </a>
1829 </li>
1830
1831
1832
1833
1834
1835
1836
1837 <li class="md-nav__item">
1838 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1839 Part 2
1840 </a>
1841 </li>
1842
1843
1844
1845
1846
1847
1848
1849 <li class="md-nav__item">
1850 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1851 Part 3
1852 </a>
1853 </li>
1854
1855
1856
1857
1858
1859
1860
1861 <li class="md-nav__item">
1862 <a href="../../../tutorial/series/part_4/" class="md-nav__link">
1863 Part 4
1864 </a>
1865 </li>
1866
1867
1868
1869
1870
1871
1872
1873 <li class="md-nav__item">
1874 <a href="../../../tutorial/series/part_5/" class="md-nav__link">
1875 Part 5
1876 </a>
1877 </li>
1878
1879
1880
1881 </ul>
1882 </nav>
1883 </li>
1884
1885
1886
1887 </ul>
1888 </nav>
1889 </li>
1890
1891
1892
1893 </ul>
1894 </nav>
1895 </div>
1896 </div>
1897 </div>
1898
1899
1900
1901 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1902 <div class="md-sidebar__scrollwrap">
1903 <div class="md-sidebar__inner">
1904
1905 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1906
1907
1908
1909
1910
1911
1912 </nav>
1913 </div>
1914 </div>
1915 </div>
1916
1917
1918 <div class="md-content" data-md-component="content">
1919 <article class="md-content__inner md-typeset">
1920
1921
1922 <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/template.md" title="Edit this page" class="md-content__button md-icon">
1923 <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>
1924 </a>
1925
1926
1927 <h1 id="template-package-installation-plugin">Template Package Installation Plugin<a class="headerlink" href="#template-package-installation-plugin" title="Permanent link">#</a></h1>
1928 <p>Add templates for frontend pages and forms by providing an archive containing the template files.</p>
1929 <div class="admonition warning">
1930 <p class="admonition-title">You cannot overwrite templates provided by other packages.</p>
1931 </div>
1932 <p>This package installation plugin behaves exactly like the <a href="../acp-template/">acpTemplate package installation plugin</a> except for installing frontend templates instead of backend/acp templates.</p>
1933
1934
1935
1936
1937 <hr>
1938 <div class="md-source-date">
1939 <small>
1940
1941 Last update: 2021-01-08
1942
1943 </small>
1944 </div>
1945
1946
1947
1948
1949
1950
1951
1952
1953 </article>
1954 </div>
1955 </div>
1956
1957 </main>
1958
1959
1960 <footer class="md-footer">
1961
1962 <nav class="md-footer__inner md-grid" aria-label="Footer">
1963
1964 <a href="../style/" class="md-footer__link md-footer__link--prev" rel="prev">
1965 <div class="md-footer__button md-icon">
1966 <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>
1967 </div>
1968 <div class="md-footer__title">
1969 <div class="md-ellipsis">
1970 <span class="md-footer__direction">
1971 Previous
1972 </span>
1973 style
1974 </div>
1975 </div>
1976 </a>
1977
1978
1979 <a href="../template-listener/" class="md-footer__link md-footer__link--next" rel="next">
1980 <div class="md-footer__title">
1981 <div class="md-ellipsis">
1982 <span class="md-footer__direction">
1983 Next
1984 </span>
1985 templateListener
1986 </div>
1987 </div>
1988 <div class="md-footer__button md-icon">
1989 <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>
1990 </div>
1991 </a>
1992
1993 </nav>
1994
1995 <div class="md-footer-meta md-typeset">
1996 <div class="md-footer-meta__inner md-grid">
1997 <div class="md-footer-copyright">
1998
1999 <div class="md-footer-copyright__highlight">
2000 Copyright © 2020 WoltLab GmbH
2001 </div>
2002
2003 Made with
2004 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2005 Material for MkDocs
2006 </a>
2007
2008 </div>
2009 <div class="md-footer-copyright">
2010 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2011 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2012 </div>
2013 </div>
2014 </div>
2015 </footer>
2016
2017 </div>
2018 <div class="md-dialog" data-md-component="dialog">
2019 <div class="md-dialog__inner md-typeset"></div>
2020 </div>
2021 <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>
2022
2023
2024 <script src="../../../assets/javascripts/bundle.4ea5477f.min.js"></script>
2025
2026
2027 </body>
2028 </html>