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