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