latest/package/pip/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>Overview - 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="#package-installation-plugins" 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               Overview
 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
 855
 856     <li class="md-nav__item md-nav__item--active">
 857
 858       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 859
 860
 861
 862
 863         <label class="md-nav__link md-nav__link--active" for="__toc">
 864           Overview
 865           <span class="md-nav__icon md-icon"></span>
 866         </label>
 867
 868       <a href="./" class="md-nav__link md-nav__link--active">
 869         Overview
 870       </a>
 871
 872
 873 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 874
 875
 876
 877
 878
 879     <label class="md-nav__title" for="__toc">
 880       <span class="md-nav__icon md-icon"></span>
 881       Table of contents
 882     </label>
 883     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 884
 885         <li class="md-nav__item">
 886   <a href="#built-in-pips" class="md-nav__link">
 887     Built-In PIPs
 888   </a>
 889
 890 </li>
 891
 892     </ul>
 893
 894 </nav>
 895
 896     </li>
 897
 898
 899
 900
 901
 902
 903
 904     <li class="md-nav__item">
 905       <a href="acl-option/" class="md-nav__link">
 906         aclOption
 907       </a>
 908     </li>
 909
 910
 911
 912
 913
 914
 915
 916     <li class="md-nav__item">
 917       <a href="acp-menu/" class="md-nav__link">
 918         acpMenu
 919       </a>
 920     </li>
 921
 922
 923
 924
 925
 926
 927
 928     <li class="md-nav__item">
 929       <a href="acp-search-provider/" class="md-nav__link">
 930         acpSearchProvider
 931       </a>
 932     </li>
 933
 934
 935
 936
 937
 938
 939
 940     <li class="md-nav__item">
 941       <a href="acp-template/" class="md-nav__link">
 942         acpTemplate
 943       </a>
 944     </li>
 945
 946
 947
 948
 949
 950
 951
 952     <li class="md-nav__item">
 953       <a href="bbcode/" class="md-nav__link">
 954         bbcode
 955       </a>
 956     </li>
 957
 958
 959
 960
 961
 962
 963
 964     <li class="md-nav__item">
 965       <a href="box/" class="md-nav__link">
 966         box
 967       </a>
 968     </li>
 969
 970
 971
 972
 973
 974
 975
 976     <li class="md-nav__item">
 977       <a href="clipboard-action/" class="md-nav__link">
 978         clipboardAction
 979       </a>
 980     </li>
 981
 982
 983
 984
 985
 986
 987
 988     <li class="md-nav__item">
 989       <a href="core-object/" class="md-nav__link">
 990         coreObject
 991       </a>
 992     </li>
 993
 994
 995
 996
 997
 998
 999
