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