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