latest/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="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>Package Components - 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="#wcf-21x-package-components" 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               Package Components
 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     <li class="md-nav__item">
 310       <a href="../../../php/api/caches/" class="md-nav__link">
 311         Caches
 312       </a>
 313     </li>
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item">
 322       <a href="../../../php/api/comments/" class="md-nav__link">
 323         Comments
 324       </a>
 325     </li>
 326
 327
 328
 329
 330
 331
 332
 333     <li class="md-nav__item">
 334       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 335         Cronjobs
 336       </a>
 337     </li>
 338
 339
 340
 341
 342
 343
 344
 345     <li class="md-nav__item">
 346       <a href="../../../php/api/events/" class="md-nav__link">
 347         Events
 348       </a>
 349     </li>
 350
 351
 352
 353
 354
 355
 356
 357
 358     <li class="md-nav__item md-nav__item--nested">
 359
 360
 361         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 362
 363       <label class="md-nav__link" for="__nav_2_5_5">
 364         Form Builder
 365         <span class="md-nav__icon md-icon"></span>
 366       </label>
 367       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 368         <label class="md-nav__title" for="__nav_2_5_5">
 369           <span class="md-nav__icon md-icon"></span>
 370           Form Builder
 371         </label>
 372         <ul class="md-nav__list" data-md-scrollfix>
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390     <li class="md-nav__item">
 391       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 392         Structure
 393       </a>
 394     </li>
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 404         Fields
 405       </a>
 406     </li>
 407
 408
 409
 410
 411
 412
 413
 414     <li class="md-nav__item">
 415       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 416         Validation and Data
 417       </a>
 418     </li>
 419
 420
 421
 422
 423
 424
 425
 426     <li class="md-nav__item">
 427       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 428         Dependencies
 429       </a>
 430     </li>
 431
 432
 433
 434         </ul>
 435       </nav>
 436     </li>
 437
 438
 439
 440
 441
 442
 443
 444     <li class="md-nav__item">
 445       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 446         Package Installation Plugins
 447       </a>
 448     </li>
 449
 450
 451
 452
 453
 454
 455
 456     <li class="md-nav__item">
 457       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 458         User Activity Points
 459       </a>
 460     </li>
 461
 462
 463
 464
 465
 466
 467
 468     <li class="md-nav__item">
 469       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 470         User Notifications
 471       </a>
 472     </li>
 473
 474
 475
 476
 477
 478
 479
 480     <li class="md-nav__item">
 481       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 482         Sitemaps
 483       </a>
 484     </li>
 485
 486
 487
 488         </ul>
 489       </nav>
 490     </li>
 491
 492
 493
 494
 495
 496
 497
 498     <li class="md-nav__item">
 499       <a href="../../../php/code-style/" class="md-nav__link">
 500         Code Style
 501       </a>
 502     </li>
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../../php/apps/" class="md-nav__link">
 512         Apps
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item">
 523       <a href="../../../php/gdpr/" class="md-nav__link">
 524         GDPR
 525       </a>
 526     </li>
 527
 528
 529
 530         </ul>
 531       </nav>
 532     </li>
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544     <li class="md-nav__item md-nav__item--nested">
 545
 546
 547         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 548
 549       <label class="md-nav__link" for="__nav_3">
 550         Languages, Templates & CSS
 551         <span class="md-nav__icon md-icon"></span>
 552       </label>
 553       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 554         <label class="md-nav__title" for="__nav_3">
 555           <span class="md-nav__icon md-icon"></span>
 556           Languages, Templates & CSS
 557         </label>
 558         <ul class="md-nav__list" data-md-scrollfix>
 559
 560
 561
 562
 563
 564     <li class="md-nav__item">
 565       <a href="../../../view/languages/" class="md-nav__link">
 566         Languages
 567       </a>
 568     </li>
 569
 570
 571
 572
 573
 574
 575
 576     <li class="md-nav__item">
 577       <a href="../../../view/templates/" class="md-nav__link">
 578         Templates
 579       </a>
 580     </li>
 581
 582
 583
 584
 585
 586
 587
 588     <li class="md-nav__item">
 589       <a href="../../../view/css/" class="md-nav__link">
 590         CSS
 591       </a>
 592     </li>
 593
 594
 595
 596         </ul>
 597       </nav>
 598     </li>
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610     <li class="md-nav__item md-nav__item--nested">
 611
 612
 613         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 614
 615       <label class="md-nav__link" for="__nav_4">
 616         JavaScript API
 617         <span class="md-nav__icon md-icon"></span>
 618       </label>
 619       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 620         <label class="md-nav__title" for="__nav_4">
 621           <span class="md-nav__icon md-icon"></span>
 622           JavaScript API
 623         </label>
 624         <ul class="md-nav__list" data-md-scrollfix>
 625
 626
 627
 628
 629
 630     <li class="md-nav__item">
 631       <a href="../../../javascript/general-usage/" class="md-nav__link">
 632         General Usage
 633       </a>
 634     </li>
 635
 636
 637
 638
 639
 640
 641
 642
 643     <li class="md-nav__item md-nav__item--nested">
 644
 645
 646         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 647
 648       <label class="md-nav__link" for="__nav_4_2">
 649         New API
 650         <span class="md-nav__icon md-icon"></span>
 651       </label>
 652       <nav class="md-nav" aria-label="New API" data-md-level="2">
 653         <label class="md-nav__title" for="__nav_4_2">
 654           <span class="md-nav__icon md-icon"></span>
 655           New API
 656         </label>
 657         <ul class="md-nav__list" data-md-scrollfix>
 658
 659
 660
 661
 662
 663     <li class="md-nav__item">
 664       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 665         Writing a module
 666       </a>
 667     </li>
 668
 669
 670
 671
 672
 673
 674
 675     <li class="md-nav__item">
 676       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 677         Data Structures
 678       </a>
 679     </li>
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item">
 688       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 689         Core Functions
 690       </a>
 691     </li>
 692
 693
 694
 695
 696
 697
 698
 699     <li class="md-nav__item">
 700       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 701         DOM
 702       </a>
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 713         Event Handling
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 725         Ajax
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735     <li class="md-nav__item">
 736       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 737         Dialogs
 738       </a>
 739     </li>
 740
 741
 742
 743
 744
 745
 746
 747     <li class="md-nav__item">
 748       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 749         Browser and Screen Sizes
 750       </a>
 751     </li>
 752
 753
 754
 755
 756
 757
 758
 759     <li class="md-nav__item">
 760       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 761         User Interface
 762       </a>
 763     </li>
 764
 765
 766
 767         </ul>
 768       </nav>
 769     </li>
 770
 771
 772
 773
 774
 775
 776
 777     <li class="md-nav__item">
 778       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 779         Legacy API
 780       </a>
 781     </li>
 782
 783
 784
 785
 786
 787
 788
 789     <li class="md-nav__item">
 790       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 791         Helper Functions
 792       </a>
 793     </li>
 794
 795
 796
 797
 798
 799
 800
 801     <li class="md-nav__item">
 802       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 803         Code Snippets
 804       </a>
 805     </li>
 806
 807
 808
 809         </ul>
 810       </nav>
 811     </li>
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823     <li class="md-nav__item md-nav__item--nested">
 824
 825
 826         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 827
 828       <label class="md-nav__link" for="__nav_5">
 829         Package Components
 830         <span class="md-nav__icon md-icon"></span>
 831       </label>
 832       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 833         <label class="md-nav__title" for="__nav_5">
 834           <span class="md-nav__icon md-icon"></span>
 835           Package Components
 836         </label>
 837         <ul class="md-nav__list" data-md-scrollfix>
 838
 839
 840
 841
 842
 843     <li class="md-nav__item">
 844       <a href="../../../package/package-xml/" class="md-nav__link">
 845         package.xml
 846       </a>
 847     </li>
 848
 849
 850
 851
 852
 853
 854
 855
 856     <li class="md-nav__item md-nav__item--nested">
 857
 858
 859         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
 860
 861       <label class="md-nav__link" for="__nav_5_2">
 862         PIPs
 863         <span class="md-nav__icon md-icon"></span>
 864       </label>
 865       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 866         <label class="md-nav__title" for="__nav_5_2">
 867           <span class="md-nav__icon md-icon"></span>
 868           PIPs
 869         </label>
 870         <ul class="md-nav__list" data-md-scrollfix>
 871
 872
 873
 874
 875
 876     <li class="md-nav__item">
 877       <a href="../../../package/pip/" class="md-nav__link">
 878         Overview
 879       </a>
 880     </li>
 881
 882
 883
 884
 885
 886
 887
 888     <li class="md-nav__item">
 889       <a href="../../../package/pip/acl-option/" class="md-nav__link">
 890         aclOption
 891       </a>
 892     </li>
 893
 894
 895
 896
 897
 898
 899
 900     <li class="md-nav__item">
 901       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
 902         acpMenu
 903       </a>
 904     </li>
 905
 906
 907
 908
 909
 910
 911
 912     <li class="md-nav__item">
 913       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
 914         acpSearchProvider
 915       </a>
 916     </li>
 917
 918
 919
 920
 921
 922
 923
 924     <li class="md-nav__item">
 925       <a href="../../../package/pip/acp-template/" class="md-nav__link">
 926         acpTemplate
 927       </a>
 928     </li>
 929
 930
 931
 932
 933
 934
 935
 936     <li class="md-nav__item">
 937       <a href="../../../package/pip/bbcode/" class="md-nav__link">
 938         bbcode
 939       </a>
 940     </li>
 941
 942
 943
 944
 945
 946
 947
 948     <li class="md-nav__item">
 949       <a href="../../../package/pip/box/" class="md-nav__link">
 950         box
 951       </a>
 952     </li>
 953
 954
 955
 956
 957
 958
 959
 960     <li class="md-nav__item">
 961       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
 962         clipboardAction
 963       </a>
 964     </li>
 965
 966
 967
 968
 969
 970
 971
 972     <li class="md-nav__item">
 973       <a href="../../../package/pip/core-object/" class="md-nav__link">
 974         coreObject
 975       </a>
 976     </li>
 977
 978
 979
 980
 981
 982
 983
 984     <li class="md-nav__item">
 985       <a href="../../../package/pip/cronjob/" class="md-nav__link">
 986         cronjob
 987       </a>
 988     </li>
 989
 990
 991
 992
 993
 994
 995
 996     <li class="md-nav__item">
 997       <a href="../../../package/pip/event-listener/" class="md-nav__link">
 998         eventListener
 999       </a>
