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