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