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