projects / GitHub / WoltLab / woltlab.github.io.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Deployed 506b5bb to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / latest / migration / wcf21 / package / index.html
CommitLineData
0c5338dd
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">
0c5338dd
TD		 14
15
16
17 <title>Package Components - WoltLab Suite Documentation</title>
18
19
20
fb88dc6e 21 <link rel="stylesheet" href="../../../assets/stylesheets/main.77f3fd56.min.css">
0c5338dd
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
34
35
36
37 <link rel="stylesheet" href="../../../stylesheets/extra.css">
38
39
40
41
42
43 </head>
44
45
46
47
48
49
50
51 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
52
53
54
55 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
56 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
57 <label class="md-overlay" for="__drawer"></label>
58 <div data-md-component="skip">
59
60
61 <a href="#wcf-21x-package-components" class="md-skip">
62 Skip to content
63 </a>
64
65 </div>
66 <div data-md-component="announce">
67
68 <aside class="md-announce">
69 <div class="md-announce__inner md-grid md-typeset">
70
71 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
72
73 </div>
74 </aside>
75
76 </div>
77
78
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">
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 Package Components
101
102 </span>
103 </div>
104 </div>
105 </div>
106 <div class="md-header__options">
107
108 </div>
109
110 <label class="md-header__button md-icon" for="__search">
111 <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>
112 </label>
113
114<div class="md-search" data-md-component="search" role="dialog">
115 <label class="md-search__overlay" for="__search"></label>
116 <div class="md-search__inner" role="search">
117 <form class="md-search__form" name="search">
118 <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>
119 <label class="md-search__icon md-icon" for="__search">
120 <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>
121 <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>
122 </label>
123 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
124 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.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>
125 </button>
126 </form>
127 <div class="md-search__output">
128 <div class="md-search__scrollwrap" data-md-scrollfix>
129 <div class="md-search-result" data-md-component="search-result">
130 <div class="md-search-result__meta">
131 Initializing search
132 </div>
133 <ol class="md-search-result__list"></ol>
134 </div>
135 </div>
136 </div>
137 </div>
138</div>
139
140
141 </nav>
142</header>
143
144 <div class="md-container" data-md-component="container">
145
146
147
148
149 <main class="md-main" data-md-component="main">
150 <div class="md-main__inner md-grid">
151
152
153
154 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
155 <div class="md-sidebar__scrollwrap">
156 <div class="md-sidebar__inner">
157
158
159
160
161
162<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
163 <label class="md-nav__title" for="__drawer">
164 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
165
166 <img src="../../../assets/logo.png" alt="logo">
167
168 </a>
169 WoltLab Suite Documentation
170 </label>
171
172 <ul class="md-nav__list" data-md-scrollfix>
173
174
175
176
177
178
179
180
181 <li class="md-nav__item">
182 <a href="../../../getting-started/" class="md-nav__link">
183 Getting Started
184 </a>
185 </li>
186
187
188
189
190
191
192
193
194
195
196
197 <li class="md-nav__item md-nav__item--nested">
198
199
200 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
201
202 <label class="md-nav__link" for="__nav_2">
203 PHP API
204 <span class="md-nav__icon md-icon"></span>
205 </label>
206 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
207 <label class="md-nav__title" for="__nav_2">
208 <span class="md-nav__icon md-icon"></span>
209 PHP API
210 </label>
211 <ul class="md-nav__list" data-md-scrollfix>
212
213
214
215
216
217 <li class="md-nav__item">
218 <a href="../../../php/pages/" class="md-nav__link">
219 Pages
220 </a>
221 </li>
222
223
224
225
226
227
228
229 <li class="md-nav__item">
230 <a href="../../../php/database-objects/" class="md-nav__link">
231 Database Objects
232 </a>
233 </li>
234
235
236
237
238
239
240
241 <li class="md-nav__item">
242 <a href="../../../php/database-access/" class="md-nav__link">
243 Database Access
244 </a>
245 </li>
246
247
248
249
250
251
252
253 <li class="md-nav__item">
254 <a href="../../../php/exceptions/" class="md-nav__link">
255 Exceptions
256 </a>
257 </li>
258
259
260
261
262
263
264
265
266 <li class="md-nav__item md-nav__item--nested">
267
268
269 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
270
271 <label class="md-nav__link" for="__nav_2_5">
272 API
273 <span class="md-nav__icon md-icon"></span>
274 </label>
275 <nav class="md-nav" aria-label="API" data-md-level="2">
276 <label class="md-nav__title" for="__nav_2_5">
277 <span class="md-nav__icon md-icon"></span>
278 API
279 </label>
280 <ul class="md-nav__list" data-md-scrollfix>
281
282
283
284
285
286 <li class="md-nav__item">
287 <a href="../../../php/api/caches/" class="md-nav__link">
288 Caches
289 </a>
290 </li>
291
292
293
294
295
296
297
298 <li class="md-nav__item">
299 <a href="../../../php/api/comments/" class="md-nav__link">
300 Comments
301 </a>
302 </li>
303
304
305
306
307
308
309
310 <li class="md-nav__item">
311 <a href="../../../php/api/cronjobs/" class="md-nav__link">
312 Cronjobs
313 </a>
314 </li>
315
316
317
318
319
320
321
322 <li class="md-nav__item">
323 <a href="../../../php/api/events/" class="md-nav__link">
324 Events
325 </a>
326 </li>
327
328
329
330
331
332
333
334
335 <li class="md-nav__item md-nav__item--nested">
336
337
338 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
339
340 <label class="md-nav__link" for="__nav_2_5_5">
341 Form Builder
342 <span class="md-nav__icon md-icon"></span>
343 </label>
344 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
345 <label class="md-nav__title" for="__nav_2_5_5">
346 <span class="md-nav__icon md-icon"></span>
347 Form Builder
348 </label>
349 <ul class="md-nav__list" data-md-scrollfix>
350
351
352
353
354
355 <li class="md-nav__item">
356 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
357 Overview
358 </a>
359 </li>
360
361
362
363
364
365
366
367 <li class="md-nav__item">
368 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
369 Structure
370 </a>
371 </li>
372
373
374
375
376
377
378
379 <li class="md-nav__item">
380 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
381 Fields
382 </a>
383 </li>
384
385
386
387
388
389
390
391 <li class="md-nav__item">
392 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
393 Validation and Data
394 </a>
395 </li>
396
397
398
399
400
401
402
403 <li class="md-nav__item">
404 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
405 Dependencies
406 </a>
407 </li>
408
409
410
411 </ul>
412 </nav>
413 </li>
414
415
416
417
418
419
420
421 <li class="md-nav__item">
422 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
423 Package Installation Plugins
424 </a>
425 </li>
426
427
428
429
430
431
432
433 <li class="md-nav__item">
434 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
435 User Activity Points
436 </a>
437 </li>
438
439
440
441
442
443
444
445 <li class="md-nav__item">
446 <a href="../../../php/api/user_notifications/" class="md-nav__link">
447 User Notifications
448 </a>
449 </li>
450
451
452
453
454
455
456
457 <li class="md-nav__item">
458 <a href="../../../php/api/sitemaps/" class="md-nav__link">
459 Sitemaps
460 </a>
461 </li>
462
463
464
465 </ul>
466 </nav>
467 </li>
468
469
470
471
472
473
474
475 <li class="md-nav__item">
476 <a href="../../../php/code-style/" class="md-nav__link">
477 Code Style
478 </a>
479 </li>
480
481
482
483
484
485
486
487 <li class="md-nav__item">
488 <a href="../../../php/apps/" class="md-nav__link">
489 Apps
490 </a>
491 </li>
492
493
494
495
496
497
498
499 <li class="md-nav__item">
500 <a href="../../../php/gdpr/" class="md-nav__link">
501 GDPR
502 </a>
503 </li>
504
505
506
507 </ul>
508 </nav>
509 </li>
510
511
512
513
514
515
516
517
518
519
520
521 <li class="md-nav__item md-nav__item--nested">
522
523
524 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
525
526 <label class="md-nav__link" for="__nav_3">
527 Languages, Templates & CSS
528 <span class="md-nav__icon md-icon"></span>
529 </label>
530 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
531 <label class="md-nav__title" for="__nav_3">
532 <span class="md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
534 </label>
535 <ul class="md-nav__list" data-md-scrollfix>
536
537
538
539
540
541 <li class="md-nav__item">
542 <a href="../../../view/languages/" class="md-nav__link">
543 Languages
544 </a>
545 </li>
546
547
548
549
550
551
552
553 <li class="md-nav__item">
554 <a href="../../../view/templates/" class="md-nav__link">
555 Templates
556 </a>
557 </li>
558
559
560
561
562
563
564
565 <li class="md-nav__item">
566 <a href="../../../view/css/" class="md-nav__link">
567 CSS
568 </a>
569 </li>
570
571
572
573 </ul>
574 </nav>
575 </li>
576
577
578
579
580
581
582
583
584
585
586
587 <li class="md-nav__item md-nav__item--nested">
588
589
590 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
591
592 <label class="md-nav__link" for="__nav_4">
593 JavaScript API
594 <span class="md-nav__icon md-icon"></span>
595 </label>
596 <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
597 <label class="md-nav__title" for="__nav_4">
598 <span class="md-nav__icon md-icon"></span>
599 JavaScript API
600 </label>
601 <ul class="md-nav__list" data-md-scrollfix>
602
603
604
605
606
607 <li class="md-nav__item">
608 <a href="../../../javascript/general-usage/" class="md-nav__link">
609 General Usage
610 </a>
611 </li>
612
613
614
615
616
617
618
619
620 <li class="md-nav__item md-nav__item--nested">
621
622
623 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
624
625 <label class="md-nav__link" for="__nav_4_2">
626 New API
627 <span class="md-nav__icon md-icon"></span>
628 </label>
629 <nav class="md-nav" aria-label="New API" data-md-level="2">
630 <label class="md-nav__title" for="__nav_4_2">
631 <span class="md-nav__icon md-icon"></span>
632 New API
633 </label>
634 <ul class="md-nav__list" data-md-scrollfix>
635
636
637
638
639
640 <li class="md-nav__item">
641 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
642 Writing a module
643 </a>
644 </li>
645
646
647
648
649
650
651
652 <li class="md-nav__item">
653 <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
654 Data Structures
655 </a>
656 </li>
657
658
659
660
661
662
663
664 <li class="md-nav__item">
665 <a href="../../../javascript/new-api_core/" class="md-nav__link">
666 Core Functions
667 </a>
668 </li>
669
670
671
672
673
674
675
676 <li class="md-nav__item">
677 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
678 DOM
679 </a>
680 </li>
681
682
683
684
685
686
687
688 <li class="md-nav__item">
689 <a href="../../../javascript/new-api_events/" class="md-nav__link">
690 Event Handling
691 </a>
692 </li>
693
694
695
696
697
698
699
700 <li class="md-nav__item">
701 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
702 Ajax
703 </a>
704 </li>
705
706
707
708
709
710
711
712 <li class="md-nav__item">
713 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
714 Dialogs
715 </a>
716 </li>
717
718
719
720
721
722
723
724 <li class="md-nav__item">
725 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
726 Browser and Screen Sizes
727 </a>
728 </li>
729
730
731
732
733
734
735
736 <li class="md-nav__item">
737 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
738 User Interface
739 </a>
740 </li>
741
742
743
744 </ul>
745 </nav>
746 </li>
747
748
749
750
751
752
753
754 <li class="md-nav__item">
755 <a href="../../../javascript/legacy-api/" class="md-nav__link">
756 Legacy API
757 </a>
758 </li>
759
760
761
762
763
764
765
766 <li class="md-nav__item">
767 <a href="../../../javascript/helper-functions/" class="md-nav__link">
768 Helper Functions
769 </a>
770 </li>
771
772
773
774
775
776
777
778 <li class="md-nav__item">
779 <a href="../../../javascript/code-snippets/" class="md-nav__link">
780 Code Snippets
781 </a>
782 </li>
783
784
785
786 </ul>
787 </nav>
788 </li>
789
790
791
792
793
794
795
796
797
798
799
800 <li class="md-nav__item md-nav__item--nested">
801
802
803 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
804
805 <label class="md-nav__link" for="__nav_5">
806 Package Components
807 <span class="md-nav__icon md-icon"></span>
808 </label>
809 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
810 <label class="md-nav__title" for="__nav_5">
811 <span class="md-nav__icon md-icon"></span>
812 Package Components
813 </label>
814 <ul class="md-nav__list" data-md-scrollfix>
815
816
817
818
819
820 <li class="md-nav__item">
821 <a href="../../../package/package-xml/" class="md-nav__link">
822 package.xml
823 </a>
824 </li>
825
826
827
828
829
830
831
832
833 <li class="md-nav__item md-nav__item--nested">
834
835
836 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
837
838 <label class="md-nav__link" for="__nav_5_2">
839 PIPs
840 <span class="md-nav__icon md-icon"></span>
841 </label>
842 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
843 <label class="md-nav__title" for="__nav_5_2">
844 <span class="md-nav__icon md-icon"></span>
845 PIPs
846 </label>
847 <ul class="md-nav__list" data-md-scrollfix>
848
849
850
851
852
853 <li class="md-nav__item">
854 <a href="../../../package/pip/" class="md-nav__link">
855 Overview
856 </a>
857 </li>
858
859
860
861
862
863
864
865 <li class="md-nav__item">
866 <a href="../../../package/pip/acl-option/" class="md-nav__link">
867 aclOption
868 </a>
869 </li>
870
871
872
873
874
875
876
877 <li class="md-nav__item">
878 <a href="../../../package/pip/acp-menu/" class="md-nav__link">
879 acpMenu
880 </a>
881 </li>
882
883
884
885
886
887
888
889 <li class="md-nav__item">
890 <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
891 acpSearchProvider
892 </a>
893 </li>
894
895
896
897
898
899
900
901 <li class="md-nav__item">
902 <a href="../../../package/pip/acp-template/" class="md-nav__link">
903 acpTemplate
904 </a>
905 </li>
906
907
908
909
910
911
912
913 <li class="md-nav__item">
914 <a href="../../../package/pip/bbcode/" class="md-nav__link">
915 bbcode
916 </a>
917 </li>
918
919
920
921
922
923
924
925 <li class="md-nav__item">
926 <a href="../../../package/pip/box/" class="md-nav__link">
927 box
928 </a>
929 </li>
930
931
932
933
934
935
936
937 <li class="md-nav__item">
938 <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
939 clipboardAction
940 </a>
941 </li>
942
943
944
945
946
947
948
949 <li class="md-nav__item">
950 <a href="../../../package/pip/core-object/" class="md-nav__link">
951 coreObject
952 </a>
953 </li>
954
955
956
957
958
959
960
961 <li class="md-nav__item">
962 <a href="../../../package/pip/cronjob/" class="md-nav__link">
963 cronjob
964 </a>
965 </li>
966
967
968
969
970
971
972
973 <li class="md-nav__item">
974 <a href="../../../package/pip/event-listener/" class="md-nav__link">
975 eventListener
976 </a>
977 </li>
978
979
980
981
982
983
984
985 <li class="md-nav__item">
986 <a href="../../../package/pip/file/" class="md-nav__link">
987 file
988 </a>
989 </li>
990
991
992
993
994
995
996
997 <li class="md-nav__item">
998 <a href="../../../package/pip/language/" class="md-nav__link">
999 language
1000 </a>
1001 </li>
1002
1003
1004
1005
1006
1007
1008
1009 <li class="md-nav__item">
1010 <a href="../../../package/pip/media-provider/" class="md-nav__link">
1011 mediaProvider
1012 </a>
1013 </li>
1014
1015
1016
1017
1018
1019
1020
1021 <li class="md-nav__item">
1022 <a href="../../../package/pip/menu/" class="md-nav__link">
1023 menu
1024 </a>
1025 </li>
1026
1027
1028
1029
1030
1031
1032
1033 <li class="md-nav__item">
1034 <a href="../../../package/pip/menu-item/" class="md-nav__link">
1035 menuItem
1036 </a>
1037 </li>
1038
1039
1040
1041
1042
1043
1044
1045 <li class="md-nav__item">
1046 <a href="../../../package/pip/object-type/" class="md-nav__link">
1047 objectType
1048 </a>
1049 </li>
1050
1051
1052
1053
1054
1055
1056
1057 <li class="md-nav__item">
1058 <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1059 objectTypeDefinition
1060 </a>
1061 </li>
1062
1063
1064
1065
1066
1067
1068
1069 <li class="md-nav__item">
1070 <a href="../../../package/pip/option/" class="md-nav__link">
1071 option
1072 </a>
1073 </li>
1074
1075
1076
1077
1078
1079
1080
1081 <li class="md-nav__item">
1082 <a href="../../../package/pip/page/" class="md-nav__link">
1083 page
1084 </a>
1085 </li>
1086
1087
1088
1089
1090
1091
1092
1093 <li class="md-nav__item">
1094 <a href="../../../package/pip/pip/" class="md-nav__link">
1095 pip
1096 </a>
1097 </li>
1098
1099
1100
1101
1102
1103
1104
1105 <li class="md-nav__item">
1106 <a href="../../../package/pip/script/" class="md-nav__link">
1107 script
1108 </a>
1109 </li>
1110
1111
1112
1113
1114
1115
1116
1117 <li class="md-nav__item">
1118 <a href="../../../package/pip/smiley/" class="md-nav__link">
1119 smiley
1120 </a>
1121 </li>
1122
1123
1124
1125
1126
1127
1128
1129 <li class="md-nav__item">
1130 <a href="../../../package/pip/sql/" class="md-nav__link">
1131 sql
1132 </a>
1133 </li>
1134
1135
1136
1137
1138
1139
1140
1141 <li class="md-nav__item">
1142 <a href="../../../package/pip/style/" class="md-nav__link">
1143 style
1144 </a>
1145 </li>
1146
1147
1148
1149
1150
1151
1152
1153 <li class="md-nav__item">
1154 <a href="../../../package/pip/template/" class="md-nav__link">
1155 template
1156 </a>
1157 </li>
1158
1159
1160
1161
1162
1163
1164
1165 <li class="md-nav__item">
1166 <a href="../../../package/pip/template-listener/" class="md-nav__link">
1167 templateListener
1168 </a>
1169 </li>
1170
1171
1172
1173
1174
1175
1176
1177 <li class="md-nav__item">
1178 <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1179 userGroupOption
1180 </a>
1181 </li>
1182
1183
1184
1185
1186
1187
1188
1189 <li class="md-nav__item">
1190 <a href="../../../package/pip/user-menu/" class="md-nav__link">
1191 userMenu
1192 </a>
1193 </li>
1194
1195
1196
1197
1198
1199
1200
1201 <li class="md-nav__item">
1202 <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1203 userNotificationEvent
1204 </a>
1205 </li>
1206
1207
1208
1209
1210
1211
1212
1213 <li class="md-nav__item">
1214 <a href="../../../package/pip/user-option/" class="md-nav__link">
1215 userOption
1216 </a>
1217 </li>
1218
1219
1220
1221
1222
1223
1224
1225 <li class="md-nav__item">
1226 <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1227 userProfileMenu
1228 </a>
1229 </li>
1230
1231
1232
1233 </ul>
1234 </nav>
1235 </li>
1236
1237
1238
1239
1240
1241
1242
1243 <li class="md-nav__item">
1244 <a href="../../../package/database-php-api/" class="md-nav__link">
1245 Database PHP API
1246 </a>
1247 </li>
1248
1249
1250
1251 </ul>
1252 </nav>
1253 </li>
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1268
1269
1270 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
1271
1272 <label class="md-nav__link" for="__nav_6">
1273 Migration
1274 <span class="md-nav__icon md-icon"></span>
1275 </label>
1276 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1277 <label class="md-nav__title" for="__nav_6">
1278 <span class="md-nav__icon md-icon"></span>
1279 Migration
1280 </label>
1281 <ul class="md-nav__list" data-md-scrollfix>
1282
1283
1284
1285
1286
1287
1288 <li class="md-nav__item md-nav__item--nested">
1289
1290
1291 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1292
1293 <label class="md-nav__link" for="__nav_6_1">
1294 Migrating from WSC 5.3
1295 <span class="md-nav__icon md-icon"></span>
1296 </label>
1297 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1298 <label class="md-nav__title" for="__nav_6_1">
1299 <span class="md-nav__icon md-icon"></span>
1300 Migrating from WSC 5.3
1301 </label>
1302 <ul class="md-nav__list" data-md-scrollfix>
1303
1304
1305
1306
1307
1308 <li class="md-nav__item">
1309 <a href="../../wsc53/php/" class="md-nav__link">
1310 PHP API
1311 </a>
1312 </li>
1313
1314
1315
1316
1317
1318
1319
1320 <li class="md-nav__item">
1321 <a href="../../wsc53/session/" class="md-nav__link">
1322 Session Handling and Authentication
1323 </a>
1324 </li>
1325
1326
1327
1328
1329
1330
1331
1332 <li class="md-nav__item">
1333 <a href="../../wsc53/javascript/" class="md-nav__link">
1334 JavaScript
1335 </a>
1336 </li>
1337
1338
1339
1340
1341
1342
1343
1344 <li class="md-nav__item">
1345 <a href="../../wsc53/templates/" class="md-nav__link">
1346 Templates
1347 </a>
1348 </li>
1349
1350
1351
1352
1353
1354
1355
1356 <li class="md-nav__item">
1357 <a href="../../wsc53/libraries/" class="md-nav__link">
1358 Third Party Libraries
1359 </a>
1360 </li>
1361
1362
1363
1364 </ul>
1365 </nav>
1366 </li>
1367
1368
1369
1370
1371
1372
1373
1374
1375 <li class="md-nav__item md-nav__item--nested">
1376
1377
1378 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1379
1380 <label class="md-nav__link" for="__nav_6_2">
1381 Migrating from WSC 5.2
1382 <span class="md-nav__icon md-icon"></span>
1383 </label>
1384 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1385 <label class="md-nav__title" for="__nav_6_2">
1386 <span class="md-nav__icon md-icon"></span>
1387 Migrating from WSC 5.2
1388 </label>
1389 <ul class="md-nav__list" data-md-scrollfix>
1390
1391
1392
1393
1394
1395 <li class="md-nav__item">
1396 <a href="../../wsc52/php/" class="md-nav__link">
1397 PHP API
1398 </a>
1399 </li>
1400
1401
1402
1403
1404
1405
1406
1407 <li class="md-nav__item">
1408 <a href="../../wsc52/templates/" class="md-nav__link">
1409 Templates and Languages
1410 </a>
1411 </li>
1412
1413
1414
1415
1416
1417
1418
1419 <li class="md-nav__item">
1420 <a href="../../wsc52/libraries/" class="md-nav__link">
1421 Third Party Libraries
1422 </a>
1423 </li>
1424
1425
1426
1427 </ul>
1428 </nav>
1429 </li>
1430
1431
1432
1433
1434
1435
1436
1437
1438 <li class="md-nav__item md-nav__item--nested">
1439
1440
1441 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1442
1443 <label class="md-nav__link" for="__nav_6_3">
1444 Migrating from WSC 3.1
1445 <span class="md-nav__icon md-icon"></span>
1446 </label>
1447 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1448 <label class="md-nav__title" for="__nav_6_3">
1449 <span class="md-nav__icon md-icon"></span>
1450 Migrating from WSC 3.1
1451 </label>
1452 <ul class="md-nav__list" data-md-scrollfix>
1453
1454
1455
1456
1457
1458 <li class="md-nav__item">
1459 <a href="../../wsc31/php/" class="md-nav__link">
1460 PHP API
1461 </a>
1462 </li>
1463
1464
1465
1466 </ul>
1467 </nav>
1468 </li>
1469
1470
1471
1472
1473
1474
1475
1476
1477 <li class="md-nav__item md-nav__item--nested">
1478
1479
1480 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1481
1482 <label class="md-nav__link" for="__nav_6_4">
1483 Migrating from WSC 3.0
1484 <span class="md-nav__icon md-icon"></span>
1485 </label>
1486 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1487 <label class="md-nav__title" for="__nav_6_4">
1488 <span class="md-nav__icon md-icon"></span>
1489 Migrating from WSC 3.0
1490 </label>
1491 <ul class="md-nav__list" data-md-scrollfix>
1492
1493
1494
1495
1496
1497 <li class="md-nav__item">
1498 <a href="../../wsc30/php/" class="md-nav__link">
1499 PHP API
1500 </a>
1501 </li>
1502
1503
1504
1505
1506
1507
1508
1509 <li class="md-nav__item">
1510 <a href="../../wsc30/javascript/" class="md-nav__link">
1511 JavaScript API
1512 </a>
1513 </li>
1514
1515
1516
1517
1518
1519
1520
1521 <li class="md-nav__item">
1522 <a href="../../wsc30/templates/" class="md-nav__link">
1523 Templates
1524 </a>
1525 </li>
1526
1527
1528
1529
1530
1531
1532
1533 <li class="md-nav__item">
1534 <a href="../../wsc30/css/" class="md-nav__link">
1535 CSS
1536 </a>
1537 </li>
1538
1539
1540
1541
1542
1543
1544
1545 <li class="md-nav__item">
1546 <a href="../../wsc30/package/" class="md-nav__link">
1547 Package Components
1548 </a>
1549 </li>
1550
1551
1552
1553 </ul>
1554 </nav>
1555 </li>
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1567
1568
1569 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" checked>
1570
1571 <label class="md-nav__link" for="__nav_6_5">
1572 Migrating from WCF 2.1
1573 <span class="md-nav__icon md-icon"></span>
1574 </label>
1575 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1576 <label class="md-nav__title" for="__nav_6_5">
1577 <span class="md-nav__icon md-icon"></span>
1578 Migrating from WCF 2.1
1579 </label>
1580 <ul class="md-nav__list" data-md-scrollfix>
1581
1582
1583
1584
1585
1586 <li class="md-nav__item">
1587 <a href="../php/" class="md-nav__link">
1588 PHP API
1589 </a>
1590 </li>
1591
1592
1593
1594
1595
1596
1597
1598 <li class="md-nav__item">
1599 <a href="../templates/" class="md-nav__link">
1600 Templates
1601 </a>
1602 </li>
1603
1604
1605
1606
1607
1608
1609
1610 <li class="md-nav__item">
1611 <a href="../css/" class="md-nav__link">
1612 CSS
1613 </a>
1614 </li>
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624 <li class="md-nav__item md-nav__item--active">
1625
1626 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1627
1628
1629
1630
1631 <label class="md-nav__link md-nav__link--active" for="__toc">
1632 Package Components
1633 <span class="md-nav__icon md-icon"></span>
1634 </label>
1635
1636 <a href="./" class="md-nav__link md-nav__link--active">
1637 Package Components
1638 </a>
1639
1640
1641<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1642
1643
1644
1645
1646
1647 <label class="md-nav__title" for="__toc">
1648 <span class="md-nav__icon md-icon"></span>
1649 Table of contents
1650 </label>
1651 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1652
1653 <li class="md-nav__item">
1654 <a href="#packagexml" class="md-nav__link">
1655 package.xml
1656 </a>
1657
1658 <nav class="md-nav" aria-label="package.xml">
1659 <ul class="md-nav__list">
1660
1661 <li class="md-nav__item">
1662 <a href="#short-instructions" class="md-nav__link">
1663 Short Instructions
1664 </a>
1665
1666</li>
1667
1668 <li class="md-nav__item">
1669 <a href="#example" class="md-nav__link">
1670 Example
1671 </a>
1672
1673</li>
1674
1675 <li class="md-nav__item">
1676 <a href="#exceptions" class="md-nav__link">
1677 Exceptions
1678 </a>
1679
1680</li>
1681
1682 </ul>
1683 </nav>
1684
1685</li>
1686
1687 <li class="md-nav__item">
1688 <a href="#acpmenuxml" class="md-nav__link">
1689 acpMenu.xml
1690 </a>
1691
1692 <nav class="md-nav" aria-label="acpMenu.xml">
1693 <ul class="md-nav__list">
1694
1695 <li class="md-nav__item">
1696 <a href="#renamed-categories" class="md-nav__link">
1697 Renamed Categories
1698 </a>
1699
1700</li>
1701
1702 <li class="md-nav__item">
1703 <a href="#submenu-items" class="md-nav__link">
1704 Submenu Items
1705 </a>
1706
1707</li>
1708
1709 <li class="md-nav__item">
1710 <a href="#example_1" class="md-nav__link">
1711 Example
1712 </a>
1713
1714</li>
1715
1716 <li class="md-nav__item">
1717 <a href="#common-icon-names" class="md-nav__link">
1718 Common Icon Names
1719 </a>
1720
1721</li>
1722
1723 </ul>
1724 </nav>
1725
1726</li>
1727
1728 <li class="md-nav__item">
1729 <a href="#boxxml" class="md-nav__link">
1730 box.xml
1731 </a>
1732
1733</li>
1734
1735 <li class="md-nav__item">
1736 <a href="#cronjobxml" class="md-nav__link">
1737 cronjob.xml
1738 </a>
1739
1740</li>
1741
1742 <li class="md-nav__item">
1743 <a href="#eventlistenerxml" class="md-nav__link">
1744 eventListener.xml
1745 </a>
1746
1747</li>
1748
1749 <li class="md-nav__item">
1750 <a href="#menuxml" class="md-nav__link">
1751 menu.xml
1752 </a>
1753
1754</li>
1755
1756 <li class="md-nav__item">
1757 <a href="#menuitemxml" class="md-nav__link">
1758 menuItem.xml
1759 </a>
1760
1761</li>
1762
1763 <li class="md-nav__item">
1764 <a href="#objecttypexml" class="md-nav__link">
1765 objectType.xml
1766 </a>
1767
1768</li>
1769
1770 <li class="md-nav__item">
1771 <a href="#optionxml" class="md-nav__link">
1772 option.xml
1773 </a>
1774
1775</li>
1776
1777 <li class="md-nav__item">
1778 <a href="#pagexml" class="md-nav__link">
1779 page.xml
1780 </a>
1781
1782</li>
1783
1784 <li class="md-nav__item">
1785 <a href="#pagemenuxml" class="md-nav__link">
1786 pageMenu.xml
1787 </a>
1788
1789</li>
1790
1791 </ul>
1792
1793</nav>
1794
1795 </li>
1796
1797
1798
1799 </ul>
1800 </nav>
1801 </li>
1802
1803
1804
1805 </ul>
1806 </nav>
1807 </li>
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819 <li class="md-nav__item md-nav__item--nested">
1820
1821
1822 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1823
1824 <label class="md-nav__link" for="__nav_7">
1825 Tutorials
1826 <span class="md-nav__icon md-icon"></span>
1827 </label>
1828 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1829 <label class="md-nav__title" for="__nav_7">
1830 <span class="md-nav__icon md-icon"></span>
1831 Tutorials
1832 </label>
1833 <ul class="md-nav__list" data-md-scrollfix>
1834
1835
1836
1837
1838
1839
1840 <li class="md-nav__item md-nav__item--nested">
1841
1842
1843 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1844
1845 <label class="md-nav__link" for="__nav_7_1">
1846 Tutorial Series
1847 <span class="md-nav__icon md-icon"></span>
1848 </label>
1849 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1850 <label class="md-nav__title" for="__nav_7_1">
1851 <span class="md-nav__icon md-icon"></span>
1852 Tutorial Series
1853 </label>
1854 <ul class="md-nav__list" data-md-scrollfix>
1855
1856
1857
1858
1859
1860 <li class="md-nav__item">
1861 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1862 Overview
1863 </a>
1864 </li>
1865
1866
1867
1868
1869
1870
1871
1872 <li class="md-nav__item">
1873 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1874 Part 1
1875 </a>
1876 </li>
1877
1878
1879
1880
1881
1882
1883
1884 <li class="md-nav__item">
1885 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1886 Part 2
1887 </a>
1888 </li>
1889
1890
1891
1892
1893
1894
1895
1896 <li class="md-nav__item">
1897 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1898 Part 3
1899 </a>
1900 </li>
1901
1902
1903
1904 </ul>
1905 </nav>
1906 </li>
1907
1908
1909
1910 </ul>
1911 </nav>
1912 </li>
1913
1914
1915
1916 </ul>
1917</nav>
1918 </div>
1919 </div>
1920 </div>
1921
1922
1923
1924 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1925 <div class="md-sidebar__scrollwrap">
1926 <div class="md-sidebar__inner">
1927
1928<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1929
1930
1931
1932
1933
1934 <label class="md-nav__title" for="__toc">
1935 <span class="md-nav__icon md-icon"></span>
1936 Table of contents
1937 </label>
1938 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1939
1940 <li class="md-nav__item">
1941 <a href="#packagexml" class="md-nav__link">
1942 package.xml
1943 </a>
1944
1945 <nav class="md-nav" aria-label="package.xml">
1946 <ul class="md-nav__list">
1947
1948 <li class="md-nav__item">
1949 <a href="#short-instructions" class="md-nav__link">
1950 Short Instructions
1951 </a>
1952
1953</li>
1954
1955 <li class="md-nav__item">
1956 <a href="#example" class="md-nav__link">
1957 Example
1958 </a>
1959
1960</li>
1961
1962 <li class="md-nav__item">
1963 <a href="#exceptions" class="md-nav__link">
1964 Exceptions
1965 </a>
1966
1967</li>
1968
1969 </ul>
1970 </nav>
1971
1972</li>
1973
1974 <li class="md-nav__item">
1975 <a href="#acpmenuxml" class="md-nav__link">
1976 acpMenu.xml
1977 </a>
1978
1979 <nav class="md-nav" aria-label="acpMenu.xml">
1980 <ul class="md-nav__list">
1981
1982 <li class="md-nav__item">
1983 <a href="#renamed-categories" class="md-nav__link">
1984 Renamed Categories
1985 </a>
1986
1987</li>
1988
1989 <li class="md-nav__item">
1990 <a href="#submenu-items" class="md-nav__link">
1991 Submenu Items
1992 </a>
1993
1994</li>
1995
1996 <li class="md-nav__item">
1997 <a href="#example_1" class="md-nav__link">
1998 Example
1999 </a>
2000
2001</li>
2002
2003 <li class="md-nav__item">
2004 <a href="#common-icon-names" class="md-nav__link">
2005 Common Icon Names
2006 </a>
2007
2008</li>
2009
2010 </ul>
2011 </nav>
2012
2013</li>
2014
2015 <li class="md-nav__item">
2016 <a href="#boxxml" class="md-nav__link">
2017 box.xml
2018 </a>
2019
2020</li>
2021
2022 <li class="md-nav__item">
2023 <a href="#cronjobxml" class="md-nav__link">
2024 cronjob.xml
2025 </a>
2026
2027</li>
2028
2029 <li class="md-nav__item">
2030 <a href="#eventlistenerxml" class="md-nav__link">
2031 eventListener.xml
2032 </a>
2033
2034</li>
2035
2036 <li class="md-nav__item">
2037 <a href="#menuxml" class="md-nav__link">
2038 menu.xml
2039 </a>
2040
2041</li>
2042
2043 <li class="md-nav__item">
2044 <a href="#menuitemxml" class="md-nav__link">
2045 menuItem.xml
2046 </a>
2047
2048</li>
2049
2050 <li class="md-nav__item">
2051 <a href="#objecttypexml" class="md-nav__link">
2052 objectType.xml
2053 </a>
2054
2055</li>
2056
2057 <li class="md-nav__item">
2058 <a href="#optionxml" class="md-nav__link">
2059 option.xml
2060 </a>
2061
2062</li>
2063
2064 <li class="md-nav__item">
2065 <a href="#pagexml" class="md-nav__link">
2066 page.xml
2067 </a>
2068
2069</li>
2070
2071 <li class="md-nav__item">
2072 <a href="#pagemenuxml" class="md-nav__link">
2073 pageMenu.xml
2074 </a>
2075
2076</li>
2077
2078 </ul>
2079
2080</nav>
2081 </div>
2082 </div>
2083 </div>
2084
2085
2086 <div class="md-content" data-md-component="content">
2087 <article class="md-content__inner md-typeset">
2088
2089
2090
2091 <h1 id="wcf-21x-package-components">WCF 2.1.x - Package Components<a class="headerlink" href="#wcf-21x-package-components" title="Permanent link">#</a></h1>
2092<h2 id="packagexml">package.xml<a class="headerlink" href="#packagexml" title="Permanent link">#</a></h2>
2093<h3 id="short-instructions">Short Instructions<a class="headerlink" href="#short-instructions" title="Permanent link">#</a></h3>
2094<p>Instructions can now omit the filename, causing them to use the default filename if defined by the package installation plugin (in short: <code>PIP</code>). Unless overridden it will default to the PIP's class name with the first letter being lower-cased, e.g. <code>EventListenerPackageInstallationPlugin</code> implies the filename <code>eventListener.xml</code>. The file is always assumed to be in the archive's root, files located in subdirectories need to be explicitly stated, just as it worked before.</p>
2095<p>Every PIP can define a custom filename if the default value cannot be properly derived. For example the <code>ACPMenu</code>-pip would default to <code>aCPMenu.xml</code>, requiring the class to explicitly override the default filename with <code>acpMenu.xml</code> for readability.</p>
2096<h3 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h3>
2097<div class="highlight"><pre><span></span><code><span class="nt">&lt;instructions</span> <span class="na">type=</span><span class="s">&quot;install&quot;</span><span class="nt">&gt;</span>
2098 <span class="c">&lt;!-- assumes `eventListener.xml` --&gt;</span>
2099 <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;eventListener&quot;</span> <span class="nt">/&gt;</span>
2100 <span class="c">&lt;!-- assumes `install.sql` --&gt;</span>
2101 <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;sql&quot;</span> <span class="nt">/&gt;</span>
2102 <span class="c">&lt;!-- assumes `language/*.xml` --&gt;</span>
2103 <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;language&quot;</span> <span class="nt">/&gt;</span>
2104
2105 <span class="c">&lt;!-- exceptions --&gt;</span>
2106
2107 <span class="c">&lt;!-- assumes `files.tar` --&gt;</span>
2108 <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;file&quot;</span> <span class="nt">/&gt;</span>
2109 <span class="c">&lt;!-- no default value, requires relative path --&gt;</span>
2110 <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;script&quot;</span><span class="nt">&gt;</span>acp/install_com.woltlab.wcf_3.0.php<span class="nt">&lt;/instruction&gt;</span>
2111<span class="nt">&lt;/instructions&gt;</span>
2112</code></pre></div>
0c5338dd
TD		 2113<h3 id="exceptions">Exceptions<a class="headerlink" href="#exceptions" title="Permanent link">#</a></h3>
2114<div class="admonition info">
2115<p class="admonition-title">These exceptions represent the built-in PIPs only, 3rd party plugins and apps may define their own exceptions.</p>
2116</div>
2117<table>
2118<thead>
2119<tr>
2120<th>PIP</th>
2121<th>Default Value</th>
2122</tr>
2123</thead>
2124<tbody>
2125<tr>
2126<td><code>acpTemplate</code></td>
2127<td><code>acptemplates.tar</code></td>
2128</tr>
2129<tr>
2130<td><code>file</code></td>
2131<td><code>files.tar</code></td>
2132</tr>
2133<tr>
2134<td><code>language</code></td>
2135<td><code>language/*.xml</code></td>
2136</tr>
2137<tr>
2138<td><code>script</code></td>
2139<td>(No default value)</td>
2140</tr>
2141<tr>
2142<td><code>sql</code></td>
2143<td><code>install.sql</code></td>
2144</tr>
2145<tr>
2146<td><code>template</code></td>
2147<td><code>templates.tar</code></td>
2148</tr>
2149</tbody>
2150</table>
2151<h2 id="acpmenuxml">acpMenu.xml<a class="headerlink" href="#acpmenuxml" title="Permanent link">#</a></h2>
2152<h3 id="renamed-categories">Renamed Categories<a class="headerlink" href="#renamed-categories" title="Permanent link">#</a></h3>
2153<p>The following categories have been renamed, menu items need to be adjusted to reflect the new names:</p>
2154<table>
2155<thead>
2156<tr>
2157<th>Old Value</th>
2158<th>New Value</th>
2159</tr>
2160</thead>
2161<tbody>
2162<tr>
2163<td><code>wcf.acp.menu.link.system</code></td>
2164<td><code>wcf.acp.menu.link.configuration</code></td>
2165</tr>
2166<tr>
2167<td><code>wcf.acp.menu.link.display</code></td>
2168<td><code>wcf.acp.menu.link.customization</code></td>
2169</tr>
2170<tr>
2171<td><code>wcf.acp.menu.link.community</code></td>
2172<td><code>wcf.acp.menu.link.application</code></td>
2173</tr>
2174</tbody>
2175</table>
2176<h3 id="submenu-items">Submenu Items<a class="headerlink" href="#submenu-items" title="Permanent link">#</a></h3>
2177<p>Menu items can now offer additional actions to be accessed from within the menu using an icon-based navigation. This step avoids filling the menu with dozens of <code>Add …</code> links, shifting the focus on to actual items. Adding more than one action is not recommended and you should at maximum specify two actions per item.</p>
2178<h3 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">#</a></h3>
2179<div class="highlight"><pre><span></span><code><span class="c">&lt;!-- category --&gt;</span>
2180<span class="nt">&lt;acpmenuitem</span> <span class="na">name=</span><span class="s">&quot;wcf.acp.menu.link.group&quot;</span><span class="nt">&gt;</span>
2181 <span class="nt">&lt;parent&gt;</span>wcf.acp.menu.link.user<span class="nt">&lt;/parent&gt;</span>
2182 <span class="nt">&lt;showorder&gt;</span>2<span class="nt">&lt;/showorder&gt;</span>
2183<span class="nt">&lt;/acpmenuitem&gt;</span>
2184
2185<span class="c">&lt;!-- menu item --&gt;</span>
2186<span class="nt">&lt;acpmenuitem</span> <span class="na">name=</span><span class="s">&quot;wcf.acp.menu.link.group.list&quot;</span><span class="nt">&gt;</span>
2187 <span class="nt">&lt;controller&gt;</span>wcf\acp\page\UserGroupListPage<span class="nt">&lt;/controller&gt;</span>
2188 <span class="nt">&lt;parent&gt;</span>wcf.acp.menu.link.group<span class="nt">&lt;/parent&gt;</span>
2189 <span class="nt">&lt;permissions&gt;</span>admin.user.canEditGroup,admin.user.canDeleteGroup<span class="nt">&lt;/permissions&gt;</span>
2190<span class="nt">&lt;/acpmenuitem&gt;</span>
2191<span class="c">&lt;!-- menu item action --&gt;</span>
2192<span class="nt">&lt;acpmenuitem</span> <span class="na">name=</span><span class="s">&quot;wcf.acp.menu.link.group.add&quot;</span><span class="nt">&gt;</span>
2193 <span class="nt">&lt;controller&gt;</span>wcf\acp\form\UserGroupAddForm<span class="nt">&lt;/controller&gt;</span>
2194 <span class="c">&lt;!-- actions are defined by menu items of menu items --&gt;</span>
2195 <span class="nt">&lt;parent&gt;</span>wcf.acp.menu.link.group.list<span class="nt">&lt;/parent&gt;</span>
2196 <span class="nt">&lt;permissions&gt;</span>admin.user.canAddGroup<span class="nt">&lt;/permissions&gt;</span>
2197 <span class="c">&lt;!-- required FontAwesome icon name used for display --&gt;</span>
2198 <span class="nt">&lt;icon&gt;</span>fa-plus<span class="nt">&lt;/icon&gt;</span>
2199<span class="nt">&lt;/acpmenuitem&gt;</span>
2200</code></pre></div>
0c5338dd
TD		 2201<h3 id="common-icon-names">Common Icon Names<a class="headerlink" href="#common-icon-names" title="Permanent link">#</a></h3>
2202<p>You should use the same icon names for the (logically) same task, unifying the meaning of items and making the actions predictable.</p>
2203<table>
2204<thead>
2205<tr>
2206<th>Meaning</th>
2207<th>Icon Name</th>
2208<th>Result</th>
2209</tr>
2210</thead>
2211<tbody>
2212<tr>
2213<td>Add or create</td>
2214<td><code>fa-plus</code></td>
2215<td><i class="fa fa-plus"></i></td>
2216</tr>
2217<tr>
2218<td>Search</td>
2219<td><code>fa-search</code></td>
2220<td><i class="fa fa-search"></i></td>
2221</tr>
2222<tr>
2223<td>Upload</td>
2224<td><code>fa-upload</code></td>
2225<td><i class="fa fa-upload"></i></td>
2226</tr>
2227</tbody>
2228</table>
2229<h2 id="boxxml">box.xml<a class="headerlink" href="#boxxml" title="Permanent link">#</a></h2>
2230<p>The <a href="../../../package/pip/box/">box</a> PIP has been added.</p>
2231<h2 id="cronjobxml">cronjob.xml<a class="headerlink" href="#cronjobxml" title="Permanent link">#</a></h2>
2232<div class="admonition warning">
2233<p class="admonition-title">Legacy cronjobs are assigned a non-deterministic generic name, the only way to assign them a name is removing them and then adding them again.</p>
2234</div>
2235<p>Cronjobs can now be assigned a name using the name attribute as in <code>&lt;cronjob name="com.woltlab.wcf.refreshPackageUpdates"&gt;</code>, it will be used to identify cronjobs during an update or delete.</p>
2236<h2 id="eventlistenerxml">eventListener.xml<a class="headerlink" href="#eventlistenerxml" title="Permanent link">#</a></h2>
2237<div class="admonition warning">
2238<p class="admonition-title">Legacy event listeners are assigned a non-deterministic generic name, the only way to assign them a name is removing them and then adding them again.</p>
2239</div>
2240<p>Event listeners can now be assigned a name using the name attribute as in <code>&lt;eventlistener name="sessionPageAccessLog"&gt;</code>, it will be used to identify event listeners during an update or delete.</p>
2241<h2 id="menuxml">menu.xml<a class="headerlink" href="#menuxml" title="Permanent link">#</a></h2>
2242<p>The <a href="../../../package/pip/menu/">menu</a> PIP has been added.</p>
2243<h2 id="menuitemxml">menuItem.xml<a class="headerlink" href="#menuitemxml" title="Permanent link">#</a></h2>
2244<p>The <a href="../../../package/pip/menu-item/">menuItem</a> PIP has been added.</p>
2245<h2 id="objecttypexml">objectType.xml<a class="headerlink" href="#objecttypexml" title="Permanent link">#</a></h2>
2246<p>The definition <code>com.woltlab.wcf.user.dashboardContainer</code> has been removed, it was previously used to register pages that qualify for dashboard boxes. Since WoltLab Suite 3.0, all pages registered through the <code>page.xml</code> are valid containers and therefore there is no need for this definition anymore.</p>
2247<p>The definitions <code>com.woltlab.wcf.page</code> and <code>com.woltlab.wcf.user.online.location</code> have been superseded by the <code>page.xml</code>, they're no longer supported.</p>
2248<h2 id="optionxml">option.xml<a class="headerlink" href="#optionxml" title="Permanent link">#</a></h2>
2249<p>The <code>module.display</code> category has been renamed into <code>module.customization</code>.</p>
2250<h2 id="pagexml">page.xml<a class="headerlink" href="#pagexml" title="Permanent link">#</a></h2>
2251<p>The <a href="../../../package/pip/page/">page</a> PIP has been added.</p>
2252<h2 id="pagemenuxml">pageMenu.xml<a class="headerlink" href="#pagemenuxml" title="Permanent link">#</a></h2>
2253<p>The <code>pageMenu.xml</code> has been superseded by the <code>page.xml</code> and is no longer available.</p>
2254
2255
2256
2257
2258
2259
2260
2261 </article>
2262 </div>
2263 </div>
2264 </main>
2265
2266
2267<footer class="md-footer">
2268
2269 <nav class="md-footer__inner md-grid" aria-label="Footer">
2270
2271 <a href="../css/" class="md-footer__link md-footer__link--prev" rel="prev">
2272 <div class="md-footer__button md-icon">
2273 <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>
2274 </div>
2275 <div class="md-footer__title">
2276 <div class="md-ellipsis">
2277 <span class="md-footer__direction">
2278 Previous
2279 </span>
2280 CSS
2281 </div>
2282 </div>
2283 </a>
2284
2285
2286 <a href="../../../tutorial/series/overview/" class="md-footer__link md-footer__link--next" rel="next">
2287 <div class="md-footer__title">
2288 <div class="md-ellipsis">
2289 <span class="md-footer__direction">
2290 Next
2291 </span>
2292 Overview
2293 </div>
2294 </div>
2295 <div class="md-footer__button md-icon">
2296 <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>
2297 </div>
2298 </a>
2299
2300 </nav>
2301
2302 <div class="md-footer-meta md-typeset">
2303 <div class="md-footer-meta__inner md-grid">
2304 <div class="md-footer-copyright">
2305
2306 <div class="md-footer-copyright__highlight">
2307 Copyright © 2020 WoltLab GmbH
2308 </div>
2309
2310 Made with
2311 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2312 Material for MkDocs
2313 </a>
fb88dc6e 2314
0c5338dd
TD		 2315 </div>
2316 <div class="md-footer-copyright">
2317 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2318 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2319</div>
2320 </div>
2321 </div>
2322</footer>
2323
2324 </div>
2325 <div class="md-dialog" data-md-component="dialog">
2326 <div class="md-dialog__inner md-typeset"></div>
2327 </div>
2328 <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>
2329
2330
fb88dc6e 2331 <script src="../../../assets/javascripts/bundle.5cf3e710.min.js"></script>
0c5338dd
TD		 2332
2333
2334 </body>
2335</html>