1000     <li class="md-nav__item">
1001       <a href="cronjob/" class="md-nav__link">
1002         cronjob
1003       </a>
1004     </li>
1005
1006
1007
1008
1009
1010
1011
1012     <li class="md-nav__item">
1013       <a href="event-listener/" class="md-nav__link">
1014         eventListener
1015       </a>
1016     </li>
1017
1018
1019
1020
1021
1022
1023
1024     <li class="md-nav__item">
1025       <a href="file/" class="md-nav__link">
1026         file
1027       </a>
1028     </li>
1029
1030
1031
1032
1033
1034
1035
1036     <li class="md-nav__item">
1037       <a href="language/" class="md-nav__link">
1038         language
1039       </a>
1040     </li>
1041
1042
1043
1044
1045
1046
1047
1048     <li class="md-nav__item">
1049       <a href="media-provider/" class="md-nav__link">
1050         mediaProvider
1051       </a>
1052     </li>
1053
1054
1055
1056
1057
1058
1059
1060     <li class="md-nav__item">
1061       <a href="menu/" class="md-nav__link">
1062         menu
1063       </a>
1064     </li>
1065
1066
1067
1068
1069
1070
1071
1072     <li class="md-nav__item">
1073       <a href="menu-item/" class="md-nav__link">
1074         menuItem
1075       </a>
1076     </li>
1077
1078
1079
1080
1081
1082
1083
1084     <li class="md-nav__item">
1085       <a href="object-type/" class="md-nav__link">
1086         objectType
1087       </a>
1088     </li>
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="object-type-definition/" class="md-nav__link">
1098         objectTypeDefinition
1099       </a>
1100     </li>
1101
1102
1103
1104
1105
1106
1107
1108     <li class="md-nav__item">
1109       <a href="option/" class="md-nav__link">
1110         option
1111       </a>
1112     </li>
1113
1114
1115
1116
1117
1118
1119
1120     <li class="md-nav__item">
1121       <a href="page/" class="md-nav__link">
1122         page
1123       </a>
1124     </li>
1125
1126
1127
1128
1129
1130
1131
1132     <li class="md-nav__item">
1133       <a href="pip/" class="md-nav__link">
1134         pip
1135       </a>
1136     </li>
1137
1138
1139
1140
1141
1142
1143
1144     <li class="md-nav__item">
1145       <a href="script/" class="md-nav__link">
1146         script
1147       </a>
1148     </li>
1149
1150
1151
1152
1153
1154
1155
1156     <li class="md-nav__item">
1157       <a href="smiley/" class="md-nav__link">
1158         smiley
1159       </a>
1160     </li>
1161
1162
1163
1164
1165
1166
1167
1168     <li class="md-nav__item">
1169       <a href="sql/" class="md-nav__link">
1170         sql
1171       </a>
1172     </li>
1173
1174
1175
1176
1177
1178
1179
1180     <li class="md-nav__item">
1181       <a href="style/" class="md-nav__link">
1182         style
1183       </a>
1184     </li>
1185
1186
1187
1188
1189
1190
1191
1192     <li class="md-nav__item">
1193       <a href="template/" class="md-nav__link">
1194         template
1195       </a>
1196     </li>
1197
1198
1199
1200
1201
1202
1203
1204     <li class="md-nav__item">
1205       <a href="template-listener/" class="md-nav__link">
1206         templateListener
1207       </a>
1208     </li>
1209
1210
1211
1212
1213
1214
1215
1216     <li class="md-nav__item">
1217       <a href="user-group-option/" class="md-nav__link">
1218         userGroupOption
1219       </a>
1220     </li>
1221
1222
1223
1224
1225
1226
1227
1228     <li class="md-nav__item">
1229       <a href="user-menu/" class="md-nav__link">
1230         userMenu
1231       </a>
1232     </li>
1233
1234
1235
1236
1237
1238
1239
1240     <li class="md-nav__item">
1241       <a href="user-notification-event/" class="md-nav__link">
1242         userNotificationEvent
1243       </a>
1244     </li>
1245
1246
1247
1248
1249
1250
1251
1252     <li class="md-nav__item">
1253       <a href="user-option/" class="md-nav__link">
1254         userOption
1255       </a>
1256     </li>
1257
1258
1259
1260
1261
1262
1263
1264     <li class="md-nav__item">
1265       <a href="user-profile-menu/" class="md-nav__link">
1266         userProfileMenu
1267       </a>
1268     </li>
1269
1270
1271
1272         </ul>
1273       </nav>
1274     </li>
1275
1276
1277
1278
1279
1280
1281
1282     <li class="md-nav__item">
1283       <a href="../database-php-api/" class="md-nav__link">
1284         Database PHP API
1285       </a>
1286     </li>
1287
1288
1289
1290         </ul>
1291       </nav>
1292     </li>
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304     <li class="md-nav__item md-nav__item--nested">
1305
1306
1307         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1308
1309       <label class="md-nav__link" for="__nav_6">
1310         Migration
1311         <span class="md-nav__icon md-icon"></span>
1312       </label>
1313       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1314         <label class="md-nav__title" for="__nav_6">
1315           <span class="md-nav__icon md-icon"></span>
1316           Migration
1317         </label>
1318         <ul class="md-nav__list" data-md-scrollfix>
1319
1320
1321
1322
1323
1324
1325     <li class="md-nav__item md-nav__item--nested">
1326
1327
1328         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1329
1330       <label class="md-nav__link" for="__nav_6_1">
1331         Migrating from WSC 5.3
1332         <span class="md-nav__icon md-icon"></span>
1333       </label>
1334       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1335         <label class="md-nav__title" for="__nav_6_1">
1336           <span class="md-nav__icon md-icon"></span>
1337           Migrating from WSC 5.3
1338         </label>
1339         <ul class="md-nav__list" data-md-scrollfix>
1340
1341
1342
1343
1344
1345     <li class="md-nav__item">
1346       <a href="../../migration/wsc53/php/" class="md-nav__link">
1347         PHP API
1348       </a>
1349     </li>
1350
1351
1352
1353
1354
1355
1356
1357     <li class="md-nav__item">
1358       <a href="../../migration/wsc53/session/" class="md-nav__link">
1359         Session Handling and Authentication
1360       </a>
1361     </li>
1362
1363
1364
1365
1366
1367
1368
1369     <li class="md-nav__item">
1370       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1371         JavaScript
1372       </a>
1373     </li>
1374
1375
1376
1377
1378
1379
1380
1381     <li class="md-nav__item">
1382       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1383         Templates
1384       </a>
1385     </li>
1386
1387
1388
1389
1390
1391
1392
1393     <li class="md-nav__item">
1394       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1395         Third Party Libraries
1396       </a>
1397     </li>
1398
1399
1400
1401         </ul>
1402       </nav>
1403     </li>
1404
1405
1406
1407
1408
1409
1410
1411
1412     <li class="md-nav__item md-nav__item--nested">
1413
1414
1415         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1416
1417       <label class="md-nav__link" for="__nav_6_2">
1418         Migrating from WSC 5.2
1419         <span class="md-nav__icon md-icon"></span>
1420       </label>
1421       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1422         <label class="md-nav__title" for="__nav_6_2">
1423           <span class="md-nav__icon md-icon"></span>
1424           Migrating from WSC 5.2
1425         </label>
1426         <ul class="md-nav__list" data-md-scrollfix>
1427
1428
1429
1430
1431
1432     <li class="md-nav__item">
1433       <a href="../../migration/wsc52/php/" class="md-nav__link">
1434         PHP API
1435       </a>
1436     </li>
1437
1438
1439
1440
1441
1442
1443
1444     <li class="md-nav__item">
1445       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1446         Templates and Languages
1447       </a>
1448     </li>
1449
1450
1451
1452
1453
1454
1455
1456     <li class="md-nav__item">
1457       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1458         Third Party Libraries
1459       </a>
1460     </li>
1461
1462
1463
1464         </ul>
1465       </nav>
1466     </li>
1467
1468
1469
1470
1471
1472
1473
1474
1475     <li class="md-nav__item md-nav__item--nested">
1476
1477
1478         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1479
1480       <label class="md-nav__link" for="__nav_6_3">
1481         Migrating from WSC 3.1
1482         <span class="md-nav__icon md-icon"></span>
1483       </label>
1484       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1485         <label class="md-nav__title" for="__nav_6_3">
1486           <span class="md-nav__icon md-icon"></span>
1487           Migrating from WSC 3.1
1488         </label>
1489         <ul class="md-nav__list" data-md-scrollfix>
1490
1491
1492
1493
1494
1495     <li class="md-nav__item">
1496       <a href="../../migration/wsc31/php/" class="md-nav__link">
1497         PHP API
1498       </a>
1499     </li>
1500
1501
1502
1503         </ul>
1504       </nav>
1505     </li>
1506
1507
1508
1509
1510
1511
1512
1513
1514     <li class="md-nav__item md-nav__item--nested">
1515
1516
1517         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1518
1519       <label class="md-nav__link" for="__nav_6_4">
1520         Migrating from WSC 3.0
1521         <span class="md-nav__icon md-icon"></span>
1522       </label>
1523       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1524         <label class="md-nav__title" for="__nav_6_4">
1525           <span class="md-nav__icon md-icon"></span>
1526           Migrating from WSC 3.0
1527         </label>
1528         <ul class="md-nav__list" data-md-scrollfix>
1529
1530
1531
1532
1533
1534     <li class="md-nav__item">
1535       <a href="../../migration/wsc30/php/" class="md-nav__link">
1536         PHP API
1537       </a>
1538     </li>
1539
1540
1541
1542
1543
1544
1545
1546     <li class="md-nav__item">
1547       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1548         JavaScript API
1549       </a>
1550     </li>
1551
1552
1553
1554
1555
1556
1557
1558     <li class="md-nav__item">
1559       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1560         Templates
1561       </a>
1562     </li>
1563
1564
1565
1566
1567
1568
1569
1570     <li class="md-nav__item">
1571       <a href="../../migration/wsc30/css/" class="md-nav__link">
1572         CSS
1573       </a>
1574     </li>
1575
1576
1577
1578
1579
1580
1581
1582     <li class="md-nav__item">
1583       <a href="../../migration/wsc30/package/" class="md-nav__link">
1584         Package Components
1585       </a>
1586     </li>
1587
1588
1589
1590         </ul>
1591       </nav>
1592     </li>
1593
1594
1595
1596
1597
1598
1599
1600
1601     <li class="md-nav__item md-nav__item--nested">
1602
1603
1604         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1605
1606       <label class="md-nav__link" for="__nav_6_5">
1607         Migrating from WCF 2.1
1608         <span class="md-nav__icon md-icon"></span>
1609       </label>
1610       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1611         <label class="md-nav__title" for="__nav_6_5">
1612           <span class="md-nav__icon md-icon"></span>
1613           Migrating from WCF 2.1
1614         </label>
1615         <ul class="md-nav__list" data-md-scrollfix>
1616
1617
1618
1619
1620
1621     <li class="md-nav__item">
1622       <a href="../../migration/wcf21/php/" class="md-nav__link">
1623         PHP API
1624       </a>
1625     </li>
1626
1627
1628
1629
1630
1631
1632
1633     <li class="md-nav__item">
1634       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1635         Templates
1636       </a>
1637     </li>
1638
1639
1640
1641
1642
1643
1644
1645     <li class="md-nav__item">
1646       <a href="../../migration/wcf21/css/" class="md-nav__link">
1647         CSS
1648       </a>
1649     </li>
1650
1651
1652
1653
1654
1655
1656
1657     <li class="md-nav__item">
1658       <a href="../../migration/wcf21/package/" class="md-nav__link">
1659         Package Components
1660       </a>
1661     </li>
1662
1663
1664
1665         </ul>
1666       </nav>
1667     </li>
1668
1669
1670
1671         </ul>
1672       </nav>
1673     </li>
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685     <li class="md-nav__item md-nav__item--nested">
1686
1687
1688         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1689
1690       <label class="md-nav__link" for="__nav_7">
1691         Tutorials
1692         <span class="md-nav__icon md-icon"></span>
1693       </label>
1694       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1695         <label class="md-nav__title" for="__nav_7">
1696           <span class="md-nav__icon md-icon"></span>
1697           Tutorials
1698         </label>
1699         <ul class="md-nav__list" data-md-scrollfix>
1700
1701
1702
1703
1704
1705
1706     <li class="md-nav__item md-nav__item--nested">
1707
1708
1709         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1710
1711       <label class="md-nav__link" for="__nav_7_1">
1712         Tutorial Series
1713         <span class="md-nav__icon md-icon"></span>
1714       </label>
1715       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1716         <label class="md-nav__title" for="__nav_7_1">
1717           <span class="md-nav__icon md-icon"></span>
1718           Tutorial Series
1719         </label>
1720         <ul class="md-nav__list" data-md-scrollfix>
1721
1722
1723
1724
1725
1726     <li class="md-nav__item">
1727       <a href="../../tutorial/series/overview/" class="md-nav__link">
1728         Overview
1729       </a>
1730     </li>
1731
1732
1733
1734
1735
1736
1737
1738     <li class="md-nav__item">
1739       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1740         Part 1
1741       </a>
1742     </li>
1743
1744
1745
1746
1747
1748
1749
1750     <li class="md-nav__item">
1751       <a href="../../tutorial/series/part_2/" class="md-nav__link">
1752         Part 2
1753       </a>
1754     </li>
1755
1756
1757
1758
1759
1760
1761
1762     <li class="md-nav__item">
1763       <a href="../../tutorial/series/part_3/" class="md-nav__link">
1764         Part 3
1765       </a>
1766     </li>
1767
1768
1769
1770         </ul>
1771       </nav>
1772     </li>
1773
1774
1775
1776         </ul>
1777       </nav>
1778     </li>
1779
1780
1781
1782   </ul>
1783 </nav>
1784                   </div>
1785                 </div>
1786               </div>
1787
1788
1789
1790               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1791                 <div class="md-sidebar__scrollwrap">
1792                   <div class="md-sidebar__inner">
1793
1794 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1795
1796
1797
1798
1799
1800     <label class="md-nav__title" for="__toc">
1801       <span class="md-nav__icon md-icon"></span>
1802       Table of contents
1803     </label>
1804     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1805
1806         <li class="md-nav__item">
1807   <a href="#built-in-pips" class="md-nav__link">
1808     Built-In PIPs
1809   </a>
1810
1811 </li>
1812
1813     </ul>
1814
1815 </nav>
1816                   </div>
1817                 </div>
1818               </div>
1819
1820
1821           <div class="md-content" data-md-component="content">
1822             <article class="md-content__inner md-typeset">
1823
1824
1825                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip.md" title="Edit this page" class="md-content__button md-icon">
1826                     <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>
1827                   </a>
1828
1829
1830                 <h1 id="package-installation-plugins">Package Installation Plugins<a class="headerlink" href="#package-installation-plugins" title="Permanent link">#</a></h1>
1831 <p>Package Installation Plugins (PIPs) are interfaces to deploy and edit content as well as components.</p>
1832 <div class="admonition info">
1833 <p class="admonition-title">For XML-based PIPs: <code>&lt;![CDATA[]]&gt;</code> must be used for language items and page contents. In all other cases it may only be used when necessary.</p>
1834 </div>
1835 <h2 id="built-in-pips">Built-In PIPs<a class="headerlink" href="#built-in-pips" title="Permanent link">#</a></h2>
1836 <table>
1837 <thead>
1838 <tr>
1839 <th>Name</th>
1840 <th>Description</th>
1841 </tr>
1842 </thead>
1843 <tbody>
1844 <tr>
1845 <td><a href="acl-option/">aclOption</a></td>
1846 <td>Customizable permissions for individual objects</td>
1847 </tr>
1848 <tr>
1849 <td><a href="acp-menu/">acpMenu</a></td>
1850 <td>Admin panel menu categories and items</td>
1851 </tr>
1852 <tr>
1853 <td><a href="acp-search-provider/">acpSearchProvider</a></td>
1854 <td>Data provider for the admin panel search</td>
1855 </tr>
1856 <tr>
1857 <td><a href="acp-template/">acpTemplate</a></td>
1858 <td>Admin panel templates</td>
1859 </tr>
1860 <tr>
1861 <td><a href="bbcode/">bbcode</a></td>
1862 <td>BBCodes for rich message formatting</td>
1863 </tr>
1864 <tr>
1865 <td><a href="box/">box</a></td>
1866 <td>Boxes that can be placed anywhere on a page</td>
1867 </tr>
1868 <tr>
1869 <td><a href="clipboard-action/">clipboardAction</a></td>
1870 <td>Perform bulk operations on marked objects</td>
1871 </tr>
1872 <tr>
1873 <td><a href="core-object/">coreObject</a></td>
1874 <td>Access Singletons from within the template</td>
1875 </tr>
1876 <tr>
1877 <td><a href="cronjob/">cronjob</a></td>
1878 <td>Periodically execute code with customizable intervals</td>
1879 </tr>
1880 <tr>
1881 <td><a href="database/">database</a></td>
1882 <td>Updates the database layout using <a href="../database-php-api/">the PHP API</a></td>
1883 </tr>
1884 <tr>
1885 <td><a href="event-listener/">eventListener</a></td>
1886 <td>Register listeners for the event system</td>
1887 </tr>
1888 <tr>
1889 <td><a href="file/">file</a></td>
1890 <td>Deploy any type of files with the exception of templates</td>
1891 </tr>
1892 <tr>
1893 <td><a href="language/">language</a></td>
1894 <td>Language items</td>
1895 </tr>
1896 <tr>
1897 <td><a href="media-provider/">mediaProvider</a></td>
1898 <td>Detect and convert links to media providers</td>
1899 </tr>
1900 <tr>
1901 <td><a href="menu/">menu</a></td>
1902 <td>Side-wide and custom per-page menus</td>
1903 </tr>
1904 <tr>
1905 <td><a href="menu-item/">menuItem</a></td>
1906 <td>Menu items for menus created through the menu PIP</td>
1907 </tr>
1908 <tr>
1909 <td><a href="object-type/">objectType</a></td>
1910 <td>Flexible type registry based on definitions</td>
1911 </tr>
1912 <tr>
1913 <td><a href="object-type-definition/">objectTypeDefinition</a></td>
1914 <td>Groups objects and classes by functionality</td>
1915 </tr>
1916 <tr>
1917 <td><a href="option/">option</a></td>
1918 <td>Side-wide configuration options</td>
1919 </tr>
1920 <tr>
1921 <td><a href="page/">page</a></td>
1922 <td>Register page controllers and text-based pages</td>
1923 </tr>
1924 <tr>
1925 <td><a href="pip/">pip</a></td>
1926 <td>Package Installation Plugins</td>
1927 </tr>
1928 <tr>
1929 <td><a href="script/">script</a></td>
1930 <td>Execute arbitrary PHP code during installation, update and uninstallation</td>
1931 </tr>
1932 <tr>
1933 <td><a href="smiley/">smiley</a></td>
1934 <td>Smileys</td>
1935 </tr>
1936 <tr>
1937 <td><a href="sql/">sql</a></td>
1938 <td>Execute SQL instructions using a MySQL-flavored syntax (also see <a href="../database-php-api/">database PHP API</a>)</td>
1939 </tr>
1940 <tr>
1941 <td><a href="style/">style</a></td>
1942 <td>Style</td>
1943 </tr>
1944 <tr>
1945 <td><a href="template/">template</a></td>
1946 <td>Frontend templates</td>
1947 </tr>
1948 <tr>
1949 <td><a href="template-listener/">templateListener</a></td>
1950 <td>Embed template code into templates without altering the original</td>
1951 </tr>
1952 <tr>
1953 <td><a href="user-group-option/">userGroupOption</a></td>
1954 <td>Permissions for user groups</td>
1955 </tr>
1956 <tr>
1957 <td><a href="user-menu/">userMenu</a></td>
1958 <td>User menu categories and items</td>
1959 </tr>
1960 <tr>
1961 <td><a href="user-notification-event/">userNotificationEvent</a></td>
1962 <td>Events of the user notification system</td>
1963 </tr>
1964 <tr>
1965 <td><a href="user-option/">userOption</a></td>
1966 <td>User settings</td>
1967 </tr>
1968 <tr>
1969 <td><a href="user-profile-menu/">userProfileMenu</a></td>
1970 <td>User profile tabs</td>
1971 </tr>
1972 </tbody>
1973 </table>
1974
1975
1976
1977
1978 <hr>
1979 <div class="md-source-date">
1980   <small>
1981
1982       Last update: 2021-03-15
1983
1984   </small>
1985 </div>
1986
1987
1988
1989
1990
1991
1992
1993
1994             </article>
1995           </div>
1996         </div>
1997       </main>
1998
1999
2000 <footer class="md-footer">
2001
2002     <nav class="md-footer__inner md-grid" aria-label="Footer">
2003
2004         <a href="../package-xml/" class="md-footer__link md-footer__link--prev" rel="prev">
2005           <div class="md-footer__button md-icon">
2006             <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>
2007           </div>
2008           <div class="md-footer__title">
2009             <div class="md-ellipsis">
2010               <span class="md-footer__direction">
2011                 Previous
2012               </span>
2013               package.xml
2014             </div>
2015           </div>
2016         </a>
2017
2018
2019         <a href="acl-option/" class="md-footer__link md-footer__link--next" rel="next">
2020           <div class="md-footer__title">
2021             <div class="md-ellipsis">
2022               <span class="md-footer__direction">
2023                 Next
2024               </span>
2025               aclOption
2026             </div>
2027           </div>
2028           <div class="md-footer__button md-icon">
2029             <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>
2030           </div>
2031         </a>
2032
2033     </nav>
2034
2035   <div class="md-footer-meta md-typeset">
2036     <div class="md-footer-meta__inner md-grid">
2037       <div class="md-footer-copyright">
2038
2039           <div class="md-footer-copyright__highlight">
2040             Copyright © 2020 WoltLab GmbH
2041           </div>
2042
2043         Made with
2044         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2045           Material for MkDocs
2046         </a>
2047
2048       </div>
2049       <div class="md-footer-copyright">
2050         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2051         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2052 </div>
2053     </div>
2054   </div>
2055 </footer>
2056
2057     </div>
2058     <div class="md-dialog" data-md-component="dialog">
2059       <div class="md-dialog__inner md-typeset"></div>
2060     </div>
2061     <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>
2062
2063
2064       <script src="../../assets/javascripts/bundle.5cf3e710.min.js"></script>
2065
2066
2067   </body>
2068 </html>