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