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 / box / 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/box/">
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>box - 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="#box-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 box
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
1030
1031 <li class="md-nav__item md-nav__item--active">
1032
1033 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1034
a4835aa6 1035
45ca63d0
TD
1036
1037
1038
1039 <label class="md-nav__link md-nav__link--active" for="__toc">
1040 box
1041 <span class="md-nav__icon md-icon"></span>
1042 </label>
1043
1044 <a href="./" class="md-nav__link md-nav__link--active">
1045 box
1046 </a>
1047
1048
1049<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1050
1051
a4835aa6 1052
45ca63d0
TD
1053
1054
1055
1056 <label class="md-nav__title" for="__toc">
1057 <span class="md-nav__icon md-icon"></span>
1058 Table of contents
1059 </label>
1060 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1061
1062 <li class="md-nav__item">
1063 <a href="#components" class="md-nav__link">
1064 Components
1065 </a>
1066
1067 <nav class="md-nav" aria-label="Components">
1068 <ul class="md-nav__list">
1069
1070 <li class="md-nav__item">
1071 <a href="#name" class="md-nav__link">
1072 &lt;name&gt;
1073 </a>
1074
1075</li>
1076
1077 <li class="md-nav__item">
1078 <a href="#boxtype" class="md-nav__link">
1079 &lt;boxType&gt;
1080 </a>
1081
1082 <nav class="md-nav" aria-label="&lt;boxType&gt;">
1083 <ul class="md-nav__list">
1084
1085 <li class="md-nav__item">
1086 <a href="#system" class="md-nav__link">
1087 system
1088 </a>
1089
1090</li>
1091
1092 <li class="md-nav__item">
1093 <a href="#html-text-or-tpl" class="md-nav__link">
1094 html, text or tpl
1095 </a>
1096
1097</li>
1098
1099 </ul>
1100 </nav>
1101
1102</li>
1103
1104 <li class="md-nav__item">
1105 <a href="#objecttype" class="md-nav__link">
1106 &lt;objectType&gt;
1107 </a>
1108
1109</li>
1110
1111 <li class="md-nav__item">
1112 <a href="#position" class="md-nav__link">
1113 &lt;position&gt;
1114 </a>
1115
1116 <nav class="md-nav" aria-label="&lt;position&gt;">
1117 <ul class="md-nav__list">
1118
1119 <li class="md-nav__item">
1120 <a href="#placeholder-positions" class="md-nav__link">
1121 Placeholder Positions
1122 </a>
1123
1124</li>
1125
1126 </ul>
1127 </nav>
1128
1129</li>
1130
1131 <li class="md-nav__item">
1132 <a href="#showheader" class="md-nav__link">
1133 &lt;showHeader&gt;
1134 </a>
1135
1136</li>
1137
1138 <li class="md-nav__item">
1139 <a href="#visibleeverywhere" class="md-nav__link">
1140 &lt;visibleEverywhere&gt;
1141 </a>
1142
1143</li>
1144
1145 <li class="md-nav__item">
1146 <a href="#visibilityexceptions" class="md-nav__link">
1147 &lt;visibilityExceptions&gt;
1148 </a>
1149
1150</li>
1151
1152 <li class="md-nav__item">
1153 <a href="#cssclassname" class="md-nav__link">
1154 &lt;cssClassName&gt;
1155 </a>
1156
1157</li>
1158
1159 <li class="md-nav__item">
1160 <a href="#content" class="md-nav__link">
1161 &lt;content&gt;
1162 </a>
1163
1164 <nav class="md-nav" aria-label="&lt;content&gt;">
1165 <ul class="md-nav__list">
1166
1167 <li class="md-nav__item">
1168 <a href="#title" class="md-nav__link">
1169 &lt;title&gt;
1170 </a>
1171
1172</li>
1173
1174 <li class="md-nav__item">
1175 <a href="#content_1" class="md-nav__link">
1176 &lt;content&gt;
1177 </a>
1178
1179</li>
1180
1181 </ul>
1182 </nav>
1183
1184</li>
1185
1186 </ul>
1187 </nav>
1188
1189</li>
1190
1191 <li class="md-nav__item">
1192 <a href="#example" class="md-nav__link">
1193 Example
1194 </a>
1195
1196</li>
1197
1198 </ul>
1199
1200</nav>
1201
1202 </li>
1203
1204
1205
1206
1207
1208
1209
1210 <li class="md-nav__item">
1211 <a href="../clipboard-action/" class="md-nav__link">
1212 clipboardAction
1213 </a>
1214 </li>
1215
1216
1217
1218
1219
1220
1221
1222 <li class="md-nav__item">
1223 <a href="../core-object/" class="md-nav__link">
1224 coreObject
1225 </a>
1226 </li>
1227
1228
1229
1230
1231
1232
1233
1234 <li class="md-nav__item">
1235 <a href="../cronjob/" class="md-nav__link">
1236 cronjob
1237 </a>
1238 </li>
1239
1240
1241
1242
1243
1244
1245
6923e968
WG
1246 <li class="md-nav__item">
1247 <a href="../database/" class="md-nav__link">
1248 database
1249 </a>
1250 </li>
1251
1252
1253
1254
1255
1256
1257
45ca63d0
TD
1258 <li class="md-nav__item">
1259 <a href="../event-listener/" class="md-nav__link">
1260 eventListener
1261 </a>
1262 </li>
1263
1264
1265
1266
1267
1268
1269
1270 <li class="md-nav__item">
1271 <a href="../file/" class="md-nav__link">
1272 file
1273 </a>
1274 </li>
1275
1276
1277
1278
1279
1280
1281
1282 <li class="md-nav__item">
1283 <a href="../language/" class="md-nav__link">
1284 language
1285 </a>
1286 </li>
1287
1288
1289
1290
1291
1292
1293
1294 <li class="md-nav__item">
1295 <a href="../media-provider/" class="md-nav__link">
1296 mediaProvider
1297 </a>
1298 </li>
1299
1300
1301
1302
1303
1304
1305
1306 <li class="md-nav__item">
1307 <a href="../menu/" class="md-nav__link">
1308 menu
1309 </a>
1310 </li>
1311
1312
1313
1314
1315
1316
1317
1318 <li class="md-nav__item">
1319 <a href="../menu-item/" class="md-nav__link">
1320 menuItem
1321 </a>
1322 </li>
1323
1324
1325
1326
1327
1328
1329
1330 <li class="md-nav__item">
1331 <a href="../object-type/" class="md-nav__link">
1332 objectType
1333 </a>
1334 </li>
1335
1336
1337
1338
1339
1340
1341
1342 <li class="md-nav__item">
1343 <a href="../object-type-definition/" class="md-nav__link">
1344 objectTypeDefinition
1345 </a>
1346 </li>
1347
1348
1349
1350
1351
1352
1353
1354 <li class="md-nav__item">
1355 <a href="../option/" class="md-nav__link">
1356 option
1357 </a>
1358 </li>
1359
1360
1361
1362
1363
1364
1365
1366 <li class="md-nav__item">
1367 <a href="../page/" class="md-nav__link">
1368 page
1369 </a>
1370 </li>
1371
1372
1373
1374
1375
1376
1377
1378 <li class="md-nav__item">
1379 <a href="../pip/" class="md-nav__link">
1380 pip
1381 </a>
1382 </li>
1383
1384
1385
1386
1387
1388
1389
1390 <li class="md-nav__item">
1391 <a href="../script/" class="md-nav__link">
1392 script
1393 </a>
1394 </li>
1395
1396
1397
1398
1399
1400
1401
1402 <li class="md-nav__item">
1403 <a href="../smiley/" class="md-nav__link">
1404 smiley
1405 </a>
1406 </li>
1407
1408
1409
1410
1411
1412
1413
1414 <li class="md-nav__item">
1415 <a href="../sql/" class="md-nav__link">
1416 sql
1417 </a>
1418 </li>
1419
1420
1421
1422
1423
1424
1425
1426 <li class="md-nav__item">
1427 <a href="../style/" class="md-nav__link">
1428 style
1429 </a>
1430 </li>
1431
1432
1433
1434
1435
1436
1437
1438 <li class="md-nav__item">
1439 <a href="../template/" class="md-nav__link">
1440 template
1441 </a>
1442 </li>
1443
1444
1445
1446
1447
1448
1449
1450 <li class="md-nav__item">
1451 <a href="../template-listener/" class="md-nav__link">
1452 templateListener
1453 </a>
1454 </li>
1455
1456
1457
1458
1459
1460
1461
1462 <li class="md-nav__item">
1463 <a href="../user-group-option/" class="md-nav__link">
1464 userGroupOption
1465 </a>
1466 </li>
1467
1468
1469
1470
1471
1472
1473
1474 <li class="md-nav__item">
1475 <a href="../user-menu/" class="md-nav__link">
1476 userMenu
1477 </a>
1478 </li>
1479
1480
1481
1482
1483
1484
1485
1486 <li class="md-nav__item">
1487 <a href="../user-notification-event/" class="md-nav__link">
1488 userNotificationEvent
1489 </a>
1490 </li>
1491
1492
1493
1494
1495
1496
1497
1498 <li class="md-nav__item">
1499 <a href="../user-option/" class="md-nav__link">
1500 userOption
1501 </a>
1502 </li>
1503
1504
1505
1506
1507
1508
1509
1510 <li class="md-nav__item">
1511 <a href="../user-profile-menu/" class="md-nav__link">
1512 userProfileMenu
1513 </a>
1514 </li>
1515
1516
1517
1518 </ul>
1519 </nav>
1520 </li>
1521
1522
1523
1524
1525
1526
1527
1528 <li class="md-nav__item">
1529 <a href="../../database-php-api/" class="md-nav__link">
1530 Database PHP API
1531 </a>
1532 </li>
1533
1534
1535
1536 </ul>
1537 </nav>
1538 </li>
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550 <li class="md-nav__item md-nav__item--nested">
1551
1552
1553 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1554
1555 <label class="md-nav__link" for="__nav_6">
1556 Migration
1557 <span class="md-nav__icon md-icon"></span>
1558 </label>
1559 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1560 <label class="md-nav__title" for="__nav_6">
1561 <span class="md-nav__icon md-icon"></span>
1562 Migration
1563 </label>
1564 <ul class="md-nav__list" data-md-scrollfix>
1565
1566
1567
1568
1569
1570
1571 <li class="md-nav__item md-nav__item--nested">
1572
1573
1574 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1575
1576 <label class="md-nav__link" for="__nav_6_1">
1577 Migrating from WSC 5.3
1578 <span class="md-nav__icon md-icon"></span>
1579 </label>
1580 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1581 <label class="md-nav__title" for="__nav_6_1">
1582 <span class="md-nav__icon md-icon"></span>
1583 Migrating from WSC 5.3
1584 </label>
1585 <ul class="md-nav__list" data-md-scrollfix>
1586
1587
1588
1589
1590
1591 <li class="md-nav__item">
1592 <a href="../../../migration/wsc53/php/" class="md-nav__link">
1593 PHP API
1594 </a>
1595 </li>
1596
1597
1598
1599
1600
1601
1602
1603 <li class="md-nav__item">
1604 <a href="../../../migration/wsc53/session/" class="md-nav__link">
1605 Session Handling and Authentication
1606 </a>
1607 </li>
1608
1609
1610
1611
1612
1613
1614
1615 <li class="md-nav__item">
1616 <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
77efcd46 1617 TypeScript and JavaScript
45ca63d0
TD
1618 </a>
1619 </li>
1620
1621
1622
1623
1624
1625
1626
1627 <li class="md-nav__item">
1628 <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1629 Templates
1630 </a>
1631 </li>
1632
1633
1634
1635
1636
1637
1638
1639 <li class="md-nav__item">
1640 <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1641 Third Party Libraries
1642 </a>
1643 </li>
1644
1645
1646
1647 </ul>
1648 </nav>
1649 </li>
1650
1651
1652
1653
1654
1655
1656
1657
1658 <li class="md-nav__item md-nav__item--nested">
1659
1660
1661 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1662
1663 <label class="md-nav__link" for="__nav_6_2">
1664 Migrating from WSC 5.2
1665 <span class="md-nav__icon md-icon"></span>
1666 </label>
1667 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1668 <label class="md-nav__title" for="__nav_6_2">
1669 <span class="md-nav__icon md-icon"></span>
1670 Migrating from WSC 5.2
1671 </label>
1672 <ul class="md-nav__list" data-md-scrollfix>
1673
1674
1675
1676
1677
1678 <li class="md-nav__item">
1679 <a href="../../../migration/wsc52/php/" class="md-nav__link">
1680 PHP API
1681 </a>
1682 </li>
1683
1684
1685
1686
1687
1688
1689
1690 <li class="md-nav__item">
1691 <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1692 Templates and Languages
1693 </a>
1694 </li>
1695
1696
1697
1698
1699
1700
1701
1702 <li class="md-nav__item">
1703 <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1704 Third Party Libraries
1705 </a>
1706 </li>
1707
1708
1709
1710 </ul>
1711 </nav>
1712 </li>
1713
1714
1715
1716
1717
1718
1719
1720
1721 <li class="md-nav__item md-nav__item--nested">
1722
1723
1724 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1725
1726 <label class="md-nav__link" for="__nav_6_3">
1727 Migrating from WSC 3.1
1728 <span class="md-nav__icon md-icon"></span>
1729 </label>
1730 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1731 <label class="md-nav__title" for="__nav_6_3">
1732 <span class="md-nav__icon md-icon"></span>
1733 Migrating from WSC 3.1
1734 </label>
1735 <ul class="md-nav__list" data-md-scrollfix>
1736
1737
1738
1739
1740
1741 <li class="md-nav__item">
1742 <a href="../../../migration/wsc31/php/" class="md-nav__link">
1743 PHP API
1744 </a>
1745 </li>
1746
1747
1748
1749 </ul>
1750 </nav>
1751 </li>
1752
1753
1754
1755
1756
1757
1758
1759
1760 <li class="md-nav__item md-nav__item--nested">
1761
1762
1763 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1764
1765 <label class="md-nav__link" for="__nav_6_4">
1766 Migrating from WSC 3.0
1767 <span class="md-nav__icon md-icon"></span>
1768 </label>
1769 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1770 <label class="md-nav__title" for="__nav_6_4">
1771 <span class="md-nav__icon md-icon"></span>
1772 Migrating from WSC 3.0
1773 </label>
1774 <ul class="md-nav__list" data-md-scrollfix>
1775
1776
1777
1778
1779
1780 <li class="md-nav__item">
1781 <a href="../../../migration/wsc30/php/" class="md-nav__link">
1782 PHP API
1783 </a>
1784 </li>
1785
1786
1787
1788
1789
1790
1791
1792 <li class="md-nav__item">
1793 <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1794 JavaScript API
1795 </a>
1796 </li>
1797
1798
1799
1800
1801
1802
1803
1804 <li class="md-nav__item">
1805 <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1806 Templates
1807 </a>
1808 </li>
1809
1810
1811
1812
1813
1814
1815
1816 <li class="md-nav__item">
1817 <a href="../../../migration/wsc30/css/" class="md-nav__link">
1818 CSS
1819 </a>
1820 </li>
1821
1822
1823
1824
1825
1826
1827
1828 <li class="md-nav__item">
1829 <a href="../../../migration/wsc30/package/" class="md-nav__link">
1830 Package Components
1831 </a>
1832 </li>
1833
1834
1835
1836 </ul>
1837 </nav>
1838 </li>
1839
1840
1841
1842
1843
1844
1845
1846
1847 <li class="md-nav__item md-nav__item--nested">
1848
1849
1850 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1851
1852 <label class="md-nav__link" for="__nav_6_5">
1853 Migrating from WCF 2.1
1854 <span class="md-nav__icon md-icon"></span>
1855 </label>
1856 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1857 <label class="md-nav__title" for="__nav_6_5">
1858 <span class="md-nav__icon md-icon"></span>
1859 Migrating from WCF 2.1
1860 </label>
1861 <ul class="md-nav__list" data-md-scrollfix>
1862
1863
1864
1865
1866
1867 <li class="md-nav__item">
1868 <a href="../../../migration/wcf21/php/" class="md-nav__link">
1869 PHP API
1870 </a>
1871 </li>
1872
1873
1874
1875
1876
1877
1878
1879 <li class="md-nav__item">
1880 <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1881 Templates
1882 </a>
1883 </li>
1884
1885
1886
1887
1888
1889
1890
1891 <li class="md-nav__item">
1892 <a href="../../../migration/wcf21/css/" class="md-nav__link">
1893 CSS
1894 </a>
1895 </li>
1896
1897
1898
1899
1900
1901
1902
1903 <li class="md-nav__item">
1904 <a href="../../../migration/wcf21/package/" class="md-nav__link">
1905 Package Components
1906 </a>
1907 </li>
1908
1909
1910
1911 </ul>
1912 </nav>
1913 </li>
1914
1915
1916
1917 </ul>
1918 </nav>
1919 </li>
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931 <li class="md-nav__item md-nav__item--nested">
1932
1933
1934 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1935
1936 <label class="md-nav__link" for="__nav_7">
1937 Tutorials
1938 <span class="md-nav__icon md-icon"></span>
1939 </label>
1940 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1941 <label class="md-nav__title" for="__nav_7">
1942 <span class="md-nav__icon md-icon"></span>
1943 Tutorials
1944 </label>
1945 <ul class="md-nav__list" data-md-scrollfix>
1946
1947
1948
1949
1950
1951
1952 <li class="md-nav__item md-nav__item--nested">
1953
1954
1955 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1956
1957 <label class="md-nav__link" for="__nav_7_1">
1958 Tutorial Series
1959 <span class="md-nav__icon md-icon"></span>
1960 </label>
1961 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1962 <label class="md-nav__title" for="__nav_7_1">
1963 <span class="md-nav__icon md-icon"></span>
1964 Tutorial Series
1965 </label>
1966 <ul class="md-nav__list" data-md-scrollfix>
1967
1968
1969
1970
1971
1972 <li class="md-nav__item">
1973 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1974 Overview
1975 </a>
1976 </li>
1977
1978
1979
1980
1981
1982
1983
1984 <li class="md-nav__item">
1985 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1986 Part 1
1987 </a>
1988 </li>
1989
1990
1991
1992
1993
1994
1995
1996 <li class="md-nav__item">
1997 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1998 Part 2
1999 </a>
2000 </li>
2001
2002
2003
2004
2005
2006
2007
2008 <li class="md-nav__item">
2009 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2010 Part 3
2011 </a>
2012 </li>
2013
2014
2015
41eda543
WG
2016
2017
2018
2019
2020 <li class="md-nav__item">
2021 <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2022 Part 4
2023 </a>
2024 </li>
2025
2026
2027
716a4ab6
WG
2028
2029
2030
2031
2032 <li class="md-nav__item">
2033 <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2034 Part 5
2035 </a>
2036 </li>
2037
2038
2039
45ca63d0
TD
2040 </ul>
2041 </nav>
2042 </li>
2043
2044
2045
2046 </ul>
2047 </nav>
2048 </li>
2049
2050
2051
2052 </ul>
2053</nav>
2054 </div>
2055 </div>
2056 </div>
2057
2058
2059
2060 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2061 <div class="md-sidebar__scrollwrap">
2062 <div class="md-sidebar__inner">
2063
2064<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2065
2066
a4835aa6 2067
45ca63d0
TD
2068
2069
2070
2071 <label class="md-nav__title" for="__toc">
2072 <span class="md-nav__icon md-icon"></span>
2073 Table of contents
2074 </label>
2075 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2076
2077 <li class="md-nav__item">
2078 <a href="#components" class="md-nav__link">
2079 Components
2080 </a>
2081
2082 <nav class="md-nav" aria-label="Components">
2083 <ul class="md-nav__list">
2084
2085 <li class="md-nav__item">
2086 <a href="#name" class="md-nav__link">
2087 &lt;name&gt;
2088 </a>
2089
2090</li>
2091
2092 <li class="md-nav__item">
2093 <a href="#boxtype" class="md-nav__link">
2094 &lt;boxType&gt;
2095 </a>
2096
2097 <nav class="md-nav" aria-label="&lt;boxType&gt;">
2098 <ul class="md-nav__list">
2099
2100 <li class="md-nav__item">
2101 <a href="#system" class="md-nav__link">
2102 system
2103 </a>
2104
2105</li>
2106
2107 <li class="md-nav__item">
2108 <a href="#html-text-or-tpl" class="md-nav__link">
2109 html, text or tpl
2110 </a>
2111
2112</li>
2113
2114 </ul>
2115 </nav>
2116
2117</li>
2118
2119 <li class="md-nav__item">
2120 <a href="#objecttype" class="md-nav__link">
2121 &lt;objectType&gt;
2122 </a>
2123
2124</li>
2125
2126 <li class="md-nav__item">
2127 <a href="#position" class="md-nav__link">
2128 &lt;position&gt;
2129 </a>
2130
2131 <nav class="md-nav" aria-label="&lt;position&gt;">
2132 <ul class="md-nav__list">
2133
2134 <li class="md-nav__item">
2135 <a href="#placeholder-positions" class="md-nav__link">
2136 Placeholder Positions
2137 </a>
2138
2139</li>
2140
2141 </ul>
2142 </nav>
2143
2144</li>
2145
2146 <li class="md-nav__item">
2147 <a href="#showheader" class="md-nav__link">
2148 &lt;showHeader&gt;
2149 </a>
2150
2151</li>
2152
2153 <li class="md-nav__item">
2154 <a href="#visibleeverywhere" class="md-nav__link">
2155 &lt;visibleEverywhere&gt;
2156 </a>
2157
2158</li>
2159
2160 <li class="md-nav__item">
2161 <a href="#visibilityexceptions" class="md-nav__link">
2162 &lt;visibilityExceptions&gt;
2163 </a>
2164
2165</li>
2166
2167 <li class="md-nav__item">
2168 <a href="#cssclassname" class="md-nav__link">
2169 &lt;cssClassName&gt;
2170 </a>
2171
2172</li>
2173
2174 <li class="md-nav__item">
2175 <a href="#content" class="md-nav__link">
2176 &lt;content&gt;
2177 </a>
2178
2179 <nav class="md-nav" aria-label="&lt;content&gt;">
2180 <ul class="md-nav__list">
2181
2182 <li class="md-nav__item">
2183 <a href="#title" class="md-nav__link">
2184 &lt;title&gt;
2185 </a>
2186
2187</li>
2188
2189 <li class="md-nav__item">
2190 <a href="#content_1" class="md-nav__link">
2191 &lt;content&gt;
2192 </a>
2193
2194</li>
2195
2196 </ul>
2197 </nav>
2198
2199</li>
2200
2201 </ul>
2202 </nav>
2203
2204</li>
2205
2206 <li class="md-nav__item">
2207 <a href="#example" class="md-nav__link">
2208 Example
2209 </a>
2210
2211</li>
2212
2213 </ul>
2214
2215</nav>
2216 </div>
2217 </div>
2218 </div>
2219
2220
2221 <div class="md-content" data-md-component="content">
2222 <article class="md-content__inner md-typeset">
2223
2224
9b8bddda 2225 <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/box.md" title="Edit this page" class="md-content__button md-icon">
7124f4cb
WG
2226 <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>
2227 </a>
2228
45ca63d0
TD
2229
2230 <h1 id="box-package-installation-plugin">Box Package Installation Plugin<a class="headerlink" href="#box-package-installation-plugin" title="Permanent link">#</a></h1>
2231<p>Deploy and manage boxes that can be placed anywhere on the site, they come in two flavors: system and content-based.</p>
2232<h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
2233<p>Each item is described as a <code>&lt;box&gt;</code> element with the mandatory attribute <code>name</code> that should follow the naming pattern <code>&lt;packageIdentifier&gt;.&lt;BoxName&gt;</code>, e.g. <code>com.woltlab.wcf.RecentActivity</code>.</p>
2234<h3 id="name"><code>&lt;name&gt;</code><a class="headerlink" href="#name" title="Permanent link">#</a></h3>
2235<div class="admonition info">
2236<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>
2237</div>
2238<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>
2239<h3 id="boxtype"><code>&lt;boxType&gt;</code><a class="headerlink" href="#boxtype" title="Permanent link">#</a></h3>
2240<h4 id="system"><code>system</code><a class="headerlink" href="#system" title="Permanent link">#</a></h4>
2241<p>The special <code>system</code> type is reserved for boxes that pull their properties and content from a registered PHP class. Requires the <code>&lt;objectType&gt;</code> element.</p>
2242<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>
2243<p>Provide arbitrary content, requires the <code>&lt;content&gt;</code> element.</p>
2244<h3 id="objecttype"><code>&lt;objectType&gt;</code><a class="headerlink" href="#objecttype" title="Permanent link">#</a></h3>
2245<p>Required for boxes with <code>boxType = system</code>, must be registered through <a href="../object-type/">the objectType PIP</a> for the definition <code>com.woltlab.wcf.boxController</code>.</p>
2246<h3 id="position"><code>&lt;position&gt;</code><a class="headerlink" href="#position" title="Permanent link">#</a></h3>
2247<p>The default display position of this box, can be any of the following:</p>
2248<ul>
2249<li>bottom</li>
2250<li>contentBottom</li>
2251<li>contentTop</li>
2252<li>footer</li>
2253<li>footerBoxes</li>
2254<li>headerBoxes</li>
2255<li>hero</li>
2256<li>sidebarLeft</li>
2257<li>sidebarRight</li>
2258<li>top</li>
2259</ul>
2260<h4 id="placeholder-positions">Placeholder Positions<a class="headerlink" href="#placeholder-positions" title="Permanent link">#</a></h4>
898918c8 2261<p><img alt="Visual illustration of placeholder positions" src="../../../assets/boxPlaceholders.png" /></p>
45ca63d0
TD
2262<h3 id="showheader"><code>&lt;showHeader&gt;</code><a class="headerlink" href="#showheader" title="Permanent link">#</a></h3>
2263<p>Setting this to <code>0</code> will suppress display of the box title, useful for boxes containing advertisements or similar. Defaults to <code>1</code>.</p>
2264<h3 id="visibleeverywhere"><code>&lt;visibleEverywhere&gt;</code><a class="headerlink" href="#visibleeverywhere" title="Permanent link">#</a></h3>
2265<p>Controls the display on all pages (<code>1</code>) or none (<code>0</code>), can be used in conjunction with <code>&lt;visibilityExceptions&gt;</code>.</p>
2266<h3 id="visibilityexceptions"><code>&lt;visibilityExceptions&gt;</code><a class="headerlink" href="#visibilityexceptions" title="Permanent link">#</a></h3>
2267<p>Inverts the <code>&lt;visibleEverywhere&gt;</code> setting for the listed pages only.</p>
2268<h3 id="cssclassname"><code>&lt;cssClassName&gt;</code><a class="headerlink" href="#cssclassname" title="Permanent link">#</a></h3>
2269<p>Provide a custom CSS class name that is added to the menu container, allowing further customization of the menu's appearance.</p>
2270<h3 id="content"><code>&lt;content&gt;</code><a class="headerlink" href="#content" title="Permanent link">#</a></h3>
2271<div class="admonition info">
2272<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>
2273</div>
2274<h4 id="title"><code>&lt;title&gt;</code><a class="headerlink" href="#title" title="Permanent link">#</a></h4>
2275<p>The title element is required and controls the box title shown to the end users.</p>
2276<h4 id="content_1"><code>&lt;content&gt;</code><a class="headerlink" href="#content_1" title="Permanent link">#</a></h4>
2277<p>The content that should be used to populate the box, only used and required if the <code>boxType</code> equals <code>text</code>, <code>html</code> and <code>tpl</code>.</p>
2278<h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
d68aabe0
WG
2279<div class="titledCodeBox">
2280 <div class="codeBoxTitle"><code>box.xml</code></div>
2281 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
704cbc4a
WG
2282<span class="normal"> 2</span>
2283<span class="normal"> 3</span>
2284<span class="normal"> 4</span>
2285<span class="normal"> 5</span>
2286<span class="normal"> 6</span>
2287<span class="normal"> 7</span>
2288<span class="normal"> 8</span>
2289<span class="normal"> 9</span>
2290<span class="normal">10</span>
2291<span class="normal">11</span>
2292<span class="normal">12</span>
2293<span class="normal">13</span>
2294<span class="normal">14</span>
2295<span class="normal">15</span>
2296<span class="normal">16</span>
2297<span class="normal">17</span>
2298<span class="normal">18</span>
2299<span class="normal">19</span>
2300<span class="normal">20</span>
2301<span class="normal">21</span>
2302<span class="normal">22</span>
2303<span class="normal">23</span>
2304<span class="normal">24</span>
2305<span class="normal">25</span>
2306<span class="normal">26</span>
2307<span class="normal">27</span>
2308<span class="normal">28</span>
2309<span class="normal">29</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
2310<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/box.xsd&quot;</span><span class="nt">&gt;</span>
2311 <span class="nt">&lt;import&gt;</span>
2312 <span class="nt">&lt;box</span> <span class="na">identifier=</span><span class="s">&quot;com.woltlab.wcf.RecentActivity&quot;</span><span class="nt">&gt;</span>
2313 <span class="nt">&lt;name</span> <span class="na">language=</span><span class="s">&quot;de&quot;</span><span class="nt">&gt;</span>Letzte Aktivitäten<span class="nt">&lt;/name&gt;</span>
2314 <span class="nt">&lt;name</span> <span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>Recent Activities<span class="nt">&lt;/name&gt;</span>
2315 <span class="nt">&lt;boxType&gt;</span>system<span class="nt">&lt;/boxType&gt;</span>
2316 <span class="nt">&lt;objectType&gt;</span>com.woltlab.wcf.recentActivityList<span class="nt">&lt;/objectType&gt;</span>
2317 <span class="nt">&lt;position&gt;</span>contentBottom<span class="nt">&lt;/position&gt;</span>
2318 <span class="nt">&lt;showHeader&gt;</span>0<span class="nt">&lt;/showHeader&gt;</span>
2319 <span class="nt">&lt;visibleEverywhere&gt;</span>0<span class="nt">&lt;/visibleEverywhere&gt;</span>
2320 <span class="nt">&lt;visibilityExceptions&gt;</span>
2321 <span class="nt">&lt;page&gt;</span>com.woltlab.wcf.Dashboard<span class="nt">&lt;/page&gt;</span>
2322 <span class="nt">&lt;/visibilityExceptions&gt;</span>
2323 <span class="nt">&lt;limit&gt;</span>10<span class="nt">&lt;/limit&gt;</span>
2324
2325 <span class="nt">&lt;content</span> <span class="na">language=</span><span class="s">&quot;de&quot;</span><span class="nt">&gt;</span>
2326 <span class="nt">&lt;title&gt;</span>Letzte Aktivitäten<span class="nt">&lt;/title&gt;</span>
2327 <span class="nt">&lt;/content&gt;</span>
2328 <span class="nt">&lt;content</span> <span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>
2329 <span class="nt">&lt;title&gt;</span>Recent Activities<span class="nt">&lt;/title&gt;</span>
2330 <span class="nt">&lt;/content&gt;</span>
2331 <span class="nt">&lt;/box&gt;</span>
2332 <span class="nt">&lt;/import&gt;</span>
2333
2334 <span class="nt">&lt;delete&gt;</span>
2335 <span class="nt">&lt;box</span> <span class="na">identifier=</span><span class="s">&quot;com.woltlab.wcf.RecentActivity&quot;</span> <span class="nt">/&gt;</span>
2336 <span class="nt">&lt;/delete&gt;</span>
2337<span class="nt">&lt;/data&gt;</span>
2338</code></pre></div>
704cbc4a 2339</td></tr></table>
d68aabe0 2340</div>
45ca63d0 2341
4a5c32e1
WG
2342
2343
2344
2345<hr>
2346<div class="md-source-date">
2347 <small>
2348
d68aabe0 2349 Last update: 2021-04-23
4a5c32e1
WG
2350
2351 </small>
2352</div>
2353
2354
45ca63d0
TD
2355
2356
2357
2358
2359
2360
2361 </article>
2362 </div>
2363 </div>
fb962f09 2364
45ca63d0
TD
2365 </main>
2366
2367
2368<footer class="md-footer">
2369
2370 <nav class="md-footer__inner md-grid" aria-label="Footer">
2371
2372 <a href="../bbcode/" class="md-footer__link md-footer__link--prev" rel="prev">
2373 <div class="md-footer__button md-icon">
2374 <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>
2375 </div>
2376 <div class="md-footer__title">
2377 <div class="md-ellipsis">
2378 <span class="md-footer__direction">
2379 Previous
2380 </span>
2381 bbcode
2382 </div>
2383 </div>
2384 </a>
2385
2386
2387 <a href="../clipboard-action/" class="md-footer__link md-footer__link--next" rel="next">
2388 <div class="md-footer__title">
2389 <div class="md-ellipsis">
2390 <span class="md-footer__direction">
2391 Next
2392 </span>
2393 clipboardAction
2394 </div>
2395 </div>
2396 <div class="md-footer__button md-icon">
2397 <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>
2398 </div>
2399 </a>
2400
2401 </nav>
2402
2403 <div class="md-footer-meta md-typeset">
2404 <div class="md-footer-meta__inner md-grid">
2405 <div class="md-footer-copyright">
2406
2407 <div class="md-footer-copyright__highlight">
2408 Copyright © 2020 WoltLab GmbH
2409 </div>
2410
2411 Made with
2412 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2413 Material for MkDocs
2414 </a>
fb88dc6e 2415
45ca63d0
TD
2416 </div>
2417 <div class="md-footer-copyright">
2418 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2419 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2420</div>
2421 </div>
2422 </div>
2423</footer>
2424
2425 </div>
2426 <div class="md-dialog" data-md-component="dialog">
2427 <div class="md-dialog__inner md-typeset"></div>
2428 </div>
fb962f09 2429 <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
2430
2431
a4835aa6 2432 <script src="../../../assets/javascripts/bundle.4ea5477f.min.js"></script>
45ca63d0
TD
2433
2434
2435 </body>
2436</html>