latest/package/pip/box/index.html

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