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