5.4/package/package-xml/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.xml - 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="#packagexml" 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.xml
 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         TypeScript and JavaScript API
 617         <span class="md-nav__icon md-icon"></span>
 618       </label>
 619       <nav class="md-nav" aria-label="TypeScript and 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           TypeScript and 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     <li class="md-nav__item">
 643       <a href="../../javascript/typescript/" class="md-nav__link">
 644         TypeScript
 645       </a>
 646     </li>
 647
 648
 649
 650
 651
 652
 653
 654
 655     <li class="md-nav__item md-nav__item--nested">
 656
 657
 658         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 659
 660       <label class="md-nav__link" for="__nav_4_3">
 661         New API
 662         <span class="md-nav__icon md-icon"></span>
 663       </label>
 664       <nav class="md-nav" aria-label="New API" data-md-level="2">
 665         <label class="md-nav__title" for="__nav_4_3">
 666           <span class="md-nav__icon md-icon"></span>
 667           New API
 668         </label>
 669         <ul class="md-nav__list" data-md-scrollfix>
 670
 671
 672
 673
 674
 675     <li class="md-nav__item">
 676       <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
 677         Writing a module
 678       </a>
 679     </li>
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item">
 688       <a href="../../javascript/new-api_data-structures/" class="md-nav__link">
 689         Data Structures
 690       </a>
 691     </li>
 692
 693
 694
 695
 696
 697
 698
 699     <li class="md-nav__item">
 700       <a href="../../javascript/new-api_core/" class="md-nav__link">
 701         Core Functions
 702       </a>
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../javascript/new-api_dom/" class="md-nav__link">
 713         DOM
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../javascript/new-api_events/" class="md-nav__link">
 725         Event Handling
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735     <li class="md-nav__item">
 736       <a href="../../javascript/new-api_ajax/" class="md-nav__link">
 737         Ajax
 738       </a>
 739     </li>
 740
 741
 742
 743
 744
 745
 746
 747     <li class="md-nav__item">
 748       <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
 749         Dialogs
 750       </a>
 751     </li>
 752
 753
 754
 755
 756
 757
 758
 759     <li class="md-nav__item">
 760       <a href="../../javascript/new-api_browser/" class="md-nav__link">
 761         Browser and Screen Sizes
 762       </a>
 763     </li>
 764
 765
 766
 767
 768
 769
 770
 771     <li class="md-nav__item">
 772       <a href="../../javascript/new-api_ui/" class="md-nav__link">
 773         User Interface
 774       </a>
 775     </li>
 776
 777
 778
 779         </ul>
 780       </nav>
 781     </li>
 782
 783
 784
 785
 786
 787
 788
 789     <li class="md-nav__item">
 790       <a href="../../javascript/legacy-api/" class="md-nav__link">
 791         Legacy API
 792       </a>
 793     </li>
 794
 795
 796
 797
 798
 799
 800
 801     <li class="md-nav__item">
 802       <a href="../../javascript/helper-functions/" class="md-nav__link">
 803         Helper Functions
 804       </a>
 805     </li>
 806
 807
 808
 809
 810
 811
 812
 813     <li class="md-nav__item">
 814       <a href="../../javascript/code-snippets/" class="md-nav__link">
 815         Code Snippets
 816       </a>
 817     </li>
 818
 819
 820
 821         </ul>
 822       </nav>
 823     </li>
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 838
 839
 840         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 841
 842       <label class="md-nav__link" for="__nav_5">
 843         Package Components
 844         <span class="md-nav__icon md-icon"></span>
 845       </label>
 846       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 847         <label class="md-nav__title" for="__nav_5">
 848           <span class="md-nav__icon md-icon"></span>
 849           Package Components
 850         </label>
 851         <ul class="md-nav__list" data-md-scrollfix>
 852
 853
 854
 855
 856
 857
 858
 859     <li class="md-nav__item md-nav__item--active">
 860
 861       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 862
 863
 864
 865
 866         <label class="md-nav__link md-nav__link--active" for="__toc">
 867           package.xml
 868           <span class="md-nav__icon md-icon"></span>
 869         </label>
 870
 871       <a href="./" class="md-nav__link md-nav__link--active">
 872         package.xml
 873       </a>
 874
 875
 876 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 877
 878
 879
 880
 881
 882     <label class="md-nav__title" for="__toc">
 883       <span class="md-nav__icon md-icon"></span>
 884       Table of contents
 885     </label>
 886     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 887
 888         <li class="md-nav__item">
 889   <a href="#example" class="md-nav__link">
 890     Example
 891   </a>
 892
 893 </li>
 894
 895         <li class="md-nav__item">
 896   <a href="#elements" class="md-nav__link">
 897     Elements
 898   </a>
 899
 900     <nav class="md-nav" aria-label="Elements">
 901       <ul class="md-nav__list">
 902
 903           <li class="md-nav__item">
 904   <a href="#package" class="md-nav__link">
 905     &lt;package&gt;
 906   </a>
 907
 908 </li>
 909
 910           <li class="md-nav__item">
 911   <a href="#packageinformation" class="md-nav__link">
 912     &lt;packageinformation&gt;
 913   </a>
 914
 915     <nav class="md-nav" aria-label="&lt;packageinformation&gt;">
 916       <ul class="md-nav__list">
 917
 918           <li class="md-nav__item">
 919   <a href="#packagename" class="md-nav__link">
 920     &lt;packagename&gt;
 921   </a>
 922
 923 </li>
 924
 925           <li class="md-nav__item">
 926   <a href="#packagedescription" class="md-nav__link">
 927     &lt;packagedescription&gt;
 928   </a>
 929
 930 </li>
 931
 932           <li class="md-nav__item">
 933   <a href="#version" class="md-nav__link">
 934     &lt;version&gt;
 935   </a>
 936
 937 </li>
 938
 939           <li class="md-nav__item">
 940   <a href="#date" class="md-nav__link">
 941     &lt;date&gt;
 942   </a>
 943
 944 </li>
 945
 946       </ul>
 947     </nav>
 948
 949 </li>
 950
 951           <li class="md-nav__item">
 952   <a href="#authorinformation" class="md-nav__link">
 953     &lt;authorinformation&gt;
 954   </a>
 955
 956     <nav class="md-nav" aria-label="&lt;authorinformation&gt;">
 957       <ul class="md-nav__list">
 958
 959           <li class="md-nav__item">
 960   <a href="#author" class="md-nav__link">
 961     &lt;author&gt;
 962   </a>
 963
 964 </li>
 965
 966           <li class="md-nav__item">
 967   <a href="#authorurl" class="md-nav__link">
 968     &lt;authorurl&gt;
 969   </a>
 970
 971 </li>
 972
 973       </ul>
 974     </nav>
 975
 976 </li>
 977
 978           <li class="md-nav__item">
 979   <a href="#requiredpackages" class="md-nav__link">
 980     &lt;requiredpackages&gt;
 981   </a>
 982
 983     <nav class="md-nav" aria-label="&lt;requiredpackages&gt;">
 984       <ul class="md-nav__list">
 985
 986           <li class="md-nav__item">
 987   <a href="#requiredpackage" class="md-nav__link">
 988     &lt;requiredpackage&gt;
 989   </a>
 990
 991 </li>
 992
 993       </ul>
 994     </nav>
 995
 996 </li>
 997
 998           <li class="md-nav__item">
 999   <a href="#optionalpackage" class="md-nav__link">
