latest/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
  12       <link rel="shortcut icon" href="../../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.3">
  14
  15
  16
  17         <title>acpTemplate - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../assets/stylesheets/main.1655a90d.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../../assets/stylesheets/palette.7fa14f5b.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  38
  39
  40
  41
  42
  43   </head>
  44
  45
  46
  47
  48
  49
  50
  51     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  52
  53
  54
  55     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  56     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  57     <label class="md-overlay" for="__drawer"></label>
  58     <div data-md-component="skip">
  59
  60
  61         <a href="#acp-template-installation-plugin" class="md-skip">
  62           Skip to content
  63         </a>
  64
  65     </div>
  66     <div data-md-component="announce">
  67
  68         <aside class="md-announce">
  69           <div class="md-announce__inner md-grid md-typeset">
  70
  71     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  72
  73           </div>
  74         </aside>
  75
  76     </div>
  77
  78
  79
  80 <header class="md-header" data-md-component="header">
  81   <nav class="md-header__inner md-grid" aria-label="Header">
  82     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation">
  83
  84   <img src="../../../assets/logo.png" alt="logo">
  85
  86     </a>
  87     <label class="md-header__button md-icon" for="__drawer">
  88       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  89     </label>
  90     <div class="md-header__title" data-md-component="header-title">
  91       <div class="md-header__ellipsis">
  92         <div class="md-header__topic">
  93           <span class="md-ellipsis">
  94             WoltLab Suite Documentation
  95           </span>
  96         </div>
  97         <div class="md-header__topic" data-md-component="header-topic">
  98           <span class="md-ellipsis">
  99
 100               acpTemplate
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106     <div class="md-header__options">
 107
 108     </div>
 109
 110       <label class="md-header__button md-icon" for="__search">
 111         <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>
 112       </label>
 113
 114 <div class="md-search" data-md-component="search" role="dialog">
 115   <label class="md-search__overlay" for="__search"></label>
 116   <div class="md-search__inner" role="search">
 117     <form class="md-search__form" name="search">
 118       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
 119       <label class="md-search__icon md-icon" for="__search">
 120         <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>
 121         <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>
 122       </label>
 123       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 124         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.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>
 125       </button>
 126     </form>
 127     <div class="md-search__output">
 128       <div class="md-search__scrollwrap" data-md-scrollfix>
 129         <div class="md-search-result" data-md-component="search-result">
 130           <div class="md-search-result__meta">
 131             Initializing search
 132           </div>
 133           <ol class="md-search-result__list"></ol>
 134         </div>
 135       </div>
 136     </div>
 137   </div>
 138 </div>
 139
 140
 141   </nav>
 142 </header>
 143
 144     <div class="md-container" data-md-component="container">
 145
 146
 147
 148
 149       <main class="md-main" data-md-component="main">
 150         <div class="md-main__inner md-grid">
 151
 152
 153
 154               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 155                 <div class="md-sidebar__scrollwrap">
 156                   <div class="md-sidebar__inner">
 157
 158
 159
 160
 161
 162 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 163   <label class="md-nav__title" for="__drawer">
 164     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
 165
 166   <img src="../../../assets/logo.png" alt="logo">
 167
 168     </a>
 169     WoltLab Suite Documentation
 170   </label>
 171
 172   <ul class="md-nav__list" data-md-scrollfix>
 173
 174
 175
 176
 177
 178
 179
 180
 181     <li class="md-nav__item">
 182       <a href="../../../getting-started/" class="md-nav__link">
 183         Getting Started
 184       </a>
 185     </li>
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197     <li class="md-nav__item md-nav__item--nested">
 198
 199
 200         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 201
 202       <label class="md-nav__link" for="__nav_2">
 203         PHP API
 204         <span class="md-nav__icon md-icon"></span>
 205       </label>
 206       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 207         <label class="md-nav__title" for="__nav_2">
 208           <span class="md-nav__icon md-icon"></span>
 209           PHP API
 210         </label>
 211         <ul class="md-nav__list" data-md-scrollfix>
 212
 213
 214
 215
 216
 217     <li class="md-nav__item">
 218       <a href="../../../php/pages/" class="md-nav__link">
 219         Pages
 220       </a>
 221     </li>
 222
 223
 224
 225
 226
 227
 228
 229     <li class="md-nav__item">
 230       <a href="../../../php/database-objects/" class="md-nav__link">
 231         Database Objects
 232       </a>
 233     </li>
 234
 235
 236
 237
 238
 239
 240
 241     <li class="md-nav__item">
 242       <a href="../../../php/database-access/" class="md-nav__link">
 243         Database Access
 244       </a>
 245     </li>
 246
 247
 248
 249
 250
 251
 252
 253     <li class="md-nav__item">
 254       <a href="../../../php/exceptions/" class="md-nav__link">
 255         Exceptions
 256       </a>
 257     </li>
 258
 259
 260
 261
 262
 263
 264
 265
 266     <li class="md-nav__item md-nav__item--nested">
 267
 268
 269         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 270
 271       <label class="md-nav__link" for="__nav_2_5">
 272         API
 273         <span class="md-nav__icon md-icon"></span>
 274       </label>
 275       <nav class="md-nav" aria-label="API" data-md-level="2">
 276         <label class="md-nav__title" for="__nav_2_5">
 277           <span class="md-nav__icon md-icon"></span>
 278           API
 279         </label>
 280         <ul class="md-nav__list" data-md-scrollfix>
 281
 282
 283
 284
 285
 286     <li class="md-nav__item">
 287       <a href="../../../php/api/caches/" class="md-nav__link">
 288         Caches
 289       </a>
 290     </li>
 291
 292
 293
 294
 295
 296
 297
 298     <li class="md-nav__item">
 299       <a href="../../../php/api/comments/" class="md-nav__link">
 300         Comments
 301       </a>
 302     </li>
 303
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item">
 311       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 312         Cronjobs
 313       </a>
 314     </li>
 315
 316
 317
 318
 319
 320
 321
 322     <li class="md-nav__item">
 323       <a href="../../../php/api/events/" class="md-nav__link">
 324         Events
 325       </a>
 326     </li>
 327
 328
 329
 330
 331
 332
 333
 334
 335     <li class="md-nav__item md-nav__item--nested">
 336
 337
 338         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 339
 340       <label class="md-nav__link" for="__nav_2_5_5">
 341         Form Builder
 342         <span class="md-nav__icon md-icon"></span>
 343       </label>
 344       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 345         <label class="md-nav__title" for="__nav_2_5_5">
 346           <span class="md-nav__icon md-icon"></span>
 347           Form Builder
 348         </label>
 349         <ul class="md-nav__list" data-md-scrollfix>
 350
 351
 352
 353
 354
 355     <li class="md-nav__item">
 356       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 357         Overview
 358       </a>
 359     </li>
 360
 361
 362
 363
 364
 365
 366
 367     <li class="md-nav__item">
 368       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 369         Structure
 370       </a>
 371     </li>
 372
 373
 374
 375
 376
 377
 378
 379     <li class="md-nav__item">
 380       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 381         Fields
 382       </a>
 383     </li>
 384
 385
 386
 387
 388
 389
 390
 391     <li class="md-nav__item">
 392       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 393         Validation and Data
 394       </a>
 395     </li>
 396
 397
 398
 399
 400
 401
 402
 403     <li class="md-nav__item">
 404       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 405         Dependencies
 406       </a>
 407     </li>
 408
 409
 410
 411         </ul>
 412       </nav>
 413     </li>
 414
 415
 416
 417
 418
 419
 420
 421     <li class="md-nav__item">
 422       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 423         Package Installation Plugins
 424       </a>
 425     </li>
 426
 427
 428
 429
 430
 431
 432
 433     <li class="md-nav__item">
 434       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 435         User Activity Points
 436       </a>
 437     </li>
 438
 439
 440
 441
 442
 443
 444
 445     <li class="md-nav__item">
 446       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 447         User Notifications
 448       </a>
 449     </li>
 450
 451
 452
 453
 454
 455
 456
 457     <li class="md-nav__item">
 458       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 459         Sitemaps
 460       </a>
 461     </li>
 462
 463
 464
 465         </ul>
 466       </nav>
 467     </li>
 468
 469
 470
 471
 472
 473
 474
 475     <li class="md-nav__item">
 476       <a href="../../../php/code-style/" class="md-nav__link">
 477         Code Style
 478       </a>
 479     </li>
 480
 481
 482
 483
 484
 485
 486
 487     <li class="md-nav__item">
 488       <a href="../../../php/apps/" class="md-nav__link">
 489         Apps
 490       </a>
 491     </li>
 492
 493
 494
 495
 496
 497
 498
 499     <li class="md-nav__item">
 500       <a href="../../../php/gdpr/" class="md-nav__link">
 501         GDPR
 502       </a>
 503     </li>
 504
 505
 506
 507         </ul>
 508       </nav>
 509     </li>
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521     <li class="md-nav__item md-nav__item--nested">
 522
 523
 524         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 525
 526       <label class="md-nav__link" for="__nav_3">
 527         Languages, Templates & CSS
 528         <span class="md-nav__icon md-icon"></span>
 529       </label>
 530       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 531         <label class="md-nav__title" for="__nav_3">
 532           <span class="md-nav__icon md-icon"></span>
 533           Languages, Templates & CSS
 534         </label>
 535         <ul class="md-nav__list" data-md-scrollfix>
 536
 537
 538
 539
 540
 541     <li class="md-nav__item">
 542       <a href="../../../view/languages/" class="md-nav__link">
 543         Languages
 544       </a>
 545     </li>
 546
 547
 548
 549
 550
 551
 552
 553     <li class="md-nav__item">
 554       <a href="../../../view/templates/" class="md-nav__link">
 555         Templates
 556       </a>
 557     </li>
 558
 559
 560
 561
 562
 563
 564
 565     <li class="md-nav__item">
 566       <a href="../../../view/css/" class="md-nav__link">
 567         CSS
 568       </a>
 569     </li>
 570
 571
 572
 573         </ul>
 574       </nav>
 575     </li>
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587     <li class="md-nav__item md-nav__item--nested">
 588
 589
 590         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 591
 592       <label class="md-nav__link" for="__nav_4">
 593         JavaScript API
 594         <span class="md-nav__icon md-icon"></span>
 595       </label>
 596       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 597         <label class="md-nav__title" for="__nav_4">
 598           <span class="md-nav__icon md-icon"></span>
 599           JavaScript API
 600         </label>
 601         <ul class="md-nav__list" data-md-scrollfix>
 602
 603
 604
 605
 606
 607     <li class="md-nav__item">
 608       <a href="../../../javascript/general-usage/" class="md-nav__link">
 609         General Usage
 610       </a>
 611     </li>
 612
 613
 614
 615
 616
 617
 618
 619
 620     <li class="md-nav__item md-nav__item--nested">
 621
 622
 623         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 624
 625       <label class="md-nav__link" for="__nav_4_2">
 626         New API
 627         <span class="md-nav__icon md-icon"></span>
 628       </label>
 629       <nav class="md-nav" aria-label="New API" data-md-level="2">
 630         <label class="md-nav__title" for="__nav_4_2">
 631           <span class="md-nav__icon md-icon"></span>
 632           New API
 633         </label>
 634         <ul class="md-nav__list" data-md-scrollfix>
 635
 636
 637
 638
 639
 640     <li class="md-nav__item">
 641       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 642         Writing a module
 643       </a>
 644     </li>
 645
 646
 647
 648
 649
 650
 651
 652     <li class="md-nav__item">
 653       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 654         Data Structures
 655       </a>
 656     </li>
 657
 658
 659
 660
 661
 662
 663
 664     <li class="md-nav__item">
 665       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 666         Core Functions
 667       </a>
 668     </li>
 669
 670
 671
 672
 673
 674
 675
 676     <li class="md-nav__item">
 677       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 678         DOM
 679       </a>
 680     </li>
 681
 682
 683
 684
 685
 686
 687
 688     <li class="md-nav__item">
 689       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 690         Event Handling
 691       </a>
 692     </li>
 693
 694
 695
 696
 697
 698
 699
 700     <li class="md-nav__item">
 701       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 702         Ajax
 703       </a>
 704     </li>
 705
 706
 707
 708
 709
 710
 711
 712     <li class="md-nav__item">
 713       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 714         Dialogs
 715       </a>
 716     </li>
 717
 718
 719
 720
 721
 722
 723
 724     <li class="md-nav__item">
 725       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 726         Browser and Screen Sizes
 727       </a>
 728     </li>
 729
 730
 731
 732
 733
 734
 735
 736     <li class="md-nav__item">
 737       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 738         User Interface
 739       </a>
 740     </li>
 741
 742
 743
 744         </ul>
 745       </nav>
 746     </li>
 747
 748
 749
 750
 751
 752
 753
 754     <li class="md-nav__item">
 755       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 756         Legacy API
 757       </a>
 758     </li>
 759
 760
 761
 762
 763
 764
 765
 766     <li class="md-nav__item">
 767       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 768         Helper Functions
 769       </a>
 770     </li>
 771
 772
 773
 774
 775
 776
 777
 778     <li class="md-nav__item">
 779       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 780         Code Snippets
 781       </a>
 782     </li>
 783
 784
 785
 786         </ul>
 787       </nav>
 788     </li>
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 803
 804
 805         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 806
 807       <label class="md-nav__link" for="__nav_5">
 808         Package Components
 809         <span class="md-nav__icon md-icon"></span>
 810       </label>
 811       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 812         <label class="md-nav__title" for="__nav_5">
 813           <span class="md-nav__icon md-icon"></span>
 814           Package Components
 815         </label>
 816         <ul class="md-nav__list" data-md-scrollfix>
 817
 818
 819
 820
 821
 822     <li class="md-nav__item">
 823       <a href="../../package-xml/" class="md-nav__link">
 824         package.xml
 825       </a>
 826     </li>
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 838
 839
 840         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 841
 842       <label class="md-nav__link" for="__nav_5_2">
 843         PIPs
 844         <span class="md-nav__icon md-icon"></span>
 845       </label>
 846       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 847         <label class="md-nav__title" for="__nav_5_2">
 848           <span class="md-nav__icon md-icon"></span>
 849           PIPs
 850         </label>
 851         <ul class="md-nav__list" data-md-scrollfix>
 852
 853
 854
 855
 856
 857     <li class="md-nav__item">
 858       <a href="../" class="md-nav__link">
 859         Overview
 860       </a>
 861     </li>
 862
 863
 864
 865
 866
 867
 868
 869     <li class="md-nav__item">
 870       <a href="../acl-option/" class="md-nav__link">
 871         aclOption
 872       </a>
 873     </li>
 874
 875
 876
 877
 878
 879
 880
 881     <li class="md-nav__item">
 882       <a href="../acp-menu/" class="md-nav__link">
 883         acpMenu
 884       </a>
 885     </li>
 886
 887
 888
 889
 890
 891
 892
 893     <li class="md-nav__item">
 894       <a href="../acp-search-provider/" class="md-nav__link">
 895         acpSearchProvider
 896       </a>
 897     </li>
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907     <li class="md-nav__item md-nav__item--active">
 908
 909       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 910
 911
 912
 913
 914         <label class="md-nav__link md-nav__link--active" for="__toc">
 915           acpTemplate
 916           <span class="md-nav__icon md-icon"></span>
 917         </label>
 918
 919       <a href="./" class="md-nav__link md-nav__link--active">
 920         acpTemplate
 921       </a>
 922
 923
 924 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 925
 926
 927
 928
 929
 930     <label class="md-nav__title" for="__toc">
 931       <span class="md-nav__icon md-icon"></span>
 932       Table of contents
 933     </label>
 934     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 935
 936         <li class="md-nav__item">
 937   <a href="#archive" class="md-nav__link">
 938     Archive
 939   </a>
 940
 941 </li>
 942
 943         <li class="md-nav__item">
 944   <a href="#attributes" class="md-nav__link">
 945     Attributes
 946   </a>
 947
 948     <nav class="md-nav" aria-label="Attributes">
 949       <ul class="md-nav__list">
 950
 951           <li class="md-nav__item">
 952   <a href="#application" class="md-nav__link">
 953     application
 954   </a>
 955
 956 </li>
 957
 958       </ul>
 959     </nav>
 960
 961 </li>
 962
 963         <li class="md-nav__item">
 964   <a href="#example-in-packagexml" class="md-nav__link">
 965     Example in package.xml
 966   </a>
 967
 968 </li>
 969
 970     </ul>
 971
 972 </nav>
 973
 974     </li>
 975
 976
 977
 978
 979
 980
 981
 982     <li class="md-nav__item">
 983       <a href="../bbcode/" class="md-nav__link">
 984         bbcode
 985       </a>
 986     </li>
 987
 988
 989
 990
 991
 992
 993
 994     <li class="md-nav__item">
 995       <a href="../box/" class="md-nav__link">
 996         box
 997       </a>
 998     </li>
 999
