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