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