5.4/package/pip/page/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="icon" href="../../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.2">
  14
  15
  16
  17         <title>page - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../assets/stylesheets/main.6f955dcd.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.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     <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  56
  57     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  58     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  59     <label class="md-overlay" for="__drawer"></label>
  60     <div data-md-component="skip">
  61
  62
  63         <a href="#page-package-installation-plugin" class="md-skip">
  64           Skip to content
  65         </a>
  66
  67     </div>
  68     <div data-md-component="announce">
  69
  70         <aside class="md-announce">
  71           <div class="md-announce__inner md-grid md-typeset">
  72
  73     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  74
  75           </div>
  76         </aside>
  77
  78     </div>
  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" data-md-component="logo">
  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               page
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106
 107
 108
 109       <label class="md-header__button md-icon" for="__search">
 110         <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>
 111       </label>
 112
 113 <div class="md-search" data-md-component="search" role="dialog">
 114   <label class="md-search__overlay" for="__search"></label>
 115   <div class="md-search__inner" role="search">
 116     <form class="md-search__form" name="search">
 117       <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>
 118       <label class="md-search__icon md-icon" for="__search">
 119         <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>
 120         <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>
 121       </label>
 122       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 123         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
 124       </button>
 125     </form>
 126     <div class="md-search__output">
 127       <div class="md-search__scrollwrap" data-md-scrollfix>
 128         <div class="md-search-result" data-md-component="search-result">
 129           <div class="md-search-result__meta">
 130             Initializing search
 131           </div>
 132           <ol class="md-search-result__list"></ol>
 133         </div>
 134       </div>
 135     </div>
 136   </div>
 137 </div>
 138
 139
 140       <div class="md-header__source">
 141
 142 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 143   <div class="md-source__icon md-icon">
 144
 145     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 146   </div>
 147   <div class="md-source__repository">
 148     GitHub
 149   </div>
 150 </a>
 151       </div>
 152
 153   </nav>
 154 </header>
 155
 156     <div class="md-container" data-md-component="container">
 157
 158
 159
 160
 161       <main class="md-main" data-md-component="main">
 162         <div class="md-main__inner md-grid">
 163
 164
 165
 166               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 167                 <div class="md-sidebar__scrollwrap">
 168                   <div class="md-sidebar__inner">
 169
 170
 171
 172 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 173   <label class="md-nav__title" for="__drawer">
 174     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 175
 176   <img src="../../../assets/logo.png" alt="logo">
 177
 178     </a>
 179     WoltLab Suite Documentation
 180   </label>
 181
 182     <div class="md-nav__source">
 183
 184 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 185   <div class="md-source__icon md-icon">
 186
 187     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 188   </div>
 189   <div class="md-source__repository">
 190     GitHub
 191   </div>
 192 </a>
 193     </div>
 194
 195   <ul class="md-nav__list" data-md-scrollfix>
 196
 197
 198
 199
 200
 201
 202
 203
 204     <li class="md-nav__item">
 205       <a href="../../../getting-started/" class="md-nav__link">
 206         Getting Started
 207       </a>
 208     </li>
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220     <li class="md-nav__item md-nav__item--nested">
 221
 222
 223         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 224
 225       <label class="md-nav__link" for="__nav_2">
 226         PHP API
 227         <span class="md-nav__icon md-icon"></span>
 228       </label>
 229       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 230         <label class="md-nav__title" for="__nav_2">
 231           <span class="md-nav__icon md-icon"></span>
 232           PHP API
 233         </label>
 234         <ul class="md-nav__list" data-md-scrollfix>
 235
 236
 237
 238
 239
 240     <li class="md-nav__item">
 241       <a href="../../../php/pages/" class="md-nav__link">
 242         Pages
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252     <li class="md-nav__item">
 253       <a href="../../../php/database-objects/" class="md-nav__link">
 254         Database Objects
 255       </a>
 256     </li>
 257
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../../php/database-access/" class="md-nav__link">
 266         Database Access
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276     <li class="md-nav__item">
 277       <a href="../../../php/exceptions/" class="md-nav__link">
 278         Exceptions
 279       </a>
 280     </li>
 281
 282
 283
 284
 285
 286
 287
 288
 289     <li class="md-nav__item md-nav__item--nested">
 290
 291
 292         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 293
 294       <label class="md-nav__link" for="__nav_2_5">
 295         API
 296         <span class="md-nav__icon md-icon"></span>
 297       </label>
 298       <nav class="md-nav" aria-label="API" data-md-level="2">
 299         <label class="md-nav__title" for="__nav_2_5">
 300           <span class="md-nav__icon md-icon"></span>
 301           API
 302         </label>
 303         <ul class="md-nav__list" data-md-scrollfix>
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item md-nav__item--nested">
 311
 312
 313         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 314
 315       <label class="md-nav__link" for="__nav_2_5_1">
 316         Caches
 317         <span class="md-nav__icon md-icon"></span>
 318       </label>
 319       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 320         <label class="md-nav__title" for="__nav_2_5_1">
 321           <span class="md-nav__icon md-icon"></span>
 322           Caches
 323         </label>
 324         <ul class="md-nav__list" data-md-scrollfix>
 325
 326
 327
 328
 329
 330     <li class="md-nav__item">
 331       <a href="../../../php/api/caches/" class="md-nav__link">
 332         Overview
 333       </a>
 334     </li>
 335
 336
 337
 338
 339
 340
 341
 342     <li class="md-nav__item">
 343       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 344         Persistent Caches
 345       </a>
 346     </li>
 347
 348
 349
 350
 351
 352
 353
 354     <li class="md-nav__item">
 355       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 356         Runtime Caches
 357       </a>
 358     </li>
 359
 360
 361
 362         </ul>
 363       </nav>
 364     </li>
 365
 366
 367
 368
 369
 370
 371
 372     <li class="md-nav__item">
 373       <a href="../../../php/api/comments/" class="md-nav__link">
 374         Comments
 375       </a>
 376     </li>
 377
 378
 379
 380
 381
 382
 383
 384     <li class="md-nav__item">
 385       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 386         Cronjobs
 387       </a>
 388     </li>
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../../php/api/events/" class="md-nav__link">
 398         Events
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409     <li class="md-nav__item md-nav__item--nested">
 410
 411
 412         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 413
 414       <label class="md-nav__link" for="__nav_2_5_5">
 415         Form Builder
 416         <span class="md-nav__icon md-icon"></span>
 417       </label>
 418       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 419         <label class="md-nav__title" for="__nav_2_5_5">
 420           <span class="md-nav__icon md-icon"></span>
 421           Form Builder
 422         </label>
 423         <ul class="md-nav__list" data-md-scrollfix>
 424
 425
 426
 427
 428
 429     <li class="md-nav__item">
 430       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 431         Overview
 432       </a>
 433     </li>
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 443         Structure
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item">
 454       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 455         Fields
 456       </a>
 457     </li>
 458
 459
 460
 461
 462
 463
 464
 465     <li class="md-nav__item">
 466       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 467         Validation and Data
 468       </a>
 469     </li>
 470
 471
 472
 473
 474
 475
 476
 477     <li class="md-nav__item">
 478       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 479         Dependencies
 480       </a>
 481     </li>
 482
 483
 484
 485         </ul>
 486       </nav>
 487     </li>
 488
 489
 490
 491
 492
 493
 494
 495     <li class="md-nav__item">
 496       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 497         Package Installation Plugins
 498       </a>
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507     <li class="md-nav__item">
 508       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 509         User Activity Points
 510       </a>
 511     </li>
 512
 513
 514
 515
 516
 517
 518
 519     <li class="md-nav__item">
 520       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 521         User Notifications
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531     <li class="md-nav__item">
 532       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 533         Sitemaps
 534       </a>
 535     </li>
 536
 537
 538
 539         </ul>
 540       </nav>
 541     </li>
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../../php/code-style/" class="md-nav__link">
 551         Code Style
 552       </a>
 553     </li>
 554
 555
 556
 557
 558
 559
 560
 561     <li class="md-nav__item">
 562       <a href="../../../php/apps/" class="md-nav__link">
 563         Apps
 564       </a>
 565     </li>
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/gdpr/" class="md-nav__link">
 575         GDPR
 576       </a>
 577     </li>
 578
 579
 580
 581         </ul>
 582       </nav>
 583     </li>
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595     <li class="md-nav__item md-nav__item--nested">
 596
 597
 598         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 599
 600       <label class="md-nav__link" for="__nav_3">
 601         Languages, Templates & CSS
 602         <span class="md-nav__icon md-icon"></span>
 603       </label>
 604       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 605         <label class="md-nav__title" for="__nav_3">
 606           <span class="md-nav__icon md-icon"></span>
 607           Languages, Templates & CSS
 608         </label>
 609         <ul class="md-nav__list" data-md-scrollfix>
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../view/languages/" class="md-nav__link">
 617         Languages
 618       </a>
 619     </li>
 620
 621
 622
 623
 624
 625
 626
 627     <li class="md-nav__item">
 628       <a href="../../../view/templates/" class="md-nav__link">
 629         Templates
 630       </a>
 631     </li>
 632
 633
 634
 635
 636
 637
 638
 639     <li class="md-nav__item">
 640       <a href="../../../view/template-plugins/" class="md-nav__link">
 641         Template Plugins
 642       </a>
 643     </li>
 644
 645
 646
 647
 648
 649
 650
 651     <li class="md-nav__item">
 652       <a href="../../../view/css/" class="md-nav__link">
 653         CSS
 654       </a>
 655     </li>
 656
 657
 658
 659         </ul>
 660       </nav>
 661     </li>
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673     <li class="md-nav__item md-nav__item--nested">
 674
 675
 676         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 677
 678       <label class="md-nav__link" for="__nav_4">
 679         TypeScript and JavaScript API
 680         <span class="md-nav__icon md-icon"></span>
 681       </label>
 682       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 683         <label class="md-nav__title" for="__nav_4">
 684           <span class="md-nav__icon md-icon"></span>
 685           TypeScript and JavaScript API
 686         </label>
 687         <ul class="md-nav__list" data-md-scrollfix>
 688
 689
 690
 691
 692
 693     <li class="md-nav__item">
 694       <a href="../../../javascript/general-usage/" class="md-nav__link">
 695         General Usage
 696       </a>
 697     </li>
 698
 699
 700
 701
 702
 703
 704
 705     <li class="md-nav__item">
 706       <a href="../../../javascript/typescript/" class="md-nav__link">
 707         TypeScript
 708       </a>
 709     </li>
 710
 711
 712
 713
 714
 715
 716
 717
 718     <li class="md-nav__item md-nav__item--nested">
 719
 720
 721         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 722
 723       <label class="md-nav__link" for="__nav_4_3">
 724         New API
 725         <span class="md-nav__icon md-icon"></span>
 726       </label>
 727       <nav class="md-nav" aria-label="New API" data-md-level="2">
 728         <label class="md-nav__title" for="__nav_4_3">
 729           <span class="md-nav__icon md-icon"></span>
 730           New API
 731         </label>
 732         <ul class="md-nav__list" data-md-scrollfix>
 733
 734
 735
 736
 737
 738     <li class="md-nav__item">
 739       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 740         Writing a module
 741       </a>
 742     </li>
 743
 744
 745
 746
 747
 748
 749
 750     <li class="md-nav__item">
 751       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 752         Data Structures
 753       </a>
 754     </li>
 755
 756
 757
 758
 759
 760
 761
 762     <li class="md-nav__item">
 763       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 764         Core Functions
 765       </a>
 766     </li>
 767
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item">
 775       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 776         DOM
 777       </a>
 778     </li>
 779
 780
 781
 782
 783
 784
 785
 786     <li class="md-nav__item">
 787       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 788         Event Handling
 789       </a>
 790     </li>
 791
 792
 793
 794
 795
 796
 797
 798     <li class="md-nav__item">
 799       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 800         Ajax
 801       </a>
 802     </li>
 803
 804
 805
 806
 807
 808
 809
 810     <li class="md-nav__item">
 811       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 812         Dialogs
 813       </a>
 814     </li>
 815
 816
 817
 818
 819
 820
 821
 822     <li class="md-nav__item">
 823       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 824         Browser and Screen Sizes
 825       </a>
 826     </li>
 827
 828
 829
 830
 831
 832
 833
 834     <li class="md-nav__item">
 835       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 836         User Interface
 837       </a>
 838     </li>
 839
 840
 841
 842         </ul>
 843       </nav>
 844     </li>
 845
 846
 847
 848
 849
 850
 851
 852     <li class="md-nav__item">
 853       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 854         Legacy API
 855       </a>
 856     </li>
 857
 858
 859
 860
 861
 862
 863
 864     <li class="md-nav__item">
 865       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 866         Helper Functions
 867       </a>
 868     </li>
 869
 870
 871
 872
 873
 874
 875
 876     <li class="md-nav__item">
 877       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 878         Code Snippets
 879       </a>
 880     </li>
 881
 882
 883
 884         </ul>
 885       </nav>
 886     </li>
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 901
 902
 903         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 904
 905       <label class="md-nav__link" for="__nav_5">
 906         Package Components
 907         <span class="md-nav__icon md-icon"></span>
 908       </label>
 909       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 910         <label class="md-nav__title" for="__nav_5">
 911           <span class="md-nav__icon md-icon"></span>
 912           Package Components
 913         </label>
 914         <ul class="md-nav__list" data-md-scrollfix>
 915
 916
 917
 918
 919
 920     <li class="md-nav__item">
 921       <a href="../../package-xml/" class="md-nav__link">
 922         package.xml
 923       </a>
 924     </li>
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 936
 937
 938         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 939
 940       <label class="md-nav__link" for="__nav_5_2">
 941         PIPs
 942         <span class="md-nav__icon md-icon"></span>
 943       </label>
 944       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 945         <label class="md-nav__title" for="__nav_5_2">
 946           <span class="md-nav__icon md-icon"></span>
 947           PIPs
 948         </label>
 949         <ul class="md-nav__list" data-md-scrollfix>
 950
 951
 952
 953
 954
 955     <li class="md-nav__item">
 956       <a href="../" class="md-nav__link">
 957         Overview
 958       </a>
 959     </li>
 960
 961
 962
 963
 964
 965
 966
 967     <li class="md-nav__item">
 968       <a href="../acl-option/" class="md-nav__link">
 969         aclOption
 970       </a>
 971     </li>
 972
 973
 974
 975
 976
 977
 978
 979     <li class="md-nav__item">
 980       <a href="../acp-menu/" class="md-nav__link">
 981         acpMenu
 982       </a>
 983     </li>
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../acp-search-provider/" class="md-nav__link">
 993         acpSearchProvider
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003     <li class="md-nav__item">
1004       <a href="../acp-template/" class="md-nav__link">
1005         acpTemplate
1006       </a>
1007     </li>
1008
1009
1010
1011
1012
1013
1014
1015     <li class="md-nav__item">
1016       <a href="../bbcode/" class="md-nav__link">
1017         bbcode
1018       </a>
1019     </li>
1020
1021
1022
1023
1024
1025
1026
1027     <li class="md-nav__item">
1028       <a href="../box/" class="md-nav__link">
1029         box
1030       </a>
1031     </li>
1032
1033
1034
1035
1036
1037
1038
1039     <li class="md-nav__item">
1040       <a href="../clipboard-action/" class="md-nav__link">
1041         clipboardAction
1042       </a>
1043     </li>
1044
1045
1046
1047
1048
1049
1050
1051     <li class="md-nav__item">
1052       <a href="../core-object/" class="md-nav__link">
1053         coreObject
1054       </a>
1055     </li>
1056
1057
1058
1059
1060
1061
1062
1063     <li class="md-nav__item">
1064       <a href="../cronjob/" class="md-nav__link">
1065         cronjob
1066       </a>
1067     </li>
1068
1069
1070
1071
1072
1073
1074
1075     <li class="md-nav__item">
1076       <a href="../database/" class="md-nav__link">
1077         database
1078       </a>
1079     </li>
1080
1081
1082
1083
1084
1085
1086
1087     <li class="md-nav__item">
1088       <a href="../event-listener/" class="md-nav__link">
1089         eventListener
1090       </a>
1091     </li>
1092
1093
1094
1095
1096
1097
1098
1099     <li class="md-nav__item">
1100       <a href="../file/" class="md-nav__link">
1101         file
1102       </a>
1103     </li>
1104
1105
1106
1107
1108
1109
1110
1111     <li class="md-nav__item">
1112       <a href="../language/" class="md-nav__link">
1113         language
1114       </a>
1115     </li>
1116
1117
1118
1119
1120
1121
1122
1123     <li class="md-nav__item">
1124       <a href="../media-provider/" class="md-nav__link">
1125         mediaProvider
1126       </a>
1127     </li>
1128
1129
1130
1131
1132
1133
1134
1135     <li class="md-nav__item">
1136       <a href="../menu/" class="md-nav__link">
1137         menu
1138       </a>
1139     </li>
1140
1141
1142
1143
1144
1145
1146
1147     <li class="md-nav__item">
1148       <a href="../menu-item/" class="md-nav__link">
1149         menuItem
1150       </a>
1151     </li>
1152
1153
1154
1155
1156
1157
1158
1159     <li class="md-nav__item">
1160       <a href="../object-type/" class="md-nav__link">
1161         objectType
1162       </a>
1163     </li>
1164
1165
1166
1167
1168
1169
1170
1171     <li class="md-nav__item">
1172       <a href="../object-type-definition/" class="md-nav__link">
1173         objectTypeDefinition
1174       </a>
1175     </li>
1176
1177
1178
1179
1180
1181
1182
1183     <li class="md-nav__item">
1184       <a href="../option/" class="md-nav__link">
1185         option
1186       </a>
1187     </li>
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197     <li class="md-nav__item md-nav__item--active">
1198
1199       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1200
1201
1202
1203
1204
1205         <label class="md-nav__link md-nav__link--active" for="__toc">
1206           page
1207           <span class="md-nav__icon md-icon"></span>
1208         </label>
1209
1210       <a href="./" class="md-nav__link md-nav__link--active">
1211         page
1212       </a>
1213
1214
1215 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1216
1217
1218
1219
1220
1221
1222     <label class="md-nav__title" for="__toc">
1223       <span class="md-nav__icon md-icon"></span>
1224       Table of contents
1225     </label>
1226     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1227
1228         <li class="md-nav__item">
1229   <a href="#components" class="md-nav__link">
1230     Components
1231   </a>
1232
1233     <nav class="md-nav" aria-label="Components">
1234       <ul class="md-nav__list">
1235
1236           <li class="md-nav__item">
1237   <a href="#pagetype" class="md-nav__link">
1238     &lt;pageType&gt;
1239   </a>
1240
1241     <nav class="md-nav" aria-label="&lt;pageType&gt;">
1242       <ul class="md-nav__list">
1243
1244           <li class="md-nav__item">
1245   <a href="#system" class="md-nav__link">
1246     system
1247   </a>
1248
1249 </li>
1250
1251           <li class="md-nav__item">
1252   <a href="#html-text-or-tpl" class="md-nav__link">
1253     html, text or tpl
1254   </a>
1255
1256 </li>
1257
1258       </ul>
1259     </nav>
1260
1261 </li>
1262
1263           <li class="md-nav__item">
1264   <a href="#controller" class="md-nav__link">
1265     &lt;controller&gt;
1266   </a>
1267
1268 </li>
1269
1270           <li class="md-nav__item">
1271   <a href="#handler" class="md-nav__link">
1272     &lt;handler&gt;
1273   </a>
1274
1275 </li>
1276
1277           <li class="md-nav__item">
1278   <a href="#name" class="md-nav__link">
1279     &lt;name&gt;
1280   </a>
1281
1282 </li>
1283
1284           <li class="md-nav__item">
1285   <a href="#parent" class="md-nav__link">
1286     &lt;parent&gt;
1287   </a>
1288
1289 </li>
1290
1291           <li class="md-nav__item">
1292   <a href="#hasfixedparent" class="md-nav__link">
1293     &lt;hasFixedParent&gt;
1294   </a>
1295
1296 </li>
1297
1298           <li class="md-nav__item">
1299   <a href="#permissions" class="md-nav__link">
1300     &lt;permissions&gt;
1301   </a>
1302
1303 </li>
1304
1305           <li class="md-nav__item">
1306   <a href="#options" class="md-nav__link">
1307     &lt;options&gt;
1308   </a>
1309
1310 </li>
1311
1312           <li class="md-nav__item">
1313   <a href="#excludefromlandingpage" class="md-nav__link">
1314     &lt;excludeFromLandingPage&gt;
1315   </a>
1316
1317 </li>
1318
1319           <li class="md-nav__item">
1320   <a href="#content" class="md-nav__link">
1321     &lt;content&gt;
1322   </a>
1323
1324     <nav class="md-nav" aria-label="&lt;content&gt;">
1325       <ul class="md-nav__list">
1326
1327           <li class="md-nav__item">
1328   <a href="#title" class="md-nav__link">
1329     &lt;title&gt;
1330   </a>
1331
1332 </li>
1333
1334           <li class="md-nav__item">
1335   <a href="#content_1" class="md-nav__link">
1336     &lt;content&gt;
1337   </a>
1338
1339 </li>
1340
1341       </ul>
1342     </nav>
1343
1344 </li>
1345
1346       </ul>
1347     </nav>
1348
1349 </li>
1350
1351         <li class="md-nav__item">
1352   <a href="#example" class="md-nav__link">
1353     Example
1354   </a>
1355
1356 </li>
1357
1358     </ul>
1359
1360 </nav>
1361
1362     </li>
1363
1364
1365
1366
1367
1368
1369
1370     <li class="md-nav__item">
1371       <a href="../pip/" class="md-nav__link">
1372         pip
1373       </a>
1374     </li>
1375
1376
1377
1378
1379
1380
1381
1382     <li class="md-nav__item">
1383       <a href="../script/" class="md-nav__link">
1384         script
1385       </a>
1386     </li>
1387
1388
1389
1390
1391
1392
1393
1394     <li class="md-nav__item">
1395       <a href="../smiley/" class="md-nav__link">
1396         smiley
1397       </a>
1398     </li>
1399
1400
1401
1402
1403
1404
1405
1406     <li class="md-nav__item">
1407       <a href="../sql/" class="md-nav__link">
1408         sql
1409       </a>
1410     </li>
1411
1412
1413
1414
1415
1416
1417
1418     <li class="md-nav__item">
1419       <a href="../style/" class="md-nav__link">
1420         style
1421       </a>
1422     </li>
1423
1424
1425
1426
1427
1428
1429
1430     <li class="md-nav__item">
1431       <a href="../template/" class="md-nav__link">
1432         template
1433       </a>
1434     </li>
1435
1436
1437
1438
1439
1440
1441
1442     <li class="md-nav__item">
1443       <a href="../template-listener/" class="md-nav__link">
1444         templateListener
1445       </a>
1446     </li>
1447
1448
1449
1450
1451
1452
1453
1454     <li class="md-nav__item">
1455       <a href="../user-group-option/" class="md-nav__link">
1456         userGroupOption
1457       </a>
1458     </li>
1459
1460
1461
1462
1463
1464
1465
1466     <li class="md-nav__item">
1467       <a href="../user-menu/" class="md-nav__link">
1468         userMenu
1469       </a>
1470     </li>
1471
1472
1473
1474
1475
1476
1477
1478     <li class="md-nav__item">
1479       <a href="../user-notification-event/" class="md-nav__link">
1480         userNotificationEvent
1481       </a>
1482     </li>
1483
1484
1485
1486
1487
1488
1489
1490     <li class="md-nav__item">
1491       <a href="../user-option/" class="md-nav__link">
1492         userOption
1493       </a>
1494     </li>
1495
1496
1497
1498
1499
1500
1501
1502     <li class="md-nav__item">
1503       <a href="../user-profile-menu/" class="md-nav__link">
1504         userProfileMenu
1505       </a>
1506     </li>
1507
1508
1509
1510         </ul>
1511       </nav>
1512     </li>
1513
1514
1515
1516
1517
1518
1519
1520     <li class="md-nav__item">
1521       <a href="../../database-php-api/" class="md-nav__link">
1522         Database PHP API
1523       </a>
1524     </li>
1525
1526
1527
1528         </ul>
1529       </nav>
1530     </li>
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542     <li class="md-nav__item md-nav__item--nested">
1543
1544
1545         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1546
1547       <label class="md-nav__link" for="__nav_6">
1548         Migration
1549         <span class="md-nav__icon md-icon"></span>
1550       </label>
1551       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1552         <label class="md-nav__title" for="__nav_6">
1553           <span class="md-nav__icon md-icon"></span>
1554           Migration
1555         </label>
1556         <ul class="md-nav__list" data-md-scrollfix>
1557
1558
1559
1560
1561
1562
1563     <li class="md-nav__item md-nav__item--nested">
1564
1565
1566         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1567
1568       <label class="md-nav__link" for="__nav_6_1">
1569         Migrating from WSC 5.3
1570         <span class="md-nav__icon md-icon"></span>
1571       </label>
1572       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1573         <label class="md-nav__title" for="__nav_6_1">
1574           <span class="md-nav__icon md-icon"></span>
1575           Migrating from WSC 5.3
1576         </label>
1577         <ul class="md-nav__list" data-md-scrollfix>
1578
1579
1580
1581
1582
1583     <li class="md-nav__item">
1584       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1585         PHP API
1586       </a>
1587     </li>
1588
1589
1590
1591
1592
1593
1594
1595     <li class="md-nav__item">
1596       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1597         Session Handling and Authentication
1598       </a>
1599     </li>
1600
1601
1602
1603
1604
1605
1606
1607     <li class="md-nav__item">
1608       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1609         TypeScript and JavaScript
1610       </a>
1611     </li>
1612
1613
1614
1615
1616
1617
1618
1619     <li class="md-nav__item">
1620       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1621         Templates
1622       </a>
1623     </li>
1624
1625
1626
1627
1628
1629
1630
1631     <li class="md-nav__item">
1632       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1633         Third Party Libraries
1634       </a>
1635     </li>
1636
1637
1638
1639         </ul>
1640       </nav>
1641     </li>
1642
1643
1644
1645
1646
1647
1648
1649
1650     <li class="md-nav__item md-nav__item--nested">
1651
1652
1653         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1654
1655       <label class="md-nav__link" for="__nav_6_2">
1656         Migrating from WSC 5.2
1657         <span class="md-nav__icon md-icon"></span>
1658       </label>
1659       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1660         <label class="md-nav__title" for="__nav_6_2">
1661           <span class="md-nav__icon md-icon"></span>
1662           Migrating from WSC 5.2
1663         </label>
1664         <ul class="md-nav__list" data-md-scrollfix>
1665
1666
1667
1668
1669
1670     <li class="md-nav__item">
1671       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1672         PHP API
1673       </a>
1674     </li>
1675
1676
1677
1678
1679
1680
1681
1682     <li class="md-nav__item">
1683       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1684         Templates and Languages
1685       </a>
1686     </li>
1687
1688
1689
1690
1691
1692
1693
1694     <li class="md-nav__item">
1695       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1696         Third Party Libraries
1697       </a>
1698     </li>
1699
1700
1701
1702         </ul>
1703       </nav>
1704     </li>
1705
1706
1707
1708
1709
1710
1711
1712
1713     <li class="md-nav__item md-nav__item--nested">
1714
1715
1716         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1717
1718       <label class="md-nav__link" for="__nav_6_3">
1719         Migrating from WSC 3.1
1720         <span class="md-nav__icon md-icon"></span>
1721       </label>
1722       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1723         <label class="md-nav__title" for="__nav_6_3">
1724           <span class="md-nav__icon md-icon"></span>
1725           Migrating from WSC 3.1
1726         </label>
1727         <ul class="md-nav__list" data-md-scrollfix>
1728
1729
1730
1731
1732
1733     <li class="md-nav__item">
1734       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1735         PHP API
1736       </a>
1737     </li>
1738
1739
1740
1741         </ul>
1742       </nav>
1743     </li>
1744
1745
1746
1747
1748
1749
1750
1751
1752     <li class="md-nav__item md-nav__item--nested">
1753
1754
1755         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1756
1757       <label class="md-nav__link" for="__nav_6_4">
1758         Migrating from WSC 3.0
1759         <span class="md-nav__icon md-icon"></span>
1760       </label>
1761       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1762         <label class="md-nav__title" for="__nav_6_4">
1763           <span class="md-nav__icon md-icon"></span>
1764           Migrating from WSC 3.0
1765         </label>
1766         <ul class="md-nav__list" data-md-scrollfix>
1767
1768
1769
1770
1771
1772     <li class="md-nav__item">
1773       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1774         PHP API
1775       </a>
1776     </li>
1777
1778
1779
1780
1781
1782
1783
1784     <li class="md-nav__item">
1785       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1786         JavaScript API
1787       </a>
1788     </li>
1789
1790
1791
1792
1793
1794
1795
1796     <li class="md-nav__item">
1797       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1798         Templates
1799       </a>
1800     </li>
1801
1802
1803
1804
1805
1806
1807
1808     <li class="md-nav__item">
1809       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1810         CSS
1811       </a>
1812     </li>
1813
1814
1815
1816
1817
1818
1819
1820     <li class="md-nav__item">
1821       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1822         Package Components
1823       </a>
1824     </li>
1825
1826
1827
1828         </ul>
1829       </nav>
1830     </li>
1831
1832
1833
1834
1835
1836
1837
1838
1839     <li class="md-nav__item md-nav__item--nested">
1840
1841
1842         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1843
1844       <label class="md-nav__link" for="__nav_6_5">
1845         Migrating from WCF 2.1
1846         <span class="md-nav__icon md-icon"></span>
1847       </label>
1848       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1849         <label class="md-nav__title" for="__nav_6_5">
1850           <span class="md-nav__icon md-icon"></span>
1851           Migrating from WCF 2.1
1852         </label>
1853         <ul class="md-nav__list" data-md-scrollfix>
1854
1855
1856
1857
1858
1859     <li class="md-nav__item">
1860       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1861         PHP API
1862       </a>
1863     </li>
1864
1865
1866
1867
1868
1869
1870
1871     <li class="md-nav__item">
1872       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1873         Templates
1874       </a>
1875     </li>
1876
1877
1878
1879
1880
1881
1882
1883     <li class="md-nav__item">
1884       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1885         CSS
1886       </a>
1887     </li>
1888
1889
1890
1891
1892
1893
1894
1895     <li class="md-nav__item">
1896       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1897         Package Components
1898       </a>
1899     </li>
1900
1901
1902
1903         </ul>
1904       </nav>
1905     </li>
1906
1907
1908
1909         </ul>
1910       </nav>
1911     </li>
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923     <li class="md-nav__item md-nav__item--nested">
1924
1925
1926         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1927
1928       <label class="md-nav__link" for="__nav_7">
1929         Tutorials
1930         <span class="md-nav__icon md-icon"></span>
1931       </label>
1932       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1933         <label class="md-nav__title" for="__nav_7">
1934           <span class="md-nav__icon md-icon"></span>
1935           Tutorials
1936         </label>
1937         <ul class="md-nav__list" data-md-scrollfix>
1938
1939
1940
1941
1942
1943
1944     <li class="md-nav__item md-nav__item--nested">
1945
1946
1947         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1948
1949       <label class="md-nav__link" for="__nav_7_1">
1950         Tutorial Series
1951         <span class="md-nav__icon md-icon"></span>
1952       </label>
1953       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1954         <label class="md-nav__title" for="__nav_7_1">
1955           <span class="md-nav__icon md-icon"></span>
1956           Tutorial Series
1957         </label>
1958         <ul class="md-nav__list" data-md-scrollfix>
1959
1960
1961
1962
1963
1964     <li class="md-nav__item">
1965       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1966         Overview
1967       </a>
1968     </li>
1969
1970
1971
1972
1973
1974
1975
1976     <li class="md-nav__item">
1977       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1978         Part 1
1979       </a>
1980     </li>
1981
1982
1983
1984
1985
1986
1987
1988     <li class="md-nav__item">
1989       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1990         Part 2
1991       </a>
1992     </li>
1993
1994
1995
1996
1997
1998
1999
2000     <li class="md-nav__item">
2001       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2002         Part 3
2003       </a>
2004     </li>
2005
2006
2007
2008
2009
2010
2011
2012     <li class="md-nav__item">
2013       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2014         Part 4
2015       </a>
2016     </li>
2017
2018
2019
2020
2021
2022
2023
2024     <li class="md-nav__item">
2025       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2026         Part 5
2027       </a>
2028     </li>
2029
2030
2031
2032         </ul>
2033       </nav>
2034     </li>
2035
2036
2037
2038         </ul>
2039       </nav>
2040     </li>
2041
2042
2043
2044   </ul>
2045 </nav>
2046                   </div>
2047                 </div>
2048               </div>
2049
2050
2051
2052               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2053                 <div class="md-sidebar__scrollwrap">
2054                   <div class="md-sidebar__inner">
2055
2056 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2057
2058
2059
2060
2061
2062
2063     <label class="md-nav__title" for="__toc">
2064       <span class="md-nav__icon md-icon"></span>
2065       Table of contents
2066     </label>
2067     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2068
2069         <li class="md-nav__item">
2070   <a href="#components" class="md-nav__link">
2071     Components
2072   </a>
2073
2074     <nav class="md-nav" aria-label="Components">
2075       <ul class="md-nav__list">
2076
2077           <li class="md-nav__item">
2078   <a href="#pagetype" class="md-nav__link">
2079     &lt;pageType&gt;
2080   </a>
2081
2082     <nav class="md-nav" aria-label="&lt;pageType&gt;">
2083       <ul class="md-nav__list">
2084
2085           <li class="md-nav__item">
2086   <a href="#system" class="md-nav__link">
2087     system
2088   </a>
2089
2090 </li>
2091
2092           <li class="md-nav__item">
2093   <a href="#html-text-or-tpl" class="md-nav__link">
2094     html, text or tpl
2095   </a>
2096
2097 </li>
2098
2099       </ul>
2100     </nav>
2101
2102 </li>
2103
2104           <li class="md-nav__item">
2105   <a href="#controller" class="md-nav__link">
2106     &lt;controller&gt;
2107   </a>
2108
2109 </li>
2110
2111           <li class="md-nav__item">
2112   <a href="#handler" class="md-nav__link">
2113     &lt;handler&gt;
2114   </a>
2115
2116 </li>
2117
2118           <li class="md-nav__item">
2119   <a href="#name" class="md-nav__link">
2120     &lt;name&gt;
2121   </a>
2122
2123 </li>
2124
2125           <li class="md-nav__item">
2126   <a href="#parent" class="md-nav__link">
2127     &lt;parent&gt;
2128   </a>
2129
2130 </li>
2131
2132           <li class="md-nav__item">
2133   <a href="#hasfixedparent" class="md-nav__link">
2134     &lt;hasFixedParent&gt;
2135   </a>
2136
2137 </li>
2138
2139           <li class="md-nav__item">
2140   <a href="#permissions" class="md-nav__link">
2141     &lt;permissions&gt;
2142   </a>
2143
2144 </li>
2145
2146           <li class="md-nav__item">
2147   <a href="#options" class="md-nav__link">
2148     &lt;options&gt;
2149   </a>
2150
2151 </li>
2152
2153           <li class="md-nav__item">
2154   <a href="#excludefromlandingpage" class="md-nav__link">
2155     &lt;excludeFromLandingPage&gt;
2156   </a>
2157
2158 </li>
2159
2160           <li class="md-nav__item">
2161   <a href="#content" class="md-nav__link">
2162     &lt;content&gt;
2163   </a>
2164
2165     <nav class="md-nav" aria-label="&lt;content&gt;">
2166       <ul class="md-nav__list">
2167
2168           <li class="md-nav__item">
2169   <a href="#title" class="md-nav__link">
2170     &lt;title&gt;
2171   </a>
2172
2173 </li>
2174
2175           <li class="md-nav__item">
2176   <a href="#content_1" class="md-nav__link">
2177     &lt;content&gt;
2178   </a>
2179
2180 </li>
2181
2182       </ul>
2183     </nav>
2184
2185 </li>
2186
2187       </ul>
2188     </nav>
2189
2190 </li>
2191
2192         <li class="md-nav__item">
2193   <a href="#example" class="md-nav__link">
2194     Example
2195   </a>
2196
2197 </li>
2198
2199     </ul>
2200
2201 </nav>
2202                   </div>
2203                 </div>
2204               </div>
2205
2206
2207           <div class="md-content" data-md-component="content">
2208             <article class="md-content__inner md-typeset">
2209
2210
2211                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/page.md" title="Edit this page" class="md-content__button md-icon">
2212                     <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>
2213                   </a>
2214
2215
2216                 <h1 id="page-package-installation-plugin">Page Package Installation Plugin<a class="headerlink" href="#page-package-installation-plugin" title="Permanent link">#</a></h1>
2217 <p>Registers page controllers, making them available for selection and configuration, including but not limited to boxes and menus.</p>
2218 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
2219 <p>Each item is described as a <code>&lt;page&gt;</code> element with the mandatory attribute <code>identifier</code> that should follow the naming pattern <code>&lt;packageIdentifier&gt;.&lt;PageName&gt;</code>, e.g. <code>com.woltlab.wcf.MembersList</code>.</p>
2220 <h3 id="pagetype"><code>&lt;pageType&gt;</code><a class="headerlink" href="#pagetype" title="Permanent link">#</a></h3>
2221 <h4 id="system"><code>system</code><a class="headerlink" href="#system" title="Permanent link">#</a></h4>
2222 <p>The special <code>system</code> type is reserved for pages that pull their properties and content from a registered PHP class. Requires the <code>&lt;controller&gt;</code> element.</p>
2223 <h4 id="html-text-or-tpl"><code>html</code>, <code>text</code> or <code>tpl</code><a class="headerlink" href="#html-text-or-tpl" title="Permanent link">#</a></h4>
2224 <p>Provide arbitrary content, requires the <code>&lt;content&gt;</code> element.</p>
2225 <h3 id="controller"><code>&lt;controller&gt;</code><a class="headerlink" href="#controller" title="Permanent link">#</a></h3>
2226 <p>Fully qualified class name for the controller, must implement <code>wcf\page\IPage</code> or <code>wcf\form\IForm</code>.</p>
2227 <h3 id="handler"><code>&lt;handler&gt;</code><a class="headerlink" href="#handler" title="Permanent link">#</a></h3>
2228 <p>Fully qualified class name that can be optionally set to provide additional methods, such as displaying a badge for unread content and verifying permissions per page object id.</p>
2229 <h3 id="name"><code>&lt;name&gt;</code><a class="headerlink" href="#name" title="Permanent link">#</a></h3>
2230 <div class="admonition info">
2231 <p class="admonition-title">The <code>language</code> attribute is required and should specify the <a href="https://en.wikipedia.org/wiki/ISO_639-1">ISO-639-1</a> language code.</p>
2232 </div>
2233 <p>The internal name displayed in the admin panel only, can be fully customized by the administrator and is immutable. Only one value is accepted and will be picked based on the site's default language, but you can provide localized values by including multiple <code>&lt;name&gt;</code> elements.</p>
2234 <h3 id="parent"><code>&lt;parent&gt;</code><a class="headerlink" href="#parent" title="Permanent link">#</a></h3>
2235 <p>Sets the default parent page using its internal identifier, this setting controls the breadcrumbs and active menu item hierarchy.</p>
2236 <h3 id="hasfixedparent"><code>&lt;hasFixedParent&gt;</code><a class="headerlink" href="#hasfixedparent" title="Permanent link">#</a></h3>
2237 <p>Pages can be assigned any other page as parent page by default, set to <code>1</code> to make the parent setting immutable.</p>
2238 <h3 id="permissions"><code>&lt;permissions&gt;</code><a class="headerlink" href="#permissions" title="Permanent link">#</a></h3>
2239 <div class="admonition warning">
2240 <p class="admonition-title">The comma represents a logical <code>or</code>, the check is successful if at least one permission is set.</p>
2241 </div>
2242 <p>Comma separated list of permission names that will be checked one after another until at least one permission is set.</p>
2243 <h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2244 <div class="admonition warning">
2245 <p class="admonition-title">The comma represents a logical <code>or</code>, the check is successful if at least one option is enabled.</p>
2246 </div>
2247 <p>Comma separated list of options that will be checked one after another until at least one option is set.</p>
2248 <h3 id="excludefromlandingpage"><code>&lt;excludeFromLandingPage&gt;</code><a class="headerlink" href="#excludefromlandingpage" title="Permanent link">#</a></h3>
2249 <p>Some pages should not be used as landing page, because they may not always be
2250 available and/or accessible to the user. For example, the account management
2251 page is available to logged-in users only and any guest attempting to visit that
2252 page would be presented with a permission denied message.</p>
2253 <p>Set this to <code>1</code> to prevent this page from becoming a landing page ever.</p>
2254 <h3 id="content"><code>&lt;content&gt;</code><a class="headerlink" href="#content" title="Permanent link">#</a></h3>
2255 <div class="admonition info">
2256 <p class="admonition-title">The <code>language</code> attribute is required and should specify the <a href="https://en.wikipedia.org/wiki/ISO_639-1">ISO-639-1</a> language code.</p>
2257 </div>
2258 <h4 id="title"><code>&lt;title&gt;</code><a class="headerlink" href="#title" title="Permanent link">#</a></h4>
2259 <p>The title element is required and controls the page title shown to the end users.</p>
2260 <h4 id="content_1"><code>&lt;content&gt;</code><a class="headerlink" href="#content_1" title="Permanent link">#</a></h4>
2261 <p>The content that should be used to populate the page, only used and required if the <code>pageType</code> equals <code>text</code>, <code>html</code> and <code>tpl</code>.</p>
2262 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2263 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2264 <span class="normal"> 2</span>
2265 <span class="normal"> 3</span>
2266 <span class="normal"> 4</span>
2267 <span class="normal"> 5</span>
2268 <span class="normal"> 6</span>
2269 <span class="normal"> 7</span>
2270 <span class="normal"> 8</span>
2271 <span class="normal"> 9</span>
2272 <span class="normal">10</span>
2273 <span class="normal">11</span>
2274 <span class="normal">12</span>
2275 <span class="normal">13</span>
2276 <span class="normal">14</span>
2277 <span class="normal">15</span>
2278 <span class="normal">16</span>
2279 <span class="normal">17</span>
2280 <span class="normal">18</span>
2281 <span class="normal">19</span>
2282 <span class="normal">20</span>
2283 <span class="normal">21</span>
2284 <span class="normal">22</span>
2285 <span class="normal">23</span>
2286 <span class="normal">24</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2287 <span class="nt">&lt;data</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span> <span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span> <span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/page.xsd&quot;</span><span class="nt">&gt;</span>
2288     <span class="nt">&lt;import&gt;</span>
2289         <span class="nt">&lt;page</span> <span class="na">identifier=</span><span class="s">&quot;com.woltlab.wcf.MembersList&quot;</span><span class="nt">&gt;</span>
2290             <span class="nt">&lt;pageType&gt;</span>system<span class="nt">&lt;/pageType&gt;</span>
2291             <span class="nt">&lt;controller&gt;</span>wcf\page\MembersListPage<span class="nt">&lt;/controller&gt;</span>
2292             <span class="nt">&lt;name</span> <span class="na">language=</span><span class="s">&quot;de&quot;</span><span class="nt">&gt;</span>Mitglieder<span class="nt">&lt;/name&gt;</span>
2293             <span class="nt">&lt;name</span> <span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>Members<span class="nt">&lt;/name&gt;</span>
2294             <span class="nt">&lt;permissions&gt;</span>user.profile.canViewMembersList<span class="nt">&lt;/permissions&gt;</span>
2295             <span class="nt">&lt;options&gt;</span>module_members_list<span class="nt">&lt;/options&gt;</span>
2296
2297             <span class="nt">&lt;content</span> <span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>
2298                 <span class="nt">&lt;title&gt;</span>Members<span class="nt">&lt;/title&gt;</span>
2299             <span class="nt">&lt;/content&gt;</span>
2300             <span class="nt">&lt;content</span> <span class="na">language=</span><span class="s">&quot;de&quot;</span><span class="nt">&gt;</span>
2301                 <span class="nt">&lt;title&gt;</span>Mitglieder<span class="nt">&lt;/title&gt;</span>
2302             <span class="nt">&lt;/content&gt;</span>
2303         <span class="nt">&lt;/page&gt;</span>
2304     <span class="nt">&lt;/import&gt;</span>
2305
2306     <span class="nt">&lt;delete&gt;</span>
2307         <span class="nt">&lt;page</span> <span class="na">identifier=</span><span class="s">&quot;com.woltlab.wcf.MembersList&quot;</span> <span class="nt">/&gt;</span>
2308     <span class="nt">&lt;/delete&gt;</span>
2309 <span class="nt">&lt;/data&gt;</span>
2310 </code></pre></div>
2311 </td></tr></table>
2312
2313
2314
2315
2316 <hr>
2317 <div class="md-source-date">
2318   <small>
2319
2320       Last update: 2021-01-08
2321
2322   </small>
2323 </div>
2324
2325
2326
2327
2328
2329
2330
2331
2332             </article>
2333           </div>
2334         </div>
2335
2336       </main>
2337
2338
2339 <footer class="md-footer">
2340
2341     <nav class="md-footer__inner md-grid" aria-label="Footer">
2342
2343         <a href="../option/" class="md-footer__link md-footer__link--prev" rel="prev">
2344           <div class="md-footer__button md-icon">
2345             <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>
2346           </div>
2347           <div class="md-footer__title">
2348             <div class="md-ellipsis">
2349               <span class="md-footer__direction">
2350                 Previous
2351               </span>
2352               option
2353             </div>
2354           </div>
2355         </a>
2356
2357
2358         <a href="../pip/" class="md-footer__link md-footer__link--next" rel="next">
2359           <div class="md-footer__title">
2360             <div class="md-ellipsis">
2361               <span class="md-footer__direction">
2362                 Next
2363               </span>
2364               pip
2365             </div>
2366           </div>
2367           <div class="md-footer__button md-icon">
2368             <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>
2369           </div>
2370         </a>
2371
2372     </nav>
2373
2374   <div class="md-footer-meta md-typeset">
2375     <div class="md-footer-meta__inner md-grid">
2376       <div class="md-footer-copyright">
2377
2378           <div class="md-footer-copyright__highlight">
2379             Copyright © 2020 WoltLab GmbH
2380           </div>
2381
2382         Made with
2383         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2384           Material for MkDocs
2385         </a>
2386
2387       </div>
2388       <div class="md-footer-copyright">
2389         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2390         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2391 </div>
2392     </div>
2393   </div>
2394 </footer>
2395
2396     </div>
2397     <div class="md-dialog" data-md-component="dialog">
2398       <div class="md-dialog__inner md-typeset"></div>
2399     </div>
2400     <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.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
2401
2402
2403       <script src="../../../assets/javascripts/bundle.4ea5477f.min.js"></script>
2404
2405
2406   </body>
2407 </html>