1000
1001
1002
1003
1004
1005
1006     <li class="md-nav__item">
1007       <a href="../clipboard-action/" class="md-nav__link">
1008         clipboardAction
1009       </a>
1010     </li>
1011
1012
1013
1014
1015
1016
1017
1018     <li class="md-nav__item">
1019       <a href="../core-object/" class="md-nav__link">
1020         coreObject
1021       </a>
1022     </li>
1023
1024
1025
1026
1027
1028
1029
1030     <li class="md-nav__item">
1031       <a href="../cronjob/" class="md-nav__link">
1032         cronjob
1033       </a>
1034     </li>
1035
1036
1037
1038
1039
1040
1041
1042     <li class="md-nav__item">
1043       <a href="../event-listener/" class="md-nav__link">
1044         eventListener
1045       </a>
1046     </li>
1047
1048
1049
1050
1051
1052
1053
1054     <li class="md-nav__item">
1055       <a href="../file/" class="md-nav__link">
1056         file
1057       </a>
1058     </li>
1059
1060
1061
1062
1063
1064
1065
1066     <li class="md-nav__item">
1067       <a href="../language/" class="md-nav__link">
1068         language
1069       </a>
1070     </li>
1071
1072
1073
1074
1075
1076
1077
1078     <li class="md-nav__item">
1079       <a href="../media-provider/" class="md-nav__link">
1080         mediaProvider
1081       </a>
1082     </li>
1083
1084
1085
1086
1087
1088
1089
1090     <li class="md-nav__item">
1091       <a href="../menu/" class="md-nav__link">
1092         menu
1093       </a>
1094     </li>
1095
1096
1097
1098
1099
1100
1101
1102     <li class="md-nav__item">
1103       <a href="../menu-item/" class="md-nav__link">
1104         menuItem
1105       </a>
1106     </li>
1107
1108
1109
1110
1111
1112
1113
1114     <li class="md-nav__item">
1115       <a href="../object-type/" class="md-nav__link">
1116         objectType
1117       </a>
1118     </li>
1119
1120
1121
1122
1123
1124
1125
1126     <li class="md-nav__item">
1127       <a href="../object-type-definition/" class="md-nav__link">
1128         objectTypeDefinition
1129       </a>
1130     </li>
1131
1132
1133
1134
1135
1136
1137
1138     <li class="md-nav__item">
1139       <a href="../option/" class="md-nav__link">
1140         option
1141       </a>
1142     </li>
1143
1144
1145
1146
1147
1148
1149
1150     <li class="md-nav__item">
1151       <a href="../page/" class="md-nav__link">
1152         page
1153       </a>
1154     </li>
1155
1156
1157
1158
1159
1160
1161
1162     <li class="md-nav__item">
1163       <a href="../pip/" class="md-nav__link">
1164         pip
1165       </a>
1166     </li>
1167
1168
1169
1170
1171
1172
1173
1174     <li class="md-nav__item">
1175       <a href="../script/" class="md-nav__link">
1176         script
1177       </a>
1178     </li>
1179
1180
1181
1182
1183
1184
1185
1186     <li class="md-nav__item">
1187       <a href="../smiley/" class="md-nav__link">
1188         smiley
1189       </a>
1190     </li>
1191
1192
1193
1194
1195
1196
1197
1198     <li class="md-nav__item">
1199       <a href="../sql/" class="md-nav__link">
1200         sql
1201       </a>
1202     </li>
1203
1204
1205
1206
1207
1208
1209
1210     <li class="md-nav__item">
1211       <a href="../style/" class="md-nav__link">
1212         style
1213       </a>
1214     </li>
1215
1216
1217
1218
1219
1220
1221
1222     <li class="md-nav__item">
1223       <a href="../template/" class="md-nav__link">
1224         template
1225       </a>
1226     </li>
1227
1228
1229
1230
1231
1232
1233
1234     <li class="md-nav__item">
1235       <a href="../template-listener/" class="md-nav__link">
1236         templateListener
1237       </a>
1238     </li>
1239
1240
1241
1242
1243
1244
1245
1246     <li class="md-nav__item">
1247       <a href="../user-group-option/" class="md-nav__link">
1248         userGroupOption
1249       </a>
1250     </li>
1251
1252
1253
1254
1255
1256
1257
1258     <li class="md-nav__item">
1259       <a href="../user-menu/" class="md-nav__link">
1260         userMenu
1261       </a>
1262     </li>
1263
1264
1265
1266
1267
1268
1269
1270     <li class="md-nav__item">
1271       <a href="../user-notification-event/" class="md-nav__link">
1272         userNotificationEvent
1273       </a>
1274     </li>
1275
1276
1277
1278
1279
1280
1281
1282     <li class="md-nav__item">
1283       <a href="../user-option/" class="md-nav__link">
1284         userOption
1285       </a>
1286     </li>
1287
1288
1289
1290
1291
1292
1293
1294     <li class="md-nav__item">
1295       <a href="../user-profile-menu/" class="md-nav__link">
1296         userProfileMenu
1297       </a>
1298     </li>
1299
1300
1301
1302         </ul>
1303       </nav>
1304     </li>
1305
1306
1307
1308
1309
1310
1311
1312     <li class="md-nav__item">
1313       <a href="../../database-php-api/" class="md-nav__link">
1314         Database PHP API
1315       </a>
1316     </li>
1317
1318
1319
1320         </ul>
1321       </nav>
1322     </li>
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334     <li class="md-nav__item md-nav__item--nested">
1335
1336
1337         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1338
1339       <label class="md-nav__link" for="__nav_6">
1340         Migration
1341         <span class="md-nav__icon md-icon"></span>
1342       </label>
1343       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1344         <label class="md-nav__title" for="__nav_6">
1345           <span class="md-nav__icon md-icon"></span>
1346           Migration
1347         </label>
1348         <ul class="md-nav__list" data-md-scrollfix>
1349
1350
1351
1352
1353
1354
1355     <li class="md-nav__item md-nav__item--nested">
1356
1357
1358         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1359
1360       <label class="md-nav__link" for="__nav_6_1">
1361         Migrating from WSC 5.3
1362         <span class="md-nav__icon md-icon"></span>
1363       </label>
1364       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1365         <label class="md-nav__title" for="__nav_6_1">
1366           <span class="md-nav__icon md-icon"></span>
1367           Migrating from WSC 5.3
1368         </label>
1369         <ul class="md-nav__list" data-md-scrollfix>
1370
1371
1372
1373
1374
1375     <li class="md-nav__item">
1376       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1377         PHP API
1378       </a>
1379     </li>
1380
1381
1382
1383
1384
1385
1386
1387     <li class="md-nav__item">
1388       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1389         Session Handling and Authentication
1390       </a>
1391     </li>
1392
1393
1394
1395
1396
1397
1398
1399     <li class="md-nav__item">
1400       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1401         JavaScript
1402       </a>
1403     </li>
1404
1405
1406
1407
1408
1409
1410
1411     <li class="md-nav__item">
1412       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1413         Templates
1414       </a>
1415     </li>
1416
1417
1418
1419
1420
1421
1422
1423     <li class="md-nav__item">
1424       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1425         Third Party Libraries
1426       </a>
1427     </li>
1428
1429
1430
1431         </ul>
1432       </nav>
1433     </li>
1434
1435
1436
1437
1438
1439
1440
1441
1442     <li class="md-nav__item md-nav__item--nested">
1443
1444
1445         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1446
1447       <label class="md-nav__link" for="__nav_6_2">
1448         Migrating from WSC 5.2
1449         <span class="md-nav__icon md-icon"></span>
1450       </label>
1451       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1452         <label class="md-nav__title" for="__nav_6_2">
1453           <span class="md-nav__icon md-icon"></span>
1454           Migrating from WSC 5.2
1455         </label>
1456         <ul class="md-nav__list" data-md-scrollfix>
1457
1458
1459
1460
1461
1462     <li class="md-nav__item">
1463       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1464         PHP API
1465       </a>
1466     </li>
1467
1468
1469
1470
1471
1472
1473
1474     <li class="md-nav__item">
1475       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1476         Templates and Languages
1477       </a>
1478     </li>
1479
1480
1481
1482
1483
1484
1485
1486     <li class="md-nav__item">
1487       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1488         Third Party Libraries
1489       </a>
1490     </li>
1491
1492
1493
1494         </ul>
1495       </nav>
1496     </li>
1497
1498
1499
1500
1501
1502
1503
1504
1505     <li class="md-nav__item md-nav__item--nested">
1506
1507
1508         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1509
1510       <label class="md-nav__link" for="__nav_6_3">
1511         Migrating from WSC 3.1
1512         <span class="md-nav__icon md-icon"></span>
1513       </label>
1514       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1515         <label class="md-nav__title" for="__nav_6_3">
1516           <span class="md-nav__icon md-icon"></span>
1517           Migrating from WSC 3.1
1518         </label>
1519         <ul class="md-nav__list" data-md-scrollfix>
1520
1521
1522
1523
1524
1525     <li class="md-nav__item">
1526       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1527         PHP API
1528       </a>
1529     </li>
1530
1531
1532
1533         </ul>
1534       </nav>
1535     </li>
1536
1537
1538
1539
1540
1541
1542
1543
1544     <li class="md-nav__item md-nav__item--nested">
1545
1546
1547         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1548
1549       <label class="md-nav__link" for="__nav_6_4">
1550         Migrating from WSC 3.0
1551         <span class="md-nav__icon md-icon"></span>
1552       </label>
1553       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1554         <label class="md-nav__title" for="__nav_6_4">
1555           <span class="md-nav__icon md-icon"></span>
1556           Migrating from WSC 3.0
1557         </label>
1558         <ul class="md-nav__list" data-md-scrollfix>
1559
1560
1561
1562
1563
1564     <li class="md-nav__item">
1565       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1566         PHP API
1567       </a>
1568     </li>
1569
1570
1571
1572
1573
1574
1575
1576     <li class="md-nav__item">
1577       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1578         JavaScript API
1579       </a>
1580     </li>
1581
1582
1583
1584
1585
1586
1587
1588     <li class="md-nav__item">
1589       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1590         Templates
1591       </a>
1592     </li>
1593
1594
1595
1596
1597
1598
1599
1600     <li class="md-nav__item">
1601       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1602         CSS
1603       </a>
1604     </li>
1605
1606
1607
1608
1609
1610
1611
1612     <li class="md-nav__item">
1613       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1614         Package Components
1615       </a>
1616     </li>
1617
1618
1619
1620         </ul>
1621       </nav>
1622     </li>
1623
1624
1625
1626
1627
1628
1629
1630
1631     <li class="md-nav__item md-nav__item--nested">
1632
1633
1634         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1635
1636       <label class="md-nav__link" for="__nav_6_5">
1637         Migrating from WCF 2.1
1638         <span class="md-nav__icon md-icon"></span>
1639       </label>
1640       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1641         <label class="md-nav__title" for="__nav_6_5">
1642           <span class="md-nav__icon md-icon"></span>
1643           Migrating from WCF 2.1
1644         </label>
1645         <ul class="md-nav__list" data-md-scrollfix>
1646
1647
1648
1649
1650
1651     <li class="md-nav__item">
1652       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1653         PHP API
1654       </a>
1655     </li>
1656
1657
1658
1659
1660
1661
1662
1663     <li class="md-nav__item">
1664       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1665         Templates
1666       </a>
1667     </li>
1668
1669
1670
1671
1672
1673
1674
1675     <li class="md-nav__item">
1676       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1677         CSS
1678       </a>
1679     </li>
1680
1681
1682
1683
1684
1685
1686
1687     <li class="md-nav__item">
1688       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1689         Package Components
1690       </a>
1691     </li>
1692
1693
1694
1695         </ul>
1696       </nav>
1697     </li>
1698
1699
1700
1701         </ul>
1702       </nav>
1703     </li>
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715     <li class="md-nav__item md-nav__item--nested">
1716
1717
1718         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1719
1720       <label class="md-nav__link" for="__nav_7">
1721         Tutorials
1722         <span class="md-nav__icon md-icon"></span>
1723       </label>
1724       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1725         <label class="md-nav__title" for="__nav_7">
1726           <span class="md-nav__icon md-icon"></span>
1727           Tutorials
1728         </label>
1729         <ul class="md-nav__list" data-md-scrollfix>
1730
1731
1732
1733
1734
1735
1736     <li class="md-nav__item md-nav__item--nested">
1737
1738
1739         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1740
1741       <label class="md-nav__link" for="__nav_7_1">
1742         Tutorial Series
1743         <span class="md-nav__icon md-icon"></span>
1744       </label>
1745       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1746         <label class="md-nav__title" for="__nav_7_1">
1747           <span class="md-nav__icon md-icon"></span>
1748           Tutorial Series
1749         </label>
1750         <ul class="md-nav__list" data-md-scrollfix>
1751
1752
1753
1754
1755
1756     <li class="md-nav__item">
1757       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1758         Overview
1759       </a>
1760     </li>
1761
1762
1763
1764
1765
1766
1767
1768     <li class="md-nav__item">
1769       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1770         Part 1
1771       </a>
1772     </li>
1773
1774
1775
1776
1777
1778
1779
1780     <li class="md-nav__item">
1781       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1782         Part 2
1783       </a>
1784     </li>
1785
1786
1787
1788
1789
1790
1791
1792     <li class="md-nav__item">
1793       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1794         Part 3
1795       </a>
1796     </li>
1797
1798
1799
1800         </ul>
1801       </nav>
1802     </li>
1803
1804
1805
1806         </ul>
1807       </nav>
1808     </li>
1809
1810
1811
1812   </ul>
1813 </nav>
1814                   </div>
1815                 </div>
1816               </div>
1817
1818
1819
1820               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1821                 <div class="md-sidebar__scrollwrap">
1822                   <div class="md-sidebar__inner">
1823
1824 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1825
1826
1827
1828
1829
1830     <label class="md-nav__title" for="__toc">
1831       <span class="md-nav__icon md-icon"></span>
1832       Table of contents
1833     </label>
1834     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1835
1836         <li class="md-nav__item">
1837   <a href="#archive" class="md-nav__link">
1838     Archive
1839   </a>
1840
1841 </li>
1842
1843         <li class="md-nav__item">
1844   <a href="#attributes" class="md-nav__link">
1845     Attributes
1846   </a>
1847
1848     <nav class="md-nav" aria-label="Attributes">
1849       <ul class="md-nav__list">
1850
1851           <li class="md-nav__item">
1852   <a href="#application" class="md-nav__link">
1853     application
1854   </a>
1855
1856 </li>
1857
1858       </ul>
1859     </nav>
1860
1861 </li>
1862
1863         <li class="md-nav__item">
1864   <a href="#example-in-packagexml" class="md-nav__link">
1865     Example in package.xml
1866   </a>
1867
1868 </li>
1869
1870     </ul>
1871
1872 </nav>
1873                   </div>
1874                 </div>
1875               </div>
1876
1877
1878           <div class="md-content" data-md-component="content">
1879             <article class="md-content__inner md-typeset">
1880
1881
1882
1883                 <h1 id="acp-template-installation-plugin">ACP Template Installation Plugin<a class="headerlink" href="#acp-template-installation-plugin" title="Permanent link">#</a></h1>
1884 <p>Add templates for acp pages and forms by providing an archive containing the template files.</p>
1885 <div class="admonition warning">
1886 <p class="admonition-title">You cannot overwrite acp templates provided by other packages.</p>
1887 </div>
1888 <h2 id="archive">Archive<a class="headerlink" href="#archive" title="Permanent link">#</a></h2>
1889 <p>The <code>acpTemplate</code> package installation plugins expects a <code>.tar</code> (recommended) or <code>.tar.gz</code> archive.
1890 The templates must all be in the root of the archive.
1891 Do not include any directories in the archive.
1892 The file path given in the <code>instruction</code> element as its value must be relative to the <code>package.xml</code> file.</p>
1893 <h2 id="attributes">Attributes<a class="headerlink" href="#attributes" title="Permanent link">#</a></h2>
1894 <h3 id="application"><code>application</code><a class="headerlink" href="#application" title="Permanent link">#</a></h3>
1895 <p>The <code>application</code> attribute determines to which application the installed acp templates belong and thus in which directory the templates are installed.
1896 The value of the <code>application</code> attribute has to be the abbreviation of an installed application.
1897 If no <code>application</code> attribute is given, the following rules are applied:</p>
1898 <ul>
1899 <li>If the package installing the acp templates is an application, then the templates will be installed in this application's directory.</li>
1900 <li>If the package installing the acp templates is no application, then the templates will be installed in WoltLab Suite Core's directory.</li>
1901 </ul>
1902 <h2 id="example-in-packagexml">Example in <code>package.xml</code><a class="headerlink" href="#example-in-packagexml" title="Permanent link">#</a></h2>
1903 <div class="highlight"><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>
1904 <span class="c">&lt;!-- is the same as --&gt;</span>
1905 <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>
1906
1907 <span class="c">&lt;!-- if an application &quot;com.woltlab.example&quot; is being installed, the following lines are equivalent --&gt;</span>
1908 <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;acpTemplate&quot;</span> <span class="nt">/&gt;</span>
1909 <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>
1910 </code></pre></div>
1911
1912
1913
1914
1915
1916
1917
1918             </article>
1919           </div>
1920         </div>
1921       </main>
1922
1923
1924 <footer class="md-footer">
1925
1926     <nav class="md-footer__inner md-grid" aria-label="Footer">
1927
1928         <a href="../acp-search-provider/" class="md-footer__link md-footer__link--prev" rel="prev">
1929           <div class="md-footer__button md-icon">
1930             <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>
1931           </div>
1932           <div class="md-footer__title">
1933             <div class="md-ellipsis">
1934               <span class="md-footer__direction">
1935                 Previous
1936               </span>
1937               acpSearchProvider
1938             </div>
1939           </div>
1940         </a>
1941
1942
1943         <a href="../bbcode/" class="md-footer__link md-footer__link--next" rel="next">
1944           <div class="md-footer__title">
1945             <div class="md-ellipsis">
1946               <span class="md-footer__direction">
1947                 Next
1948               </span>
1949               bbcode
1950             </div>
1951           </div>
1952           <div class="md-footer__button md-icon">
1953             <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>
1954           </div>
1955         </a>
1956
1957     </nav>
1958
1959   <div class="md-footer-meta md-typeset">
1960     <div class="md-footer-meta__inner md-grid">
1961       <div class="md-footer-copyright">
1962
1963           <div class="md-footer-copyright__highlight">
1964             Copyright © 2020 WoltLab GmbH
1965           </div>
1966
1967         Made with
1968         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1969           Material for MkDocs
1970         </a>
1971       </div>
1972       <div class="md-footer-copyright">
1973         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
1974         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
1975 </div>
1976     </div>
1977   </div>
1978 </footer>
1979
1980     </div>
1981     <div class="md-dialog" data-md-component="dialog">
1982       <div class="md-dialog__inner md-typeset"></div>
1983     </div>
1984     <script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.fb4a9340.min.js", "version": {"provider": "mike"}}</script>
1985
1986
1987       <script src="../../../assets/javascripts/bundle.ca5457b8.min.js"></script>
1988
1989
1990   </body>
1991 </html>