5.4/view/template-plugins/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.0">
  14
  15
  16
  17         <title>Template Plugins - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../assets/stylesheets/main.33e2939f.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="#template-plugins" 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               Template Plugins
 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     <li class="md-nav__item">
 310       <a href="../../php/api/caches/" class="md-nav__link">
 311         Caches
 312       </a>
 313     </li>
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item">
 322       <a href="../../php/api/comments/" class="md-nav__link">
 323         Comments
 324       </a>
 325     </li>
 326
 327
 328
 329
 330
 331
 332
 333     <li class="md-nav__item">
 334       <a href="../../php/api/cronjobs/" class="md-nav__link">
 335         Cronjobs
 336       </a>
 337     </li>
 338
 339
 340
 341
 342
 343
 344
 345     <li class="md-nav__item">
 346       <a href="../../php/api/events/" class="md-nav__link">
 347         Events
 348       </a>
 349     </li>
 350
 351
 352
 353
 354
 355
 356
 357
 358     <li class="md-nav__item md-nav__item--nested">
 359
 360
 361         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 362
 363       <label class="md-nav__link" for="__nav_2_5_5">
 364         Form Builder
 365         <span class="md-nav__icon md-icon"></span>
 366       </label>
 367       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 368         <label class="md-nav__title" for="__nav_2_5_5">
 369           <span class="md-nav__icon md-icon"></span>
 370           Form Builder
 371         </label>
 372         <ul class="md-nav__list" data-md-scrollfix>
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../php/api/form_builder/overview/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390     <li class="md-nav__item">
 391       <a href="../../php/api/form_builder/structure/" class="md-nav__link">
 392         Structure
 393       </a>
 394     </li>
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
 404         Fields
 405       </a>
 406     </li>
 407
 408
 409
 410
 411
 412
 413
 414     <li class="md-nav__item">
 415       <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
 416         Validation and Data
 417       </a>
 418     </li>
 419
 420
 421
 422
 423
 424
 425
 426     <li class="md-nav__item">
 427       <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
 428         Dependencies
 429       </a>
 430     </li>
 431
 432
 433
 434         </ul>
 435       </nav>
 436     </li>
 437
 438
 439
 440
 441
 442
 443
 444     <li class="md-nav__item">
 445       <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
 446         Package Installation Plugins
 447       </a>
 448     </li>
 449
 450
 451
 452
 453
 454
 455
 456     <li class="md-nav__item">
 457       <a href="../../php/api/user_activity_points/" class="md-nav__link">
 458         User Activity Points
 459       </a>
 460     </li>
 461
 462
 463
 464
 465
 466
 467
 468     <li class="md-nav__item">
 469       <a href="../../php/api/user_notifications/" class="md-nav__link">
 470         User Notifications
 471       </a>
 472     </li>
 473
 474
 475
 476
 477
 478
 479
 480     <li class="md-nav__item">
 481       <a href="../../php/api/sitemaps/" class="md-nav__link">
 482         Sitemaps
 483       </a>
 484     </li>
 485
 486
 487
 488         </ul>
 489       </nav>
 490     </li>
 491
 492
 493
 494
 495
 496
 497
 498     <li class="md-nav__item">
 499       <a href="../../php/code-style/" class="md-nav__link">
 500         Code Style
 501       </a>
 502     </li>
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../php/apps/" class="md-nav__link">
 512         Apps
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item">
 523       <a href="../../php/gdpr/" class="md-nav__link">
 524         GDPR
 525       </a>
 526     </li>
 527
 528
 529
 530         </ul>
 531       </nav>
 532     </li>
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544     <li class="md-nav__item md-nav__item--nested">
 545
 546
 547         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 548
 549       <label class="md-nav__link" for="__nav_3">
 550         Languages, Templates & CSS
 551         <span class="md-nav__icon md-icon"></span>
 552       </label>
 553       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 554         <label class="md-nav__title" for="__nav_3">
 555           <span class="md-nav__icon md-icon"></span>
 556           Languages, Templates & CSS
 557         </label>
 558         <ul class="md-nav__list" data-md-scrollfix>
 559
 560
 561
 562
 563
 564     <li class="md-nav__item">
 565       <a href="../languages/" class="md-nav__link">
 566         Languages
 567       </a>
 568     </li>
 569
 570
 571
 572
 573
 574
 575
 576     <li class="md-nav__item">
 577       <a href="../templates/" class="md-nav__link">
 578         Templates
 579       </a>
 580     </li>
 581
 582
 583
 584
 585
 586
 587
 588     <li class="md-nav__item">
 589       <a href="../css/" class="md-nav__link">
 590         CSS
 591       </a>
 592     </li>
 593
 594
 595
 596         </ul>
 597       </nav>
 598     </li>
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610     <li class="md-nav__item md-nav__item--nested">
 611
 612
 613         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 614
 615       <label class="md-nav__link" for="__nav_4">
 616         JavaScript API
 617         <span class="md-nav__icon md-icon"></span>
 618       </label>
 619       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 620         <label class="md-nav__title" for="__nav_4">
 621           <span class="md-nav__icon md-icon"></span>
 622           JavaScript API
 623         </label>
 624         <ul class="md-nav__list" data-md-scrollfix>
 625
 626
 627
 628
 629
 630     <li class="md-nav__item">
 631       <a href="../../javascript/general-usage/" class="md-nav__link">
 632         General Usage
 633       </a>
 634     </li>
 635
 636
 637
 638
 639
 640
 641
 642
 643     <li class="md-nav__item md-nav__item--nested">
 644
 645
 646         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 647
 648       <label class="md-nav__link" for="__nav_4_2">
 649         New API
 650         <span class="md-nav__icon md-icon"></span>
 651       </label>
 652       <nav class="md-nav" aria-label="New API" data-md-level="2">
 653         <label class="md-nav__title" for="__nav_4_2">
 654           <span class="md-nav__icon md-icon"></span>
 655           New API
 656         </label>
 657         <ul class="md-nav__list" data-md-scrollfix>
 658
 659
 660
 661
 662
 663     <li class="md-nav__item">
 664       <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
 665         Writing a module
 666       </a>
 667     </li>
 668
 669
 670
 671
 672
 673
 674
 675     <li class="md-nav__item">
 676       <a href="../../javascript/new-api_data-structures/" class="md-nav__link">
 677         Data Structures
 678       </a>
 679     </li>
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item">
 688       <a href="../../javascript/new-api_core/" class="md-nav__link">
 689         Core Functions
 690       </a>
 691     </li>
 692
 693
 694
 695
 696
 697
 698
 699     <li class="md-nav__item">
 700       <a href="../../javascript/new-api_dom/" class="md-nav__link">
 701         DOM
 702       </a>
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../javascript/new-api_events/" class="md-nav__link">
 713         Event Handling
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../javascript/new-api_ajax/" class="md-nav__link">
 725         Ajax
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735     <li class="md-nav__item">
 736       <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
 737         Dialogs
 738       </a>
 739     </li>
 740
 741
 742
 743
 744
 745
 746
 747     <li class="md-nav__item">
 748       <a href="../../javascript/new-api_browser/" class="md-nav__link">
 749         Browser and Screen Sizes
 750       </a>
 751     </li>
 752
 753
 754
 755
 756
 757
 758
 759     <li class="md-nav__item">
 760       <a href="../../javascript/new-api_ui/" class="md-nav__link">
 761         User Interface
 762       </a>
 763     </li>
 764
 765
 766
 767         </ul>
 768       </nav>
 769     </li>
 770
 771
 772
 773
 774
 775
 776
 777     <li class="md-nav__item">
 778       <a href="../../javascript/legacy-api/" class="md-nav__link">
 779         Legacy API
 780       </a>
 781     </li>
 782
 783
 784
 785
 786
 787
 788
 789     <li class="md-nav__item">
 790       <a href="../../javascript/helper-functions/" class="md-nav__link">
 791         Helper Functions
 792       </a>
 793     </li>
 794
 795
 796
 797
 798
 799
 800
 801     <li class="md-nav__item">
 802       <a href="../../javascript/code-snippets/" class="md-nav__link">
 803         Code Snippets
 804       </a>
 805     </li>
 806
 807
 808
 809         </ul>
 810       </nav>
 811     </li>
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823     <li class="md-nav__item md-nav__item--nested">
 824
 825
 826         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 827
 828       <label class="md-nav__link" for="__nav_5">
 829         Package Components
 830         <span class="md-nav__icon md-icon"></span>
 831       </label>
 832       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 833         <label class="md-nav__title" for="__nav_5">
 834           <span class="md-nav__icon md-icon"></span>
 835           Package Components
 836         </label>
 837         <ul class="md-nav__list" data-md-scrollfix>
 838
 839
 840
 841
 842
 843     <li class="md-nav__item">
 844       <a href="../../package/package-xml/" class="md-nav__link">
 845         package.xml
 846       </a>
 847     </li>
 848
 849
 850
 851
 852
 853
 854
 855
 856     <li class="md-nav__item md-nav__item--nested">
 857
 858
 859         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
 860
 861       <label class="md-nav__link" for="__nav_5_2">
 862         PIPs
 863         <span class="md-nav__icon md-icon"></span>
 864       </label>
 865       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 866         <label class="md-nav__title" for="__nav_5_2">
 867           <span class="md-nav__icon md-icon"></span>
 868           PIPs
 869         </label>
 870         <ul class="md-nav__list" data-md-scrollfix>
 871
 872
 873
 874
 875
 876     <li class="md-nav__item">
 877       <a href="../../package/pip/" class="md-nav__link">
 878         Overview
 879       </a>
 880     </li>
 881
 882
 883
 884
 885
 886
 887
 888     <li class="md-nav__item">
 889       <a href="../../package/pip/acl-option/" class="md-nav__link">
 890         aclOption
 891       </a>
 892     </li>
 893
 894
 895
 896
 897
 898
 899
 900     <li class="md-nav__item">
 901       <a href="../../package/pip/acp-menu/" class="md-nav__link">
 902         acpMenu
 903       </a>
 904     </li>
 905
 906
 907
 908
 909
 910
 911
 912     <li class="md-nav__item">
 913       <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
 914         acpSearchProvider
 915       </a>
 916     </li>
 917
 918
 919
 920
 921
 922
 923
 924     <li class="md-nav__item">
 925       <a href="../../package/pip/acp-template/" class="md-nav__link">
 926         acpTemplate
 927       </a>
 928     </li>
 929
 930
 931
 932
 933
 934
 935
 936     <li class="md-nav__item">
 937       <a href="../../package/pip/bbcode/" class="md-nav__link">
 938         bbcode
 939       </a>
 940     </li>
 941
 942
 943
 944
 945
 946
 947
 948     <li class="md-nav__item">
 949       <a href="../../package/pip/box/" class="md-nav__link">
 950         box
 951       </a>
 952     </li>
 953
 954
 955
 956
 957
 958
 959
 960     <li class="md-nav__item">
 961       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
 962         clipboardAction
 963       </a>
 964     </li>
 965
 966
 967
 968
 969
 970
 971
 972     <li class="md-nav__item">
 973       <a href="../../package/pip/core-object/" class="md-nav__link">
 974         coreObject
 975       </a>
 976     </li>
 977
 978
 979
 980
 981
 982
 983
 984     <li class="md-nav__item">
 985       <a href="../../package/pip/cronjob/" class="md-nav__link">
 986         cronjob
 987       </a>
 988     </li>
 989
 990
 991
 992
 993
 994
 995
 996     <li class="md-nav__item">
 997       <a href="../../package/pip/event-listener/" class="md-nav__link">
 998         eventListener
 999       </a>
