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 / package / pip / page / 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>page - 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="#page-package-installation-plugin" 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 page
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
801
802 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
803
804
805 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
806
807 <label class="md-nav__link" for="__nav_5">
808 Package Components
809 <span class="md-nav__icon md-icon"></span>
810 </label>
811 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
812 <label class="md-nav__title" for="__nav_5">
813 <span class="md-nav__icon md-icon"></span>
814 Package Components
815 </label>
816 <ul class="md-nav__list" data-md-scrollfix>
817
818
819
820
821
822 <li class="md-nav__item">
823 <a href="../../package-xml/" class="md-nav__link">
824 package.xml
825 </a>
826 </li>
827
828
829
830
831
832
833
834
835
836
837 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
838
839
840 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
841
842 <label class="md-nav__link" for="__nav_5_2">
843 PIPs
844 <span class="md-nav__icon md-icon"></span>
845 </label>
846 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
847 <label class="md-nav__title" for="__nav_5_2">
848 <span class="md-nav__icon md-icon"></span>
849 PIPs
850 </label>
851 <ul class="md-nav__list" data-md-scrollfix>
852
853
854
855
856
857 <li class="md-nav__item">
858 <a href="../" class="md-nav__link">
859 Overview
860 </a>
861 </li>
862
863
864
865
866
867
868
869 <li class="md-nav__item">
870 <a href="../acl-option/" class="md-nav__link">
871 aclOption
872 </a>
873 </li>
874
875
876
877
878
879
880
881 <li class="md-nav__item">
882 <a href="../acp-menu/" class="md-nav__link">
883 acpMenu
884 </a>
885 </li>
886
887
888
889
890
891
892
893 <li class="md-nav__item">
894 <a href="../acp-search-provider/" class="md-nav__link">
895 acpSearchProvider
896 </a>
897 </li>
898
899
900
901
902
903
904
905 <li class="md-nav__item">
906 <a href="../acp-template/" class="md-nav__link">
907 acpTemplate
908 </a>
909 </li>
910
911
912
913
914
915
916
917 <li class="md-nav__item">
918 <a href="../bbcode/" class="md-nav__link">
919 bbcode
920 </a>
921 </li>
922
923
924
925
926
927
928
929 <li class="md-nav__item">
930 <a href="../box/" class="md-nav__link">
931 box
932 </a>
933 </li>
934
935
936
937
938
939
940
941 <li class="md-nav__item">
942 <a href="../clipboard-action/" class="md-nav__link">
943 clipboardAction
944 </a>
945 </li>
946
947
948
949
950
951
952
953 <li class="md-nav__item">
954 <a href="../core-object/" class="md-nav__link">
955 coreObject
956 </a>
957 </li>
958
959
960
961
962
963
964
965 <li class="md-nav__item">
966 <a href="../cronjob/" class="md-nav__link">
967 cronjob
968 </a>
969 </li>
970
971
972
973
974
975
976
977 <li class="md-nav__item">
978 <a href="../event-listener/" class="md-nav__link">
979 eventListener
980 </a>
981 </li>
982
983
984
985
986
987
988
989 <li class="md-nav__item">
990 <a href="../file/" class="md-nav__link">
991 file
992 </a>
993 </li>
994
995
996
997
998
999
1000
1001 <li class="md-nav__item">
1002 <a href="../language/" class="md-nav__link">
1003 language
1004 </a>
1005 </li>
1006
1007
1008
1009
1010
1011
1012
1013 <li class="md-nav__item">
1014 <a href="../media-provider/" class="md-nav__link">
1015 mediaProvider
1016 </a>
1017 </li>
1018
1019
1020
1021
1022
1023
1024
1025 <li class="md-nav__item">
1026 <a href="../menu/" class="md-nav__link">
1027 menu
1028 </a>
1029 </li>
1030
1031
1032
1033
1034
1035
1036
1037 <li class="md-nav__item">
1038 <a href="../menu-item/" class="md-nav__link">
1039 menuItem
1040 </a>
1041 </li>
1042
1043
1044
1045
1046
1047
1048
1049 <li class="md-nav__item">
1050 <a href="../object-type/" class="md-nav__link">
1051 objectType
1052 </a>
1053 </li>
1054
1055
1056
1057
1058
1059
1060
1061 <li class="md-nav__item">
1062 <a href="../object-type-definition/" class="md-nav__link">
1063 objectTypeDefinition
1064 </a>
1065 </li>
1066
1067
1068
1069
1070
1071
1072
1073 <li class="md-nav__item">
1074 <a href="../option/" class="md-nav__link">
1075 option
1076 </a>
1077 </li>
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087 <li class="md-nav__item md-nav__item--active">
1088
1089 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1090
1091
1092
1093
1094 <label class="md-nav__link md-nav__link--active" for="__toc">
1095 page
1096 <span class="md-nav__icon md-icon"></span>
1097 </label>
1098
1099 <a href="./" class="md-nav__link md-nav__link--active">
1100 page
1101 </a>
1102
1103
1104<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1105
1106
1107
1108
1109
1110 <label class="md-nav__title" for="__toc">
1111 <span class="md-nav__icon md-icon"></span>
1112 Table of contents
1113 </label>
1114 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1115
1116 <li class="md-nav__item">
1117 <a href="#components" class="md-nav__link">
1118 Components
1119 </a>
1120
1121 <nav class="md-nav" aria-label="Components">
1122 <ul class="md-nav__list">
1123
1124 <li class="md-nav__item">
1125 <a href="#pagetype" class="md-nav__link">
1126 &lt;pageType&gt;
1127 </a>
1128
1129 <nav class="md-nav" aria-label="&lt;pageType&gt;">
1130 <ul class="md-nav__list">
1131
1132 <li class="md-nav__item">
1133 <a href="#system" class="md-nav__link">
1134 system
1135 </a>
1136
1137</li>
1138
1139 <li class="md-nav__item">
1140 <a href="#html-text-or-tpl" class="md-nav__link">
1141 html, text or tpl
1142 </a>
1143
1144</li>
1145
1146 </ul>
1147 </nav>
1148
1149</li>
1150
1151 <li class="md-nav__item">
1152 <a href="#controller" class="md-nav__link">
1153 &lt;controller&gt;
1154 </a>
1155
1156</li>
1157
1158 <li class="md-nav__item">
1159 <a href="#handler" class="md-nav__link">
1160 &lt;handler&gt;
1161 </a>
1162
1163</li>
1164
1165 <li class="md-nav__item">
1166 <a href="#name" class="md-nav__link">
1167 &lt;name&gt;
1168 </a>
1169
1170</li>
1171
1172 <li class="md-nav__item">
1173 <a href="#parent" class="md-nav__link">
1174 &lt;parent&gt;
1175 </a>
1176
1177</li>
1178
1179 <li class="md-nav__item">
1180 <a href="#hasfixedparent" class="md-nav__link">
1181 &lt;hasFixedParent&gt;
1182 </a>
1183
1184</li>
1185
1186 <li class="md-nav__item">
1187 <a href="#permissions" class="md-nav__link">
1188 &lt;permissions&gt;
1189 </a>
1190
1191</li>
1192
1193 <li class="md-nav__item">
1194 <a href="#options" class="md-nav__link">
1195 &lt;options&gt;
1196 </a>
1197
1198</li>
1199
1200 <li class="md-nav__item">
1201 <a href="#excludefromlandingpage" class="md-nav__link">
1202 &lt;excludeFromLandingPage&gt;
1203 </a>
1204
1205</li>
1206
1207 <li class="md-nav__item">
1208 <a href="#content" class="md-nav__link">
1209 &lt;content&gt;
1210 </a>
1211
1212 <nav class="md-nav" aria-label="&lt;content&gt;">
1213 <ul class="md-nav__list">
1214
1215 <li class="md-nav__item">
1216 <a href="#title" class="md-nav__link">
1217 &lt;title&gt;
1218 </a>
1219
1220</li>
1221
1222 <li class="md-nav__item">
1223 <a href="#content_1" class="md-nav__link">
1224 &lt;content&gt;
1225 </a>
1226
1227</li>
1228
1229 </ul>
1230 </nav>
1231
1232</li>
1233
1234 </ul>
1235 </nav>
1236
1237</li>
1238
1239 <li class="md-nav__item">
1240 <a href="#example" class="md-nav__link">
1241 Example
1242 </a>
1243
1244</li>
1245
1246 </ul>
1247
1248</nav>
1249
1250 </li>
1251
1252
1253
1254
1255
1256
1257
1258 <li class="md-nav__item">
1259 <a href="../pip/" class="md-nav__link">
1260 pip
1261 </a>
1262 </li>
1263
1264
1265
1266
1267
1268
1269
1270 <li class="md-nav__item">
1271 <a href="../script/" class="md-nav__link">
1272 script
1273 </a>
1274 </li>
1275
1276
1277
1278
1279
1280
1281
1282 <li class="md-nav__item">
1283 <a href="../smiley/" class="md-nav__link">
1284 smiley
1285 </a>
1286 </li>
1287
1288
1289
1290
1291
1292
1293
1294 <li class="md-nav__item">
1295 <a href="../sql/" class="md-nav__link">
1296 sql
1297 </a>
1298 </li>
1299
1300
1301
1302
1303
1304
1305
1306 <li class="md-nav__item">
1307 <a href="../style/" class="md-nav__link">
1308 style
1309 </a>
1310 </li>
1311
1312
1313
1314
1315
1316
1317
1318 <li class="md-nav__item">
1319 <a href="../template/" class="md-nav__link">
1320 template
1321 </a>
1322 </li>
1323
1324
1325
1326
1327
1328
1329
1330 <li class="md-nav__item">
1331 <a href="../template-listener/" class="md-nav__link">
1332 templateListener
1333 </a>
1334 </li>
1335
1336
1337
1338
1339
1340
1341
1342 <li class="md-nav__item">
1343 <a href="../user-group-option/" class="md-nav__link">
1344 userGroupOption
1345 </a>
1346 </li>
1347
1348
1349
1350
1351
1352
1353
1354 <li class="md-nav__item">
1355 <a href="../user-menu/" class="md-nav__link">
1356 userMenu
1357 </a>
1358 </li>
1359
1360
1361
1362
1363
1364
1365
1366 <li class="md-nav__item">
1367 <a href="../user-notification-event/" class="md-nav__link">
1368 userNotificationEvent
1369 </a>
1370 </li>
1371
1372
1373
1374
1375
1376
1377
1378 <li class="md-nav__item">
1379 <a href="../user-option/" class="md-nav__link">
1380 userOption
1381 </a>
1382 </li>
1383
1384
1385
1386
1387
1388
1389
1390 <li class="md-nav__item">
1391 <a href="../user-profile-menu/" class="md-nav__link">
1392 userProfileMenu
1393 </a>
1394 </li>
1395
1396
1397
1398 </ul>
1399 </nav>
1400 </li>
1401
1402
1403
1404
1405
1406
1407
1408 <li class="md-nav__item">
1409 <a href="../../database-php-api/" class="md-nav__link">
1410 Database PHP API
1411 </a>
1412 </li>
1413
1414
1415
1416 </ul>
1417 </nav>
1418 </li>
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430 <li class="md-nav__item md-nav__item--nested">
1431
1432
1433 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1434
1435 <label class="md-nav__link" for="__nav_6">
1436 Migration
1437 <span class="md-nav__icon md-icon"></span>
1438 </label>
1439 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1440 <label class="md-nav__title" for="__nav_6">
1441 <span class="md-nav__icon md-icon"></span>
1442 Migration
1443 </label>
1444 <ul class="md-nav__list" data-md-scrollfix>
1445
1446
1447
1448
1449
1450
1451 <li class="md-nav__item md-nav__item--nested">
1452
1453
1454 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1455
1456 <label class="md-nav__link" for="__nav_6_1">
1457 Migrating from WSC 5.3
1458 <span class="md-nav__icon md-icon"></span>
1459 </label>
1460 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1461 <label class="md-nav__title" for="__nav_6_1">
1462 <span class="md-nav__icon md-icon"></span>
1463 Migrating from WSC 5.3
1464 </label>
1465 <ul class="md-nav__list" data-md-scrollfix>
1466
1467
1468
1469
1470
1471 <li class="md-nav__item">
1472 <a href="../../../migration/wsc53/php/" class="md-nav__link">
1473 PHP API
1474 </a>
1475 </li>
1476
1477
1478
1479
1480
1481
1482
1483 <li class="md-nav__item">
1484 <a href="../../../migration/wsc53/session/" class="md-nav__link">
1485 Session Handling and Authentication
1486 </a>
1487 </li>
1488
1489
1490
1491
1492
1493
1494
1495 <li class="md-nav__item">
1496 <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1497 JavaScript
1498 </a>
1499 </li>
1500
1501
1502
1503
1504
1505
1506
1507 <li class="md-nav__item">
1508 <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1509 Templates
1510 </a>
1511 </li>
1512
1513
1514
1515
1516
1517
1518
1519 <li class="md-nav__item">
1520 <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1521 Third Party Libraries
1522 </a>
1523 </li>
1524
1525
1526
1527 </ul>
1528 </nav>
1529 </li>
1530
1531
1532
1533
1534
1535
1536
1537
1538 <li class="md-nav__item md-nav__item--nested">
1539
1540
1541 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1542
1543 <label class="md-nav__link" for="__nav_6_2">
1544 Migrating from WSC 5.2
1545 <span class="md-nav__icon md-icon"></span>
1546 </label>
1547 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1548 <label class="md-nav__title" for="__nav_6_2">
1549 <span class="md-nav__icon md-icon"></span>
1550 Migrating from WSC 5.2
1551 </label>
1552 <ul class="md-nav__list" data-md-scrollfix>
1553
1554
1555
1556
1557
1558 <li class="md-nav__item">
1559 <a href="../../../migration/wsc52/php/" class="md-nav__link">
1560 PHP API
1561 </a>
1562 </li>
1563
1564
1565
1566
1567
1568
1569
1570 <li class="md-nav__item">
1571 <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1572 Templates and Languages
1573 </a>
1574 </li>
1575
1576
1577
1578
1579
1580
1581
1582 <li class="md-nav__item">
1583 <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1584 Third Party Libraries
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_3" type="checkbox" id="__nav_6_3" >
1605
1606 <label class="md-nav__link" for="__nav_6_3">
1607 Migrating from WSC 3.1
1608 <span class="md-nav__icon md-icon"></span>
1609 </label>
1610 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1611 <label class="md-nav__title" for="__nav_6_3">
1612 <span class="md-nav__icon md-icon"></span>
1613 Migrating from WSC 3.1
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/wsc31/php/" class="md-nav__link">
1623 PHP API
1624 </a>
1625 </li>
1626
1627
1628
1629 </ul>
1630 </nav>
1631 </li>
1632
1633
1634
1635
1636
1637
1638
1639
1640 <li class="md-nav__item md-nav__item--nested">
1641
1642
1643 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1644
1645 <label class="md-nav__link" for="__nav_6_4">
1646 Migrating from WSC 3.0
1647 <span class="md-nav__icon md-icon"></span>
1648 </label>
1649 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1650 <label class="md-nav__title" for="__nav_6_4">
1651 <span class="md-nav__icon md-icon"></span>
1652 Migrating from WSC 3.0
1653 </label>
1654 <ul class="md-nav__list" data-md-scrollfix>
1655
1656
1657
1658
1659
1660 <li class="md-nav__item">
1661 <a href="../../../migration/wsc30/php/" class="md-nav__link">
1662 PHP API
1663 </a>
1664 </li>
1665
1666
1667
1668
1669
1670
1671
1672 <li class="md-nav__item">
1673 <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1674 JavaScript API
1675 </a>
1676 </li>
1677
1678
1679
1680
1681
1682
1683
1684 <li class="md-nav__item">
1685 <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1686 Templates
1687 </a>
1688 </li>
1689
1690
1691
1692
1693
1694
1695
1696 <li class="md-nav__item">
1697 <a href="../../../migration/wsc30/css/" class="md-nav__link">
1698 CSS
1699 </a>
1700 </li>
1701
1702
1703
1704
1705
1706
1707
1708 <li class="md-nav__item">
1709 <a href="../../../migration/wsc30/package/" class="md-nav__link">
1710 Package Components
1711 </a>
1712 </li>
1713
1714
1715
1716 </ul>
1717 </nav>
1718 </li>
1719
1720
1721
1722
1723
1724
1725
1726
1727 <li class="md-nav__item md-nav__item--nested">
1728
1729
1730 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1731
1732 <label class="md-nav__link" for="__nav_6_5">
1733 Migrating from WCF 2.1
1734 <span class="md-nav__icon md-icon"></span>
1735 </label>
1736 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1737 <label class="md-nav__title" for="__nav_6_5">
1738 <span class="md-nav__icon md-icon"></span>
1739 Migrating from WCF 2.1
1740 </label>
1741 <ul class="md-nav__list" data-md-scrollfix>
1742
1743
1744
1745
1746
1747 <li class="md-nav__item">
1748 <a href="../../../migration/wcf21/php/" class="md-nav__link">
1749 PHP API
1750 </a>
1751 </li>
1752
1753
1754
1755
1756
1757
1758
1759 <li class="md-nav__item">
1760 <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1761 Templates
1762 </a>
1763 </li>
1764
1765
1766
1767
1768
1769
1770
1771 <li class="md-nav__item">
1772 <a href="../../../migration/wcf21/css/" class="md-nav__link">
1773 CSS
1774 </a>
1775 </li>
1776
1777
1778
1779
1780
1781
1782
1783 <li class="md-nav__item">
1784 <a href="../../../migration/wcf21/package/" class="md-nav__link">
1785 Package Components
1786 </a>
1787 </li>
1788
1789
1790
1791 </ul>
1792 </nav>
1793 </li>
1794
1795
1796
1797 </ul>
1798 </nav>
1799 </li>
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811 <li class="md-nav__item md-nav__item--nested">
1812
1813
1814 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1815
1816 <label class="md-nav__link" for="__nav_7">
1817 Tutorials
1818 <span class="md-nav__icon md-icon"></span>
1819 </label>
1820 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1821 <label class="md-nav__title" for="__nav_7">
1822 <span class="md-nav__icon md-icon"></span>
1823 Tutorials
1824 </label>
1825 <ul class="md-nav__list" data-md-scrollfix>
1826
1827
1828
1829
1830
1831
1832 <li class="md-nav__item md-nav__item--nested">
1833
1834
1835 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1836
1837 <label class="md-nav__link" for="__nav_7_1">
1838 Tutorial Series
1839 <span class="md-nav__icon md-icon"></span>
1840 </label>
1841 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1842 <label class="md-nav__title" for="__nav_7_1">
1843 <span class="md-nav__icon md-icon"></span>
1844 Tutorial Series
1845 </label>
1846 <ul class="md-nav__list" data-md-scrollfix>
1847
1848
1849
1850
1851
1852 <li class="md-nav__item">
1853 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1854 Overview
1855 </a>
1856 </li>
1857
1858
1859
1860
1861
1862
1863
1864 <li class="md-nav__item">
1865 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1866 Part 1
1867 </a>
1868 </li>
1869
1870
1871
1872
1873
1874
1875
1876 <li class="md-nav__item">
1877 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1878 Part 2
1879 </a>
1880 </li>
1881
1882
1883
1884
1885
1886
1887
1888 <li class="md-nav__item">
1889 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1890 Part 3
1891 </a>
1892 </li>
1893
1894
1895
1896 </ul>
1897 </nav>
1898 </li>
1899
1900
1901
1902 </ul>
1903 </nav>
1904 </li>
1905
1906
1907
1908 </ul>
1909</nav>
1910 </div>
1911 </div>
1912 </div>
1913
1914
1915
1916 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1917 <div class="md-sidebar__scrollwrap">
1918 <div class="md-sidebar__inner">
1919
1920<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1921
1922
1923
1924
1925
1926 <label class="md-nav__title" for="__toc">
1927 <span class="md-nav__icon md-icon"></span>
1928 Table of contents
1929 </label>
1930 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1931
1932 <li class="md-nav__item">
1933 <a href="#components" class="md-nav__link">
1934 Components
1935 </a>
1936
1937 <nav class="md-nav" aria-label="Components">
1938 <ul class="md-nav__list">
1939
1940 <li class="md-nav__item">
1941 <a href="#pagetype" class="md-nav__link">
1942 &lt;pageType&gt;
1943 </a>
1944
1945 <nav class="md-nav" aria-label="&lt;pageType&gt;">
1946 <ul class="md-nav__list">
1947
1948 <li class="md-nav__item">
1949 <a href="#system" class="md-nav__link">
1950 system
1951 </a>
1952
1953</li>
1954
1955 <li class="md-nav__item">
1956 <a href="#html-text-or-tpl" class="md-nav__link">
1957 html, text or tpl
1958 </a>
1959
1960</li>
1961
1962 </ul>
1963 </nav>
1964
1965</li>
1966
1967 <li class="md-nav__item">
1968 <a href="#controller" class="md-nav__link">
1969 &lt;controller&gt;
1970 </a>
1971
1972</li>
1973
1974 <li class="md-nav__item">
1975 <a href="#handler" class="md-nav__link">
1976 &lt;handler&gt;
1977 </a>
1978
1979</li>
1980
1981 <li class="md-nav__item">
1982 <a href="#name" class="md-nav__link">
1983 &lt;name&gt;
1984 </a>
1985
1986</li>
1987
1988 <li class="md-nav__item">
1989 <a href="#parent" class="md-nav__link">
1990 &lt;parent&gt;
1991 </a>
1992
1993</li>
1994
1995 <li class="md-nav__item">
1996 <a href="#hasfixedparent" class="md-nav__link">
1997 &lt;hasFixedParent&gt;
1998 </a>
1999
2000</li>
2001
2002 <li class="md-nav__item">
2003 <a href="#permissions" class="md-nav__link">
2004 &lt;permissions&gt;
2005 </a>
2006
2007</li>
2008
2009 <li class="md-nav__item">
2010 <a href="#options" class="md-nav__link">
2011 &lt;options&gt;
2012 </a>
2013
2014</li>
2015
2016 <li class="md-nav__item">
2017 <a href="#excludefromlandingpage" class="md-nav__link">
2018 &lt;excludeFromLandingPage&gt;
2019 </a>
2020
2021</li>
2022
2023 <li class="md-nav__item">
2024 <a href="#content" class="md-nav__link">
2025 &lt;content&gt;
2026 </a>
2027
2028 <nav class="md-nav" aria-label="&lt;content&gt;">
2029 <ul class="md-nav__list">
2030
2031 <li class="md-nav__item">
2032 <a href="#title" class="md-nav__link">
2033 &lt;title&gt;
2034 </a>
2035
2036</li>
2037
2038 <li class="md-nav__item">
2039 <a href="#content_1" class="md-nav__link">
2040 &lt;content&gt;
2041 </a>
2042
2043</li>
2044
2045 </ul>
2046 </nav>
2047
2048</li>
2049
2050 </ul>
2051 </nav>
2052
2053</li>
2054
2055 <li class="md-nav__item">
2056 <a href="#example" class="md-nav__link">
2057 Example
2058 </a>
2059
2060</li>
2061
2062 </ul>
2063
2064</nav>
2065 </div>
2066 </div>
2067 </div>
2068
2069
2070 <div class="md-content" data-md-component="content">
2071 <article class="md-content__inner md-typeset">
2072
2073
2074
2075 <h1 id="page-package-installation-plugin">Page Package Installation Plugin<a class="headerlink" href="#page-package-installation-plugin" title="Permanent link">#</a></h1>
2076<p>Registers page controllers, making them available for selection and configuration, including but not limited to boxes and menus.</p>
2077<h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
2078<p>Each item is described as a <code>&lt;page&gt;</code> element with the mandatory attribute <code>identifier</code> that should follow the naming pattern <code>&lt;packageIdentifier&gt;.&lt;PageName&gt;</code>, e.g. <code>com.woltlab.wcf.MembersList</code>.</p>
2079<h3 id="pagetype"><code>&lt;pageType&gt;</code><a class="headerlink" href="#pagetype" title="Permanent link">#</a></h3>
2080<h4 id="system"><code>system</code><a class="headerlink" href="#system" title="Permanent link">#</a></h4>
2081<p>The special <code>system</code> type is reserved for pages that pull their properties and content from a registered PHP class. Requires the <code>&lt;controller&gt;</code> element.</p>
2082<h4 id="html-text-or-tpl"><code>html</code>, <code>text</code> or <code>tpl</code><a class="headerlink" href="#html-text-or-tpl" title="Permanent link">#</a></h4>
2083<p>Provide arbitrary content, requires the <code>&lt;content&gt;</code> element.</p>
2084<h3 id="controller"><code>&lt;controller&gt;</code><a class="headerlink" href="#controller" title="Permanent link">#</a></h3>
2085<p>Fully qualified class name for the controller, must implement <code>wcf\page\IPage</code> or <code>wcf\form\IForm</code>.</p>
2086<h3 id="handler"><code>&lt;handler&gt;</code><a class="headerlink" href="#handler" title="Permanent link">#</a></h3>
2087<p>Fully qualified class name that can be optionally set to provide additional methods, such as displaying a badge for unread content and verifying permissions per page object id.</p>
2088<h3 id="name"><code>&lt;name&gt;</code><a class="headerlink" href="#name" title="Permanent link">#</a></h3>
2089<div class="admonition info">
2090<p class="admonition-title">The <code>language</code> attribute is required and should specify the <a href="https://en.wikipedia.org/wiki/ISO_639-1">ISO-639-1</a> language code.</p>
2091</div>
2092<p>The internal name displayed in the admin panel only, can be fully customized by the administrator and is immutable. Only one value is accepted and will be picked based on the site's default language, but you can provide localized values by including multiple <code>&lt;name&gt;</code> elements.</p>
2093<h3 id="parent"><code>&lt;parent&gt;</code><a class="headerlink" href="#parent" title="Permanent link">#</a></h3>
2094<p>Sets the default parent page using its internal identifier, this setting controls the breadcrumbs and active menu item hierarchy.</p>
2095<h3 id="hasfixedparent"><code>&lt;hasFixedParent&gt;</code><a class="headerlink" href="#hasfixedparent" title="Permanent link">#</a></h3>
2096<p>Pages can be assigned any other page as parent page by default, set to <code>1</code> to make the parent setting immutable.</p>
2097<h3 id="permissions"><code>&lt;permissions&gt;</code><a class="headerlink" href="#permissions" title="Permanent link">#</a></h3>
2098<div class="admonition warning">
2099<p class="admonition-title">The comma represents a logical <code>or</code>, the check is successful if at least one permission is set.</p>
2100</div>
2101<p>Comma separated list of permission names that will be checked one after another until at least one permission is set.</p>
2102<h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2103<div class="admonition warning">
2104<p class="admonition-title">The comma represents a logical <code>or</code>, the check is successful if at least one option is enabled.</p>
2105</div>
2106<p>Comma separated list of options that will be checked one after another until at least one option is set.</p>
2107<h3 id="excludefromlandingpage"><code>&lt;excludeFromLandingPage&gt;</code><a class="headerlink" href="#excludefromlandingpage" title="Permanent link">#</a></h3>
2108<p>Some pages should not be used as landing page, because they may not always be
2109available and/or accessible to the user. For example, the account management
2110page is available to logged-in users only and any guest attempting to visit that
2111page would be presented with a permission denied message.</p>
2112<p>Set this to <code>1</code> to prevent this page from becoming a landing page ever.</p>
2113<h3 id="content"><code>&lt;content&gt;</code><a class="headerlink" href="#content" title="Permanent link">#</a></h3>
2114<div class="admonition info">
2115<p class="admonition-title">The <code>language</code> attribute is required and should specify the <a href="https://en.wikipedia.org/wiki/ISO_639-1">ISO-639-1</a> language code.</p>
2116</div>
2117<h4 id="title"><code>&lt;title&gt;</code><a class="headerlink" href="#title" title="Permanent link">#</a></h4>
2118<p>The title element is required and controls the page title shown to the end users.</p>
2119<h4 id="content_1"><code>&lt;content&gt;</code><a class="headerlink" href="#content_1" title="Permanent link">#</a></h4>
2120<p>The content that should be used to populate the page, only used and required if the <code>pageType</code> equals <code>text</code>, <code>html</code> and <code>tpl</code>.</p>
2121<h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2122<div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2123<span class="nt">&lt;data</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span> <span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span> <span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/page.xsd&quot;</span><span class="nt">&gt;</span>
2124 <span class="nt">&lt;import&gt;</span>
2125 <span class="nt">&lt;page</span> <span class="na">identifier=</span><span class="s">&quot;com.woltlab.wcf.MembersList&quot;</span><span class="nt">&gt;</span>
2126 <span class="nt">&lt;pageType&gt;</span>system<span class="nt">&lt;/pageType&gt;</span>
2127 <span class="nt">&lt;controller&gt;</span>wcf\page\MembersListPage<span class="nt">&lt;/controller&gt;</span>
2128 <span class="nt">&lt;name</span> <span class="na">language=</span><span class="s">&quot;de&quot;</span><span class="nt">&gt;</span>Mitglieder<span class="nt">&lt;/name&gt;</span>
2129 <span class="nt">&lt;name</span> <span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>Members<span class="nt">&lt;/name&gt;</span>
2130 <span class="nt">&lt;permissions&gt;</span>user.profile.canViewMembersList<span class="nt">&lt;/permissions&gt;</span>
2131 <span class="nt">&lt;options&gt;</span>module_members_list<span class="nt">&lt;/options&gt;</span>
2132
2133 <span class="nt">&lt;content</span> <span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>
2134 <span class="nt">&lt;title&gt;</span>Members<span class="nt">&lt;/title&gt;</span>
2135 <span class="nt">&lt;/content&gt;</span>
2136 <span class="nt">&lt;content</span> <span class="na">language=</span><span class="s">&quot;de&quot;</span><span class="nt">&gt;</span>
2137 <span class="nt">&lt;title&gt;</span>Mitglieder<span class="nt">&lt;/title&gt;</span>
2138 <span class="nt">&lt;/content&gt;</span>
2139 <span class="nt">&lt;/page&gt;</span>
2140 <span class="nt">&lt;/import&gt;</span>
2141
2142 <span class="nt">&lt;delete&gt;</span>
2143 <span class="nt">&lt;page</span> <span class="na">identifier=</span><span class="s">&quot;com.woltlab.wcf.MembersList&quot;</span> <span class="nt">/&gt;</span>
2144 <span class="nt">&lt;/delete&gt;</span>
2145<span class="nt">&lt;/data&gt;</span>
2146</code></pre></div>
2147
2148
2149
2150
2151
2152
2153
2154 </article>
2155 </div>
2156 </div>
2157 </main>
2158
2159
2160<footer class="md-footer">
2161
2162 <nav class="md-footer__inner md-grid" aria-label="Footer">
2163
2164 <a href="../option/" class="md-footer__link md-footer__link--prev" rel="prev">
2165 <div class="md-footer__button md-icon">
2166 <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>
2167 </div>
2168 <div class="md-footer__title">
2169 <div class="md-ellipsis">
2170 <span class="md-footer__direction">
2171 Previous
2172 </span>
2173 option
2174 </div>
2175 </div>
2176 </a>
2177
2178
2179 <a href="../pip/" class="md-footer__link md-footer__link--next" rel="next">
2180 <div class="md-footer__title">
2181 <div class="md-ellipsis">
2182 <span class="md-footer__direction">
2183 Next
2184 </span>
2185 pip
2186 </div>
2187 </div>
2188 <div class="md-footer__button md-icon">
2189 <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>
2190 </div>
2191 </a>
2192
2193 </nav>
2194
2195 <div class="md-footer-meta md-typeset">
2196 <div class="md-footer-meta__inner md-grid">
2197 <div class="md-footer-copyright">
2198
2199 <div class="md-footer-copyright__highlight">
2200 Copyright © 2020 WoltLab GmbH
2201 </div>
2202
2203 Made with
2204 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2205 Material for MkDocs
2206 </a>
fb88dc6e 2207
0c5338dd
TD		 2208 </div>
2209 <div class="md-footer-copyright">
2210 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2211 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2212</div>
2213 </div>
2214 </div>
2215</footer>
2216
2217 </div>
2218 <div class="md-dialog" data-md-component="dialog">
2219 <div class="md-dialog__inner md-typeset"></div>
2220 </div>
2221 <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>
2222
2223
fb88dc6e 2224 <script src="../../../assets/javascripts/bundle.5cf3e710.min.js"></script>
0c5338dd
TD		 2225
2226
2227 </body>
2228</html>