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.2">
  14
  15
  16
  17         <title>package.xml - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../assets/stylesheets/main.6f955dcd.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
 310     <li class="md-nav__item md-nav__item--nested">
 311
 312
 313         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 314
 315       <label class="md-nav__link" for="__nav_2_5_1">
 316         Caches
 317         <span class="md-nav__icon md-icon"></span>
 318       </label>
 319       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 320         <label class="md-nav__title" for="__nav_2_5_1">
 321           <span class="md-nav__icon md-icon"></span>
 322           Caches
 323         </label>
 324         <ul class="md-nav__list" data-md-scrollfix>
 325
 326
 327
 328
 329
 330     <li class="md-nav__item">
 331       <a href="../../php/api/caches/" class="md-nav__link">
 332         Overview
 333       </a>
 334     </li>
 335
 336
 337
 338
 339
 340
 341
 342     <li class="md-nav__item">
 343       <a href="../../php/api/caches_persistent-caches/" class="md-nav__link">
 344         Persistent Caches
 345       </a>
 346     </li>
 347
 348
 349
 350
 351
 352
 353
 354     <li class="md-nav__item">
 355       <a href="../../php/api/caches_runtime-caches/" class="md-nav__link">
 356         Runtime Caches
 357       </a>
 358     </li>
 359
 360
 361
 362         </ul>
 363       </nav>
 364     </li>
 365
 366
 367
 368
 369
 370
 371
 372     <li class="md-nav__item">
 373       <a href="../../php/api/comments/" class="md-nav__link">
 374         Comments
 375       </a>
 376     </li>
 377
 378
 379
 380
 381
 382
 383
 384     <li class="md-nav__item">
 385       <a href="../../php/api/cronjobs/" class="md-nav__link">
 386         Cronjobs
 387       </a>
 388     </li>
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../php/api/events/" class="md-nav__link">
 398         Events
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409     <li class="md-nav__item md-nav__item--nested">
 410
 411
 412         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 413
 414       <label class="md-nav__link" for="__nav_2_5_5">
 415         Form Builder
 416         <span class="md-nav__icon md-icon"></span>
 417       </label>
 418       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 419         <label class="md-nav__title" for="__nav_2_5_5">
 420           <span class="md-nav__icon md-icon"></span>
 421           Form Builder
 422         </label>
 423         <ul class="md-nav__list" data-md-scrollfix>
 424
 425
 426
 427
 428
 429     <li class="md-nav__item">
 430       <a href="../../php/api/form_builder/overview/" class="md-nav__link">
 431         Overview
 432       </a>
 433     </li>
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../php/api/form_builder/structure/" class="md-nav__link">
 443         Structure
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item">
 454       <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
 455         Fields
 456       </a>
 457     </li>
 458
 459
 460
 461
 462
 463
 464
 465     <li class="md-nav__item">
 466       <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
 467         Validation and Data
 468       </a>
 469     </li>
 470
 471
 472
 473
 474
 475
 476
 477     <li class="md-nav__item">
 478       <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
 479         Dependencies
 480       </a>
 481     </li>
 482
 483
 484
 485         </ul>
 486       </nav>
 487     </li>
 488
 489
 490
 491
 492
 493
 494
 495     <li class="md-nav__item">
 496       <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
 497         Package Installation Plugins
 498       </a>
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507     <li class="md-nav__item">
 508       <a href="../../php/api/user_activity_points/" class="md-nav__link">
 509         User Activity Points
 510       </a>
 511     </li>
 512
 513
 514
 515
 516
 517
 518
 519     <li class="md-nav__item">
 520       <a href="../../php/api/user_notifications/" class="md-nav__link">
 521         User Notifications
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531     <li class="md-nav__item">
 532       <a href="../../php/api/sitemaps/" class="md-nav__link">
 533         Sitemaps
 534       </a>
 535     </li>
 536
 537
 538
 539         </ul>
 540       </nav>
 541     </li>
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../php/code-style/" class="md-nav__link">
 551         Code Style
 552       </a>
 553     </li>
 554
 555
 556
 557
 558
 559
 560
 561     <li class="md-nav__item">
 562       <a href="../../php/apps/" class="md-nav__link">
 563         Apps
 564       </a>
 565     </li>
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../php/gdpr/" class="md-nav__link">
 575         GDPR
 576       </a>
 577     </li>
 578
 579
 580
 581         </ul>
 582       </nav>
 583     </li>
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595     <li class="md-nav__item md-nav__item--nested">
 596
 597
 598         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 599
 600       <label class="md-nav__link" for="__nav_3">
 601         Languages, Templates & CSS
 602         <span class="md-nav__icon md-icon"></span>
 603       </label>
 604       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 605         <label class="md-nav__title" for="__nav_3">
 606           <span class="md-nav__icon md-icon"></span>
 607           Languages, Templates & CSS
 608         </label>
 609         <ul class="md-nav__list" data-md-scrollfix>
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../view/languages/" class="md-nav__link">
 617         Languages
 618       </a>
 619     </li>
 620
 621
 622
 623
 624
 625
 626
 627     <li class="md-nav__item">
 628       <a href="../../view/templates/" class="md-nav__link">
 629         Templates
 630       </a>
 631     </li>
 632
 633
 634
 635
 636
 637
 638
 639     <li class="md-nav__item">
 640       <a href="../../view/template-plugins/" class="md-nav__link">
 641         Template Plugins
 642       </a>
 643     </li>
 644
 645
 646
 647
 648
 649
 650
 651     <li class="md-nav__item">
 652       <a href="../../view/css/" class="md-nav__link">
 653         CSS
 654       </a>
 655     </li>
 656
 657
 658
 659         </ul>
 660       </nav>
 661     </li>
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673     <li class="md-nav__item md-nav__item--nested">
 674
 675
 676         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 677
 678       <label class="md-nav__link" for="__nav_4">
 679         TypeScript and JavaScript API
 680         <span class="md-nav__icon md-icon"></span>
 681       </label>
 682       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 683         <label class="md-nav__title" for="__nav_4">
 684           <span class="md-nav__icon md-icon"></span>
 685           TypeScript and JavaScript API
 686         </label>
 687         <ul class="md-nav__list" data-md-scrollfix>
 688
 689
 690
 691
 692
 693     <li class="md-nav__item">
 694       <a href="../../javascript/general-usage/" class="md-nav__link">
 695         General Usage
 696       </a>
 697     </li>
 698
 699
 700
 701
 702
 703
 704
 705     <li class="md-nav__item">
 706       <a href="../../javascript/typescript/" class="md-nav__link">
 707         TypeScript
 708       </a>
 709     </li>
 710
 711
 712
 713
 714
 715
 716
 717
 718     <li class="md-nav__item md-nav__item--nested">
 719
 720
 721         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 722
 723       <label class="md-nav__link" for="__nav_4_3">
 724         New API
 725         <span class="md-nav__icon md-icon"></span>
 726       </label>
 727       <nav class="md-nav" aria-label="New API" data-md-level="2">
 728         <label class="md-nav__title" for="__nav_4_3">
 729           <span class="md-nav__icon md-icon"></span>
 730           New API
 731         </label>
 732         <ul class="md-nav__list" data-md-scrollfix>
 733
 734
 735
 736
 737
 738     <li class="md-nav__item">
 739       <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
 740         Writing a module
 741       </a>
 742     </li>
 743
 744
 745
 746
 747
 748
 749
 750     <li class="md-nav__item">
 751       <a href="../../javascript/new-api_data-structures/" class="md-nav__link">
 752         Data Structures
 753       </a>
 754     </li>
 755
 756
 757
 758
 759
 760
 761
 762     <li class="md-nav__item">
 763       <a href="../../javascript/new-api_core/" class="md-nav__link">
 764         Core Functions
 765       </a>
 766     </li>
 767
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item">
 775       <a href="../../javascript/new-api_dom/" class="md-nav__link">
 776         DOM
 777       </a>
 778     </li>
 779
 780
 781
 782
 783
 784
 785
 786     <li class="md-nav__item">
 787       <a href="../../javascript/new-api_events/" class="md-nav__link">
 788         Event Handling
 789       </a>
 790     </li>
 791
 792
 793
 794
 795
 796
 797
 798     <li class="md-nav__item">
 799       <a href="../../javascript/new-api_ajax/" class="md-nav__link">
 800         Ajax
 801       </a>
 802     </li>
 803
 804
 805
 806
 807
 808
 809
 810     <li class="md-nav__item">
 811       <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
 812         Dialogs
 813       </a>
 814     </li>
 815
 816
 817
 818
 819
 820
 821
 822     <li class="md-nav__item">
 823       <a href="../../javascript/new-api_browser/" class="md-nav__link">
 824         Browser and Screen Sizes
 825       </a>
 826     </li>
 827
 828
 829
 830
 831
 832
 833
 834     <li class="md-nav__item">
 835       <a href="../../javascript/new-api_ui/" class="md-nav__link">
 836         User Interface
 837       </a>
 838     </li>
 839
 840
 841
 842         </ul>
 843       </nav>
 844     </li>
 845
 846
 847
 848
 849
 850
 851
 852     <li class="md-nav__item">
 853       <a href="../../javascript/legacy-api/" class="md-nav__link">
 854         Legacy API
 855       </a>
 856     </li>
 857
 858
 859
 860
 861
 862
 863
 864     <li class="md-nav__item">
 865       <a href="../../javascript/helper-functions/" class="md-nav__link">
 866         Helper Functions
 867       </a>
 868     </li>
 869
 870
 871
 872
 873
 874
 875
 876     <li class="md-nav__item">
 877       <a href="../../javascript/code-snippets/" class="md-nav__link">
 878         Code Snippets
 879       </a>
 880     </li>
 881
 882
 883
 884         </ul>
 885       </nav>
 886     </li>
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 901
 902
 903         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 904
 905       <label class="md-nav__link" for="__nav_5">
 906         Package Components
 907         <span class="md-nav__icon md-icon"></span>
 908       </label>
 909       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 910         <label class="md-nav__title" for="__nav_5">
 911           <span class="md-nav__icon md-icon"></span>
 912           Package Components
 913         </label>
 914         <ul class="md-nav__list" data-md-scrollfix>
 915
 916
 917
 918
 919
 920
 921
 922     <li class="md-nav__item md-nav__item--active">
 923
 924       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 925
 926
 927
 928
 929
 930         <label class="md-nav__link md-nav__link--active" for="__toc">
 931           package.xml
 932           <span class="md-nav__icon md-icon"></span>
 933         </label>
 934
 935       <a href="./" class="md-nav__link md-nav__link--active">
 936         package.xml
 937       </a>
 938
 939
 940 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 941
 942
 943
 944
 945
 946
 947     <label class="md-nav__title" for="__toc">
 948       <span class="md-nav__icon md-icon"></span>
 949       Table of contents
 950     </label>
 951     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 952
 953         <li class="md-nav__item">
 954   <a href="#example" class="md-nav__link">
 955     Example
 956   </a>
 957
 958 </li>
 959
 960         <li class="md-nav__item">
 961   <a href="#elements" class="md-nav__link">
 962     Elements
 963   </a>
 964
 965     <nav class="md-nav" aria-label="Elements">
 966       <ul class="md-nav__list">
 967
 968           <li class="md-nav__item">
 969   <a href="#package" class="md-nav__link">
 970     &lt;package&gt;
 971   </a>
 972
 973 </li>
 974
 975           <li class="md-nav__item">
 976   <a href="#packageinformation" class="md-nav__link">
 977     &lt;packageinformation&gt;
 978   </a>
 979
 980     <nav class="md-nav" aria-label="&lt;packageinformation&gt;">
 981       <ul class="md-nav__list">
 982
 983           <li class="md-nav__item">
 984   <a href="#packagename" class="md-nav__link">
 985     &lt;packagename&gt;
 986   </a>
 987
 988 </li>
 989
 990           <li class="md-nav__item">
 991   <a href="#packagedescription" class="md-nav__link">
 992     &lt;packagedescription&gt;
 993   </a>
 994
 995 </li>
 996
 997           <li class="md-nav__item">
 998   <a href="#version" class="md-nav__link">
 999     &lt;version&gt;
