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