1000     </li>
1001
1002
1003
1004
1005
1006
1007
1008     <li class="md-nav__item">
1009       <a href="../../../package/pip/file/" class="md-nav__link">
1010         file
1011       </a>
1012     </li>
1013
1014
1015
1016
1017
1018
1019
1020     <li class="md-nav__item">
1021       <a href="../../../package/pip/language/" class="md-nav__link">
1022         language
1023       </a>
1024     </li>
1025
1026
1027
1028
1029
1030
1031
1032     <li class="md-nav__item">
1033       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1034         mediaProvider
1035       </a>
1036     </li>
1037
1038
1039
1040
1041
1042
1043
1044     <li class="md-nav__item">
1045       <a href="../../../package/pip/menu/" class="md-nav__link">
1046         menu
1047       </a>
1048     </li>
1049
1050
1051
1052
1053
1054
1055
1056     <li class="md-nav__item">
1057       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1058         menuItem
1059       </a>
1060     </li>
1061
1062
1063
1064
1065
1066
1067
1068     <li class="md-nav__item">
1069       <a href="../../../package/pip/object-type/" class="md-nav__link">
1070         objectType
1071       </a>
1072     </li>
1073
1074
1075
1076
1077
1078
1079
1080     <li class="md-nav__item">
1081       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1082         objectTypeDefinition
1083       </a>
1084     </li>
1085
1086
1087
1088
1089
1090
1091
1092     <li class="md-nav__item">
1093       <a href="../../../package/pip/option/" class="md-nav__link">
1094         option
1095       </a>
1096     </li>
1097
1098
1099
1100
1101
1102
1103
1104     <li class="md-nav__item">
1105       <a href="../../../package/pip/page/" class="md-nav__link">
1106         page
1107       </a>
1108     </li>
1109
1110
1111
1112
1113
1114
1115
1116     <li class="md-nav__item">
1117       <a href="../../../package/pip/pip/" class="md-nav__link">
1118         pip
1119       </a>
1120     </li>
1121
1122
1123
1124
1125
1126
1127
1128     <li class="md-nav__item">
1129       <a href="../../../package/pip/script/" class="md-nav__link">
1130         script
1131       </a>
1132     </li>
1133
1134
1135
1136
1137
1138
1139
1140     <li class="md-nav__item">
1141       <a href="../../../package/pip/smiley/" class="md-nav__link">
1142         smiley
1143       </a>
1144     </li>
1145
1146
1147
1148
1149
1150
1151
1152     <li class="md-nav__item">
1153       <a href="../../../package/pip/sql/" class="md-nav__link">
1154         sql
1155       </a>
1156     </li>
1157
1158
1159
1160
1161
1162
1163
1164     <li class="md-nav__item">
1165       <a href="../../../package/pip/style/" class="md-nav__link">
1166         style
1167       </a>
1168     </li>
1169
1170
1171
1172
1173
1174
1175
1176     <li class="md-nav__item">
1177       <a href="../../../package/pip/template/" class="md-nav__link">
1178         template
1179       </a>
1180     </li>
1181
1182
1183
1184
1185
1186
1187
1188     <li class="md-nav__item">
1189       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1190         templateListener
1191       </a>
1192     </li>
1193
1194
1195
1196
1197
1198
1199
1200     <li class="md-nav__item">
1201       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1202         userGroupOption
1203       </a>
1204     </li>
1205
1206
1207
1208
1209
1210
1211
1212     <li class="md-nav__item">
1213       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1214         userMenu
1215       </a>
1216     </li>
1217
1218
1219
1220
1221
1222
1223
1224     <li class="md-nav__item">
1225       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1226         userNotificationEvent
1227       </a>
1228     </li>
1229
1230
1231
1232
1233
1234
1235
1236     <li class="md-nav__item">
1237       <a href="../../../package/pip/user-option/" class="md-nav__link">
1238         userOption
1239       </a>
1240     </li>
1241
1242
1243
1244
1245
1246
1247
1248     <li class="md-nav__item">
1249       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1250         userProfileMenu
1251       </a>
1252     </li>
1253
1254
1255
1256         </ul>
1257       </nav>
1258     </li>
1259
1260
1261
1262
1263
1264
1265
1266     <li class="md-nav__item">
1267       <a href="../../../package/database-php-api/" class="md-nav__link">
1268         Database PHP API
1269       </a>
1270     </li>
1271
1272
1273
1274         </ul>
1275       </nav>
1276     </li>
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1291
1292
1293         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
1294
1295       <label class="md-nav__link" for="__nav_6">
1296         Migration
1297         <span class="md-nav__icon md-icon"></span>
1298       </label>
1299       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1300         <label class="md-nav__title" for="__nav_6">
1301           <span class="md-nav__icon md-icon"></span>
1302           Migration
1303         </label>
1304         <ul class="md-nav__list" data-md-scrollfix>
1305
1306
1307
1308
1309
1310
1311     <li class="md-nav__item md-nav__item--nested">
1312
1313
1314         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1315
1316       <label class="md-nav__link" for="__nav_6_1">
1317         Migrating from WSC 5.3
1318         <span class="md-nav__icon md-icon"></span>
1319       </label>
1320       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1321         <label class="md-nav__title" for="__nav_6_1">
1322           <span class="md-nav__icon md-icon"></span>
1323           Migrating from WSC 5.3
1324         </label>
1325         <ul class="md-nav__list" data-md-scrollfix>
1326
1327
1328
1329
1330
1331     <li class="md-nav__item">
1332       <a href="../../wsc53/php/" class="md-nav__link">
1333         PHP API
1334       </a>
1335     </li>
1336
1337
1338
1339
1340
1341
1342
1343     <li class="md-nav__item">
1344       <a href="../../wsc53/session/" class="md-nav__link">
1345         Session Handling and Authentication
1346       </a>
1347     </li>
1348
1349
1350
1351
1352
1353
1354
1355     <li class="md-nav__item">
1356       <a href="../../wsc53/javascript/" class="md-nav__link">
1357         JavaScript
1358       </a>
1359     </li>
1360
1361
1362
1363
1364
1365
1366
1367     <li class="md-nav__item">
1368       <a href="../../wsc53/templates/" class="md-nav__link">
1369         Templates
1370       </a>
1371     </li>
1372
1373
1374
1375
1376
1377
1378
1379     <li class="md-nav__item">
1380       <a href="../../wsc53/libraries/" class="md-nav__link">
1381         Third Party Libraries
1382       </a>
1383     </li>
1384
1385
1386
1387         </ul>
1388       </nav>
1389     </li>
1390
1391
1392
1393
1394
1395
1396
1397
1398     <li class="md-nav__item md-nav__item--nested">
1399
1400
1401         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1402
1403       <label class="md-nav__link" for="__nav_6_2">
1404         Migrating from WSC 5.2
1405         <span class="md-nav__icon md-icon"></span>
1406       </label>
1407       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1408         <label class="md-nav__title" for="__nav_6_2">
1409           <span class="md-nav__icon md-icon"></span>
1410           Migrating from WSC 5.2
1411         </label>
1412         <ul class="md-nav__list" data-md-scrollfix>
1413
1414
1415
1416
1417
1418     <li class="md-nav__item">
1419       <a href="../../wsc52/php/" class="md-nav__link">
1420         PHP API
1421       </a>
1422     </li>
1423
1424
1425
1426
1427
1428
1429
1430     <li class="md-nav__item">
1431       <a href="../../wsc52/templates/" class="md-nav__link">
1432         Templates and Languages
1433       </a>
1434     </li>
1435
1436
1437
1438
1439
1440
1441
1442     <li class="md-nav__item">
1443       <a href="../../wsc52/libraries/" class="md-nav__link">
1444         Third Party Libraries
1445       </a>
1446     </li>
1447
1448
1449
1450         </ul>
1451       </nav>
1452     </li>
1453
1454
1455
1456
1457
1458
1459
1460
1461     <li class="md-nav__item md-nav__item--nested">
1462
1463
1464         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1465
1466       <label class="md-nav__link" for="__nav_6_3">
1467         Migrating from WSC 3.1
1468         <span class="md-nav__icon md-icon"></span>
1469       </label>
1470       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1471         <label class="md-nav__title" for="__nav_6_3">
1472           <span class="md-nav__icon md-icon"></span>
1473           Migrating from WSC 3.1
1474         </label>
1475         <ul class="md-nav__list" data-md-scrollfix>
1476
1477
1478
1479
1480
1481     <li class="md-nav__item">
1482       <a href="../../wsc31/php/" class="md-nav__link">
1483         PHP API
1484       </a>
1485     </li>
1486
1487
1488
1489         </ul>
1490       </nav>
1491     </li>
1492
1493
1494
1495
1496
1497
1498
1499
1500     <li class="md-nav__item md-nav__item--nested">
1501
1502
1503         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1504
1505       <label class="md-nav__link" for="__nav_6_4">
1506         Migrating from WSC 3.0
1507         <span class="md-nav__icon md-icon"></span>
1508       </label>
1509       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1510         <label class="md-nav__title" for="__nav_6_4">
1511           <span class="md-nav__icon md-icon"></span>
1512           Migrating from WSC 3.0
1513         </label>
1514         <ul class="md-nav__list" data-md-scrollfix>
1515
1516
1517
1518
1519
1520     <li class="md-nav__item">
1521       <a href="../../wsc30/php/" class="md-nav__link">
1522         PHP API
1523       </a>
1524     </li>
1525
1526
1527
1528
1529
1530
1531
1532     <li class="md-nav__item">
1533       <a href="../../wsc30/javascript/" class="md-nav__link">
1534         JavaScript API
1535       </a>
1536     </li>
1537
1538
1539
1540
1541
1542
1543
1544     <li class="md-nav__item">
1545       <a href="../../wsc30/templates/" class="md-nav__link">
1546         Templates
1547       </a>
1548     </li>
1549
1550
1551
1552
1553
1554
1555
1556     <li class="md-nav__item">
1557       <a href="../../wsc30/css/" class="md-nav__link">
1558         CSS
1559       </a>
1560     </li>
1561
1562
1563
1564
1565
1566
1567
1568     <li class="md-nav__item">
1569       <a href="../../wsc30/package/" class="md-nav__link">
1570         Package Components
1571       </a>
1572     </li>
1573
1574
1575
1576         </ul>
1577       </nav>
1578     </li>
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1590
1591
1592         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" checked>
1593
1594       <label class="md-nav__link" for="__nav_6_5">
1595         Migrating from WCF 2.1
1596         <span class="md-nav__icon md-icon"></span>
1597       </label>
1598       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1599         <label class="md-nav__title" for="__nav_6_5">
1600           <span class="md-nav__icon md-icon"></span>
1601           Migrating from WCF 2.1
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="../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="../templates/" class="md-nav__link">
1623         Templates
1624       </a>
1625     </li>
1626
1627
1628
1629
1630
1631
1632
1633     <li class="md-nav__item">
1634       <a href="../css/" class="md-nav__link">
1635         CSS
1636       </a>
1637     </li>
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647     <li class="md-nav__item md-nav__item--active">
1648
1649       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1650
1651
1652
1653
1654         <label class="md-nav__link md-nav__link--active" for="__toc">
1655           Package Components
1656           <span class="md-nav__icon md-icon"></span>
1657         </label>
1658
1659       <a href="./" class="md-nav__link md-nav__link--active">
1660         Package Components
1661       </a>
1662
1663
1664 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1665
1666
1667
1668
1669
1670     <label class="md-nav__title" for="__toc">
1671       <span class="md-nav__icon md-icon"></span>
1672       Table of contents
1673     </label>
1674     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1675
1676         <li class="md-nav__item">
1677   <a href="#packagexml" class="md-nav__link">
1678     package.xml
1679   </a>
1680
1681     <nav class="md-nav" aria-label="package.xml">
1682       <ul class="md-nav__list">
1683
1684           <li class="md-nav__item">
1685   <a href="#short-instructions" class="md-nav__link">
1686     Short Instructions
1687   </a>
1688
1689 </li>
1690
1691           <li class="md-nav__item">
1692   <a href="#example" class="md-nav__link">
1693     Example
1694   </a>
1695
1696 </li>
1697
1698           <li class="md-nav__item">
1699   <a href="#exceptions" class="md-nav__link">
1700     Exceptions
1701   </a>
1702
1703 </li>
1704
1705       </ul>
1706     </nav>
1707
1708 </li>
1709
1710         <li class="md-nav__item">
1711   <a href="#acpmenuxml" class="md-nav__link">
1712     acpMenu.xml
1713   </a>
1714
1715     <nav class="md-nav" aria-label="acpMenu.xml">
1716       <ul class="md-nav__list">
1717
1718           <li class="md-nav__item">
1719   <a href="#renamed-categories" class="md-nav__link">
1720     Renamed Categories
1721   </a>
1722
1723 </li>
1724
1725           <li class="md-nav__item">
1726   <a href="#submenu-items" class="md-nav__link">
1727     Submenu Items
1728   </a>
1729
1730 </li>
1731
1732           <li class="md-nav__item">
1733   <a href="#example_1" class="md-nav__link">
1734     Example
1735   </a>
1736
1737 </li>
1738
1739           <li class="md-nav__item">
1740   <a href="#common-icon-names" class="md-nav__link">
1741     Common Icon Names
1742   </a>
1743
1744 </li>
1745
1746       </ul>
1747     </nav>
1748
1749 </li>
1750
1751         <li class="md-nav__item">
1752   <a href="#boxxml" class="md-nav__link">
1753     box.xml
1754   </a>
1755
1756 </li>
1757
1758         <li class="md-nav__item">
1759   <a href="#cronjobxml" class="md-nav__link">
1760     cronjob.xml
1761   </a>
1762
1763 </li>
1764
1765         <li class="md-nav__item">
1766   <a href="#eventlistenerxml" class="md-nav__link">
1767     eventListener.xml
1768   </a>
1769
1770 </li>
1771
1772         <li class="md-nav__item">
1773   <a href="#menuxml" class="md-nav__link">
1774     menu.xml
1775   </a>
1776
1777 </li>
1778
1779         <li class="md-nav__item">
1780   <a href="#menuitemxml" class="md-nav__link">
1781     menuItem.xml
1782   </a>
1783
1784 </li>
1785
1786         <li class="md-nav__item">
1787   <a href="#objecttypexml" class="md-nav__link">
1788     objectType.xml
1789   </a>
1790
1791 </li>
1792
1793         <li class="md-nav__item">
1794   <a href="#optionxml" class="md-nav__link">
1795     option.xml
1796   </a>
1797
1798 </li>
1799
1800         <li class="md-nav__item">
1801   <a href="#pagexml" class="md-nav__link">
1802     page.xml
1803   </a>
1804
1805 </li>
1806
1807         <li class="md-nav__item">
1808   <a href="#pagemenuxml" class="md-nav__link">
1809     pageMenu.xml
1810   </a>
1811
1812 </li>
1813
1814     </ul>
1815
1816 </nav>
1817
1818     </li>
1819
1820
1821
1822         </ul>
1823       </nav>
1824     </li>
1825
1826
1827
1828         </ul>
1829       </nav>
1830     </li>
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842     <li class="md-nav__item md-nav__item--nested">
1843
1844
1845         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1846
1847       <label class="md-nav__link" for="__nav_7">
1848         Tutorials
1849         <span class="md-nav__icon md-icon"></span>
1850       </label>
1851       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1852         <label class="md-nav__title" for="__nav_7">
1853           <span class="md-nav__icon md-icon"></span>
1854           Tutorials
1855         </label>
1856         <ul class="md-nav__list" data-md-scrollfix>
1857
1858
1859
1860
1861
1862
1863     <li class="md-nav__item md-nav__item--nested">
1864
1865
1866         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1867
1868       <label class="md-nav__link" for="__nav_7_1">
1869         Tutorial Series
1870         <span class="md-nav__icon md-icon"></span>
1871       </label>
1872       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1873         <label class="md-nav__title" for="__nav_7_1">
1874           <span class="md-nav__icon md-icon"></span>
1875           Tutorial Series
1876         </label>
1877         <ul class="md-nav__list" data-md-scrollfix>
1878
1879
1880
1881
1882
1883     <li class="md-nav__item">
1884       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1885         Overview
1886       </a>
1887     </li>
1888
1889
1890
1891
1892
1893
1894
1895     <li class="md-nav__item">
1896       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1897         Part 1
1898       </a>
1899     </li>
1900
1901
1902
1903
1904
1905
1906
1907     <li class="md-nav__item">
1908       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1909         Part 2
1910       </a>
1911     </li>
1912
1913
1914
1915
1916
1917
1918
1919     <li class="md-nav__item">
1920       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1921         Part 3
1922       </a>
1923     </li>
1924
1925
1926
1927         </ul>
1928       </nav>
1929     </li>
1930
1931
1932
1933         </ul>
1934       </nav>
1935     </li>
1936
1937
1938
1939   </ul>
1940 </nav>
1941                   </div>
1942                 </div>
1943               </div>
1944
1945
1946
1947               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1948                 <div class="md-sidebar__scrollwrap">
1949                   <div class="md-sidebar__inner">
1950
1951 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1952
1953
1954
1955
1956
1957     <label class="md-nav__title" for="__toc">
1958       <span class="md-nav__icon md-icon"></span>
1959       Table of contents
1960     </label>
1961     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1962
1963         <li class="md-nav__item">
1964   <a href="#packagexml" class="md-nav__link">
1965     package.xml
1966   </a>
1967
1968     <nav class="md-nav" aria-label="package.xml">
1969       <ul class="md-nav__list">
1970
1971           <li class="md-nav__item">
1972   <a href="#short-instructions" class="md-nav__link">
1973     Short Instructions
1974   </a>
1975
1976 </li>
1977
1978           <li class="md-nav__item">
1979   <a href="#example" class="md-nav__link">
1980     Example
1981   </a>
1982
1983 </li>
1984
1985           <li class="md-nav__item">
1986   <a href="#exceptions" class="md-nav__link">
1987     Exceptions
1988   </a>
1989
1990 </li>
1991
1992       </ul>
1993     </nav>
1994
1995 </li>
1996
1997         <li class="md-nav__item">
1998   <a href="#acpmenuxml" class="md-nav__link">
1999     acpMenu.xml
2000   </a>
2001
2002     <nav class="md-nav" aria-label="acpMenu.xml">
2003       <ul class="md-nav__list">
2004
2005           <li class="md-nav__item">
2006   <a href="#renamed-categories" class="md-nav__link">
2007     Renamed Categories
2008   </a>
2009
2010 </li>
2011
2012           <li class="md-nav__item">
2013   <a href="#submenu-items" class="md-nav__link">
2014     Submenu Items
2015   </a>
2016
2017 </li>
2018
2019           <li class="md-nav__item">
2020   <a href="#example_1" class="md-nav__link">
2021     Example
2022   </a>
2023
2024 </li>
2025
2026           <li class="md-nav__item">
2027   <a href="#common-icon-names" class="md-nav__link">
2028     Common Icon Names
2029   </a>
2030
2031 </li>
2032
2033       </ul>
2034     </nav>
2035
2036 </li>
2037
2038         <li class="md-nav__item">
2039   <a href="#boxxml" class="md-nav__link">
2040     box.xml
2041   </a>
2042
2043 </li>
2044
2045         <li class="md-nav__item">
2046   <a href="#cronjobxml" class="md-nav__link">
2047     cronjob.xml
2048   </a>
2049
2050 </li>
2051
2052         <li class="md-nav__item">
2053   <a href="#eventlistenerxml" class="md-nav__link">
2054     eventListener.xml
2055   </a>
2056
2057 </li>
2058
2059         <li class="md-nav__item">
2060   <a href="#menuxml" class="md-nav__link">
2061     menu.xml
2062   </a>
2063
2064 </li>
2065
2066         <li class="md-nav__item">
2067   <a href="#menuitemxml" class="md-nav__link">
2068     menuItem.xml
2069   </a>
2070
2071 </li>
2072
2073         <li class="md-nav__item">
2074   <a href="#objecttypexml" class="md-nav__link">
2075     objectType.xml
2076   </a>
2077
2078 </li>
2079
2080         <li class="md-nav__item">
2081   <a href="#optionxml" class="md-nav__link">
2082     option.xml
2083   </a>
2084
2085 </li>
2086
2087         <li class="md-nav__item">
2088   <a href="#pagexml" class="md-nav__link">
2089     page.xml
2090   </a>
2091
2092 </li>
2093
2094         <li class="md-nav__item">
2095   <a href="#pagemenuxml" class="md-nav__link">
2096     pageMenu.xml
2097   </a>
2098
2099 </li>
2100
2101     </ul>
2102
2103 </nav>
2104                   </div>
2105                 </div>
2106               </div>
2107
2108
2109           <div class="md-content" data-md-component="content">
2110             <article class="md-content__inner md-typeset">
2111
2112
2113                   <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">
2114                     <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>
2115                   </a>
2116
2117
2118                 <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>
2119 <h2 id="packagexml">package.xml<a class="headerlink" href="#packagexml" title="Permanent link">#</a></h2>
2120 <h3 id="short-instructions">Short Instructions<a class="headerlink" href="#short-instructions" title="Permanent link">#</a></h3>
2121 <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>
2122 <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>
2123 <h3 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h3>
2124 <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>
2125     <span class="c">&lt;!-- assumes `eventListener.xml` --&gt;</span>
2126     <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;eventListener&quot;</span> <span class="nt">/&gt;</span>
2127     <span class="c">&lt;!-- assumes `install.sql` --&gt;</span>
2128     <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;sql&quot;</span> <span class="nt">/&gt;</span>
2129     <span class="c">&lt;!-- assumes `language/*.xml` --&gt;</span>
2130     <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;language&quot;</span> <span class="nt">/&gt;</span>
2131
2132     <span class="c">&lt;!-- exceptions --&gt;</span>
2133
2134     <span class="c">&lt;!-- assumes `files.tar` --&gt;</span>
2135     <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;file&quot;</span> <span class="nt">/&gt;</span>
2136     <span class="c">&lt;!-- no default value, requires relative path --&gt;</span>
2137     <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>
2138 <span class="nt">&lt;/instructions&gt;</span>
2139 </code></pre></div>
2140 <h3 id="exceptions">Exceptions<a class="headerlink" href="#exceptions" title="Permanent link">#</a></h3>
2141 <div class="admonition info">
2142 <p class="admonition-title">These exceptions represent the built-in PIPs only, 3rd party plugins and apps may define their own exceptions.</p>
2143 </div>
2144 <table>
2145 <thead>
2146 <tr>
2147 <th>PIP</th>
2148 <th>Default Value</th>
2149 </tr>
2150 </thead>
2151 <tbody>
2152 <tr>
2153 <td><code>acpTemplate</code></td>
2154 <td><code>acptemplates.tar</code></td>
2155 </tr>
2156 <tr>
2157 <td><code>file</code></td>
2158 <td><code>files.tar</code></td>
2159 </tr>
2160 <tr>
2161 <td><code>language</code></td>
2162 <td><code>language/*.xml</code></td>
2163 </tr>
2164 <tr>
2165 <td><code>script</code></td>
2166 <td>(No default value)</td>
2167 </tr>
2168 <tr>
2169 <td><code>sql</code></td>
2170 <td><code>install.sql</code></td>
2171 </tr>
2172 <tr>
2173 <td><code>template</code></td>
2174 <td><code>templates.tar</code></td>
2175 </tr>
2176 </tbody>
2177 </table>
2178 <h2 id="acpmenuxml">acpMenu.xml<a class="headerlink" href="#acpmenuxml" title="Permanent link">#</a></h2>
2179 <h3 id="renamed-categories">Renamed Categories<a class="headerlink" href="#renamed-categories" title="Permanent link">#</a></h3>
2180 <p>The following categories have been renamed, menu items need to be adjusted to reflect the new names:</p>
2181 <table>
2182 <thead>
2183 <tr>
2184 <th>Old Value</th>
2185 <th>New Value</th>
2186 </tr>
2187 </thead>
2188 <tbody>
2189 <tr>
2190 <td><code>wcf.acp.menu.link.system</code></td>
2191 <td><code>wcf.acp.menu.link.configuration</code></td>
2192 </tr>
2193 <tr>
2194 <td><code>wcf.acp.menu.link.display</code></td>
2195 <td><code>wcf.acp.menu.link.customization</code></td>
2196 </tr>
2197 <tr>
2198 <td><code>wcf.acp.menu.link.community</code></td>
2199 <td><code>wcf.acp.menu.link.application</code></td>
2200 </tr>
2201 </tbody>
2202 </table>
2203 <h3 id="submenu-items">Submenu Items<a class="headerlink" href="#submenu-items" title="Permanent link">#</a></h3>
2204 <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>
2205 <h3 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">#</a></h3>
2206 <div class="highlight"><pre><span></span><code><span class="c">&lt;!-- category --&gt;</span>
2207 <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>
2208     <span class="nt">&lt;parent&gt;</span>wcf.acp.menu.link.user<span class="nt">&lt;/parent&gt;</span>
2209     <span class="nt">&lt;showorder&gt;</span>2<span class="nt">&lt;/showorder&gt;</span>
2210 <span class="nt">&lt;/acpmenuitem&gt;</span>
2211
2212 <span class="c">&lt;!-- menu item --&gt;</span>
2213 <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>
2214     <span class="nt">&lt;controller&gt;</span>wcf\acp\page\UserGroupListPage<span class="nt">&lt;/controller&gt;</span>
2215     <span class="nt">&lt;parent&gt;</span>wcf.acp.menu.link.group<span class="nt">&lt;/parent&gt;</span>
2216     <span class="nt">&lt;permissions&gt;</span>admin.user.canEditGroup,admin.user.canDeleteGroup<span class="nt">&lt;/permissions&gt;</span>
2217 <span class="nt">&lt;/acpmenuitem&gt;</span>
2218 <span class="c">&lt;!-- menu item action --&gt;</span>
2219 <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>
2220     <span class="nt">&lt;controller&gt;</span>wcf\acp\form\UserGroupAddForm<span class="nt">&lt;/controller&gt;</span>
2221     <span class="c">&lt;!-- actions are defined by menu items of menu items --&gt;</span>
2222     <span class="nt">&lt;parent&gt;</span>wcf.acp.menu.link.group.list<span class="nt">&lt;/parent&gt;</span>
2223     <span class="nt">&lt;permissions&gt;</span>admin.user.canAddGroup<span class="nt">&lt;/permissions&gt;</span>
2224     <span class="c">&lt;!-- required FontAwesome icon name used for display --&gt;</span>
2225     <span class="nt">&lt;icon&gt;</span>fa-plus<span class="nt">&lt;/icon&gt;</span>
2226 <span class="nt">&lt;/acpmenuitem&gt;</span>
2227 </code></pre></div>
2228 <h3 id="common-icon-names">Common Icon Names<a class="headerlink" href="#common-icon-names" title="Permanent link">#</a></h3>
2229 <p>You should use the same icon names for the (logically) same task, unifying the meaning of items and making the actions predictable.</p>
2230 <table>
2231 <thead>
2232 <tr>
2233 <th>Meaning</th>
2234 <th>Icon Name</th>
2235 <th>Result</th>
2236 </tr>
2237 </thead>
2238 <tbody>
2239 <tr>
2240 <td>Add or create</td>
2241 <td><code>fa-plus</code></td>
2242 <td><i class="fa fa-plus"></i></td>
2243 </tr>
2244 <tr>
2245 <td>Search</td>
2246 <td><code>fa-search</code></td>
2247 <td><i class="fa fa-search"></i></td>
2248 </tr>
2249 <tr>
2250 <td>Upload</td>
2251 <td><code>fa-upload</code></td>
2252 <td><i class="fa fa-upload"></i></td>
2253 </tr>
2254 </tbody>
2255 </table>
2256 <h2 id="boxxml">box.xml<a class="headerlink" href="#boxxml" title="Permanent link">#</a></h2>
2257 <p>The <a href="../../../package/pip/box/">box</a> PIP has been added.</p>
2258 <h2 id="cronjobxml">cronjob.xml<a class="headerlink" href="#cronjobxml" title="Permanent link">#</a></h2>
2259 <div class="admonition warning">
2260 <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>
2261 </div>
2262 <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>
2263 <h2 id="eventlistenerxml">eventListener.xml<a class="headerlink" href="#eventlistenerxml" title="Permanent link">#</a></h2>
2264 <div class="admonition warning">
2265 <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>
2266 </div>
2267 <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>
2268 <h2 id="menuxml">menu.xml<a class="headerlink" href="#menuxml" title="Permanent link">#</a></h2>
2269 <p>The <a href="../../../package/pip/menu/">menu</a> PIP has been added.</p>
2270 <h2 id="menuitemxml">menuItem.xml<a class="headerlink" href="#menuitemxml" title="Permanent link">#</a></h2>
2271 <p>The <a href="../../../package/pip/menu-item/">menuItem</a> PIP has been added.</p>
2272 <h2 id="objecttypexml">objectType.xml<a class="headerlink" href="#objecttypexml" title="Permanent link">#</a></h2>
2273 <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>
2274 <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>
2275 <h2 id="optionxml">option.xml<a class="headerlink" href="#optionxml" title="Permanent link">#</a></h2>
2276 <p>The <code>module.display</code> category has been renamed into <code>module.customization</code>.</p>
2277 <h2 id="pagexml">page.xml<a class="headerlink" href="#pagexml" title="Permanent link">#</a></h2>
2278 <p>The <a href="../../../package/pip/page/">page</a> PIP has been added.</p>
2279 <h2 id="pagemenuxml">pageMenu.xml<a class="headerlink" href="#pagemenuxml" title="Permanent link">#</a></h2>
2280 <p>The <code>pageMenu.xml</code> has been superseded by the <code>page.xml</code> and is no longer available.</p>
2281
2282
2283
2284
2285 <hr>
2286 <div class="md-source-date">
2287   <small>
2288
2289       Last update: 2021-01-08
2290
2291   </small>
2292 </div>
2293
2294
2295
2296
2297
2298
2299
2300
2301             </article>
2302           </div>
2303         </div>
2304
2305       </main>
2306
2307
2308 <footer class="md-footer">
2309
2310     <nav class="md-footer__inner md-grid" aria-label="Footer">
2311
2312         <a href="../css/" class="md-footer__link md-footer__link--prev" rel="prev">
2313           <div class="md-footer__button md-icon">
2314             <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>
2315           </div>
2316           <div class="md-footer__title">
2317             <div class="md-ellipsis">
2318               <span class="md-footer__direction">
2319                 Previous
2320               </span>
2321               CSS
2322             </div>
2323           </div>
2324         </a>
2325
2326
2327         <a href="../../../tutorial/series/overview/" class="md-footer__link md-footer__link--next" rel="next">
2328           <div class="md-footer__title">
2329             <div class="md-ellipsis">
2330               <span class="md-footer__direction">
2331                 Next
2332               </span>
2333               Overview
2334             </div>
2335           </div>
2336           <div class="md-footer__button md-icon">
2337             <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>
2338           </div>
2339         </a>
2340
2341     </nav>
2342
2343   <div class="md-footer-meta md-typeset">
2344     <div class="md-footer-meta__inner md-grid">
2345       <div class="md-footer-copyright">
2346
2347           <div class="md-footer-copyright__highlight">
2348             Copyright © 2020 WoltLab GmbH
2349           </div>
2350
2351         Made with
2352         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2353           Material for MkDocs
2354         </a>
2355
2356       </div>
2357       <div class="md-footer-copyright">
2358         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2359         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2360 </div>
2361     </div>
2362   </div>
2363 </footer>
2364
2365     </div>
2366     <div class="md-dialog" data-md-component="dialog">
2367       <div class="md-dialog__inner md-typeset"></div>
2368     </div>
2369     <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>
2370
2371
2372       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2373
2374
2375   </body>
2376 </html>