1000   </a>
1001
1002 </li>
1003
1004           <li class="md-nav__item">
1005   <a href="#date" class="md-nav__link">
1006     &lt;date&gt;
1007   </a>
1008
1009 </li>
1010
1011       </ul>
1012     </nav>
1013
1014 </li>
1015
1016           <li class="md-nav__item">
1017   <a href="#authorinformation" class="md-nav__link">
1018     &lt;authorinformation&gt;
1019   </a>
1020
1021     <nav class="md-nav" aria-label="&lt;authorinformation&gt;">
1022       <ul class="md-nav__list">
1023
1024           <li class="md-nav__item">
1025   <a href="#author" class="md-nav__link">
1026     &lt;author&gt;
1027   </a>
1028
1029 </li>
1030
1031           <li class="md-nav__item">
1032   <a href="#authorurl" class="md-nav__link">
1033     &lt;authorurl&gt;
1034   </a>
1035
1036 </li>
1037
1038       </ul>
1039     </nav>
1040
1041 </li>
1042
1043           <li class="md-nav__item">
1044   <a href="#requiredpackages" class="md-nav__link">
1045     &lt;requiredpackages&gt;
1046   </a>
1047
1048     <nav class="md-nav" aria-label="&lt;requiredpackages&gt;">
1049       <ul class="md-nav__list">
1050
1051           <li class="md-nav__item">
1052   <a href="#requiredpackage" class="md-nav__link">
1053     &lt;requiredpackage&gt;
1054   </a>
1055
1056 </li>
1057
1058       </ul>
1059     </nav>
1060
1061 </li>
1062
1063           <li class="md-nav__item">
1064   <a href="#optionalpackage" class="md-nav__link">
1065     &lt;optionalpackage&gt;
1066   </a>
1067
1068     <nav class="md-nav" aria-label="&lt;optionalpackage&gt;">
1069       <ul class="md-nav__list">
1070
1071           <li class="md-nav__item">
1072   <a href="#optionalpackage_1" class="md-nav__link">
1073     &lt;optionalpackage&gt;
1074   </a>
1075
1076 </li>
1077
1078       </ul>
1079     </nav>
1080
1081 </li>
1082
1083           <li class="md-nav__item">
1084   <a href="#excludedpackages" class="md-nav__link">
1085     &lt;excludedpackages&gt;
1086   </a>
1087
1088     <nav class="md-nav" aria-label="&lt;excludedpackages&gt;">
1089       <ul class="md-nav__list">
1090
1091           <li class="md-nav__item">
1092   <a href="#excludedpackage" class="md-nav__link">
1093     &lt;excludedpackage&gt;
1094   </a>
1095
1096 </li>
1097
1098       </ul>
1099     </nav>
1100
1101 </li>
1102
1103           <li class="md-nav__item">
1104   <a href="#compatibility" class="md-nav__link">
1105     &lt;compatibility&gt;
1106   </a>
1107
1108     <nav class="md-nav" aria-label="&lt;compatibility&gt;">
1109       <ul class="md-nav__list">
1110
1111           <li class="md-nav__item">
1112   <a href="#existing-api-versions" class="md-nav__link">
1113     Existing API versions
1114   </a>
1115
1116 </li>
1117
1118       </ul>
1119     </nav>
1120
1121 </li>
1122
1123           <li class="md-nav__item">
1124   <a href="#instructions" class="md-nav__link">
1125     &lt;instructions&gt;
1126   </a>
1127
1128     <nav class="md-nav" aria-label="&lt;instructions&gt;">
1129       <ul class="md-nav__list">
1130
1131           <li class="md-nav__item">
1132   <a href="#instructions-typeinstall" class="md-nav__link">
1133     &lt;instructions type="install"&gt;
1134   </a>
1135
1136 </li>
1137
1138           <li class="md-nav__item">
1139   <a href="#instructions-typeupdate-fromversion" class="md-nav__link">
1140     &lt;instructions type="update" fromversion="…"&gt;
1141   </a>
1142
1143 </li>
1144
1145           <li class="md-nav__item">
1146   <a href="#instruction" class="md-nav__link">
1147     &lt;instruction&gt;
1148   </a>
1149
1150 </li>
1151
1152           <li class="md-nav__item">
1153   <a href="#void" class="md-nav__link">
1154     &lt;void/&gt;
1155   </a>
1156
1157 </li>
1158
1159       </ul>
1160     </nav>
1161
1162 </li>
1163
1164       </ul>
1165     </nav>
1166
1167 </li>
1168
1169     </ul>
1170
1171 </nav>
1172
1173     </li>
1174
1175
1176
1177
1178
1179
1180
1181
1182     <li class="md-nav__item md-nav__item--nested">
1183
1184
1185         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1186
1187       <label class="md-nav__link" for="__nav_5_2">
1188         PIPs
1189         <span class="md-nav__icon md-icon"></span>
1190       </label>
1191       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1192         <label class="md-nav__title" for="__nav_5_2">
1193           <span class="md-nav__icon md-icon"></span>
1194           PIPs
1195         </label>
1196         <ul class="md-nav__list" data-md-scrollfix>
1197
1198
1199
1200
1201
1202     <li class="md-nav__item">
1203       <a href="../pip/" class="md-nav__link">
1204         Overview
1205       </a>
1206     </li>
1207
1208
1209
1210
1211
1212
1213
1214     <li class="md-nav__item">
1215       <a href="../pip/acl-option/" class="md-nav__link">
1216         aclOption
1217       </a>
1218     </li>
1219
1220
1221
1222
1223
1224
1225
1226     <li class="md-nav__item">
1227       <a href="../pip/acp-menu/" class="md-nav__link">
1228         acpMenu
1229       </a>
1230     </li>
1231
1232
1233
1234
1235
1236
1237
1238     <li class="md-nav__item">
1239       <a href="../pip/acp-search-provider/" class="md-nav__link">
1240         acpSearchProvider
1241       </a>
1242     </li>
1243
1244
1245
1246
1247
1248
1249
1250     <li class="md-nav__item">
1251       <a href="../pip/acp-template/" class="md-nav__link">
1252         acpTemplate
1253       </a>
1254     </li>
1255
1256
1257
1258
1259
1260
1261
1262     <li class="md-nav__item">
1263       <a href="../pip/bbcode/" class="md-nav__link">
1264         bbcode
1265       </a>
1266     </li>
1267
1268
1269
1270
1271
1272
1273
1274     <li class="md-nav__item">
1275       <a href="../pip/box/" class="md-nav__link">
1276         box
1277       </a>
1278     </li>
1279
1280
1281
1282
1283
1284
1285
1286     <li class="md-nav__item">
1287       <a href="../pip/clipboard-action/" class="md-nav__link">
1288         clipboardAction
1289       </a>
1290     </li>
1291
1292
1293
1294
1295
1296
1297
1298     <li class="md-nav__item">
1299       <a href="../pip/core-object/" class="md-nav__link">
1300         coreObject
1301       </a>
1302     </li>
1303
1304
1305
1306
1307
1308
1309
1310     <li class="md-nav__item">
1311       <a href="../pip/cronjob/" class="md-nav__link">
1312         cronjob
1313       </a>
1314     </li>
1315
1316
1317
1318
1319
1320
1321
1322     <li class="md-nav__item">
1323       <a href="../pip/database/" class="md-nav__link">
1324         database
1325       </a>
1326     </li>
1327
1328
1329
1330
1331
1332
1333
1334     <li class="md-nav__item">
1335       <a href="../pip/event-listener/" class="md-nav__link">
1336         eventListener
1337       </a>
1338     </li>
1339
1340
1341
1342
1343
1344
1345
1346     <li class="md-nav__item">
1347       <a href="../pip/file/" class="md-nav__link">
1348         file
1349       </a>
1350     </li>
1351
1352
1353
1354
1355
1356
1357
1358     <li class="md-nav__item">
1359       <a href="../pip/language/" class="md-nav__link">
1360         language
1361       </a>
1362     </li>
1363
1364
1365
1366
1367
1368
1369
1370     <li class="md-nav__item">
1371       <a href="../pip/media-provider/" class="md-nav__link">
1372         mediaProvider
1373       </a>
1374     </li>
1375
1376
1377
1378
1379
1380
1381
1382     <li class="md-nav__item">
1383       <a href="../pip/menu/" class="md-nav__link">
1384         menu
1385       </a>
1386     </li>
1387
1388
1389
1390
1391
1392
1393
1394     <li class="md-nav__item">
1395       <a href="../pip/menu-item/" class="md-nav__link">
1396         menuItem
1397       </a>
1398     </li>
1399
1400
1401
1402
1403
1404
1405
1406     <li class="md-nav__item">
1407       <a href="../pip/object-type/" class="md-nav__link">
1408         objectType
1409       </a>
1410     </li>
1411
1412
1413
1414
1415
1416
1417
1418     <li class="md-nav__item">
1419       <a href="../pip/object-type-definition/" class="md-nav__link">
1420         objectTypeDefinition
1421       </a>
1422     </li>
1423
1424
1425
1426
1427
1428
1429
1430     <li class="md-nav__item">
1431       <a href="../pip/option/" class="md-nav__link">
1432         option
1433       </a>
1434     </li>
1435
1436
1437
1438
1439
1440
1441
1442     <li class="md-nav__item">
1443       <a href="../pip/page/" class="md-nav__link">
1444         page
1445       </a>
1446     </li>
1447
1448
1449
1450
1451
1452
1453
1454     <li class="md-nav__item">
1455       <a href="../pip/pip/" class="md-nav__link">
1456         pip
1457       </a>
1458     </li>
1459
1460
1461
1462
1463
1464
1465
1466     <li class="md-nav__item">
1467       <a href="../pip/script/" class="md-nav__link">
1468         script
1469       </a>
1470     </li>
1471
1472
1473
1474
1475
1476
1477
1478     <li class="md-nav__item">
1479       <a href="../pip/smiley/" class="md-nav__link">
1480         smiley
1481       </a>
1482     </li>
1483
1484
1485
1486
1487
1488
1489
1490     <li class="md-nav__item">
1491       <a href="../pip/sql/" class="md-nav__link">
1492         sql
1493       </a>
1494     </li>
1495
1496
1497
1498
1499
1500
1501
1502     <li class="md-nav__item">
1503       <a href="../pip/style/" class="md-nav__link">
1504         style
1505       </a>
1506     </li>
1507
1508
1509
1510
1511
1512
1513
1514     <li class="md-nav__item">
1515       <a href="../pip/template/" class="md-nav__link">
1516         template
1517       </a>
1518     </li>
1519
1520
1521
1522
1523
1524
1525
1526     <li class="md-nav__item">
1527       <a href="../pip/template-listener/" class="md-nav__link">
1528         templateListener
1529       </a>
1530     </li>
1531
1532
1533
1534
1535
1536
1537
1538     <li class="md-nav__item">
1539       <a href="../pip/user-group-option/" class="md-nav__link">
1540         userGroupOption
1541       </a>
1542     </li>
1543
1544
1545
1546
1547
1548
1549
1550     <li class="md-nav__item">
1551       <a href="../pip/user-menu/" class="md-nav__link">
1552         userMenu
1553       </a>
1554     </li>
1555
1556
1557
1558
1559
1560
1561
1562     <li class="md-nav__item">
1563       <a href="../pip/user-notification-event/" class="md-nav__link">
1564         userNotificationEvent
1565       </a>
1566     </li>
1567
1568
1569
1570
1571
1572
1573
1574     <li class="md-nav__item">
1575       <a href="../pip/user-option/" class="md-nav__link">
1576         userOption
1577       </a>
1578     </li>
1579
1580
1581
1582
1583
1584
1585
1586     <li class="md-nav__item">
1587       <a href="../pip/user-profile-menu/" class="md-nav__link">
1588         userProfileMenu
1589       </a>
1590     </li>
1591
1592
1593
1594         </ul>
1595       </nav>
1596     </li>
1597
1598
1599
1600
1601
1602
1603
1604     <li class="md-nav__item">
1605       <a href="../database-php-api/" class="md-nav__link">
1606         Database PHP API
1607       </a>
1608     </li>
1609
1610
1611
1612         </ul>
1613       </nav>
1614     </li>
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626     <li class="md-nav__item md-nav__item--nested">
1627
1628
1629         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1630
1631       <label class="md-nav__link" for="__nav_6">
1632         Migration
1633         <span class="md-nav__icon md-icon"></span>
1634       </label>
1635       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1636         <label class="md-nav__title" for="__nav_6">
1637           <span class="md-nav__icon md-icon"></span>
1638           Migration
1639         </label>
1640         <ul class="md-nav__list" data-md-scrollfix>
1641
1642
1643
1644
1645
1646
1647     <li class="md-nav__item md-nav__item--nested">
1648
1649
1650         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1651
1652       <label class="md-nav__link" for="__nav_6_1">
1653         Migrating from WSC 5.3
1654         <span class="md-nav__icon md-icon"></span>
1655       </label>
1656       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1657         <label class="md-nav__title" for="__nav_6_1">
1658           <span class="md-nav__icon md-icon"></span>
1659           Migrating from WSC 5.3
1660         </label>
1661         <ul class="md-nav__list" data-md-scrollfix>
1662
1663
1664
1665
1666
1667     <li class="md-nav__item">
1668       <a href="../../migration/wsc53/php/" class="md-nav__link">
1669         PHP API
1670       </a>
1671     </li>
1672
1673
1674
1675
1676
1677
1678
1679     <li class="md-nav__item">
1680       <a href="../../migration/wsc53/session/" class="md-nav__link">
1681         Session Handling and Authentication
1682       </a>
1683     </li>
1684
1685
1686
1687
1688
1689
1690
1691     <li class="md-nav__item">
1692       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1693         TypeScript and JavaScript
1694       </a>
1695     </li>
1696
1697
1698
1699
1700
1701
1702
1703     <li class="md-nav__item">
1704       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1705         Templates
1706       </a>
1707     </li>
1708
1709
1710
1711
1712
1713
1714
1715     <li class="md-nav__item">
1716       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1717         Third Party Libraries
1718       </a>
1719     </li>
1720
1721
1722
1723         </ul>
1724       </nav>
1725     </li>
1726
1727
1728
1729
1730
1731
1732
1733
1734     <li class="md-nav__item md-nav__item--nested">
1735
1736
1737         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1738
1739       <label class="md-nav__link" for="__nav_6_2">
1740         Migrating from WSC 5.2
1741         <span class="md-nav__icon md-icon"></span>
1742       </label>
1743       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1744         <label class="md-nav__title" for="__nav_6_2">
1745           <span class="md-nav__icon md-icon"></span>
1746           Migrating from WSC 5.2
1747         </label>
1748         <ul class="md-nav__list" data-md-scrollfix>
1749
1750
1751
1752
1753
1754     <li class="md-nav__item">
1755       <a href="../../migration/wsc52/php/" class="md-nav__link">
1756         PHP API
1757       </a>
1758     </li>
1759
1760
1761
1762
1763
1764
1765
1766     <li class="md-nav__item">
1767       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1768         Templates and Languages
1769       </a>
1770     </li>
1771
1772
1773
1774
1775
1776
1777
1778     <li class="md-nav__item">
1779       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1780         Third Party Libraries
1781       </a>
1782     </li>
1783
1784
1785
1786         </ul>
1787       </nav>
1788     </li>
1789
1790
1791
1792
1793
1794
1795
1796
1797     <li class="md-nav__item md-nav__item--nested">
1798
1799
1800         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1801
1802       <label class="md-nav__link" for="__nav_6_3">
1803         Migrating from WSC 3.1
1804         <span class="md-nav__icon md-icon"></span>
1805       </label>
1806       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1807         <label class="md-nav__title" for="__nav_6_3">
1808           <span class="md-nav__icon md-icon"></span>
1809           Migrating from WSC 3.1
1810         </label>
1811         <ul class="md-nav__list" data-md-scrollfix>
1812
1813
1814
1815
1816
1817     <li class="md-nav__item">
1818       <a href="../../migration/wsc31/php/" class="md-nav__link">
1819         PHP API
1820       </a>
1821     </li>
1822
1823
1824
1825         </ul>
1826       </nav>
1827     </li>
1828
1829
1830
1831
1832
1833
1834
1835
1836     <li class="md-nav__item md-nav__item--nested">
1837
1838
1839         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1840
1841       <label class="md-nav__link" for="__nav_6_4">
1842         Migrating from WSC 3.0
1843         <span class="md-nav__icon md-icon"></span>
1844       </label>
1845       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1846         <label class="md-nav__title" for="__nav_6_4">
1847           <span class="md-nav__icon md-icon"></span>
1848           Migrating from WSC 3.0
1849         </label>
1850         <ul class="md-nav__list" data-md-scrollfix>
1851
1852
1853
1854
1855
1856     <li class="md-nav__item">
1857       <a href="../../migration/wsc30/php/" class="md-nav__link">
1858         PHP API
1859       </a>
1860     </li>
1861
1862
1863
1864
1865
1866
1867
1868     <li class="md-nav__item">
1869       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1870         JavaScript API
1871       </a>
1872     </li>
1873
1874
1875
1876
1877
1878
1879
1880     <li class="md-nav__item">
1881       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1882         Templates
1883       </a>
1884     </li>
1885
1886
1887
1888
1889
1890
1891
1892     <li class="md-nav__item">
1893       <a href="../../migration/wsc30/css/" class="md-nav__link">
1894         CSS
1895       </a>
1896     </li>
1897
1898
1899
1900
1901
1902
1903
1904     <li class="md-nav__item">
1905       <a href="../../migration/wsc30/package/" class="md-nav__link">
1906         Package Components
1907       </a>
1908     </li>
1909
1910
1911
1912         </ul>
1913       </nav>
1914     </li>
1915
1916
1917
1918
1919
1920
1921
1922
1923     <li class="md-nav__item md-nav__item--nested">
1924
1925
1926         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1927
1928       <label class="md-nav__link" for="__nav_6_5">
1929         Migrating from WCF 2.1
1930         <span class="md-nav__icon md-icon"></span>
1931       </label>
1932       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1933         <label class="md-nav__title" for="__nav_6_5">
1934           <span class="md-nav__icon md-icon"></span>
1935           Migrating from WCF 2.1
1936         </label>
1937         <ul class="md-nav__list" data-md-scrollfix>
1938
1939
1940
1941
1942
1943     <li class="md-nav__item">
1944       <a href="../../migration/wcf21/php/" class="md-nav__link">
1945         PHP API
1946       </a>
1947     </li>
1948
1949
1950
1951
1952
1953
1954
1955     <li class="md-nav__item">
1956       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1957         Templates
1958       </a>
1959     </li>
1960
1961
1962
1963
1964
1965
1966
1967     <li class="md-nav__item">
1968       <a href="../../migration/wcf21/css/" class="md-nav__link">
1969         CSS
1970       </a>
1971     </li>
1972
1973
1974
1975
1976
1977
1978
1979     <li class="md-nav__item">
1980       <a href="../../migration/wcf21/package/" class="md-nav__link">
1981         Package Components
1982       </a>
1983     </li>
1984
1985
1986
1987         </ul>
1988       </nav>
1989     </li>
1990
1991
1992
1993         </ul>
1994       </nav>
1995     </li>
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007     <li class="md-nav__item md-nav__item--nested">
2008
2009
2010         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
2011
2012       <label class="md-nav__link" for="__nav_7">
2013         Tutorials
2014         <span class="md-nav__icon md-icon"></span>
2015       </label>
2016       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
2017         <label class="md-nav__title" for="__nav_7">
2018           <span class="md-nav__icon md-icon"></span>
2019           Tutorials
2020         </label>
2021         <ul class="md-nav__list" data-md-scrollfix>
2022
2023
2024
2025
2026
2027
2028     <li class="md-nav__item md-nav__item--nested">
2029
2030
2031         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
2032
2033       <label class="md-nav__link" for="__nav_7_1">
2034         Tutorial Series
2035         <span class="md-nav__icon md-icon"></span>
2036       </label>
2037       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
2038         <label class="md-nav__title" for="__nav_7_1">
2039           <span class="md-nav__icon md-icon"></span>
2040           Tutorial Series
2041         </label>
2042         <ul class="md-nav__list" data-md-scrollfix>
2043
2044
2045
2046
2047
2048     <li class="md-nav__item">
2049       <a href="../../tutorial/series/overview/" class="md-nav__link">
2050         Overview
2051       </a>
2052     </li>
2053
2054
2055
2056
2057
2058
2059
2060     <li class="md-nav__item">
2061       <a href="../../tutorial/series/part_1/" class="md-nav__link">
2062         Part 1
2063       </a>
2064     </li>
2065
2066
2067
2068
2069
2070
2071
2072     <li class="md-nav__item">
2073       <a href="../../tutorial/series/part_2/" class="md-nav__link">
2074         Part 2
2075       </a>
2076     </li>
2077
2078
2079
2080
2081
2082
2083
2084     <li class="md-nav__item">
2085       <a href="../../tutorial/series/part_3/" class="md-nav__link">
2086         Part 3
2087       </a>
2088     </li>
2089
2090
2091
2092
2093
2094
2095
2096     <li class="md-nav__item">
2097       <a href="../../tutorial/series/part_4/" class="md-nav__link">
2098         Part 4
2099       </a>
2100     </li>
2101
2102
2103
2104
2105
2106
2107
2108     <li class="md-nav__item">
2109       <a href="../../tutorial/series/part_5/" class="md-nav__link">
2110         Part 5
2111       </a>
2112     </li>
2113
2114
2115
2116         </ul>
2117       </nav>
2118     </li>
2119
2120
2121
2122         </ul>
2123       </nav>
2124     </li>
2125
2126
2127
2128   </ul>
2129 </nav>
2130                   </div>
2131                 </div>
2132               </div>
2133
2134
2135
2136               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2137                 <div class="md-sidebar__scrollwrap">
2138                   <div class="md-sidebar__inner">
2139
2140 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2141
2142
2143
2144
2145
2146
2147     <label class="md-nav__title" for="__toc">
2148       <span class="md-nav__icon md-icon"></span>
2149       Table of contents
2150     </label>
2151     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2152
2153         <li class="md-nav__item">
2154   <a href="#example" class="md-nav__link">
2155     Example
2156   </a>
2157
2158 </li>
2159
2160         <li class="md-nav__item">
2161   <a href="#elements" class="md-nav__link">
2162     Elements
2163   </a>
2164
2165     <nav class="md-nav" aria-label="Elements">
2166       <ul class="md-nav__list">
2167
2168           <li class="md-nav__item">
2169   <a href="#package" class="md-nav__link">
2170     &lt;package&gt;
2171   </a>
2172
2173 </li>
2174
2175           <li class="md-nav__item">
2176   <a href="#packageinformation" class="md-nav__link">
2177     &lt;packageinformation&gt;
2178   </a>
2179
2180     <nav class="md-nav" aria-label="&lt;packageinformation&gt;">
2181       <ul class="md-nav__list">
2182
2183           <li class="md-nav__item">
2184   <a href="#packagename" class="md-nav__link">
2185     &lt;packagename&gt;
2186   </a>
2187
2188 </li>
2189
2190           <li class="md-nav__item">
2191   <a href="#packagedescription" class="md-nav__link">
2192     &lt;packagedescription&gt;
2193   </a>
2194
2195 </li>
2196
2197           <li class="md-nav__item">
2198   <a href="#version" class="md-nav__link">
2199     &lt;version&gt;
2200   </a>
2201
2202 </li>
2203
2204           <li class="md-nav__item">
2205   <a href="#date" class="md-nav__link">
2206     &lt;date&gt;
2207   </a>
2208
2209 </li>
2210
2211       </ul>
2212     </nav>
2213
2214 </li>
2215
2216           <li class="md-nav__item">
2217   <a href="#authorinformation" class="md-nav__link">
2218     &lt;authorinformation&gt;
2219   </a>
2220
2221     <nav class="md-nav" aria-label="&lt;authorinformation&gt;">
2222       <ul class="md-nav__list">
2223
2224           <li class="md-nav__item">
2225   <a href="#author" class="md-nav__link">
2226     &lt;author&gt;
2227   </a>
2228
2229 </li>
2230
2231           <li class="md-nav__item">
2232   <a href="#authorurl" class="md-nav__link">
2233     &lt;authorurl&gt;
2234   </a>
2235
2236 </li>
2237
2238       </ul>
2239     </nav>
2240
2241 </li>
2242
2243           <li class="md-nav__item">
2244   <a href="#requiredpackages" class="md-nav__link">
2245     &lt;requiredpackages&gt;
2246   </a>
2247
2248     <nav class="md-nav" aria-label="&lt;requiredpackages&gt;">
2249       <ul class="md-nav__list">
2250
2251           <li class="md-nav__item">
2252   <a href="#requiredpackage" class="md-nav__link">
2253     &lt;requiredpackage&gt;
2254   </a>
2255
2256 </li>
2257
2258       </ul>
2259     </nav>
2260
2261 </li>
2262
2263           <li class="md-nav__item">
2264   <a href="#optionalpackage" class="md-nav__link">
2265     &lt;optionalpackage&gt;
2266   </a>
2267
2268     <nav class="md-nav" aria-label="&lt;optionalpackage&gt;">
2269       <ul class="md-nav__list">
2270
2271           <li class="md-nav__item">
2272   <a href="#optionalpackage_1" class="md-nav__link">
2273     &lt;optionalpackage&gt;
2274   </a>
2275
2276 </li>
2277
2278       </ul>
2279     </nav>
2280
2281 </li>
2282
2283           <li class="md-nav__item">
2284   <a href="#excludedpackages" class="md-nav__link">
2285     &lt;excludedpackages&gt;
2286   </a>
2287
2288     <nav class="md-nav" aria-label="&lt;excludedpackages&gt;">
2289       <ul class="md-nav__list">
2290
2291           <li class="md-nav__item">
2292   <a href="#excludedpackage" class="md-nav__link">
2293     &lt;excludedpackage&gt;
2294   </a>
2295
2296 </li>
2297
2298       </ul>
2299     </nav>
2300
2301 </li>
2302
2303           <li class="md-nav__item">
2304   <a href="#compatibility" class="md-nav__link">
2305     &lt;compatibility&gt;
2306   </a>
2307
2308     <nav class="md-nav" aria-label="&lt;compatibility&gt;">
2309       <ul class="md-nav__list">
2310
2311           <li class="md-nav__item">
2312   <a href="#existing-api-versions" class="md-nav__link">
2313     Existing API versions
2314   </a>
2315
2316 </li>
2317
2318       </ul>
2319     </nav>
2320
2321 </li>
2322
2323           <li class="md-nav__item">
2324   <a href="#instructions" class="md-nav__link">
2325     &lt;instructions&gt;
2326   </a>
2327
2328     <nav class="md-nav" aria-label="&lt;instructions&gt;">
2329       <ul class="md-nav__list">
2330
2331           <li class="md-nav__item">
2332   <a href="#instructions-typeinstall" class="md-nav__link">
2333     &lt;instructions type="install"&gt;
2334   </a>
2335
2336 </li>
2337
2338           <li class="md-nav__item">
2339   <a href="#instructions-typeupdate-fromversion" class="md-nav__link">
2340     &lt;instructions type="update" fromversion="…"&gt;
2341   </a>
2342
2343 </li>
2344
2345           <li class="md-nav__item">
2346   <a href="#instruction" class="md-nav__link">
2347     &lt;instruction&gt;
2348   </a>
2349
2350 </li>
2351
2352           <li class="md-nav__item">
2353   <a href="#void" class="md-nav__link">
2354     &lt;void/&gt;
2355   </a>
2356
2357 </li>
2358
2359       </ul>
2360     </nav>
2361
2362 </li>
2363
2364       </ul>
2365     </nav>
2366
2367 </li>
2368
2369     </ul>
2370
2371 </nav>
2372                   </div>
2373                 </div>
2374               </div>
2375
2376
2377           <div class="md-content" data-md-component="content">
2378             <article class="md-content__inner md-typeset">
2379
2380
2381                   <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">
2382                     <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>
2383                   </a>
2384
2385
2386                 <h1 id="packagexml">package.xml<a class="headerlink" href="#packagexml" title="Permanent link">#</a></h1>
2387 <p>The <code>package.xml</code> is the core component of every package.
2388 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>
2389 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2390 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2391 <span class="normal"> 2</span>
2392 <span class="normal"> 3</span>
2393 <span class="normal"> 4</span>
2394 <span class="normal"> 5</span>
2395 <span class="normal"> 6</span>
2396 <span class="normal"> 7</span>
2397 <span class="normal"> 8</span>
2398 <span class="normal"> 9</span>
2399 <span class="normal">10</span>
2400 <span class="normal">11</span>
2401 <span class="normal">12</span>
2402 <span class="normal">13</span>
2403 <span class="normal">14</span>
2404 <span class="normal">15</span>
2405 <span class="normal">16</span>
2406 <span class="normal">17</span>
2407 <span class="normal">18</span>
2408 <span class="normal">19</span>
2409 <span class="normal">20</span>
2410 <span class="normal">21</span>
2411 <span class="normal">22</span>
2412 <span class="normal">23</span>
2413 <span class="normal">24</span>
2414 <span class="normal">25</span>
2415 <span class="normal">26</span>
2416 <span class="normal">27</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2417 <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>
2418     <span class="nt">&lt;packageinformation&gt;</span>
2419         <span class="nt">&lt;packagename&gt;</span>Simple Package<span class="nt">&lt;/packagename&gt;</span>
2420         <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>
2421         <span class="nt">&lt;version&gt;</span>1.0.0<span class="nt">&lt;/version&gt;</span>
2422         <span class="nt">&lt;date&gt;</span>2016-12-18<span class="nt">&lt;/date&gt;</span>
2423     <span class="nt">&lt;/packageinformation&gt;</span>
2424
2425     <span class="nt">&lt;authorinformation&gt;</span>
2426         <span class="nt">&lt;author&gt;</span>YOUR NAME<span class="nt">&lt;/author&gt;</span>
2427         <span class="nt">&lt;authorurl&gt;</span>http://www.example.com<span class="nt">&lt;/authorurl&gt;</span>
2428     <span class="nt">&lt;/authorinformation&gt;</span>
2429
2430     <span class="nt">&lt;requiredpackages&gt;</span>
2431         <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>
2432     <span class="nt">&lt;/requiredpackages&gt;</span>
2433
2434     <span class="nt">&lt;excludedpackages&gt;</span>
2435         <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>
2436     <span class="nt">&lt;/excludedpackages&gt;</span>
2437
2438     <span class="nt">&lt;instructions</span> <span class="na">type=</span><span class="s">&quot;install&quot;</span><span class="nt">&gt;</span>
2439         <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;file&quot;</span> <span class="nt">/&gt;</span>
2440         <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>
2441     <span class="nt">&lt;/instructions&gt;</span>
2442 <span class="nt">&lt;/package&gt;</span>
2443 </code></pre></div>
2444 </td></tr></table>
2445 <h2 id="elements">Elements<a class="headerlink" href="#elements" title="Permanent link">#</a></h2>
2446 <h3 id="package"><code>&lt;package&gt;</code><a class="headerlink" href="#package" title="Permanent link">#</a></h3>
2447 <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>
2448 <p>The attribute <code>name</code> is the most important part, it holds the unique package identifier and is mandatory.
2449 It is based upon your domain name and the package name of your choice.</p>
2450 <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>.
2451 The resulting package identifier is <code>com.woltlab.wbb</code> (<code>&lt;tld&gt;.&lt;domain&gt;.&lt;packageName&gt;</code>).</p>
2452 <h3 id="packageinformation"><code>&lt;packageinformation&gt;</code><a class="headerlink" href="#packageinformation" title="Permanent link">#</a></h3>
2453 <p>Holds the entire meta data of the package.</p>
2454 <h4 id="packagename"><code>&lt;packagename&gt;</code><a class="headerlink" href="#packagename" title="Permanent link">#</a></h4>
2455 <p>This is the actual package name displayed to the end user, this can be anything you want, try to keep it short.
2456 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>
2457 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2458 <span class="normal">2</span>
2459 <span class="normal">3</span>
2460 <span class="normal">4</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="nt">&lt;packageinformation&gt;</span>
2461     <span class="nt">&lt;packagename&gt;</span>Simple Package<span class="nt">&lt;/packagename&gt;</span>
2462     <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>
2463 <span class="nt">&lt;/packageinformation&gt;</span>
2464 </code></pre></div>
2465 </td></tr></table>
2466 <h4 id="packagedescription"><code>&lt;packagedescription&gt;</code><a class="headerlink" href="#packagedescription" title="Permanent link">#</a></h4>
2467 <p>Brief summary of the package, use it to explain what it does since the package name might not always be clear enough.
2468 The attribute <code>languagecode</code> is available here too, please reference to <a href="#packageName"><code>&lt;packagename&gt;</code></a> for details.</p>
2469 <h4 id="version"><code>&lt;version&gt;</code><a class="headerlink" href="#version" title="Permanent link">#</a></h4>
2470 <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>
2471 <p>The possible keywords are:</p>
2472 <ul>
2473 <li>Alpha/dev (both is regarded to be the same)</li>
2474 <li>Beta</li>
2475 <li>RC (release candidate)</li>
2476 <li>pl (patch level)</li>
2477 </ul>
2478 <p>Valid examples:</p>
2479 <ul>
2480 <li>1.0.0</li>
2481 <li>1.12.13 Alpha 19</li>
2482 <li>7.0.0 pl 3</li>
2483 </ul>
2484 <p>Invalid examples:</p>
2485 <ul>
2486 <li>1.0.0 Beta (keyword Beta must be followed by a number)</li>
2487 <li>2.0 RC 3 (version number must consists of 3 blocks of numbers)</li>
2488 <li>1.2.3 dev 4.5 (4.5 is not an integer, 4 or 5 would be valid but not the fraction)</li>
2489 </ul>
2490 <h4 id="date"><code>&lt;date&gt;</code><a class="headerlink" href="#date" title="Permanent link">#</a></h4>
2491 <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>
2492 <h3 id="authorinformation"><code>&lt;authorinformation&gt;</code><a class="headerlink" href="#authorinformation" title="Permanent link">#</a></h3>
2493 <p>Holds meta data regarding the package's author.</p>
2494 <h4 id="author"><code>&lt;author&gt;</code><a class="headerlink" href="#author" title="Permanent link">#</a></h4>
2495 <p>Can be anything you want.</p>
2496 <h4 id="authorurl"><code>&lt;authorurl&gt;</code><a class="headerlink" href="#authorurl" title="Permanent link">#</a></h4>
2497 <blockquote>
2498 <p>(optional)</p>
2499 </blockquote>
2500 <p>URL to the author's website.</p>
2501 <h3 id="requiredpackages"><code>&lt;requiredpackages&gt;</code><a class="headerlink" href="#requiredpackages" title="Permanent link">#</a></h3>
2502 <p>A list of packages including their version required for this package to work.</p>
2503 <h4 id="requiredpackage"><code>&lt;requiredpackage&gt;</code><a class="headerlink" href="#requiredpackage" title="Permanent link">#</a></h4>
2504 <p>Example:</p>
2505 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><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>
2506 </code></pre></div>
2507 </td></tr></table>
2508 <p>The attribute <code>minversion</code> must be a valid version number as described in <a href="#version"><code>&lt;version&gt;</code></a>.
2509 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>
2510 <h3 id="optionalpackage"><code>&lt;optionalpackage&gt;</code><a class="headerlink" href="#optionalpackage" title="Permanent link">#</a></h3>
2511 <p>A list of optional packages which can be selected by the user at the very end of the installation process.</p>
2512 <h4 id="optionalpackage_1"><code>&lt;optionalpackage&gt;</code><a class="headerlink" href="#optionalpackage_1" title="Permanent link">#</a></h4>
2513 <p>Example:</p>
2514 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><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>
2515 </code></pre></div>
2516 </td></tr></table>
2517 <p>The <code>file</code> attribute specifies the location of the optional package's archive relative to the <code>package.xml</code>.</p>
2518 <h3 id="excludedpackages"><code>&lt;excludedpackages&gt;</code><a class="headerlink" href="#excludedpackages" title="Permanent link">#</a></h3>
2519 <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>
2520 <h4 id="excludedpackage"><code>&lt;excludedpackage&gt;</code><a class="headerlink" href="#excludedpackage" title="Permanent link">#</a></h4>
2521 <p>Example:</p>
2522 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><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>
2523 </code></pre></div>
2524 </td></tr></table>
2525 <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>
2526 <h3 id="compatibility"><code>&lt;compatibility&gt;</code><a class="headerlink" href="#compatibility" title="Permanent link">#</a></h3>
2527 <div class="admonition info">
2528 <p class="admonition-title">Available since WoltLab Suite 3.1</p>
2529 </div>
2530 <div class="admonition warning">
2531 <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>
2532 </div>
2533 <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>
2534 <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>
2535 <p>Example:</p>
2536 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2537 <span class="normal">2</span>
2538 <span class="normal">3</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="nt">&lt;compatibility&gt;</span>
2539     <span class="nt">&lt;api</span> <span class="na">version=</span><span class="s">&quot;2018&quot;</span> <span class="nt">/&gt;</span>
2540 <span class="nt">&lt;/compatibility&gt;</span>
2541 </code></pre></div>
2542 </td></tr></table>
2543 <h4 id="existing-api-versions">Existing API versions<a class="headerlink" href="#existing-api-versions" title="Permanent link">#</a></h4>
2544 <table>
2545 <thead>
2546 <tr>
2547 <th>WoltLab Suite Core</th>
2548 <th>API-Version</th>
2549 <th>Backwards-Compatible to API-Version</th>
2550 </tr>
2551 </thead>
2552 <tbody>
2553 <tr>
2554 <td>3.1</td>
2555 <td>2018</td>
2556 <td>n/a</td>
2557 </tr>
2558 </tbody>
2559 </table>
2560 <h3 id="instructions"><code>&lt;instructions&gt;</code><a class="headerlink" href="#instructions" title="Permanent link">#</a></h3>
2561 <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>
2562 <h4 id="instructions-typeinstall"><code>&lt;instructions type="install"&gt;</code><a class="headerlink" href="#instructions-typeinstall" title="Permanent link">#</a></h4>
2563 <p>List of instructions for a new installation of this package.</p>
2564 <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>
2565 <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>
2566 <div class="admonition warning">
2567 <p class="admonition-title">The installation process will pick exactly one update instruction, ignoring everything else. Please read the explanation below!</p>
2568 </div>
2569 <p>Example:</p>
2570 <ul>
2571 <li>Installed version: <code>1.0.0</code></li>
2572 <li>Package version: <code>1.0.2</code></li>
2573 </ul>
2574 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2575 <span class="normal">2</span>
2576 <span class="normal">3</span>
2577 <span class="normal">4</span>
2578 <span class="normal">5</span>
2579 <span class="normal">6</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="nt">&lt;instructions</span> <span class="na">type=</span><span class="s">&quot;update&quot;</span> <span class="na">fromversion=</span><span class="s">&quot;1.0.0&quot;</span><span class="nt">&gt;</span>
2580     <span class="c">&lt;!-- … --&gt;</span>
2581 <span class="nt">&lt;/instructions&gt;</span>
2582 <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>
2583     <span class="c">&lt;!-- … --&gt;</span>
2584 <span class="nt">&lt;/instructions&gt;</span>
2585 </code></pre></div>
2586 </td></tr></table>
2587 <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>.
2588 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>
2589 <h4 id="instruction"><code>&lt;instruction&gt;</code><a class="headerlink" href="#instruction" title="Permanent link">#</a></h4>
2590 <p>Example:</p>
2591 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><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>
2592 </code></pre></div>
2593 </td></tr></table>
2594 <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.
2595 The value must be a valid file relative to the location of <code>package.xml</code>.
2596 Many PIPs provide default file names which are used if no value is given:</p>
2597 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><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>
2598 </code></pre></div>
2599 </td></tr></table>
2600 <p>There is a <a href="../pip/">list of all default PIPs</a> available.</p>
2601 <div class="admonition warning">
2602 <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>
2603 </div>
2604 <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>
2605 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><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>
2606 </code></pre></div>
2607 </td></tr></table>
2608 <h4 id="void"><code>&lt;void/&gt;</code><a class="headerlink" href="#void" title="Permanent link">#</a></h4>
2609 <p>Sometimes a package update should only adjust the metadata of the package, for example, an optional package was added.
2610 However, WoltLab Suite Core requires that the list of <code>&lt;instructions&gt;</code> is non-empty.
2611 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>
2612 <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>
2613 <p>Example:</p>
2614 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2615 <span class="normal">2</span>
2616 <span class="normal">3</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="nt">&lt;instructions</span> <span class="na">type=</span><span class="s">&quot;update&quot;</span> <span class="na">fromversion=</span><span class="s">&quot;1.0.0&quot;</span><span class="nt">&gt;</span>
2617     <span class="nt">&lt;void/&gt;</span>
2618 <span class="nt">&lt;/instructions&gt;</span>
2619 </code></pre></div>
2620 </td></tr></table>
2621
2622
2623
2624
2625 <hr>
2626 <div class="md-source-date">
2627   <small>
2628
2629       Last update: 2021-01-08
2630
2631   </small>
2632 </div>
2633
2634
2635
2636
2637
2638
2639
2640
2641             </article>
2642           </div>
2643         </div>
2644
2645       </main>
2646
2647
2648 <footer class="md-footer">
2649
2650     <nav class="md-footer__inner md-grid" aria-label="Footer">
2651
2652         <a href="../../javascript/code-snippets/" class="md-footer__link md-footer__link--prev" rel="prev">
2653           <div class="md-footer__button md-icon">
2654             <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>
2655           </div>
2656           <div class="md-footer__title">
2657             <div class="md-ellipsis">
2658               <span class="md-footer__direction">
2659                 Previous
2660               </span>
2661               Code Snippets
2662             </div>
2663           </div>
2664         </a>
2665
2666
2667         <a href="../pip/" class="md-footer__link md-footer__link--next" rel="next">
2668           <div class="md-footer__title">
2669             <div class="md-ellipsis">
2670               <span class="md-footer__direction">
2671                 Next
2672               </span>
2673               Overview
2674             </div>
2675           </div>
2676           <div class="md-footer__button md-icon">
2677             <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>
2678           </div>
2679         </a>
2680
2681     </nav>
2682
2683   <div class="md-footer-meta md-typeset">
2684     <div class="md-footer-meta__inner md-grid">
2685       <div class="md-footer-copyright">
2686
2687           <div class="md-footer-copyright__highlight">
2688             Copyright © 2020 WoltLab GmbH
2689           </div>
2690
2691         Made with
2692         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2693           Material for MkDocs
2694         </a>
2695
2696       </div>
2697       <div class="md-footer-copyright">
2698         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2699         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2700 </div>
2701     </div>
2702   </div>
2703 </footer>
2704
2705     </div>
2706     <div class="md-dialog" data-md-component="dialog">
2707       <div class="md-dialog__inner md-typeset"></div>
2708     </div>
2709     <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>
2710
2711
2712       <script src="../../assets/javascripts/bundle.4ea5477f.min.js"></script>
2713
2714
2715   </body>
2716 </html>