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