1000     &lt;optionalpackage&gt;
1001   </a>
1002
1003     <nav class="md-nav" aria-label="&lt;optionalpackage&gt;">
1004       <ul class="md-nav__list">
1005
1006           <li class="md-nav__item">
1007   <a href="#optionalpackage_1" class="md-nav__link">
1008     &lt;optionalpackage&gt;
1009   </a>
1010
1011 </li>
1012
1013       </ul>
1014     </nav>
1015
1016 </li>
1017
1018           <li class="md-nav__item">
1019   <a href="#excludedpackages" class="md-nav__link">
1020     &lt;excludedpackages&gt;
1021   </a>
1022
1023     <nav class="md-nav" aria-label="&lt;excludedpackages&gt;">
1024       <ul class="md-nav__list">
1025
1026           <li class="md-nav__item">
1027   <a href="#excludedpackage" class="md-nav__link">
1028     &lt;excludedpackage&gt;
1029   </a>
1030
1031 </li>
1032
1033       </ul>
1034     </nav>
1035
1036 </li>
1037
1038           <li class="md-nav__item">
1039   <a href="#compatibility" class="md-nav__link">
1040     &lt;compatibility&gt;
1041   </a>
1042
1043     <nav class="md-nav" aria-label="&lt;compatibility&gt;">
1044       <ul class="md-nav__list">
1045
1046           <li class="md-nav__item">
1047   <a href="#existing-api-versions" class="md-nav__link">
1048     Existing API versions
1049   </a>
1050
1051 </li>
1052
1053       </ul>
1054     </nav>
1055
1056 </li>
1057
1058           <li class="md-nav__item">
1059   <a href="#instructions" class="md-nav__link">
1060     &lt;instructions&gt;
1061   </a>
1062
1063     <nav class="md-nav" aria-label="&lt;instructions&gt;">
1064       <ul class="md-nav__list">
1065
1066           <li class="md-nav__item">
1067   <a href="#instructions-typeinstall" class="md-nav__link">
1068     &lt;instructions type="install"&gt;
1069   </a>
1070
1071 </li>
1072
1073           <li class="md-nav__item">
1074   <a href="#instructions-typeupdate-fromversion" class="md-nav__link">
1075     &lt;instructions type="update" fromversion="…"&gt;
1076   </a>
1077
1078 </li>
1079
1080           <li class="md-nav__item">
1081   <a href="#instruction" class="md-nav__link">
1082     &lt;instruction&gt;
1083   </a>
1084
1085 </li>
1086
1087           <li class="md-nav__item">
1088   <a href="#void" class="md-nav__link">
1089     &lt;void/&gt;
1090   </a>
1091
1092 </li>
1093
1094       </ul>
1095     </nav>
1096
1097 </li>
1098
1099       </ul>
1100     </nav>
1101
1102 </li>
1103
1104     </ul>
1105
1106 </nav>
1107
1108     </li>
1109
1110
1111
1112
1113
1114
1115
1116
1117     <li class="md-nav__item md-nav__item--nested">
1118
1119
1120         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1121
1122       <label class="md-nav__link" for="__nav_5_2">
1123         PIPs
1124         <span class="md-nav__icon md-icon"></span>
1125       </label>
1126       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1127         <label class="md-nav__title" for="__nav_5_2">
1128           <span class="md-nav__icon md-icon"></span>
1129           PIPs
1130         </label>
1131         <ul class="md-nav__list" data-md-scrollfix>
1132
1133
1134
1135
1136
1137     <li class="md-nav__item">
1138       <a href="../pip/" class="md-nav__link">
1139         Overview
1140       </a>
1141     </li>
1142
1143
1144
1145
1146
1147
1148
1149     <li class="md-nav__item">
1150       <a href="../pip/acl-option/" class="md-nav__link">
1151         aclOption
1152       </a>
1153     </li>
1154
1155
1156
1157
1158
1159
1160
1161     <li class="md-nav__item">
1162       <a href="../pip/acp-menu/" class="md-nav__link">
1163         acpMenu
1164       </a>
1165     </li>
1166
1167
1168
1169
1170
1171
1172
1173     <li class="md-nav__item">
1174       <a href="../pip/acp-search-provider/" class="md-nav__link">
1175         acpSearchProvider
1176       </a>
1177     </li>
1178
1179
1180
1181
1182
1183
1184
1185     <li class="md-nav__item">
1186       <a href="../pip/acp-template/" class="md-nav__link">
1187         acpTemplate
1188       </a>
1189     </li>
1190
1191
1192
1193
1194
1195
1196
1197     <li class="md-nav__item">
1198       <a href="../pip/bbcode/" class="md-nav__link">
1199         bbcode
1200       </a>
1201     </li>
1202
1203
1204
1205
1206
1207
1208
1209     <li class="md-nav__item">
1210       <a href="../pip/box/" class="md-nav__link">
1211         box
1212       </a>
1213     </li>
1214
1215
1216
1217
1218
1219
1220
1221     <li class="md-nav__item">
1222       <a href="../pip/clipboard-action/" class="md-nav__link">
1223         clipboardAction
1224       </a>
1225     </li>
1226
1227
1228
1229
1230
1231
1232
1233     <li class="md-nav__item">
1234       <a href="../pip/core-object/" class="md-nav__link">
1235         coreObject
1236       </a>
1237     </li>
1238
1239
1240
1241
1242
1243
1244
1245     <li class="md-nav__item">
1246       <a href="../pip/cronjob/" class="md-nav__link">
1247         cronjob
1248       </a>
1249     </li>
1250
1251
1252
1253
1254
1255
1256
1257     <li class="md-nav__item">
1258       <a href="../pip/event-listener/" class="md-nav__link">
1259         eventListener
1260       </a>
1261     </li>
1262
1263
1264
1265
1266
1267
1268
1269     <li class="md-nav__item">
1270       <a href="../pip/file/" class="md-nav__link">
1271         file
1272       </a>
1273     </li>
1274
1275
1276
1277
1278
1279
1280
1281     <li class="md-nav__item">
1282       <a href="../pip/language/" class="md-nav__link">
1283         language
1284       </a>
1285     </li>
1286
1287
1288
1289
1290
1291
1292
1293     <li class="md-nav__item">
1294       <a href="../pip/media-provider/" class="md-nav__link">
1295         mediaProvider
1296       </a>
1297     </li>
1298
1299
1300
1301
1302
1303
1304
1305     <li class="md-nav__item">
1306       <a href="../pip/menu/" class="md-nav__link">
1307         menu
1308       </a>
1309     </li>
1310
1311
1312
1313
1314
1315
1316
1317     <li class="md-nav__item">
1318       <a href="../pip/menu-item/" class="md-nav__link">
1319         menuItem
1320       </a>
1321     </li>
1322
1323
1324
1325
1326
1327
1328
1329     <li class="md-nav__item">
1330       <a href="../pip/object-type/" class="md-nav__link">
1331         objectType
1332       </a>
1333     </li>
1334
1335
1336
1337
1338
1339
1340
1341     <li class="md-nav__item">
1342       <a href="../pip/object-type-definition/" class="md-nav__link">
1343         objectTypeDefinition
1344       </a>
1345     </li>
1346
1347
1348
1349
1350
1351
1352
1353     <li class="md-nav__item">
1354       <a href="../pip/option/" class="md-nav__link">
1355         option
1356       </a>
1357     </li>
1358
1359
1360
1361
1362
1363
1364
1365     <li class="md-nav__item">
1366       <a href="../pip/page/" class="md-nav__link">
1367         page
1368       </a>
1369     </li>
1370
1371
1372
1373
1374
1375
1376
1377     <li class="md-nav__item">
1378       <a href="../pip/pip/" class="md-nav__link">
1379         pip
1380       </a>
1381     </li>
1382
1383
1384
1385
1386
1387
1388
1389     <li class="md-nav__item">
1390       <a href="../pip/script/" class="md-nav__link">
1391         script
1392       </a>
1393     </li>
1394
1395
1396
1397
1398
1399
1400
1401     <li class="md-nav__item">
1402       <a href="../pip/smiley/" class="md-nav__link">
1403         smiley
1404       </a>
1405     </li>
1406
1407
1408
1409
1410
1411
1412
1413     <li class="md-nav__item">
1414       <a href="../pip/sql/" class="md-nav__link">
1415         sql
1416       </a>
1417     </li>
1418
1419
1420
1421
1422
1423
1424
1425     <li class="md-nav__item">
1426       <a href="../pip/style/" class="md-nav__link">
1427         style
1428       </a>
1429     </li>
1430
1431
1432
1433
1434
1435
1436
1437     <li class="md-nav__item">
1438       <a href="../pip/template/" class="md-nav__link">
1439         template
1440       </a>
1441     </li>
1442
1443
1444
1445
1446
1447
1448
1449     <li class="md-nav__item">
1450       <a href="../pip/template-listener/" class="md-nav__link">
1451         templateListener
1452       </a>
1453     </li>
1454
1455
1456
1457
1458
1459
1460
1461     <li class="md-nav__item">
1462       <a href="../pip/user-group-option/" class="md-nav__link">
1463         userGroupOption
1464       </a>
1465     </li>
1466
1467
1468
1469
1470
1471
1472
1473     <li class="md-nav__item">
1474       <a href="../pip/user-menu/" class="md-nav__link">
1475         userMenu
1476       </a>
1477     </li>
1478
1479
1480
1481
1482
1483
1484
1485     <li class="md-nav__item">
1486       <a href="../pip/user-notification-event/" class="md-nav__link">
1487         userNotificationEvent
1488       </a>
1489     </li>
1490
1491
1492
1493
1494
1495
1496
1497     <li class="md-nav__item">
1498       <a href="../pip/user-option/" class="md-nav__link">
1499         userOption
1500       </a>
1501     </li>
1502
1503
1504
1505
1506
1507
1508
1509     <li class="md-nav__item">
1510       <a href="../pip/user-profile-menu/" class="md-nav__link">
1511         userProfileMenu
1512       </a>
1513     </li>
1514
1515
1516
1517         </ul>
1518       </nav>
1519     </li>
1520
1521
1522
1523
1524
1525
1526
1527     <li class="md-nav__item">
1528       <a href="../database-php-api/" class="md-nav__link">
1529         Database PHP API
1530       </a>
1531     </li>
1532
1533
1534
1535         </ul>
1536       </nav>
1537     </li>
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549     <li class="md-nav__item md-nav__item--nested">
1550
1551
1552         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1553
1554       <label class="md-nav__link" for="__nav_6">
1555         Migration
1556         <span class="md-nav__icon md-icon"></span>
1557       </label>
1558       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1559         <label class="md-nav__title" for="__nav_6">
1560           <span class="md-nav__icon md-icon"></span>
1561           Migration
1562         </label>
1563         <ul class="md-nav__list" data-md-scrollfix>
1564
1565
1566
1567
1568
1569
1570     <li class="md-nav__item md-nav__item--nested">
1571
1572
1573         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1574
1575       <label class="md-nav__link" for="__nav_6_1">
1576         Migrating from WSC 5.3
1577         <span class="md-nav__icon md-icon"></span>
1578       </label>
1579       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1580         <label class="md-nav__title" for="__nav_6_1">
1581           <span class="md-nav__icon md-icon"></span>
1582           Migrating from WSC 5.3
1583         </label>
1584         <ul class="md-nav__list" data-md-scrollfix>
1585
1586
1587
1588
1589
1590     <li class="md-nav__item">
1591       <a href="../../migration/wsc53/php/" class="md-nav__link">
1592         PHP API
1593       </a>
1594     </li>
1595
1596
1597
1598
1599
1600
1601
1602     <li class="md-nav__item">
1603       <a href="../../migration/wsc53/session/" class="md-nav__link">
1604         Session Handling and Authentication
1605       </a>
1606     </li>
1607
1608
1609
1610
1611
1612
1613
1614     <li class="md-nav__item">
1615       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1616         TypeScript and JavaScript
1617       </a>
1618     </li>
1619
1620
1621
1622
1623
1624
1625
1626     <li class="md-nav__item">
1627       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1628         Templates
1629       </a>
1630     </li>
1631
1632
1633
1634
1635
1636
1637
1638     <li class="md-nav__item">
1639       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1640         Third Party Libraries
1641       </a>
1642     </li>
1643
1644
1645
1646         </ul>
1647       </nav>
1648     </li>
1649
1650
1651
1652
1653
1654
1655
1656
1657     <li class="md-nav__item md-nav__item--nested">
1658
1659
1660         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1661
1662       <label class="md-nav__link" for="__nav_6_2">
1663         Migrating from WSC 5.2
1664         <span class="md-nav__icon md-icon"></span>
1665       </label>
1666       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1667         <label class="md-nav__title" for="__nav_6_2">
1668           <span class="md-nav__icon md-icon"></span>
1669           Migrating from WSC 5.2
1670         </label>
1671         <ul class="md-nav__list" data-md-scrollfix>
1672
1673
1674
1675
1676
1677     <li class="md-nav__item">
1678       <a href="../../migration/wsc52/php/" class="md-nav__link">
1679         PHP API
1680       </a>
1681     </li>
1682
1683
1684
1685
1686
1687
1688
1689     <li class="md-nav__item">
1690       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1691         Templates and Languages
1692       </a>
1693     </li>
1694
1695
1696
1697
1698
1699
1700
1701     <li class="md-nav__item">
1702       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1703         Third Party Libraries
1704       </a>
1705     </li>
1706
1707
1708
1709         </ul>
1710       </nav>
1711     </li>
1712
1713
1714
1715
1716
1717
1718
1719
1720     <li class="md-nav__item md-nav__item--nested">
1721
1722
1723         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1724
1725       <label class="md-nav__link" for="__nav_6_3">
1726         Migrating from WSC 3.1
1727         <span class="md-nav__icon md-icon"></span>
1728       </label>
1729       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1730         <label class="md-nav__title" for="__nav_6_3">
1731           <span class="md-nav__icon md-icon"></span>
1732           Migrating from WSC 3.1
1733         </label>
1734         <ul class="md-nav__list" data-md-scrollfix>
1735
1736
1737
1738
1739
1740     <li class="md-nav__item">
1741       <a href="../../migration/wsc31/php/" class="md-nav__link">
1742         PHP API
1743       </a>
1744     </li>
1745
1746
1747
1748         </ul>
1749       </nav>
1750     </li>
1751
1752
1753
1754
1755
1756
1757
1758
1759     <li class="md-nav__item md-nav__item--nested">
1760
1761
1762         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1763
1764       <label class="md-nav__link" for="__nav_6_4">
1765         Migrating from WSC 3.0
1766         <span class="md-nav__icon md-icon"></span>
1767       </label>
1768       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1769         <label class="md-nav__title" for="__nav_6_4">
1770           <span class="md-nav__icon md-icon"></span>
1771           Migrating from WSC 3.0
1772         </label>
1773         <ul class="md-nav__list" data-md-scrollfix>
1774
1775
1776
1777
1778
1779     <li class="md-nav__item">
1780       <a href="../../migration/wsc30/php/" class="md-nav__link">
1781         PHP API
1782       </a>
1783     </li>
1784
1785
1786
1787
1788
1789
1790
1791     <li class="md-nav__item">
1792       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1793         JavaScript API
1794       </a>
1795     </li>
1796
1797
1798
1799
1800
1801
1802
1803     <li class="md-nav__item">
1804       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1805         Templates
1806       </a>
1807     </li>
1808
1809
1810
1811
1812
1813
1814
1815     <li class="md-nav__item">
1816       <a href="../../migration/wsc30/css/" class="md-nav__link">
1817         CSS
1818       </a>
1819     </li>
1820
1821
1822
1823
1824
1825
1826
1827     <li class="md-nav__item">
1828       <a href="../../migration/wsc30/package/" class="md-nav__link">
1829         Package Components
1830       </a>
1831     </li>
1832
1833
1834
1835         </ul>
1836       </nav>
1837     </li>
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_6_5" type="checkbox" id="__nav_6_5" >
1850
1851       <label class="md-nav__link" for="__nav_6_5">
1852         Migrating from WCF 2.1
1853         <span class="md-nav__icon md-icon"></span>
1854       </label>
1855       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1856         <label class="md-nav__title" for="__nav_6_5">
1857           <span class="md-nav__icon md-icon"></span>
1858           Migrating from WCF 2.1
1859         </label>
1860         <ul class="md-nav__list" data-md-scrollfix>
1861
1862
1863
1864
1865
1866     <li class="md-nav__item">
1867       <a href="../../migration/wcf21/php/" class="md-nav__link">
1868         PHP API
1869       </a>
1870     </li>
1871
1872
1873
1874
1875
1876
1877
1878     <li class="md-nav__item">
1879       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1880         Templates
1881       </a>
1882     </li>
1883
1884
1885
1886
1887
1888
1889
1890     <li class="md-nav__item">
1891       <a href="../../migration/wcf21/css/" class="md-nav__link">
1892         CSS
1893       </a>
1894     </li>
1895
1896
1897
1898
1899
1900
1901
1902     <li class="md-nav__item">
1903       <a href="../../migration/wcf21/package/" class="md-nav__link">
1904         Package Components
1905       </a>
1906     </li>
1907
1908
1909
1910         </ul>
1911       </nav>
1912     </li>
1913
1914
1915
1916         </ul>
1917       </nav>
1918     </li>
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930     <li class="md-nav__item md-nav__item--nested">
1931
1932
1933         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1934
1935       <label class="md-nav__link" for="__nav_7">
1936         Tutorials
1937         <span class="md-nav__icon md-icon"></span>
1938       </label>
1939       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1940         <label class="md-nav__title" for="__nav_7">
1941           <span class="md-nav__icon md-icon"></span>
1942           Tutorials
1943         </label>
1944         <ul class="md-nav__list" data-md-scrollfix>
1945
1946
1947
1948
1949
1950
1951     <li class="md-nav__item md-nav__item--nested">
1952
1953
1954         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1955
1956       <label class="md-nav__link" for="__nav_7_1">
1957         Tutorial Series
1958         <span class="md-nav__icon md-icon"></span>
1959       </label>
1960       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1961         <label class="md-nav__title" for="__nav_7_1">
1962           <span class="md-nav__icon md-icon"></span>
1963           Tutorial Series
1964         </label>
1965         <ul class="md-nav__list" data-md-scrollfix>
1966
1967
1968
1969
1970
1971     <li class="md-nav__item">
1972       <a href="../../tutorial/series/overview/" class="md-nav__link">
1973         Overview
1974       </a>
1975     </li>
1976
1977
1978
1979
1980
1981
1982
1983     <li class="md-nav__item">
1984       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1985         Part 1
1986       </a>
1987     </li>
1988
1989
1990
1991
1992
1993
1994
1995     <li class="md-nav__item">
1996       <a href="../../tutorial/series/part_2/" class="md-nav__link">
1997         Part 2
1998       </a>
1999     </li>
2000
2001
2002
2003
2004
2005
2006
2007     <li class="md-nav__item">
2008       <a href="../../tutorial/series/part_3/" class="md-nav__link">
2009         Part 3
2010       </a>
2011     </li>
2012
2013
2014
2015         </ul>
2016       </nav>
2017     </li>
2018
2019
2020
2021         </ul>
2022       </nav>
2023     </li>
2024
2025
2026
2027   </ul>
2028 </nav>
2029                   </div>
2030                 </div>
2031               </div>
2032
2033
2034
2035               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2036                 <div class="md-sidebar__scrollwrap">
2037                   <div class="md-sidebar__inner">
2038
2039 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2040
2041
2042
2043
2044
2045     <label class="md-nav__title" for="__toc">
2046       <span class="md-nav__icon md-icon"></span>
2047       Table of contents
2048     </label>
2049     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2050
2051         <li class="md-nav__item">
2052   <a href="#example" class="md-nav__link">
2053     Example
2054   </a>
2055
2056 </li>
2057
2058         <li class="md-nav__item">
2059   <a href="#elements" class="md-nav__link">
2060     Elements
2061   </a>
2062
2063     <nav class="md-nav" aria-label="Elements">
2064       <ul class="md-nav__list">
2065
2066           <li class="md-nav__item">
2067   <a href="#package" class="md-nav__link">
2068     &lt;package&gt;
2069   </a>
2070
2071 </li>
2072
2073           <li class="md-nav__item">
2074   <a href="#packageinformation" class="md-nav__link">
2075     &lt;packageinformation&gt;
2076   </a>
2077
2078     <nav class="md-nav" aria-label="&lt;packageinformation&gt;">
2079       <ul class="md-nav__list">
2080
2081           <li class="md-nav__item">
2082   <a href="#packagename" class="md-nav__link">
2083     &lt;packagename&gt;
2084   </a>
2085
2086 </li>
2087
2088           <li class="md-nav__item">
2089   <a href="#packagedescription" class="md-nav__link">
2090     &lt;packagedescription&gt;
2091   </a>
2092
2093 </li>
2094
2095           <li class="md-nav__item">
2096   <a href="#version" class="md-nav__link">
2097     &lt;version&gt;
2098   </a>
2099
2100 </li>
2101
2102           <li class="md-nav__item">
2103   <a href="#date" class="md-nav__link">
2104     &lt;date&gt;
2105   </a>
2106
2107 </li>
2108
2109       </ul>
2110     </nav>
2111
2112 </li>
2113
2114           <li class="md-nav__item">
2115   <a href="#authorinformation" class="md-nav__link">
2116     &lt;authorinformation&gt;
2117   </a>
2118
2119     <nav class="md-nav" aria-label="&lt;authorinformation&gt;">
2120       <ul class="md-nav__list">
2121
2122           <li class="md-nav__item">
2123   <a href="#author" class="md-nav__link">
2124     &lt;author&gt;
2125   </a>
2126
2127 </li>
2128
2129           <li class="md-nav__item">
2130   <a href="#authorurl" class="md-nav__link">
2131     &lt;authorurl&gt;
2132   </a>
2133
2134 </li>
2135
2136       </ul>
2137     </nav>
2138
2139 </li>
2140
2141           <li class="md-nav__item">
2142   <a href="#requiredpackages" class="md-nav__link">
2143     &lt;requiredpackages&gt;
2144   </a>
2145
2146     <nav class="md-nav" aria-label="&lt;requiredpackages&gt;">
2147       <ul class="md-nav__list">
2148
2149           <li class="md-nav__item">
2150   <a href="#requiredpackage" class="md-nav__link">
2151     &lt;requiredpackage&gt;
2152   </a>
2153
2154 </li>
2155
2156       </ul>
2157     </nav>
2158
2159 </li>
2160
2161           <li class="md-nav__item">
2162   <a href="#optionalpackage" class="md-nav__link">
2163     &lt;optionalpackage&gt;
2164   </a>
2165
2166     <nav class="md-nav" aria-label="&lt;optionalpackage&gt;">
2167       <ul class="md-nav__list">
2168
2169           <li class="md-nav__item">
2170   <a href="#optionalpackage_1" class="md-nav__link">
2171     &lt;optionalpackage&gt;
2172   </a>
2173
2174 </li>
2175
2176       </ul>
2177     </nav>
2178
2179 </li>
2180
2181           <li class="md-nav__item">
2182   <a href="#excludedpackages" class="md-nav__link">
2183     &lt;excludedpackages&gt;
2184   </a>
2185
2186     <nav class="md-nav" aria-label="&lt;excludedpackages&gt;">
2187       <ul class="md-nav__list">
2188
2189           <li class="md-nav__item">
2190   <a href="#excludedpackage" class="md-nav__link">
2191     &lt;excludedpackage&gt;
2192   </a>
2193
2194 </li>
2195
2196       </ul>
2197     </nav>
2198
2199 </li>
2200
2201           <li class="md-nav__item">
2202   <a href="#compatibility" class="md-nav__link">
2203     &lt;compatibility&gt;
2204   </a>
2205
2206     <nav class="md-nav" aria-label="&lt;compatibility&gt;">
2207       <ul class="md-nav__list">
2208
2209           <li class="md-nav__item">
2210   <a href="#existing-api-versions" class="md-nav__link">
2211     Existing API versions
2212   </a>
2213
2214 </li>
2215
2216       </ul>
2217     </nav>
2218
2219 </li>
2220
2221           <li class="md-nav__item">
2222   <a href="#instructions" class="md-nav__link">
2223     &lt;instructions&gt;
2224   </a>
2225
2226     <nav class="md-nav" aria-label="&lt;instructions&gt;">
2227       <ul class="md-nav__list">
2228
2229           <li class="md-nav__item">
2230   <a href="#instructions-typeinstall" class="md-nav__link">
2231     &lt;instructions type="install"&gt;
2232   </a>
2233
2234 </li>
2235
2236           <li class="md-nav__item">
2237   <a href="#instructions-typeupdate-fromversion" class="md-nav__link">
2238     &lt;instructions type="update" fromversion="…"&gt;
2239   </a>
2240
2241 </li>
2242
2243           <li class="md-nav__item">
2244   <a href="#instruction" class="md-nav__link">
2245     &lt;instruction&gt;
2246   </a>
2247
2248 </li>
2249
2250           <li class="md-nav__item">
2251   <a href="#void" class="md-nav__link">
2252     &lt;void/&gt;
2253   </a>
2254
2255 </li>
2256
2257       </ul>
2258     </nav>
2259
2260 </li>
2261
2262       </ul>
2263     </nav>
2264
2265 </li>
2266
2267     </ul>
2268
2269 </nav>
2270                   </div>
2271                 </div>
2272               </div>
2273
2274
2275           <div class="md-content" data-md-component="content">
2276             <article class="md-content__inner md-typeset">
2277
2278
2279                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/package-xml.md" title="Edit this page" class="md-content__button md-icon">
2280                     <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>
2281                   </a>
2282
2283
2284                 <h1 id="packagexml">package.xml<a class="headerlink" href="#packagexml" title="Permanent link">#</a></h1>
2285 <p>The <code>package.xml</code> is the core component of every package.
2286 It provides the meta data (e.g. package name, description, author) and the instruction set for a new installation and/or updating from a previous version.</p>
2287 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2288 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2289 <span class="nt">&lt;package</span> <span class="na">name=</span><span class="s">&quot;com.example.package&quot;</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span> <span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span> <span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/package.xsd&quot;</span><span class="nt">&gt;</span>
2290     <span class="nt">&lt;packageinformation&gt;</span>
2291         <span class="nt">&lt;packagename&gt;</span>Simple Package<span class="nt">&lt;/packagename&gt;</span>
2292         <span class="nt">&lt;packagedescription&gt;</span>A simple package to demonstrate the package system of WoltLab Suite Core<span class="nt">&lt;/packagedescription&gt;</span>
2293         <span class="nt">&lt;version&gt;</span>1.0.0<span class="nt">&lt;/version&gt;</span>
2294         <span class="nt">&lt;date&gt;</span>2016-12-18<span class="nt">&lt;/date&gt;</span>
2295     <span class="nt">&lt;/packageinformation&gt;</span>
2296
2297     <span class="nt">&lt;authorinformation&gt;</span>
2298         <span class="nt">&lt;author&gt;</span>YOUR NAME<span class="nt">&lt;/author&gt;</span>
2299         <span class="nt">&lt;authorurl&gt;</span>http://www.example.com<span class="nt">&lt;/authorurl&gt;</span>
2300     <span class="nt">&lt;/authorinformation&gt;</span>
2301
2302     <span class="nt">&lt;requiredpackages&gt;</span>
2303         <span class="nt">&lt;requiredpackage</span> <span class="na">minversion=</span><span class="s">&quot;3.0.0&quot;</span><span class="nt">&gt;</span>com.woltlab.wcf<span class="nt">&lt;/requiredpackage&gt;</span>
2304     <span class="nt">&lt;/requiredpackages&gt;</span>
2305
2306     <span class="nt">&lt;excludedpackages&gt;</span>
2307         <span class="nt">&lt;excludedpackage</span> <span class="na">version=</span><span class="s">&quot;6.0.0 Alpha 1&quot;</span><span class="nt">&gt;</span>com.woltlab.wcf<span class="nt">&lt;/excludedpackage&gt;</span>
2308     <span class="nt">&lt;/excludedpackages&gt;</span>
2309
2310     <span class="nt">&lt;instructions</span> <span class="na">type=</span><span class="s">&quot;install&quot;</span><span class="nt">&gt;</span>
2311         <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;file&quot;</span> <span class="nt">/&gt;</span>
2312         <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;template&quot;</span><span class="nt">&gt;</span>templates.tar<span class="nt">&lt;/instruction&gt;</span>
2313     <span class="nt">&lt;/instructions&gt;</span>
2314 <span class="nt">&lt;/package&gt;</span>
2315 </code></pre></div>
2316 <h2 id="elements">Elements<a class="headerlink" href="#elements" title="Permanent link">#</a></h2>
2317 <h3 id="package"><code>&lt;package&gt;</code><a class="headerlink" href="#package" title="Permanent link">#</a></h3>
2318 <p>The root node of every <code>package.xml</code> it contains the reference to the namespace and the location of the XML Schema Definition (XSD).</p>
2319 <p>The attribute <code>name</code> is the most important part, it holds the unique package identifier and is mandatory.
2320 It is based upon your domain name and the package name of your choice.</p>
2321 <p>For example WoltLab Suite Forum (formerly know an WoltLab Burning Board and usually abbreviated as <code>wbb</code>) is created by WoltLab which owns the domain <code>woltlab.com</code>.
2322 The resulting package identifier is <code>com.woltlab.wbb</code> (<code>&lt;tld&gt;.&lt;domain&gt;.&lt;packageName&gt;</code>).</p>
2323 <h3 id="packageinformation"><code>&lt;packageinformation&gt;</code><a class="headerlink" href="#packageinformation" title="Permanent link">#</a></h3>
2324 <p>Holds the entire meta data of the package.</p>
2325 <h4 id="packagename"><code>&lt;packagename&gt;</code><a class="headerlink" href="#packagename" title="Permanent link">#</a></h4>
2326 <p>This is the actual package name displayed to the end user, this can be anything you want, try to keep it short.
2327 It supports the attribute <code>languagecode</code> which allows you to provide the package name in different languages, please be aware that if it is not present, <code>en</code> (English) is assumed:</p>
2328 <div class="highlight"><pre><span></span><code><span class="nt">&lt;packageinformation&gt;</span>
2329     <span class="nt">&lt;packagename&gt;</span>Simple Package<span class="nt">&lt;/packagename&gt;</span>
2330     <span class="nt">&lt;packagename</span> <span class="na">languagecode=</span><span class="s">&quot;de&quot;</span><span class="nt">&gt;</span>Einfaches Paket<span class="nt">&lt;/packagename&gt;</span>
2331 <span class="nt">&lt;/packageinformation&gt;</span>
2332 </code></pre></div>
2333 <h4 id="packagedescription"><code>&lt;packagedescription&gt;</code><a class="headerlink" href="#packagedescription" title="Permanent link">#</a></h4>
2334 <p>Brief summary of the package, use it to explain what it does since the package name might not always be clear enough.
2335 The attribute <code>languagecode</code> is available here too, please reference to <a href="#packageName"><code>&lt;packagename&gt;</code></a> for details.</p>
2336 <h4 id="version"><code>&lt;version&gt;</code><a class="headerlink" href="#version" title="Permanent link">#</a></h4>
2337 <p>The package's version number, this is a string consisting of three numbers separated with a dot and optionally followed by a keyword (must be followed with another number).</p>
2338 <p>The possible keywords are:</p>
2339 <ul>
2340 <li>Alpha/dev (both is regarded to be the same)</li>
2341 <li>Beta</li>
2342 <li>RC (release candidate)</li>
2343 <li>pl (patch level)</li>
2344 </ul>
2345 <p>Valid examples:</p>
2346 <ul>
2347 <li>1.0.0</li>
2348 <li>1.12.13 Alpha 19</li>
2349 <li>7.0.0 pl 3</li>
2350 </ul>
2351 <p>Invalid examples:</p>
2352 <ul>
2353 <li>1.0.0 Beta (keyword Beta must be followed by a number)</li>
2354 <li>2.0 RC 3 (version number must consists of 3 blocks of numbers)</li>
2355 <li>1.2.3 dev 4.5 (4.5 is not an integer, 4 or 5 would be valid but not the fraction)</li>
2356 </ul>
2357 <h4 id="date"><code>&lt;date&gt;</code><a class="headerlink" href="#date" title="Permanent link">#</a></h4>
2358 <p>Must be a valid <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> date, e.g. <code>2013-12-27</code>.</p>
2359 <h3 id="authorinformation"><code>&lt;authorinformation&gt;</code><a class="headerlink" href="#authorinformation" title="Permanent link">#</a></h3>
2360 <p>Holds meta data regarding the package's author.</p>
2361 <h4 id="author"><code>&lt;author&gt;</code><a class="headerlink" href="#author" title="Permanent link">#</a></h4>
2362 <p>Can be anything you want.</p>
2363 <h4 id="authorurl"><code>&lt;authorurl&gt;</code><a class="headerlink" href="#authorurl" title="Permanent link">#</a></h4>
2364 <blockquote>
2365 <p>(optional)</p>
2366 </blockquote>
2367 <p>URL to the author's website.</p>
2368 <h3 id="requiredpackages"><code>&lt;requiredpackages&gt;</code><a class="headerlink" href="#requiredpackages" title="Permanent link">#</a></h3>
2369 <p>A list of packages including their version required for this package to work.</p>
2370 <h4 id="requiredpackage"><code>&lt;requiredpackage&gt;</code><a class="headerlink" href="#requiredpackage" title="Permanent link">#</a></h4>
2371 <p>Example:</p>
2372 <div class="highlight"><pre><span></span><code><span class="nt">&lt;requiredpackage</span> <span class="na">minversion=</span><span class="s">&quot;2.0.0&quot;</span> <span class="na">file=</span><span class="s">&quot;requirements/com.woltlab.wcf.tar&quot;</span><span class="nt">&gt;</span>com.woltlab.wcf<span class="nt">&lt;/requiredpackage&gt;</span>
2373 </code></pre></div>
2374 <p>The attribute <code>minversion</code> must be a valid version number as described in <a href="#version"><code>&lt;version&gt;</code></a>.
2375 The <code>file</code> attribute is optional and specifies the location of the required package's archive relative to the <code>package.xml</code>.</p>
2376 <h3 id="optionalpackage"><code>&lt;optionalpackage&gt;</code><a class="headerlink" href="#optionalpackage" title="Permanent link">#</a></h3>
2377 <p>A list of optional packages which can be selected by the user at the very end of the installation process.</p>
2378 <h4 id="optionalpackage_1"><code>&lt;optionalpackage&gt;</code><a class="headerlink" href="#optionalpackage_1" title="Permanent link">#</a></h4>
2379 <p>Example:</p>
2380 <div class="highlight"><pre><span></span><code><span class="nt">&lt;optionalpackage</span> <span class="na">file=</span><span class="s">&quot;optionals/com.woltlab.wcf.moderatedUserGroup.tar&quot;</span><span class="nt">&gt;</span>com.woltlab.wcf.moderatedUserGroup<span class="nt">&lt;/optionalpackage&gt;</span>
2381 </code></pre></div>
2382 <p>The <code>file</code> attribute specifies the location of the optional package's archive relative to the <code>package.xml</code>.</p>
2383 <h3 id="excludedpackages"><code>&lt;excludedpackages&gt;</code><a class="headerlink" href="#excludedpackages" title="Permanent link">#</a></h3>
2384 <p>List of packages which conflict with this package. It is not possible to install it if any of the specified packages is installed. In return you cannot install an excluded package if this package is installed.</p>
2385 <h4 id="excludedpackage"><code>&lt;excludedpackage&gt;</code><a class="headerlink" href="#excludedpackage" title="Permanent link">#</a></h4>
2386 <p>Example:</p>
2387 <div class="highlight"><pre><span></span><code><span class="nt">&lt;excludedpackage</span> <span class="na">version=</span><span class="s">&quot;3.1.0 Alpha 1&quot;</span><span class="nt">&gt;</span>com.woltlab.wcf<span class="nt">&lt;/excludedpackage&gt;</span>
2388 </code></pre></div>
2389 <p>The attribute <code>version</code> must be a valid version number as described in the <a href="#version">\&lt;version></a> section. In the example above it will be impossible to install this package in WoltLab Suite Core 3.1.0 Alpha 1 or higher.</p>
2390 <h3 id="compatibility"><code>&lt;compatibility&gt;</code><a class="headerlink" href="#compatibility" title="Permanent link">#</a></h3>
2391 <div class="admonition info">
2392 <p class="admonition-title">Available since WoltLab Suite 3.1</p>
2393 </div>
2394 <div class="admonition warning">
2395 <p class="admonition-title">With the release of WoltLab Suite 5.2 the API versions were abolished. Instead of using API versions packages should exclude version <code>6.0.0 Alpha 1</code> of <code>com.woltlab.wcf</code> going forward.</p>
2396 </div>
2397 <p>WoltLab Suite 3.1 introduced a new versioning system that focused around the API compatibility and is intended to replace the <code>&lt;excludedpackage&gt;</code> instruction for the Core for most plugins.</p>
2398 <p>The <code>&lt;compatibility&gt;</code>-tag holds a list of compatible API versions, and while only a single version is available at the time of writing, future versions will add more versions with backwards-compatibility in mind.</p>
2399 <p>Example:</p>
2400 <div class="highlight"><pre><span></span><code><span class="nt">&lt;compatibility&gt;</span>
2401     <span class="nt">&lt;api</span> <span class="na">version=</span><span class="s">&quot;2018&quot;</span> <span class="nt">/&gt;</span>
2402 <span class="nt">&lt;/compatibility&gt;</span>
2403 </code></pre></div>
2404 <h4 id="existing-api-versions">Existing API versions<a class="headerlink" href="#existing-api-versions" title="Permanent link">#</a></h4>
2405 <table>
2406 <thead>
2407 <tr>
2408 <th>WoltLab Suite Core</th>
2409 <th>API-Version</th>
2410 <th>Backwards-Compatible to API-Version</th>
2411 </tr>
2412 </thead>
2413 <tbody>
2414 <tr>
2415 <td>3.1</td>
2416 <td>2018</td>
2417 <td>n/a</td>
2418 </tr>
2419 </tbody>
2420 </table>
2421 <h3 id="instructions"><code>&lt;instructions&gt;</code><a class="headerlink" href="#instructions" title="Permanent link">#</a></h3>
2422 <p>List of instructions to be executed upon install or update. The order is important, the topmost <code>&lt;instruction&gt;</code> will be executed first.</p>
2423 <h4 id="instructions-typeinstall"><code>&lt;instructions type="install"&gt;</code><a class="headerlink" href="#instructions-typeinstall" title="Permanent link">#</a></h4>
2424 <p>List of instructions for a new installation of this package.</p>
2425 <h4 id="instructions-typeupdate-fromversion"><code>&lt;instructions type="update" fromversion="…"&gt;</code><a class="headerlink" href="#instructions-typeupdate-fromversion" title="Permanent link">#</a></h4>
2426 <p>The attribute <code>fromversion</code> must be a valid version number as described in the <a href="#version">\&lt;version></a> section and specifies a possible update from that very version to the package's version.</p>
2427 <div class="admonition warning">
2428 <p class="admonition-title">The installation process will pick exactly one update instruction, ignoring everything else. Please read the explanation below!</p>
2429 </div>
2430 <p>Example:</p>
2431 <ul>
2432 <li>Installed version: <code>1.0.0</code></li>
2433 <li>Package version: <code>1.0.2</code></li>
2434 </ul>
2435 <div class="highlight"><pre><span></span><code><span class="nt">&lt;instructions</span> <span class="na">type=</span><span class="s">&quot;update&quot;</span> <span class="na">fromversion=</span><span class="s">&quot;1.0.0&quot;</span><span class="nt">&gt;</span>
2436     <span class="c">&lt;!-- … --&gt;</span>
2437 <span class="nt">&lt;/instructions&gt;</span>
2438 <span class="nt">&lt;instructions</span> <span class="na">type=</span><span class="s">&quot;update&quot;</span> <span class="na">fromversion=</span><span class="s">&quot;1.0.1&quot;</span><span class="nt">&gt;</span>
2439     <span class="c">&lt;!-- … --&gt;</span>
2440 <span class="nt">&lt;/instructions&gt;</span>
2441 </code></pre></div>
2442 <p>In this example WoltLab Suite Core will pick the first update block since it allows an update from <code>1.0.0 -&gt; 1.0.2</code>.
2443 The other block is not considered, since the currently installed version is <code>1.0.0</code>. After applying the update block (<code>fromversion="1.0.0"</code>), the version now reads <code>1.0.2</code>.</p>
2444 <h4 id="instruction"><code>&lt;instruction&gt;</code><a class="headerlink" href="#instruction" title="Permanent link">#</a></h4>
2445 <p>Example:</p>
2446 <div class="highlight"><pre><span></span><code><span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;objectTypeDefinition&quot;</span><span class="nt">&gt;</span>objectTypeDefinition.xml<span class="nt">&lt;/instruction&gt;</span>
2447 </code></pre></div>
2448 <p>The attribute <code>type</code> specifies the instruction type which is used to determine the package installation plugin (PIP) invoked to handle its value.
2449 The value must be a valid file relative to the location of <code>package.xml</code>.
2450 Many PIPs provide default file names which are used if no value is given:</p>
2451 <div class="highlight"><pre><span></span><code><span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;objectTypeDefinition&quot;</span> <span class="nt">/&gt;</span>
2452 </code></pre></div>
2453 <p>There is a <a href="../pip/">list of all default PIPs</a> available.</p>
2454 <div class="admonition warning">
2455 <p class="admonition-title">Both the <code>type</code>-attribute and the element value are case-sensitive. Windows does not care if the file is called <code>objecttypedefinition.xml</code> but was referenced as <code>objectTypeDefinition.xml</code>, but both Linux and Mac systems will be unable to find the file.</p>
2456 </div>
2457 <p>In addition to the <code>type</code> attribute, an optional <code>run</code> attribute (with <code>standalone</code> as the only valid value) is supported which forces the installation to execute this PIP in an isolated request, allowing a single, resource-heavy PIP to execute without encountering restrictions such as PHP’s <code>memory_limit</code> or <code>max_execution_time</code>:</p>
2458 <div class="highlight"><pre><span></span><code><span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;file&quot;</span> <span class="na">run=</span><span class="s">&quot;standalone&quot;</span> <span class="nt">/&gt;</span>
2459 </code></pre></div>
2460 <h4 id="void"><code>&lt;void/&gt;</code><a class="headerlink" href="#void" title="Permanent link">#</a></h4>
2461 <p>Sometimes a package update should only adjust the metadata of the package, for example, an optional package was added.
2462 However, WoltLab Suite Core requires that the list of <code>&lt;instructions&gt;</code> is non-empty.
2463 Instead of using a dummy <code>&lt;instruction&gt;</code> that idempotently updates some PIP, the <code>&lt;void/&gt;</code> tag can be used for this use-case.</p>
2464 <p>Using the <code>&lt;void/&gt;</code> tag is only valid for <code>&lt;instructions type="update"&gt;</code> and must not be accompanied by other <code>&lt;instruction&gt;</code> tags.</p>
2465 <p>Example:</p>
2466 <div class="highlight"><pre><span></span><code><span class="nt">&lt;instructions</span> <span class="na">type=</span><span class="s">&quot;update&quot;</span> <span class="na">fromversion=</span><span class="s">&quot;1.0.0&quot;</span><span class="nt">&gt;</span>
2467     <span class="nt">&lt;void/&gt;</span>
2468 <span class="nt">&lt;/instructions&gt;</span>
2469 </code></pre></div>
2470
2471
2472
2473
2474 <hr>
2475 <div class="md-source-date">
2476   <small>
2477
2478       Last update: 2021-01-08
2479
2480   </small>
2481 </div>
2482
2483
2484
2485
2486
2487
2488
2489
2490             </article>
2491           </div>
2492         </div>
2493
2494       </main>
2495
2496
2497 <footer class="md-footer">
2498
2499     <nav class="md-footer__inner md-grid" aria-label="Footer">
2500
2501         <a href="../../javascript/code-snippets/" class="md-footer__link md-footer__link--prev" rel="prev">
2502           <div class="md-footer__button md-icon">
2503             <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>
2504           </div>
2505           <div class="md-footer__title">
2506             <div class="md-ellipsis">
2507               <span class="md-footer__direction">
2508                 Previous
2509               </span>
2510               Code Snippets
2511             </div>
2512           </div>
2513         </a>
2514
2515
2516         <a href="../pip/" class="md-footer__link md-footer__link--next" rel="next">
2517           <div class="md-footer__title">
2518             <div class="md-ellipsis">
2519               <span class="md-footer__direction">
2520                 Next
2521               </span>
2522               Overview
2523             </div>
2524           </div>
2525           <div class="md-footer__button md-icon">
2526             <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>
2527           </div>
2528         </a>
2529
2530     </nav>
2531
2532   <div class="md-footer-meta md-typeset">
2533     <div class="md-footer-meta__inner md-grid">
2534       <div class="md-footer-copyright">
2535
2536           <div class="md-footer-copyright__highlight">
2537             Copyright © 2020 WoltLab GmbH
2538           </div>
2539
2540         Made with
2541         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2542           Material for MkDocs
2543         </a>
2544
2545       </div>
2546       <div class="md-footer-copyright">
2547         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2548         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2549 </div>
2550     </div>
2551   </div>
2552 </footer>
2553
2554     </div>
2555     <div class="md-dialog" data-md-component="dialog">
2556       <div class="md-dialog__inner md-typeset"></div>
2557     </div>
2558     <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>
2559
2560
2561       <script src="../../assets/javascripts/bundle.d892486b.min.js"></script>
2562
2563
2564   </body>
2565 </html>