1000     </li>
1001
1002
1003
1004
1005
1006
1007
1008     <li class="md-nav__item">
1009       <a href="../../package/pip/file/" class="md-nav__link">
1010         file
1011       </a>
1012     </li>
1013
1014
1015
1016
1017
1018
1019
1020     <li class="md-nav__item">
1021       <a href="../../package/pip/language/" class="md-nav__link">
1022         language
1023       </a>
1024     </li>
1025
1026
1027
1028
1029
1030
1031
1032     <li class="md-nav__item">
1033       <a href="../../package/pip/media-provider/" class="md-nav__link">
1034         mediaProvider
1035       </a>
1036     </li>
1037
1038
1039
1040
1041
1042
1043
1044     <li class="md-nav__item">
1045       <a href="../../package/pip/menu/" class="md-nav__link">
1046         menu
1047       </a>
1048     </li>
1049
1050
1051
1052
1053
1054
1055
1056     <li class="md-nav__item">
1057       <a href="../../package/pip/menu-item/" class="md-nav__link">
1058         menuItem
1059       </a>
1060     </li>
1061
1062
1063
1064
1065
1066
1067
1068     <li class="md-nav__item">
1069       <a href="../../package/pip/object-type/" class="md-nav__link">
1070         objectType
1071       </a>
1072     </li>
1073
1074
1075
1076
1077
1078
1079
1080     <li class="md-nav__item">
1081       <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1082         objectTypeDefinition
1083       </a>
1084     </li>
1085
1086
1087
1088
1089
1090
1091
1092     <li class="md-nav__item">
1093       <a href="../../package/pip/option/" class="md-nav__link">
1094         option
1095       </a>
1096     </li>
1097
1098
1099
1100
1101
1102
1103
1104     <li class="md-nav__item">
1105       <a href="../../package/pip/page/" class="md-nav__link">
1106         page
1107       </a>
1108     </li>
1109
1110
1111
1112
1113
1114
1115
1116     <li class="md-nav__item">
1117       <a href="../../package/pip/pip/" class="md-nav__link">
1118         pip
1119       </a>
1120     </li>
1121
1122
1123
1124
1125
1126
1127
1128     <li class="md-nav__item">
1129       <a href="../../package/pip/script/" class="md-nav__link">
1130         script
1131       </a>
1132     </li>
1133
1134
1135
1136
1137
1138
1139
1140     <li class="md-nav__item">
1141       <a href="../../package/pip/smiley/" class="md-nav__link">
1142         smiley
1143       </a>
1144     </li>
1145
1146
1147
1148
1149
1150
1151
1152     <li class="md-nav__item">
1153       <a href="../../package/pip/sql/" class="md-nav__link">
1154         sql
1155       </a>
1156     </li>
1157
1158
1159
1160
1161
1162
1163
1164     <li class="md-nav__item">
1165       <a href="../../package/pip/style/" class="md-nav__link">
1166         style
1167       </a>
1168     </li>
1169
1170
1171
1172
1173
1174
1175
1176     <li class="md-nav__item">
1177       <a href="../../package/pip/template/" class="md-nav__link">
1178         template
1179       </a>
1180     </li>
1181
1182
1183
1184
1185
1186
1187
1188     <li class="md-nav__item">
1189       <a href="../../package/pip/template-listener/" class="md-nav__link">
1190         templateListener
1191       </a>
1192     </li>
1193
1194
1195
1196
1197
1198
1199
1200     <li class="md-nav__item">
1201       <a href="../../package/pip/user-group-option/" class="md-nav__link">
1202         userGroupOption
1203       </a>
1204     </li>
1205
1206
1207
1208
1209
1210
1211
1212     <li class="md-nav__item">
1213       <a href="../../package/pip/user-menu/" class="md-nav__link">
1214         userMenu
1215       </a>
1216     </li>
1217
1218
1219
1220
1221
1222
1223
1224     <li class="md-nav__item">
1225       <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1226         userNotificationEvent
1227       </a>
1228     </li>
1229
1230
1231
1232
1233
1234
1235
1236     <li class="md-nav__item">
1237       <a href="../../package/pip/user-option/" class="md-nav__link">
1238         userOption
1239       </a>
1240     </li>
1241
1242
1243
1244
1245
1246
1247
1248     <li class="md-nav__item">
1249       <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1250         userProfileMenu
1251       </a>
1252     </li>
1253
1254
1255
1256         </ul>
1257       </nav>
1258     </li>
1259
1260
1261
1262
1263
1264
1265
1266     <li class="md-nav__item">
1267       <a href="../../package/database-php-api/" class="md-nav__link">
1268         Database PHP API
1269       </a>
1270     </li>
1271
1272
1273
1274         </ul>
1275       </nav>
1276     </li>
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288     <li class="md-nav__item md-nav__item--nested">
1289
1290
1291         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1292
1293       <label class="md-nav__link" for="__nav_6">
1294         Migration
1295         <span class="md-nav__icon md-icon"></span>
1296       </label>
1297       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1298         <label class="md-nav__title" for="__nav_6">
1299           <span class="md-nav__icon md-icon"></span>
1300           Migration
1301         </label>
1302         <ul class="md-nav__list" data-md-scrollfix>
1303
1304
1305
1306
1307
1308
1309     <li class="md-nav__item md-nav__item--nested">
1310
1311
1312         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1313
1314       <label class="md-nav__link" for="__nav_6_1">
1315         Migrating from WSC 5.3
1316         <span class="md-nav__icon md-icon"></span>
1317       </label>
1318       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1319         <label class="md-nav__title" for="__nav_6_1">
1320           <span class="md-nav__icon md-icon"></span>
1321           Migrating from WSC 5.3
1322         </label>
1323         <ul class="md-nav__list" data-md-scrollfix>
1324
1325
1326
1327
1328
1329     <li class="md-nav__item">
1330       <a href="../../migration/wsc53/php/" class="md-nav__link">
1331         PHP API
1332       </a>
1333     </li>
1334
1335
1336
1337
1338
1339
1340
1341     <li class="md-nav__item">
1342       <a href="../../migration/wsc53/session/" class="md-nav__link">
1343         Session Handling and Authentication
1344       </a>
1345     </li>
1346
1347
1348
1349
1350
1351
1352
1353     <li class="md-nav__item">
1354       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1355         JavaScript
1356       </a>
1357     </li>
1358
1359
1360
1361
1362
1363
1364
1365     <li class="md-nav__item">
1366       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1367         Templates
1368       </a>
1369     </li>
1370
1371
1372
1373
1374
1375
1376
1377     <li class="md-nav__item">
1378       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1379         Third Party Libraries
1380       </a>
1381     </li>
1382
1383
1384
1385         </ul>
1386       </nav>
1387     </li>
1388
1389
1390
1391
1392
1393
1394
1395
1396     <li class="md-nav__item md-nav__item--nested">
1397
1398
1399         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1400
1401       <label class="md-nav__link" for="__nav_6_2">
1402         Migrating from WSC 5.2
1403         <span class="md-nav__icon md-icon"></span>
1404       </label>
1405       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1406         <label class="md-nav__title" for="__nav_6_2">
1407           <span class="md-nav__icon md-icon"></span>
1408           Migrating from WSC 5.2
1409         </label>
1410         <ul class="md-nav__list" data-md-scrollfix>
1411
1412
1413
1414
1415
1416     <li class="md-nav__item">
1417       <a href="../../migration/wsc52/php/" class="md-nav__link">
1418         PHP API
1419       </a>
1420     </li>
1421
1422
1423
1424
1425
1426
1427
1428     <li class="md-nav__item">
1429       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1430         Templates and Languages
1431       </a>
1432     </li>
1433
1434
1435
1436
1437
1438
1439
1440     <li class="md-nav__item">
1441       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1442         Third Party Libraries
1443       </a>
1444     </li>
1445
1446
1447
1448         </ul>
1449       </nav>
1450     </li>
1451
1452
1453
1454
1455
1456
1457
1458
1459     <li class="md-nav__item md-nav__item--nested">
1460
1461
1462         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1463
1464       <label class="md-nav__link" for="__nav_6_3">
1465         Migrating from WSC 3.1
1466         <span class="md-nav__icon md-icon"></span>
1467       </label>
1468       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1469         <label class="md-nav__title" for="__nav_6_3">
1470           <span class="md-nav__icon md-icon"></span>
1471           Migrating from WSC 3.1
1472         </label>
1473         <ul class="md-nav__list" data-md-scrollfix>
1474
1475
1476
1477
1478
1479     <li class="md-nav__item">
1480       <a href="../../migration/wsc31/php/" class="md-nav__link">
1481         PHP API
1482       </a>
1483     </li>
1484
1485
1486
1487         </ul>
1488       </nav>
1489     </li>
1490
1491
1492
1493
1494
1495
1496
1497
1498     <li class="md-nav__item md-nav__item--nested">
1499
1500
1501         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1502
1503       <label class="md-nav__link" for="__nav_6_4">
1504         Migrating from WSC 3.0
1505         <span class="md-nav__icon md-icon"></span>
1506       </label>
1507       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1508         <label class="md-nav__title" for="__nav_6_4">
1509           <span class="md-nav__icon md-icon"></span>
1510           Migrating from WSC 3.0
1511         </label>
1512         <ul class="md-nav__list" data-md-scrollfix>
1513
1514
1515
1516
1517
1518     <li class="md-nav__item">
1519       <a href="../../migration/wsc30/php/" class="md-nav__link">
1520         PHP API
1521       </a>
1522     </li>
1523
1524
1525
1526
1527
1528
1529
1530     <li class="md-nav__item">
1531       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1532         JavaScript API
1533       </a>
1534     </li>
1535
1536
1537
1538
1539
1540
1541
1542     <li class="md-nav__item">
1543       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1544         Templates
1545       </a>
1546     </li>
1547
1548
1549
1550
1551
1552
1553
1554     <li class="md-nav__item">
1555       <a href="../../migration/wsc30/css/" class="md-nav__link">
1556         CSS
1557       </a>
1558     </li>
1559
1560
1561
1562
1563
1564
1565
1566     <li class="md-nav__item">
1567       <a href="../../migration/wsc30/package/" class="md-nav__link">
1568         Package Components
1569       </a>
1570     </li>
1571
1572
1573
1574         </ul>
1575       </nav>
1576     </li>
1577
1578
1579
1580
1581
1582
1583
1584
1585     <li class="md-nav__item md-nav__item--nested">
1586
1587
1588         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1589
1590       <label class="md-nav__link" for="__nav_6_5">
1591         Migrating from WCF 2.1
1592         <span class="md-nav__icon md-icon"></span>
1593       </label>
1594       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1595         <label class="md-nav__title" for="__nav_6_5">
1596           <span class="md-nav__icon md-icon"></span>
1597           Migrating from WCF 2.1
1598         </label>
1599         <ul class="md-nav__list" data-md-scrollfix>
1600
1601
1602
1603
1604
1605     <li class="md-nav__item">
1606       <a href="../../migration/wcf21/php/" class="md-nav__link">
1607         PHP API
1608       </a>
1609     </li>
1610
1611
1612
1613
1614
1615
1616
1617     <li class="md-nav__item">
1618       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1619         Templates
1620       </a>
1621     </li>
1622
1623
1624
1625
1626
1627
1628
1629     <li class="md-nav__item">
1630       <a href="../../migration/wcf21/css/" class="md-nav__link">
1631         CSS
1632       </a>
1633     </li>
1634
1635
1636
1637
1638
1639
1640
1641     <li class="md-nav__item">
1642       <a href="../../migration/wcf21/package/" class="md-nav__link">
1643         Package Components
1644       </a>
1645     </li>
1646
1647
1648
1649         </ul>
1650       </nav>
1651     </li>
1652
1653
1654
1655         </ul>
1656       </nav>
1657     </li>
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669     <li class="md-nav__item md-nav__item--nested">
1670
1671
1672         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1673
1674       <label class="md-nav__link" for="__nav_7">
1675         Tutorials
1676         <span class="md-nav__icon md-icon"></span>
1677       </label>
1678       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1679         <label class="md-nav__title" for="__nav_7">
1680           <span class="md-nav__icon md-icon"></span>
1681           Tutorials
1682         </label>
1683         <ul class="md-nav__list" data-md-scrollfix>
1684
1685
1686
1687
1688
1689
1690     <li class="md-nav__item md-nav__item--nested">
1691
1692
1693         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1694
1695       <label class="md-nav__link" for="__nav_7_1">
1696         Tutorial Series
1697         <span class="md-nav__icon md-icon"></span>
1698       </label>
1699       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1700         <label class="md-nav__title" for="__nav_7_1">
1701           <span class="md-nav__icon md-icon"></span>
1702           Tutorial Series
1703         </label>
1704         <ul class="md-nav__list" data-md-scrollfix>
1705
1706
1707
1708
1709
1710     <li class="md-nav__item">
1711       <a href="../../tutorial/series/overview/" class="md-nav__link">
1712         Overview
1713       </a>
1714     </li>
1715
1716
1717
1718
1719
1720
1721
1722     <li class="md-nav__item">
1723       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1724         Part 1
1725       </a>
1726     </li>
1727
1728
1729
1730
1731
1732
1733
1734     <li class="md-nav__item">
1735       <a href="../../tutorial/series/part_2/" class="md-nav__link">
1736         Part 2
1737       </a>
1738     </li>
1739
1740
1741
1742
1743
1744
1745
1746     <li class="md-nav__item">
1747       <a href="../../tutorial/series/part_3/" class="md-nav__link">
1748         Part 3
1749       </a>
1750     </li>
1751
1752
1753
1754         </ul>
1755       </nav>
1756     </li>
1757
1758
1759
1760         </ul>
1761       </nav>
1762     </li>
1763
1764
1765
1766   </ul>
1767 </nav>
1768                   </div>
1769                 </div>
1770               </div>
1771
1772
1773
1774               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1775                 <div class="md-sidebar__scrollwrap">
1776                   <div class="md-sidebar__inner">
1777
1778 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1779
1780
1781
1782
1783
1784     <label class="md-nav__title" for="__toc">
1785       <span class="md-nav__icon md-icon"></span>
1786       Table of contents
1787     </label>
1788     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1789
1790         <li class="md-nav__item">
1791   <a href="#53-anchor" class="md-nav__link">
1792     5.3+ anchor
1793   </a>
1794
1795 </li>
1796
1797         <li class="md-nav__item">
1798   <a href="#53-anchorattributes" class="md-nav__link">
1799     5.3+ anchorAttributes
1800   </a>
1801
1802 </li>
1803
1804         <li class="md-nav__item">
1805   <a href="#append" class="md-nav__link">
1806     append
1807   </a>
1808
1809 </li>
1810
1811         <li class="md-nav__item">
1812   <a href="#assign" class="md-nav__link">
1813     assign
1814   </a>
1815
1816 </li>
1817
1818         <li class="md-nav__item">
1819   <a href="#capture" class="md-nav__link">
1820     capture
1821   </a>
1822
1823 </li>
1824
1825         <li class="md-nav__item">
1826   <a href="#concat" class="md-nav__link">
1827     concat
1828   </a>
1829
1830 </li>
1831
1832         <li class="md-nav__item">
1833   <a href="#counter" class="md-nav__link">
1834     counter
1835   </a>
1836
1837 </li>
1838
1839         <li class="md-nav__item">
1840   <a href="#54-csrftoken" class="md-nav__link">
1841     5.4+ csrfToken
1842   </a>
1843
1844 </li>
1845
1846         <li class="md-nav__item">
1847   <a href="#currency" class="md-nav__link">
1848     currency
1849   </a>
1850
1851 </li>
1852
1853         <li class="md-nav__item">
1854   <a href="#cycle" class="md-nav__link">
1855     cycle
1856   </a>
1857
1858 </li>
1859
1860         <li class="md-nav__item">
1861   <a href="#date" class="md-nav__link">
1862     date
1863   </a>
1864
1865 </li>
1866
1867         <li class="md-nav__item">
1868   <a href="#31-dateinterval" class="md-nav__link">
1869     3.1+ dateInterval
1870   </a>
1871
1872 </li>
1873
1874         <li class="md-nav__item">
1875   <a href="#encodejs" class="md-nav__link">
1876     encodeJS
1877   </a>
1878
1879 </li>
1880
1881         <li class="md-nav__item">
1882   <a href="#encodejson" class="md-nav__link">
1883     encodeJSON
1884   </a>
1885
1886 </li>
1887
1888         <li class="md-nav__item">
1889   <a href="#escapecdata" class="md-nav__link">
1890     escapeCDATA
1891   </a>
1892
1893 </li>
1894
1895         <li class="md-nav__item">
1896   <a href="#event" class="md-nav__link">
1897     event
1898   </a>
1899
1900 </li>
1901
1902         <li class="md-nav__item">
1903   <a href="#fetch" class="md-nav__link">
1904     fetch
1905   </a>
1906
1907 </li>
1908
1909         <li class="md-nav__item">
1910   <a href="#filesizebinary" class="md-nav__link">
1911     filesizeBinary
1912   </a>
1913
1914 </li>
1915
1916         <li class="md-nav__item">
1917   <a href="#filesize" class="md-nav__link">
1918     filesize
1919   </a>
1920
1921 </li>
1922
1923         <li class="md-nav__item">
1924   <a href="#hascontent" class="md-nav__link">
1925     hascontent
1926   </a>
1927
1928 </li>
1929
1930         <li class="md-nav__item">
1931   <a href="#htmlcheckboxes" class="md-nav__link">
1932     htmlCheckboxes
1933   </a>
1934
1935 </li>
1936
1937         <li class="md-nav__item">
1938   <a href="#htmloptions" class="md-nav__link">
1939     htmlOptions
1940   </a>
1941
1942 </li>
1943
1944         <li class="md-nav__item">
1945   <a href="#implode" class="md-nav__link">
1946     implode
1947   </a>
1948
1949 </li>
1950
1951         <li class="md-nav__item">
1952   <a href="#52-ipsearch" class="md-nav__link">
1953     5.2+ ipSearch
1954   </a>
1955
1956 </li>
1957
1958         <li class="md-nav__item">
1959   <a href="#30-js" class="md-nav__link">
1960     3.0+ js
1961   </a>
1962
1963 </li>
1964
1965         <li class="md-nav__item">
1966   <a href="#53-jslang" class="md-nav__link">
1967     5.3+ jslang
1968   </a>
1969
1970 </li>
1971
1972         <li class="md-nav__item">
1973   <a href="#lang" class="md-nav__link">
1974     lang
1975   </a>
1976
1977 </li>
1978
1979         <li class="md-nav__item">
1980   <a href="#language" class="md-nav__link">
1981     language
1982   </a>
1983
1984 </li>
1985
1986         <li class="md-nav__item">
1987   <a href="#link" class="md-nav__link">
1988     link
1989   </a>
1990
1991 </li>
1992
1993         <li class="md-nav__item">
1994   <a href="#newlinetobreak" class="md-nav__link">
1995     newlineToBreak
1996   </a>
1997
1998 </li>
1999
2000         <li class="md-nav__item">
2001   <a href="#30-page" class="md-nav__link">
2002     3.0+ page
2003   </a>
2004
2005 </li>
2006
2007         <li class="md-nav__item">
2008   <a href="#pages" class="md-nav__link">
2009     pages
2010   </a>
2011
2012 </li>
2013
2014         <li class="md-nav__item">
2015   <a href="#plaintime" class="md-nav__link">
2016     plainTime
2017   </a>
2018
2019 </li>
2020
2021         <li class="md-nav__item">
2022   <a href="#53-plural" class="md-nav__link">
2023     5.3+ plural
2024   </a>
2025
2026 </li>
2027
2028         <li class="md-nav__item">
2029   <a href="#prepend" class="md-nav__link">
2030     prepend
2031   </a>
2032
2033 </li>
2034
2035         <li class="md-nav__item">
2036   <a href="#shortunit" class="md-nav__link">
2037     shortUnit
2038   </a>
2039
2040 </li>
2041
2042         <li class="md-nav__item">
2043   <a href="#smallpages" class="md-nav__link">
2044     smallpages
2045   </a>
2046
2047 </li>
2048
2049         <li class="md-nav__item">
2050   <a href="#tablewordwrap" class="md-nav__link">
2051     tableWordwrap
2052   </a>
2053
2054 </li>
2055
2056         <li class="md-nav__item">
2057   <a href="#time" class="md-nav__link">
2058     time
2059   </a>
2060
2061 </li>
2062
2063         <li class="md-nav__item">
2064   <a href="#truncate" class="md-nav__link">
2065     truncate
2066   </a>
2067
2068 </li>
2069
2070         <li class="md-nav__item">
2071   <a href="#53-user" class="md-nav__link">
2072     5.3+ user
2073   </a>
2074
2075 </li>
2076
2077     </ul>
2078
2079 </nav>
2080                   </div>
2081                 </div>
2082               </div>
2083
2084
2085           <div class="md-content" data-md-component="content">
2086             <article class="md-content__inner md-typeset">
2087
2088
2089                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/view/template-plugins.md" title="Edit this page" class="md-content__button md-icon">
2090                     <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>
2091                   </a>
2092
2093
2094                 <h1 id="template-plugins">Template Plugins<a class="headerlink" href="#template-plugins" title="Permanent link">#</a></h1>
2095 <h2 id="53-anchor"><span class="label label-info">5.3+</span> <code>anchor</code><a class="headerlink" href="#53-anchor" title="Permanent link">#</a></h2>
2096 <p>The <code>anchor</code> template plugin creates <code>a</code> HTML elements.
2097 The easiest way to use the template plugin is to pass it an instance of <code>ITitledLinkObject</code>:</p>
2098 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">anchor</span> <span class="na">object</span><span class="o">=</span><span class="nv">$object</span><span class="cp">}</span><span class="x"></span>
2099 </code></pre></div>
2100 <p>generates the same output as</p>
2101 <div class="highlight"><pre><span></span><code><span class="x">&lt;a href=&quot;</span><span class="cp">{</span><span class="nv">$object</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot;&gt;</span><span class="cp">{</span><span class="nv">$object</span><span class="o">-&gt;</span><span class="na">getTitle</span><span class="o">()</span><span class="cp">}</span><span class="x">&lt;/a&gt;</span>
2102 </code></pre></div>
2103 <p>Instead of an <code>object</code> parameter, a <code>link</code> and <code>content</code> parameter can be used:</p>
2104 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">anchor</span> <span class="na">link</span><span class="o">=</span><span class="nv">$linkObject</span> <span class="na">content</span><span class="o">=</span><span class="nv">$content</span><span class="cp">}</span><span class="x"></span>
2105 </code></pre></div>
2106 <p>where <code>$linkObject</code> implements <code>ILinkableObject</code> and <code>$content</code> is either an object implementing <code>ITitledObject</code> or having a <code>__toString()</code> method or <code>$content</code> is a string or a number.</p>
2107 <p>The last special attribute is <code>append</code> whose contents are appended to the <code>href</code> attribute of the generated anchor element.</p>
2108 <p>All of the other attributes matching <code>~^[a-z]+([A-z]+)+$~</code>, expect for <code>href</code> which is disallowed, are added as attributes to the anchor element.</p>
2109 <p>If an <code>object</code> attribute is present, the object also implements <code>IPopoverObject</code> and if the return value of <code>IPopoverObject::getPopoverLinkClass()</code> is included in the <code>class</code> attribute of the <code>anchor</code> tag, <code>data-object-id</code> is automatically added.
2110 This functionality makes it easy to generate links with popover support.
2111 Instead of</p>
2112 <div class="highlight"><pre><span></span><code><span class="x">&lt;a href=&quot;</span><span class="cp">{</span><span class="nv">$entry</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot; class=&quot;blogEntryLink&quot; data-object-id=&quot;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$entry</span><span class="o">-&gt;</span><span class="na">entryID</span><span class="cp">}</span><span class="x">&quot;&gt;</span><span class="cp">{</span><span class="nv">$entry</span><span class="o">-&gt;</span><span class="na">subject</span><span class="cp">}</span><span class="x">&lt;/a&gt;</span>
2113 </code></pre></div>
2114 <p>using</p>
2115 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">anchor</span> <span class="na">object</span><span class="o">=</span><span class="nv">$entry</span> <span class="na">class</span><span class="o">=</span><span class="s1">&#39;blogEntryLink&#39;</span><span class="cp">}</span><span class="x"></span>
2116 </code></pre></div>
2117 <p>is sufficient if <code>Entry::getPopoverLinkClass()</code> returns <code>blogEntryLink</code>.</p>
2118 <h2 id="53-anchorattributes"><span class="label label-info">5.3+</span> <code>anchorAttributes</code><a class="headerlink" href="#53-anchorattributes" title="Permanent link">#</a></h2>
2119 <p><code>anchorAttributes</code> compliments the <code>StringUtil::getAnchorTagAttributes(string, bool): string</code> method.
2120 It allows to easily generate the necessary attributes for an anchor tag based off the destination URL.</p>
2121 <div class="highlight"><pre><span></span><code><span class="x">&lt;a href=&quot;https://www.example.com&quot; </span><span class="cp">{</span><span class="nf">anchorAttributes</span> <span class="na">url</span><span class="o">=</span><span class="s1">&#39;https://www.example.com&#39;</span> <span class="na">appendHref</span><span class="o">=</span><span class="kc">false</span> <span class="na">appendClassname</span><span class="o">=</span><span class="kc">true</span> <span class="na">isUgc</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x">&gt;</span>
2122 </code></pre></div>
2123 <table>
2124 <thead>
2125 <tr>
2126 <th>Attribute</th>
2127 <th>Description</th>
2128 </tr>
2129 </thead>
2130 <tbody>
2131 <tr>
2132 <td><code>url</code></td>
2133 <td>destination URL</td>
2134 </tr>
2135 <tr>
2136 <td><code>appendHref</code></td>
2137 <td>whether the <code>href</code> attribute should be generated; <code>true</code> by default</td>
2138 </tr>
2139 <tr>
2140 <td><code>isUgc</code></td>
2141 <td>whether the <code>rel="ugc"</code> attribute should be generated; <code>false</code> by default</td>
2142 </tr>
2143 <tr>
2144 <td><code>appendClassname</code></td>
2145 <td>whether the <code>class="externalURL"</code> attribute should be generated; <code>true</code> by default</td>
2146 </tr>
2147 </tbody>
2148 </table>
2149 <h2 id="append"><code>append</code><a class="headerlink" href="#append" title="Permanent link">#</a></h2>
2150 <p>If a string should be appended to the value of a variable, <code>append</code> can be used:</p>
2151 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;newValue&#39;</span><span class="cp">}</span><span class="x"></span>
2152
2153 <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;newValue *</span><span class="cp">}</span><span class="x"></span>
2154
2155 <span class="cp">{</span><span class="nf">append</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;2&#39;</span><span class="cp">}</span><span class="x"></span>
2156
2157 <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* now prints &#39;newValue2 *</span><span class="cp">}</span><span class="x"></span>
2158 </code></pre></div>
2159 <p>If the variables does not exist yet, <code>append</code> creates a new one with the given value.
2160 If <code>append</code> is used on an array as the variable, the value is appended to all elements of the array.</p>
2161 <h2 id="assign"><code>assign</code><a class="headerlink" href="#assign" title="Permanent link">#</a></h2>
2162 <p>New template variables can be declared and new values can be assigned to existing template variables using <code>assign</code>:</p>
2163 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;newValue&#39;</span><span class="cp">}</span><span class="x"></span>
2164
2165 <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;newValue *</span><span class="cp">}</span><span class="x"></span>
2166 </code></pre></div>
2167 <h2 id="capture"><code>capture</code><a class="headerlink" href="#capture" title="Permanent link">#</a></h2>
2168 <p>In some situations, <code>assign</code> is not sufficient to assign values to variables in templates if the value is complex.
2169 Instead, <code>capture</code> can be used:</p>
2170 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">capture</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span><span class="cp">}</span><span class="x"></span>
2171 <span class="x">    </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span><span class="cp">}</span><span class="x"></span>
2172 <span class="x">        &lt;p&gt;</span><span class="cp">{</span><span class="nv">$bar</span><span class="cp">}</span><span class="x">&lt;/p&gt;</span>
2173 <span class="x">    </span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span><span class="x"></span>
2174 <span class="x">        &lt;small&gt;</span><span class="cp">{</span><span class="nv">$baz</span><span class="cp">}</span><span class="x">&lt;/small&gt;</span>
2175 <span class="x">    </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2176 <span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2177 </code></pre></div>
2178 <h2 id="concat"><code>concat</code><a class="headerlink" href="#concat" title="Permanent link">#</a></h2>
2179 <p><code>concat</code> is a modifier used to concatenate multiple strings:</p>
2180 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">foo</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span><span class="cp">}</span><span class="x"></span>
2181
2182 <span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;bar&#39;</span><span class="o">|</span><span class="na">concat</span><span class="o">:</span><span class="nv">$foo</span><span class="cp">}</span><span class="x"></span>
2183
2184 <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;foobar *</span><span class="cp">}</span><span class="x"></span>
2185 </code></pre></div>
2186 <h2 id="counter"><code>counter</code><a class="headerlink" href="#counter" title="Permanent link">#</a></h2>
2187 <p><code>counter</code> can be used to generate and optionally print a counter:</p>
2188 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;1&#39; *</span><span class="cp">}</span><span class="x"></span>
2189
2190 <span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;2&#39; now *</span><span class="cp">}</span><span class="x"></span>
2191
2192 <span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints nothing, but counter value is &#39;3&#39; now internally *</span><span class="cp">}</span><span class="x"></span>
2193
2194 <span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;4&#39; *</span><span class="cp">}</span><span class="x"></span>
2195 </code></pre></div>
2196 <p>Counter supports the following attributes:</p>
2197 <table>
2198 <thead>
2199 <tr>
2200 <th>Attribute</th>
2201 <th>Description</th>
2202 </tr>
2203 </thead>
2204 <tbody>
2205 <tr>
2206 <td><code>assign</code></td>
2207 <td>optional name of the template variable the current counter value is assigned to</td>
2208 </tr>
2209 <tr>
2210 <td><code>direction</code></td>
2211 <td>counting direction, either <code>up</code> or <code>down</code>; <code>up</code> by default</td>
2212 </tr>
2213 <tr>
2214 <td><code>name</code></td>
2215 <td>name of the counter, relevant if multiple counters are used simultaneously</td>
2216 </tr>
2217 <tr>
2218 <td><code>print</code></td>
2219 <td>if <code>true</code>, the current counter value is printed; <code>false</code> by default</td>
2220 </tr>
2221 <tr>
2222 <td><code>skip</code></td>
2223 <td>positive counting increment; <code>1</code> by default</td>
2224 </tr>
2225 <tr>
2226 <td><code>start</code></td>
2227 <td>start counter value; <code>1</code> by default</td>
2228 </tr>
2229 </tbody>
2230 </table>
2231 <h2 id="54-csrftoken"><span class="label label-info">5.4+</span> <code>csrfToken</code><a class="headerlink" href="#54-csrftoken" title="Permanent link">#</a></h2>
2232 <p><code>{csrfToken}</code> prints out the session's CSRF token (“Security Token”).</p>
2233 <div class="highlight"><pre><span></span><code><span class="x">&lt;form action=&quot;</span><span class="cp">{</span><span class="nf">link</span> <span class="na">controller</span><span class="o">=</span><span class="s2">&quot;Foo&quot;</span><span class="cp">}{</span><span class="nf">/link</span><span class="cp">}</span><span class="x">&quot; method=&quot;post&quot;&gt;</span>
2234 <span class="x">    </span><span class="cp">{</span><span class="c">* snip *</span><span class="cp">}</span><span class="x"></span>
2235
2236 <span class="x">    </span><span class="cp">{</span><span class="nf">csrfToken</span><span class="cp">}</span><span class="x"></span>
2237 <span class="x">&lt;/form&gt;</span>
2238 </code></pre></div>
2239 <p>The <code>{csrfToken}</code> template plugin supports a <code>type</code> parameter.
2240 Specifying this parameter might be required in rare situations.
2241 Please <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/template/plugin/CsrfTokenFunctionTemplatePlugin.class.php">check the implementation</a> for details.</p>
2242 <h2 id="currency"><code>currency</code><a class="headerlink" href="#currency" title="Permanent link">#</a></h2>
2243 <p><code>currency</code> is a modifier used to format currency values with two decimals using language dependent thousands separators and decimal point:</p>
2244 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">currencyValue</span> <span class="na">value</span><span class="o">=</span><span class="m">12.345</span><span class="cp">}</span><span class="x"></span>
2245
2246 <span class="cp">{</span><span class="nv">$currencyValue</span><span class="o">|</span><span class="na">currency</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;12.34&#39; *</span><span class="cp">}</span><span class="x"></span>
2247 </code></pre></div>
2248 <h2 id="cycle"><code>cycle</code><a class="headerlink" href="#cycle" title="Permanent link">#</a></h2>
2249 <p><code>cycle</code> can be used to cycle between different values:</p>
2250 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span> <span class="na">values</span><span class="o">=</span><span class="s1">&#39;bar,baz&#39;</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;bar&#39; *</span><span class="cp">}</span><span class="x"></span>
2251
2252 <span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;baz&#39; *</span><span class="cp">}</span><span class="x"></span>
2253
2254 <span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span> <span class="na">advance</span><span class="o">=</span><span class="kc">false</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;baz&#39; again *</span><span class="cp">}</span><span class="x"></span>
2255
2256 <span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;bar&#39; *</span><span class="cp">}</span><span class="x"></span>
2257 </code></pre></div>
2258 <div class="admonition info">
2259 <p class="admonition-title">The values attribute only has to be present for the first call. If <code>cycle</code> is used in a loop, the presence of the same values in consecutive calls has no effect. Only once the values change, the cycle is reset.</p>
2260 </div>
2261 <table>
2262 <thead>
2263 <tr>
2264 <th>Attribute</th>
2265 <th>Description</th>
2266 </tr>
2267 </thead>
2268 <tbody>
2269 <tr>
2270 <td><code>advance</code></td>
2271 <td>if <code>true</code>, the current cycle value is advanced to the next value; <code>true</code> by default</td>
2272 </tr>
2273 <tr>
2274 <td><code>assign</code></td>
2275 <td>optional name of the template variable the current cycle value is assigned to; if used, <code>print</code> is set to <code>false</code></td>
2276 </tr>
2277 <tr>
2278 <td><code>delimiter</code></td>
2279 <td>delimiter between the different cycle values; <code>,</code> by default</td>
2280 </tr>
2281 <tr>
2282 <td><code>name</code></td>
2283 <td>name of the cycle, relevant if multiple cycles are used simultaneously</td>
2284 </tr>
2285 <tr>
2286 <td><code>print</code></td>
2287 <td>if <code>true</code>, the current cycle value is printed, <code>false</code> by default</td>
2288 </tr>
2289 <tr>
2290 <td><code>reset</code></td>
2291 <td>if <code>true</code>, the current cycle value is set to the first value, <code>false</code> by default</td>
2292 </tr>
2293 <tr>
2294 <td><code>values</code></td>
2295 <td>string containing the different cycles values, also see <code>delimiter</code></td>
2296 </tr>
2297 </tbody>
2298 </table>
2299 <h2 id="date"><code>date</code><a class="headerlink" href="#date" title="Permanent link">#</a></h2>
2300 <p><code>date</code> generated a formatted date using <code>wcf\util\DateUtil::format()</code> with <code>DateUtil::DATE_FORMAT</code> internally.</p>
2301 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$timestamp</span><span class="o">|</span><span class="na">date</span><span class="cp">}</span><span class="x"></span>
2302 </code></pre></div>
2303 <h2 id="31-dateinterval"><span class="label label-info">3.1+</span> <code>dateInterval</code><a class="headerlink" href="#31-dateinterval" title="Permanent link">#</a></h2>
2304 <p><code>dateInterval</code> calculates the difference between two unix timestamps and generated a textual date interval.</p>
2305 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">dateInterval</span> <span class="na">start</span><span class="o">=</span><span class="nv">$startTimestamp</span> <span class="na">end</span><span class="o">=</span><span class="nv">$endTimestamp</span> <span class="na">full</span><span class="o">=</span><span class="kc">true</span> <span class="na">format</span><span class="o">=</span><span class="s1">&#39;sentence&#39;</span><span class="cp">}</span><span class="x"></span>
2306 </code></pre></div>
2307 <table>
2308 <thead>
2309 <tr>
2310 <th>Attribute</th>
2311 <th>Description</th>
2312 </tr>
2313 </thead>
2314 <tbody>
2315 <tr>
2316 <td><code>end</code></td>
2317 <td>end of the time interval; current timestamp by default (though either <code>start</code> or <code>end</code> has to be set)</td>
2318 </tr>
2319 <tr>
2320 <td><code>format</code></td>
2321 <td>output format, either <code>default</code>, <code>sentence</code>, or <code>plain</code>; defaults to <code>default</code>, see <code>wcf\util\DateUtil::FORMAT_*</code> constants</td>
2322 </tr>
2323 <tr>
2324 <td><code>full</code></td>
2325 <td>if <code>true</code>, full difference in minutes is shown; if <code>false</code>, only the longest time interval is shown; <code>false</code> by default</td>
2326 </tr>
2327 <tr>
2328 <td><code>start</code></td>
2329 <td>start of the time interval; current timestamp by default (though either <code>start</code> or <code>end</code> has to be set)</td>
2330 </tr>
2331 </tbody>
2332 </table>
2333 <h2 id="encodejs"><code>encodeJS</code><a class="headerlink" href="#encodejs" title="Permanent link">#</a></h2>
2334 <p><code>encodeJS</code> encodes a string to be used as a single-quoted string in JavaScript by replacing <code>\\</code> with <code>\\\\</code>, <code>'</code> with <code>\'</code>, linebreaks with <code>\n</code>, and <code>/</code> with <code>\/</code>.</p>
2335 <div class="highlight"><pre><span></span><code><span class="x">&lt;script&gt;</span>
2336 <span class="x">    var foo = &#39;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">|</span><span class="na">encodeJS</span><span class="cp">}</span><span class="x">&#39;;</span>
2337 <span class="x">&lt;/script&gt;</span>
2338 </code></pre></div>
2339 <h2 id="encodejson"><code>encodeJSON</code><a class="headerlink" href="#encodejson" title="Permanent link">#</a></h2>
2340 <p><code>encodeJSON</code> encodes a JSON string to be used as a single-quoted string in JavaScript by replacing <code>\\</code> with <code>\\\\</code>, <code>'</code> with <code>&amp;#39;</code>, linebreaks with <code>\n</code>, and <code>/</code> with <code>\/</code>.
2341 Additionally, <code>htmlspecialchars</code> is applied to the string.</p>
2342 <div class="highlight"><pre><span></span><code><span class="x">&#39;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">|</span><span class="na">encodeJSON</span><span class="cp">}</span><span class="x">&#39;</span>
2343 </code></pre></div>
2344 <h2 id="escapecdata"><code>escapeCDATA</code><a class="headerlink" href="#escapecdata" title="Permanent link">#</a></h2>
2345 <p><code>escapeCDATA</code> encodes a string to be used in a <code>CDATA</code> element by replacing <code>]]&gt;</code> with <code>]]]]&gt;&lt;![CDATA[&gt;</code>.</p>
2346 <div class="highlight"><pre><span></span><code><span class="x">&lt;![CDATA[</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">|</span><span class="na">encodeCDATA</span><span class="cp">}</span><span class="x">]]&gt;</span>
2347 </code></pre></div>
2348 <h2 id="event"><code>event</code><a class="headerlink" href="#event" title="Permanent link">#</a></h2>
2349 <p><code>event</code> provides extension points in templates that <a href="../../package/pip/template-listener/">template listeners</a> can use.</p>
2350 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span><span class="cp">}</span><span class="x"></span>
2351 </code></pre></div>
2352 <h2 id="fetch"><code>fetch</code><a class="headerlink" href="#fetch" title="Permanent link">#</a></h2>
2353 <p><code>fetch</code> fetches the contents of a file using <code>file_get_contents</code>.</p>
2354 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">fetch</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;foo.html&#39;</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints the contents of `foo.html` *</span><span class="cp">}</span><span class="x"></span>
2355
2356 <span class="cp">{</span><span class="nf">fetch</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;bar.html&#39;</span> <span class="na">assign</span><span class="o">=</span><span class="na">bar</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* assigns the contents of `foo.html` to `$bar`; does not print the contents *</span><span class="cp">}</span><span class="x"></span>
2357 </code></pre></div>
2358 <h2 id="filesizebinary"><code>filesizeBinary</code><a class="headerlink" href="#filesizebinary" title="Permanent link">#</a></h2>
2359 <p><code>filesizeBinary</code> formats the filesize using binary filesize (in bytes).</p>
2360 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$filesize</span><span class="o">|</span><span class="na">filesizeBinary</span><span class="cp">}</span><span class="x"></span>
2361 </code></pre></div>
2362 <h2 id="filesize"><code>filesize</code><a class="headerlink" href="#filesize" title="Permanent link">#</a></h2>
2363 <p><code>filesize</code> formats the filesize using filesize (in bytes).</p>
2364 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$filesize</span><span class="o">|</span><span class="na">filesize</span><span class="cp">}</span><span class="x"></span>
2365 </code></pre></div>
2366 <h2 id="hascontent"><code>hascontent</code><a class="headerlink" href="#hascontent" title="Permanent link">#</a></h2>
2367 <p>In many cases, conditional statements can be used to determine if a certain section of a template is shown:</p>
2368 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">&#39;bar&#39;</span><span class="cp">}</span><span class="x"></span>
2369 <span class="x">    only shown if $foo is bar</span>
2370 <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2371 </code></pre></div>
2372 <p>In some situations, however, such conditional statements are not sufficient.
2373 One prominent example is a template event:</p>
2374 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">&#39;bar&#39;</span><span class="cp">}</span><span class="x"></span>
2375 <span class="x">    &lt;ul&gt;</span>
2376 <span class="x">        </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">&#39;bar&#39;</span><span class="cp">}</span><span class="x"></span>
2377 <span class="x">            &lt;li&gt;Bar&lt;/li&gt;</span>
2378 <span class="x">        </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2379
2380 <span class="x">        </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;listItems&#39;</span><span class="cp">}</span><span class="x"></span>
2381 <span class="x">    &lt;/li&gt;</span>
2382 <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2383 </code></pre></div>
2384 <p>In this example, if <code>$foo !== 'bar'</code>, the list will not be shown, regardless of the additional template code provided by template listeners.
2385 In such a situation, <code>hascontent</code> has to be used:</p>
2386 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span><span class="x"></span>
2387 <span class="x">    &lt;ul&gt;</span>
2388 <span class="x">        </span><span class="cp">{</span><span class="nf">content</span><span class="cp">}</span><span class="x"></span>
2389 <span class="x">            </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">&#39;bar&#39;</span><span class="cp">}</span><span class="x"></span>
2390 <span class="x">                &lt;li&gt;Bar&lt;/li&gt;</span>
2391 <span class="x">            </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2392
2393 <span class="x">            </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;listItems&#39;</span><span class="cp">}</span><span class="x"></span>
2394 <span class="x">        </span><span class="cp">{</span><span class="nf">/content</span><span class="cp">}</span><span class="x"></span>
2395 <span class="x">    &lt;/ul&gt;</span>
2396 <span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span><span class="x"></span>
2397 </code></pre></div>
2398 <p>If the part of the template wrapped in the <code>content</code> tags has any (trimmed) content, the part of the template wrapped by <code>hascontent</code> tags is shown (including the part wrapped by the <code>content</code> tags), otherwise nothing is shown.
2399 Thus, this construct avoids an empty list compared to the <code>if</code> solution above.</p>
2400 <p>Like <code>foreach</code>, <code>hascontent</code> also supports an <code>else</code> part:</p>
2401 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span><span class="x"></span>
2402 <span class="x">    &lt;ul&gt;</span>
2403 <span class="x">        </span><span class="cp">{</span><span class="nf">content</span><span class="cp">}</span><span class="x"></span>
2404 <span class="x">            </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
2405 <span class="x">        </span><span class="cp">{</span><span class="nf">/content</span><span class="cp">}</span><span class="x"></span>
2406 <span class="x">    &lt;/ul&gt;</span>
2407 <span class="cp">{</span><span class="nf">hascontentelse</span><span class="cp">}</span><span class="x"></span>
2408 <span class="x">    no list</span>
2409 <span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span><span class="x"></span>
2410 </code></pre></div>
2411 <h2 id="htmlcheckboxes"><code>htmlCheckboxes</code><a class="headerlink" href="#htmlcheckboxes" title="Permanent link">#</a></h2>
2412 <p><code>htmlCheckboxes</code> generates a list of HTML checkboxes.</p>
2413 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">htmlCheckboxes</span> <span class="na">name</span><span class="o">=</span><span class="na">foo</span> <span class="na">options</span><span class="o">=</span><span class="nv">$fooOptions</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$currentFoo</span><span class="cp">}</span><span class="x"></span>
2414
2415 <span class="cp">{</span><span class="nf">htmlCheckboxes</span> <span class="na">name</span><span class="o">=</span><span class="na">bar</span> <span class="na">output</span><span class="o">=</span><span class="nv">$barLabels</span> <span class="na">values</span><span class="o">=</span><span class="nv">$barValues</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$currentBar</span><span class="cp">}</span><span class="x"></span>
2416 </code></pre></div>
2417 <table>
2418 <thead>
2419 <tr>
2420 <th>Attribute</th>
2421 <th>Description</th>
2422 </tr>
2423 </thead>
2424 <tbody>
2425 <tr>
2426 <td><span class="label label-info">5.2+</span> <code>disabled</code></td>
2427 <td>if <code>true</code>, all checkboxes are disabled</td>
2428 </tr>
2429 <tr>
2430 <td><code>disableEncoding</code></td>
2431 <td>if <code>true</code>, the values are not passed through <code>wcf\util\StringUtil::encodeHTML()</code>; <code>false</code> by default</td>
2432 </tr>
2433 <tr>
2434 <td><code>name</code></td>
2435 <td><code>name</code> attribute of the <code>input</code> checkbox element</td>
2436 </tr>
2437 <tr>
2438 <td><code>output</code></td>
2439 <td>array used as keys and values for <code>options</code> if present; not present by default</td>
2440 </tr>
2441 <tr>
2442 <td><code>options</code></td>
2443 <td>array selectable options with the key used as <code>value</code> attribute and the value as the checkbox label</td>
2444 </tr>
2445 <tr>
2446 <td><code>selected</code></td>
2447 <td>current selected value(s)</td>
2448 </tr>
2449 <tr>
2450 <td><code>separator</code></td>
2451 <td>separator between the different checkboxes in the generated output; empty string by default</td>
2452 </tr>
2453 <tr>
2454 <td><code>values</code></td>
2455 <td>array with values used in combination with <code>output</code>, where <code>output</code> is only used as keys for <code>options</code></td>
2456 </tr>
2457 </tbody>
2458 </table>
2459 <h2 id="htmloptions"><code>htmlOptions</code><a class="headerlink" href="#htmloptions" title="Permanent link">#</a></h2>
2460 <p><code>htmlOptions</code> generates an <code>select</code> HTML element.</p>
2461 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">htmlOptions</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span> <span class="na">options</span><span class="o">=</span><span class="nv">$options</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$selected</span><span class="cp">}</span><span class="x"></span>
2462
2463 <span class="x">&lt;select name=&quot;bar&quot;&gt;</span>
2464 <span class="x">    &lt;option value=&quot;&quot;</span><span class="cp">{</span><span class="nf">if</span> <span class="o">!</span><span class="nv">$selected</span><span class="cp">}</span><span class="x"> selected</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x">&gt;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.default</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&lt;/option&gt;</span>
2465 <span class="x">    </span><span class="cp">{</span><span class="nf">htmlOptions</span> <span class="na">options</span><span class="o">=</span><span class="nv">$options</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$selected</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* no `name` attribute *</span><span class="cp">}</span><span class="x"></span>
2466 <span class="x">&lt;/select&gt;</span>
2467 </code></pre></div>
2468 <table>
2469 <thead>
2470 <tr>
2471 <th>Attribute</th>
2472 <th>Description</th>
2473 </tr>
2474 </thead>
2475 <tbody>
2476 <tr>
2477 <td><code>disableEncoding</code></td>
2478 <td>if <code>true</code>, the values are not passed through <code>wcf\util\StringUtil::encodeHTML()</code>; <code>false</code> by default</td>
2479 </tr>
2480 <tr>
2481 <td><code>object</code></td>
2482 <td>optional instance of <code>wcf\data\DatabaseObjectList</code> that provides the selectable options (overwrites <code>options</code> attribute internally)</td>
2483 </tr>
2484 <tr>
2485 <td><code>name</code></td>
2486 <td><code>name</code> attribute of the <code>select</code> element; if not present, only the <strong>contents</strong> of the <code>select</code> element are printed</td>
2487 </tr>
2488 <tr>
2489 <td><code>output</code></td>
2490 <td>array used as keys and values for <code>options</code> if present; not present by default</td>
2491 </tr>
2492 <tr>
2493 <td><code>values</code></td>
2494 <td>array with values used in combination with <code>output</code>, where <code>output</code> is only used as keys for <code>options</code></td>
2495 </tr>
2496 <tr>
2497 <td><code>options</code></td>
2498 <td>array selectable options with the key used as <code>value</code> attribute and the value as the option label; if a value is an array, an <code>optgroup</code> is generated with the array key as the <code>optgroup</code> label</td>
2499 </tr>
2500 <tr>
2501 <td><code>selected</code></td>
2502 <td>current selected value(s)</td>
2503 </tr>
2504 </tbody>
2505 </table>
2506 <p>All additional attributes are added as attributes of the <code>select</code> HTML element.</p>
2507 <h2 id="implode"><code>implode</code><a class="headerlink" href="#implode" title="Permanent link">#</a></h2>
2508 <p><code>implodes</code> transforms an array into a string and prints it.</p>
2509 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">implode</span> <span class="na">from</span><span class="o">=</span><span class="nv">$array</span> <span class="na">key</span><span class="o">=</span><span class="na">key</span> <span class="na">item</span><span class="o">=</span><span class="na">item</span> <span class="na">glue</span><span class="o">=</span><span class="s2">&quot;;&quot;</span><span class="cp">}{</span><span class="nv">$key</span><span class="cp">}</span><span class="x">: </span><span class="cp">{</span><span class="nv">$value</span><span class="cp">}{</span><span class="nf">/implode</span><span class="cp">}</span><span class="x"></span>
2510 </code></pre></div>
2511 <table>
2512 <thead>
2513 <tr>
2514 <th>Attribute</th>
2515 <th>Description</th>
2516 </tr>
2517 </thead>
2518 <tbody>
2519 <tr>
2520 <td><code>from</code></td>
2521 <td>array with the imploded values</td>
2522 </tr>
2523 <tr>
2524 <td><code>glue</code></td>
2525 <td>separator between the different array values; <code>', '</code> by default</td>
2526 </tr>
2527 <tr>
2528 <td><code>item</code></td>
2529 <td>template variable name where the current array value is stored during the iteration</td>
2530 </tr>
2531 <tr>
2532 <td><code>key</code></td>
2533 <td>optional template variable name where the current array key is stored during the iteration</td>
2534 </tr>
2535 </tbody>
2536 </table>
2537 <h2 id="52-ipsearch"><span class="label label-info">5.2+</span> <code>ipSearch</code><a class="headerlink" href="#52-ipsearch" title="Permanent link">#</a></h2>
2538 <p><code>ipSearch</code> generates a link to search for an IP address.</p>
2539 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="s2">&quot;127.0.0.1&quot;</span><span class="o">|</span><span class="na">ipSearch</span><span class="cp">}</span><span class="x"></span>
2540 </code></pre></div>
2541 <h2 id="30-js"><span class="label label-info">3.0+</span> <code>js</code><a class="headerlink" href="#30-js" title="Permanent link">#</a></h2>
2542 <p><code>js</code> generates script tags based on whether <code>ENABLE_DEBUG_MODE</code> and <code>VISITOR_USE_TINY_BUILD</code> are enabled.</p>
2543 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;wbb&#39;</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;WBB&#39;</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/js/WBB.js&#39; *</span><span class="cp">}</span><span class="x"></span>
2544
2545 <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;wcf&#39;</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;WCF.Like&#39;</span> <span class="na">bundle</span><span class="o">=</span><span class="s1">&#39;WCF.Combined&#39;</span><span class="cp">}</span><span class="x"></span>
2546 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/WCF.Like.js&#39; if ENABLE_DEBUG_MODE=1 *</span><span class="cp">}</span><span class="x"></span>
2547 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/WCF.Combined.min.js&#39; if ENABLE_DEBUG_MODE=0 *</span><span class="cp">}</span><span class="x"></span>
2548
2549 <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;wcf&#39;</span> <span class="na">lib</span><span class="o">=</span><span class="s1">&#39;jquery&#39;</span><span class="cp">}</span><span class="x"></span>
2550 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/3rdParty/jquery.js&#39; *</span><span class="cp">}</span><span class="x"></span>
2551
2552 <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;wcf&#39;</span> <span class="na">lib</span><span class="o">=</span><span class="s1">&#39;jquery-ui&#39;</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;awesomeWidget&#39;</span><span class="cp">}</span><span class="x"></span>
2553 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/3rdParty/jquery-ui/awesomeWidget.js&#39; *</span><span class="cp">}</span><span class="x"></span>
2554
2555 <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;wcf&#39;</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;WCF.Like&#39;</span> <span class="na">bundle</span><span class="o">=</span><span class="s1">&#39;WCF.Combined&#39;</span> <span class="na">hasTiny</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"></span>
2556 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/WCF.Like.js&#39; if ENABLE_DEBUG_MODE=1 *</span><span class="cp">}</span><span class="x"></span>
2557 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/WCF.Combined.min.js&#39; (ENABLE_DEBUG_MODE=0 *</span><span class="cp">}</span><span class="x"></span>
2558 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/WCF.Combined.tiny.min.js&#39; if ENABLE_DEBUG_MODE=0 and VISITOR_USE_TINY_BUILD=1 *</span><span class="cp">}</span><span class="x"></span>
2559 </code></pre></div>
2560 <h2 id="53-jslang"><span class="label label-info">5.3+</span> <code>jslang</code><a class="headerlink" href="#53-jslang" title="Permanent link">#</a></h2>
2561 <p><code>jslang</code> works like <a href="#lang"><code>lang</code></a> with the difference that the resulting string is automatically passed through <a href="#encodejs"><code>encodeJS</code></a>.</p>
2562 <div class="highlight"><pre><span></span><code><span class="x">require([&#39;Language&#39;, /* … */], function(Language, /* … */) </span><span class="cp">{</span>
2563     <span class="na">Language</span><span class="o">.</span><span class="na">addObject</span><span class="o">(</span><span class="cp">{</span>
2564         <span class="s1">&#39;app.foo.bar&#39;</span><span class="o">:</span> <span class="s1">&#39;{jslang}app.foo.bar{/jslang}&#39;</span><span class="o">,</span>
2565     <span class="cp">}</span><span class="o">);</span>
2566
2567     <span class="o">//</span> <span class="err">…</span>
2568 <span class="cp">}</span><span class="x">);</span>
2569 </code></pre></div>
2570 <h2 id="lang"><code>lang</code><a class="headerlink" href="#lang" title="Permanent link">#</a></h2>
2571 <p><code>lang</code> replaces a language items with its value.</p>
2572 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span>
2573
2574 <span class="cp">{</span><span class="nf">lang</span> <span class="na">__literal</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span>
2575
2576 <span class="cp">{</span><span class="nf">lang</span> <span class="na">foo</span><span class="o">=</span><span class="s1">&#39;baz&#39;</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span>
2577
2578 <span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.baz.</span><span class="cp">{</span><span class="nv">$action</span><span class="cp">}{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span>
2579 </code></pre></div>
2580 <table>
2581 <thead>
2582 <tr>
2583 <th>Attribute</th>
2584 <th>Description</th>
2585 </tr>
2586 </thead>
2587 <tbody>
2588 <tr>
2589 <td><code>__encode</code></td>
2590 <td>if <code>true</code>, the output will be passed through <code>StringUtil::encodeHTML()</code></td>
2591 </tr>
2592 <tr>
2593 <td><code>__literal</code></td>
2594 <td>if <code>true</code>, template variables will not resolved but printed as they are in the language item; <code>false</code> by default</td>
2595 </tr>
2596 <tr>
2597 <td><code>__optional</code></td>
2598 <td>if <code>true</code> and the language item does not exist, an empty string is printed; <code>false</code> by default</td>
2599 </tr>
2600 </tbody>
2601 </table>
2602 <p>All additional attributes are available when parsing the language item.</p>
2603 <h2 id="language"><code>language</code><a class="headerlink" href="#language" title="Permanent link">#</a></h2>
2604 <p><code>language</code> replaces a language items with its value.
2605 If the template variable <code>__language</code> exists, this language object will be used instead of <code>WCF::getLanguage()</code>.
2606 This modifier is useful when assigning the value directly to a variable.</p>
2607 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$languageItem</span><span class="o">|</span><span class="na">language</span><span class="cp">}</span><span class="x"></span>
2608
2609 <span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">foo</span> <span class="na">value</span><span class="o">=</span><span class="nv">$languageItem</span><span class="o">|</span><span class="na">language</span><span class="cp">}</span><span class="x"></span>
2610 </code></pre></div>
2611 <h2 id="link"><code>link</code><a class="headerlink" href="#link" title="Permanent link">#</a></h2>
2612 <p><code>link</code> generates internal links using <code>LinkHandler</code>.</p>
2613 <div class="highlight"><pre><span></span><code><span class="x">&lt;a href=&quot;</span><span class="cp">{</span><span class="nf">link</span> <span class="na">controller</span><span class="o">=</span><span class="s1">&#39;FooList&#39;</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;bar&#39;</span><span class="cp">}</span><span class="x">param1=2&amp;param2=A</span><span class="cp">{</span><span class="nf">/link</span><span class="cp">}</span><span class="x">&quot;&gt;Foo&lt;/a&gt;</span>
2614 </code></pre></div>
2615 <table>
2616 <thead>
2617 <tr>
2618 <th>Attribute</th>
2619 <th>Description</th>
2620 </tr>
2621 </thead>
2622 <tbody>
2623 <tr>
2624 <td><code>application</code></td>
2625 <td>abbreviation of the application the controller belongs to; <code>wcf</code> by default</td>
2626 </tr>
2627 <tr>
2628 <td><code>controller</code></td>
2629 <td>name of the controller; if not present, the landing page is linked in the frontend and the index page in the ACP</td>
2630 </tr>
2631 <tr>
2632 <td><code>encode</code></td>
2633 <td>if <code>true</code>, the generated link is passed through <code>wcf\util\StringUtil::encodeHTML()</code>; <code>true</code> by default</td>
2634 </tr>
2635 <tr>
2636 <td><code>isEmail</code></td>
2637 <td>sets <code>encode=false</code> and forces links to link to the frontend</td>
2638 </tr>
2639 </tbody>
2640 </table>
2641 <p>Additional attributes are passed to <code>LinkHandler::getLink()</code>.</p>
2642 <h2 id="newlinetobreak"><code>newlineToBreak</code><a class="headerlink" href="#newlinetobreak" title="Permanent link">#</a></h2>
2643 <p><code>newlineToBreak</code> transforms newlines into HTML <code>&lt;br&gt;</code> elements after encoding the content via <code>wcf\util\StringUtil::encodeHTML()</code>.</p>
2644 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">newlineToBreak</span><span class="cp">}</span><span class="x"></span>
2645 </code></pre></div>
2646 <h2 id="30-page"><span class="label label-info">3.0+</span> <code>page</code><a class="headerlink" href="#30-page" title="Permanent link">#</a></h2>
2647 <p><code>page</code> generates an internal link to a CMS page.</p>
2648 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">page</span><span class="cp">}</span><span class="x">com.woltlab.wcf.CookiePolicy</span><span class="cp">{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span>
2649
2650 <span class="cp">{</span><span class="nf">page</span> <span class="na">pageID</span><span class="o">=</span><span class="m">1</span><span class="cp">}{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span>
2651
2652 <span class="cp">{</span><span class="nf">page</span> <span class="na">language</span><span class="o">=</span><span class="s1">&#39;de&#39;</span><span class="cp">}</span><span class="x">com.woltlab.wcf.CookiePolicy</span><span class="cp">{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span>
2653
2654 <span class="cp">{</span><span class="nf">page</span> <span class="na">languageID</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x">com.woltlab.wcf.CookiePolicy</span><span class="cp">{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span>
2655 </code></pre></div>
2656 <table>
2657 <thead>
2658 <tr>
2659 <th>Attribute</th>
2660 <th>Description</th>
2661 </tr>
2662 </thead>
2663 <tbody>
2664 <tr>
2665 <td><code>pageID</code></td>
2666 <td>unique id of the page (cannot be used together with a page identifier as value)</td>
2667 </tr>
2668 <tr>
2669 <td><code>languageID</code></td>
2670 <td>id of the page language (cannot be used together with <code>language</code>)</td>
2671 </tr>
2672 <tr>
2673 <td><code>language</code></td>
2674 <td>language code of the page language (cannot be used together with <code>languageID</code>)</td>
2675 </tr>
2676 </tbody>
2677 </table>
2678 <h2 id="pages"><code>pages</code><a class="headerlink" href="#pages" title="Permanent link">#</a></h2>
2679 <p><code>pages</code> generates a pagination.</p>
2680 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">pages</span> <span class="na">controller</span><span class="o">=</span><span class="s1">&#39;FooList&#39;</span> <span class="na">link</span><span class="o">=</span><span class="s2">&quot;pageNo=%d&quot;</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span> <span class="na">assign</span><span class="o">=</span><span class="na">pagesLinks</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints pagination *</span><span class="cp">}</span><span class="x"></span>
2681
2682 <span class="cp">{</span><span class="o">@</span><span class="nv">$pagesLinks</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints same pagination again *</span><span class="cp">}</span><span class="x"></span>
2683 </code></pre></div>
2684 <table>
2685 <thead>
2686 <tr>
2687 <th>Attribute</th>
2688 <th>Description</th>
2689 </tr>
2690 </thead>
2691 <tbody>
2692 <tr>
2693 <td><code>assign</code></td>
2694 <td>optional name of the template variable the pagination is assigned to</td>
2695 </tr>
2696 <tr>
2697 <td><code>controller</code></td>
2698 <td>controller name of the generated links</td>
2699 </tr>
2700 <tr>
2701 <td><code>link</code></td>
2702 <td>additional link parameter where <code>%d</code> will be replaced with the relevant page number</td>
2703 </tr>
2704 <tr>
2705 <td><code>pages</code></td>
2706 <td>maximum number of of pages; by default, the template variable <code>$pages</code> is used</td>
2707 </tr>
2708 <tr>
2709 <td><code>print</code></td>
2710 <td>if <code>false</code> and <code>assign=true</code>, the pagination is not printed</td>
2711 </tr>
2712 <tr>
2713 <td><code>application</code>, <code>id</code>, <code>object</code>, <code>title</code></td>
2714 <td>additional parameters passed to <code>LinkHandler::getLink()</code> to generate page links</td>
2715 </tr>
2716 </tbody>
2717 </table>
2718 <h2 id="plaintime"><code>plainTime</code><a class="headerlink" href="#plaintime" title="Permanent link">#</a></h2>
2719 <p><code>plainTime</code> formats a timestamp to include year, month, day, hour, and minutes.
2720 The exact formatting depends on the current language (via the language items <code>wcf.date.dateTimeFormat</code>, <code>wcf.date.dateFormat</code>, and <code>wcf.date.timeFormat</code>).</p>
2721 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$timestamp</span><span class="o">|</span><span class="na">plainTime</span><span class="cp">}</span><span class="x"></span>
2722 </code></pre></div>
2723 <h2 id="53-plural"><span class="label label-info">5.3+</span> <code>plural</code><a class="headerlink" href="#53-plural" title="Permanent link">#</a></h2>
2724 <p><code>plural</code> allows to easily select the correct plural form of a phrase based on a given <code>value</code>.
2725 The pluralization logic follows the <a href="https://unicode-org.github.io/cldr-staging/charts/37/supplemental/language_plural_rules.md">Unicode Language Plural Rules</a> for cardinal numbers.</p>
2726 <p>The <code>#</code> placeholder within the resulting phrase is replaced by the <code>value</code>.
2727 It is automatically formatted using <code>StringUtil::formatNumeric</code>.</p>
2728 <p>English:</p>
2729 <p>Note the use of <code>1</code> if the number (<code>#</code>) is not used within the phrase and the use of <code>one</code> otherwise.
2730 They are equivalent for English, but following this rule generalizes better to other languages, helping the translator.
2731 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span>
2732 <span class="x">&lt;h1&gt;Hello </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;World&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;Worlds&#39;</span><span class="cp">}</span><span class="x">!&lt;/h1&gt;</span>
2733 <span class="x">&lt;p&gt;There </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;is one world&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;are # worlds&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2734 <span class="x">&lt;p&gt;There </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="na">one</span><span class="o">=</span><span class="s1">&#39;is # world&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;are # worlds&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2735 </code></pre></div></p>
2736 <p>German:
2737 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span>
2738 <span class="x">&lt;h1&gt;Hallo </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;Welt&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;Welten&#39;</span><span class="cp">}</span><span class="x">!&lt;/h1&gt;</span>
2739 <span class="x">&lt;p&gt;Es gibt </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;eine Welt&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;# Welten&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2740 <span class="x">&lt;p&gt;Es gibt </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="na">one</span><span class="o">=</span><span class="s1">&#39;# Welt&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;# Welten&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2741 </code></pre></div></p>
2742 <p>Romanian:</p>
2743 <p>Note the additional use of <code>few</code> which is not required in English or German.
2744 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span>
2745 <span class="x">&lt;h1&gt;Salut </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;lume&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;lumi&#39;</span><span class="cp">}</span><span class="x">!&lt;/h1&gt;</span>
2746 <span class="x">&lt;p&gt;Există </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;o lume&#39;</span> <span class="na">few</span><span class="o">=</span><span class="s1">&#39;# lumi&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;# de lumi&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2747 <span class="x">&lt;p&gt;Există </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="na">one</span><span class="o">=</span><span class="s1">&#39;# lume&#39;</span> <span class="na">few</span><span class="o">=</span><span class="s1">&#39;# lumi&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;# de lumi&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2748 </code></pre></div></p>
2749 <p>Russian:</p>
2750 <p>Note the difference between <code>1</code> (exactly <code>1</code>) and <code>one</code> (ending in <code>1</code>, except ending in <code>11</code>).
2751 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span>
2752 <span class="x">&lt;h1&gt;Привет </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorld</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;мир&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;миры&#39;</span><span class="cp">}</span><span class="x">!&lt;/h1&gt;</span>
2753 <span class="x">&lt;p&gt;Есть </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;мир&#39;</span> <span class="na">one</span><span class="o">=</span><span class="s1">&#39;# мир&#39;</span> <span class="na">few</span><span class="o">=</span><span class="s1">&#39;# мира&#39;</span> <span class="na">many</span><span class="o">=</span><span class="s1">&#39;# миров&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;# миров&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2754 </code></pre></div></p>
2755 <table>
2756 <thead>
2757 <tr>
2758 <th>Attribute</th>
2759 <th>Description</th>
2760 </tr>
2761 </thead>
2762 <tbody>
2763 <tr>
2764 <td>value</td>
2765 <td>The value that is used to select the proper phrase.</td>
2766 </tr>
2767 <tr>
2768 <td>other</td>
2769 <td>The phrase that is used when no other selector matches.</td>
2770 </tr>
2771 <tr>
2772 <td>Any Category Name</td>
2773 <td>The phrase that is used when <code>value</code> belongs to the named category. Available categories depend on the language.</td>
2774 </tr>
2775 <tr>
2776 <td>Any Integer</td>
2777 <td>The phrase that is used when <code>value</code> is that exact integer.</td>
2778 </tr>
2779 </tbody>
2780 </table>
2781 <h2 id="prepend"><code>prepend</code><a class="headerlink" href="#prepend" title="Permanent link">#</a></h2>
2782 <p>If a string should be prepended to the value of a variable, <code>prepend</code> can be used:</p>
2783 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;newValue&#39;</span><span class="cp">}</span><span class="x"></span>
2784
2785 <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;newValue *</span><span class="cp">}</span><span class="x"></span>
2786
2787 <span class="cp">{</span><span class="nf">prepend</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;2&#39;</span><span class="cp">}</span><span class="x"></span>
2788
2789 <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* now prints &#39;2newValue&#39; *</span><span class="cp">}</span><span class="x"></span>
2790 </code></pre></div>
2791 <p>If the variables does not exist yet, <code>prepend</code> creates a new one with the given value.
2792 If <code>prepend</code> is used on an array as the variable, the value is prepended to all elements of the array.</p>
2793 <h2 id="shortunit"><code>shortUnit</code><a class="headerlink" href="#shortunit" title="Permanent link">#</a></h2>
2794 <p><code>shortUnit</code> shortens numbers larger than 1000 by using unit suffixes:</p>
2795 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="m">10000</span><span class="o">|</span><span class="na">shortUnit</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 10k *</span><span class="cp">}</span><span class="x"></span>
2796 <span class="cp">{</span><span class="m">5400000</span><span class="o">|</span><span class="na">shortUnit</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 5.4M *</span><span class="cp">}</span><span class="x"></span>
2797 </code></pre></div>
2798 <h2 id="smallpages"><code>smallpages</code><a class="headerlink" href="#smallpages" title="Permanent link">#</a></h2>
2799 <p><code>smallpages</code> generates a smaller version of <code>pages</code> by using adding the <code>small</code> CSS class to the generated <code>&lt;nav&gt;</code> element and only showing 7 instead of 9 links. </p>
2800 <h2 id="tablewordwrap"><code>tableWordwrap</code><a class="headerlink" href="#tablewordwrap" title="Permanent link">#</a></h2>
2801 <p><code>tableWordwrap</code> inserts zero width spaces every 30 characters in words longer than 30 characters.</p>
2802 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">tableWordwrap</span><span class="cp">}</span><span class="x"></span>
2803 </code></pre></div>
2804 <h2 id="time"><code>time</code><a class="headerlink" href="#time" title="Permanent link">#</a></h2>
2805 <p><code>time</code> generates an HTML <code>time</code> elements based on a timestamp that shows a relative time or the absolute time if the timestamp more than six days ago.</p>
2806 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$timestamp</span><span class="o">|</span><span class="na">time</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints a &#39;&lt;time&gt;&#39; element *</span><span class="cp">}</span><span class="x"></span>
2807 </code></pre></div>
2808 <h2 id="truncate"><code>truncate</code><a class="headerlink" href="#truncate" title="Permanent link">#</a></h2>
2809 <p><code>truncate</code> truncates a long string into a shorter one:</p>
2810 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">truncate</span><span class="o">:</span><span class="m">35</span><span class="cp">}</span><span class="x"></span>
2811
2812 <span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">truncate</span><span class="o">:</span><span class="m">35</span><span class="o">:</span><span class="s1">&#39;_&#39;</span><span class="o">:</span><span class="kc">true</span><span class="cp">}</span><span class="x"></span>
2813 </code></pre></div>
2814 <table>
2815 <thead>
2816 <tr>
2817 <th>Parameter Number</th>
2818 <th>Description</th>
2819 </tr>
2820 </thead>
2821 <tbody>
2822 <tr>
2823 <td>0</td>
2824 <td>truncated string</td>
2825 </tr>
2826 <tr>
2827 <td>1</td>
2828 <td>truncated length; <code>80</code> by default</td>
2829 </tr>
2830 <tr>
2831 <td>2</td>
2832 <td>ellipsis symbol; <code>wcf\util\StringUtil::HELLIP</code> by default</td>
2833 </tr>
2834 <tr>
2835 <td>3</td>
2836 <td>if <code>true</code>, words can be broken up in the middle; <code>false</code> by default</td>
2837 </tr>
2838 </tbody>
2839 </table>
2840 <h2 id="53-user"><span class="label label-info">5.3+</span> <code>user</code><a class="headerlink" href="#53-user" title="Permanent link">#</a></h2>
2841 <p><code>user</code> generates links to user profiles.
2842 The mandatory <code>object</code> parameter requires an instances of <code>UserProfile</code>.
2843 The optional <code>type</code> parameter is responsible for what the generated link contains:</p>
2844 <ul>
2845 <li><code>type='default'</code> (also applies if no <code>type</code> is given) outputs the formatted username relying on the “User Marking” setting of the relevant user group.
2846   Additionally, the user popover card will be shown when hovering over the generated link.</li>
2847 <li><code>type='plain'</code> outputs the username without additional formatting.</li>
2848 <li><code>type='avatar(\d+)'</code> outputs the user’s avatar in the specified size, i.e., <code>avatar48</code> outputs the avatar with a width and height of 48 pixels.</li>
2849 </ul>
2850 <p>The last special attribute is <code>append</code> whose contents are appended to the <code>href</code> attribute of the generated anchor element.</p>
2851 <p>All of the other attributes matching <code>~^[a-z]+([A-z]+)+$~</code>, except for <code>href</code> which may not be added, are added as attributes to the anchor element.</p>
2852 <p>Examples:</p>
2853 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">user</span> <span class="na">object</span><span class="o">=</span><span class="nv">$user</span><span class="cp">}</span><span class="x"></span>
2854 </code></pre></div>
2855 <p>generates</p>
2856 <div class="highlight"><pre><span></span><code><span class="x">&lt;a href=&quot;</span><span class="cp">{</span><span class="nv">$user</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot; data-object-id=&quot;</span><span class="cp">{</span><span class="nv">$user</span><span class="o">-&gt;</span><span class="na">userID</span><span class="cp">}</span><span class="x">&quot; class=&quot;userLink&quot;&gt;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$user</span><span class="o">-&gt;</span><span class="na">getFormattedUsername</span><span class="o">()</span><span class="cp">}</span><span class="x">&lt;/a&gt;</span>
2857 </code></pre></div>
2858 <p>and</p>
2859 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">user</span> <span class="na">object</span><span class="o">=</span><span class="nv">$user</span> <span class="na">type</span><span class="o">=</span><span class="s1">&#39;avatar48&#39;</span> <span class="na">foo</span><span class="o">=</span><span class="s1">&#39;bar&#39;</span><span class="cp">}</span><span class="x"></span>
2860 </code></pre></div>
2861 <p>generates</p>
2862 <div class="highlight"><pre><span></span><code><span class="x">&lt;a href=&quot;</span><span class="cp">{</span><span class="nv">$user</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot; foo=&quot;bar&quot;&gt;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$object</span><span class="o">-&gt;</span><span class="na">getAvatar</span><span class="o">()-&gt;</span><span class="na">getImageTag</span><span class="o">(</span><span class="m">48</span><span class="o">)</span><span class="cp">}</span><span class="x">&lt;/a&gt;</span>
2863 </code></pre></div>
2864
2865
2866
2867
2868 <hr>
2869 <div class="md-source-date">
2870   <small>
2871
2872       Last update: 2021-01-08
2873
2874   </small>
2875 </div>
2876
2877
2878
2879
2880
2881
2882
2883
2884             </article>
2885           </div>
2886         </div>
2887
2888       </main>
2889
2890
2891 <footer class="md-footer">
2892
2893   <div class="md-footer-meta md-typeset">
2894     <div class="md-footer-meta__inner md-grid">
2895       <div class="md-footer-copyright">
2896
2897           <div class="md-footer-copyright__highlight">
2898             Copyright © 2020 WoltLab GmbH
2899           </div>
2900
2901         Made with
2902         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2903           Material for MkDocs
2904         </a>
2905
2906       </div>
2907       <div class="md-footer-copyright">
2908         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2909         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2910 </div>
2911     </div>
2912   </div>
2913 </footer>
2914
2915     </div>
2916     <div class="md-dialog" data-md-component="dialog">
2917       <div class="md-dialog__inner md-typeset"></div>
2918     </div>
2919     <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>
2920
2921
2922       <script src="../../assets/javascripts/bundle.d892486b.min.js"></script>
2923
2924
2925   </body>
2926 </html>