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