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