6.0/view/languages-naming-conventions/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         <link rel="canonical" href="https://docs.woltlab.com/6.0/view/languages-naming-conventions/">
  12
  13
  14
  15       <link rel="icon" href="../../assets/default.favicon.ico">
  16       <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
  17
  18
  19
  20         <title>Language Naming Conventions - WoltLab Suite Documentation</title>
  21
  22
  23
  24       <link rel="stylesheet" href="../../assets/stylesheets/main.ded33207.min.css">
  25
  26
  27         <link rel="stylesheet" href="../../assets/stylesheets/palette.a0c5b2b5.min.css">
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37       <link rel="stylesheet" href="../../stylesheets/extra.css">
  38
  39     <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  40
  41
  42
  43
  44
  45
  46   </head>
  47
  48
  49
  50
  51
  52
  53
  54     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  55
  56
  57
  58     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  59     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  60     <label class="md-overlay" for="__drawer"></label>
  61     <div data-md-component="skip">
  62
  63
  64         <a href="#language-naming-conventions" class="md-skip">
  65           Skip to content
  66         </a>
  67
  68     </div>
  69     <div data-md-component="announce">
  70
  71         <aside class="md-banner">
  72           <div class="md-banner__inner md-grid md-typeset">
  73
  74
  75     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  76
  77           </div>
  78
  79         </aside>
  80
  81     </div>
  82
  83       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  84
  85       </div>
  86
  87
  88
  89
  90
  91
  92 <header class="md-header md-header--shadow" data-md-component="header">
  93   <nav class="md-header__inner md-grid" aria-label="Header">
  94     <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  95
  96   <img src="../../assets/logo.png" alt="logo">
  97
  98     </a>
  99     <label class="md-header__button md-icon" for="__drawer">
 100       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 101     </label>
 102     <div class="md-header__title" data-md-component="header-title">
 103       <div class="md-header__ellipsis">
 104         <div class="md-header__topic">
 105           <span class="md-ellipsis">
 106             WoltLab Suite Documentation
 107           </span>
 108         </div>
 109         <div class="md-header__topic" data-md-component="header-topic">
 110           <span class="md-ellipsis">
 111
 112               Language Naming Conventions
 113
 114           </span>
 115         </div>
 116       </div>
 117     </div>
 118
 119
 120
 121
 122
 123       <label class="md-header__button md-icon" for="__search">
 124         <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>
 125       </label>
 126       <div class="md-search" data-md-component="search" role="dialog">
 127   <label class="md-search__overlay" for="__search"></label>
 128   <div class="md-search__inner" role="search">
 129     <form class="md-search__form" name="search">
 130       <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" required>
 131       <label class="md-search__icon md-icon" for="__search">
 132         <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>
 133         <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>
 134       </label>
 135       <nav class="md-search__options" aria-label="Search">
 136
 137         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 138           <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>
 139         </button>
 140       </nav>
 141
 142     </form>
 143     <div class="md-search__output">
 144       <div class="md-search__scrollwrap" data-md-scrollfix>
 145         <div class="md-search-result" data-md-component="search-result">
 146           <div class="md-search-result__meta">
 147             Initializing search
 148           </div>
 149           <ol class="md-search-result__list" role="presentation"></ol>
 150         </div>
 151       </div>
 152     </div>
 153   </div>
 154 </div>
 155
 156
 157       <div class="md-header__source">
 158         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 159   <div class="md-source__icon md-icon">
 160
 161     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
 162   </div>
 163   <div class="md-source__repository">
 164     GitHub
 165   </div>
 166 </a>
 167       </div>
 168
 169   </nav>
 170
 171 </header>
 172
 173     <div class="md-container" data-md-component="container">
 174
 175
 176
 177
 178
 179
 180       <main class="md-main" data-md-component="main">
 181         <div class="md-main__inner md-grid">
 182
 183
 184
 185               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 186                 <div class="md-sidebar__scrollwrap">
 187                   <div class="md-sidebar__inner">
 188
 189
 190
 191 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 192   <label class="md-nav__title" for="__drawer">
 193     <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 194
 195   <img src="../../assets/logo.png" alt="logo">
 196
 197     </a>
 198     WoltLab Suite Documentation
 199   </label>
 200
 201     <div class="md-nav__source">
 202       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 203   <div class="md-source__icon md-icon">
 204
 205     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
 206   </div>
 207   <div class="md-source__repository">
 208     GitHub
 209   </div>
 210 </a>
 211     </div>
 212
 213   <ul class="md-nav__list" data-md-scrollfix>
 214
 215
 216
 217
 218
 219
 220
 221
 222     <li class="md-nav__item">
 223       <a href="../../getting-started/" class="md-nav__link">
 224         Getting Started
 225       </a>
 226     </li>
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238     <li class="md-nav__item md-nav__item--nested">
 239
 240
 241
 242
 243       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 244
 245
 246
 247         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 248           PHP API
 249           <span class="md-nav__icon md-icon"></span>
 250         </label>
 251
 252       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 253         <label class="md-nav__title" for="__nav_2">
 254           <span class="md-nav__icon md-icon"></span>
 255           PHP API
 256         </label>
 257         <ul class="md-nav__list" data-md-scrollfix>
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../php/pages/" class="md-nav__link">
 266         Pages
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278     <li class="md-nav__item">
 279       <a href="../../php/database-objects/" class="md-nav__link">
 280         Database Objects
 281       </a>
 282     </li>
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292     <li class="md-nav__item">
 293       <a href="../../php/database-access/" class="md-nav__link">
 294         Database Access
 295       </a>
 296     </li>
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306     <li class="md-nav__item">
 307       <a href="../../php/exceptions/" class="md-nav__link">
 308         Exceptions
 309       </a>
 310     </li>
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item md-nav__item--nested">
 322
 323
 324
 325
 326       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 327
 328
 329
 330         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 331           API
 332           <span class="md-nav__icon md-icon"></span>
 333         </label>
 334
 335       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 336         <label class="md-nav__title" for="__nav_2_5">
 337           <span class="md-nav__icon md-icon"></span>
 338           API
 339         </label>
 340         <ul class="md-nav__list" data-md-scrollfix>
 341
 342
 343
 344
 345
 346
 347
 348     <li class="md-nav__item md-nav__item--nested">
 349
 350
 351
 352
 353       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 354
 355
 356
 357         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 358           Caches
 359           <span class="md-nav__icon md-icon"></span>
 360         </label>
 361
 362       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 363         <label class="md-nav__title" for="__nav_2_5_1">
 364           <span class="md-nav__icon md-icon"></span>
 365           Caches
 366         </label>
 367         <ul class="md-nav__list" data-md-scrollfix>
 368
 369
 370
 371
 372
 373
 374     <li class="md-nav__item">
 375       <a href="../../php/api/caches/" class="md-nav__link">
 376         Overview
 377       </a>
 378     </li>
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388     <li class="md-nav__item">
 389       <a href="../../php/api/caches_persistent-caches/" class="md-nav__link">
 390         Persistent Caches
 391       </a>
 392     </li>
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../php/api/caches_runtime-caches/" class="md-nav__link">
 404         Runtime Caches
 405       </a>
 406     </li>
 407
 408
 409
 410
 411         </ul>
 412       </nav>
 413     </li>
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423     <li class="md-nav__item">
 424       <a href="../../php/api/comments/" class="md-nav__link">
 425         Comments
 426       </a>
 427     </li>
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437     <li class="md-nav__item">
 438       <a href="../../php/api/cronjobs/" class="md-nav__link">
 439         Cronjobs
 440       </a>
 441     </li>
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451     <li class="md-nav__item">
 452       <a href="../../php/api/events/" class="md-nav__link">
 453         Events
 454       </a>
 455     </li>
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466     <li class="md-nav__item md-nav__item--nested">
 467
 468
 469
 470
 471       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 472
 473
 474
 475         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 476           Form Builder
 477           <span class="md-nav__icon md-icon"></span>
 478         </label>
 479
 480       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 481         <label class="md-nav__title" for="__nav_2_5_5">
 482           <span class="md-nav__icon md-icon"></span>
 483           Form Builder
 484         </label>
 485         <ul class="md-nav__list" data-md-scrollfix>
 486
 487
 488
 489
 490
 491
 492     <li class="md-nav__item">
 493       <a href="../../php/api/form_builder/overview/" class="md-nav__link">
 494         Overview
 495       </a>
 496     </li>
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506     <li class="md-nav__item">
 507       <a href="../../php/api/form_builder/structure/" class="md-nav__link">
 508         Structure
 509       </a>
 510     </li>
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520     <li class="md-nav__item">
 521       <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
 522         Fields
 523       </a>
 524     </li>
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534     <li class="md-nav__item">
 535       <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
 536         Validation and Data
 537       </a>
 538     </li>
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548     <li class="md-nav__item">
 549       <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
 550         Dependencies
 551       </a>
 552     </li>
 553
 554
 555
 556
 557         </ul>
 558       </nav>
 559     </li>
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569     <li class="md-nav__item">
 570       <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
 571         Package Installation Plugins
 572       </a>
 573     </li>
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583     <li class="md-nav__item">
 584       <a href="../../php/api/user_activity_points/" class="md-nav__link">
 585         User Activity Points
 586       </a>
 587     </li>
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597     <li class="md-nav__item">
 598       <a href="../../php/api/user_notifications/" class="md-nav__link">
 599         User Notifications
 600       </a>
 601     </li>
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611     <li class="md-nav__item">
 612       <a href="../../php/api/sitemaps/" class="md-nav__link">
 613         Sitemaps
 614       </a>
 615     </li>
 616
 617
 618
 619
 620         </ul>
 621       </nav>
 622     </li>
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632     <li class="md-nav__item">
 633       <a href="../../php/code-style/" class="md-nav__link">
 634         Code Style
 635       </a>
 636     </li>
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646     <li class="md-nav__item">
 647       <a href="../../php/apps/" class="md-nav__link">
 648         Apps
 649       </a>
 650     </li>
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660     <li class="md-nav__item">
 661       <a href="../../php/gdpr/" class="md-nav__link">
 662         GDPR
 663       </a>
 664     </li>
 665
 666
 667
 668
 669         </ul>
 670       </nav>
 671     </li>
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683     <li class="md-nav__item md-nav__item--nested">
 684
 685
 686
 687
 688       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 689
 690
 691
 692         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 693           Languages, Templates & CSS
 694           <span class="md-nav__icon md-icon"></span>
 695         </label>
 696
 697       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 698         <label class="md-nav__title" for="__nav_3">
 699           <span class="md-nav__icon md-icon"></span>
 700           Languages, Templates & CSS
 701         </label>
 702         <ul class="md-nav__list" data-md-scrollfix>
 703
 704
 705
 706
 707
 708
 709     <li class="md-nav__item">
 710       <a href="../languages/" class="md-nav__link">
 711         Languages
 712       </a>
 713     </li>
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../templates/" class="md-nav__link">
 725         Templates
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737     <li class="md-nav__item">
 738       <a href="../template-plugins/" class="md-nav__link">
 739         Template Plugins
 740       </a>
 741     </li>
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751     <li class="md-nav__item">
 752       <a href="../css/" class="md-nav__link">
 753         CSS
 754       </a>
 755     </li>
 756
 757
 758
 759
 760         </ul>
 761       </nav>
 762     </li>
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item md-nav__item--nested">
 775
 776
 777
 778
 779       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 780
 781
 782
 783         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 784           TypeScript and JavaScript API
 785           <span class="md-nav__icon md-icon"></span>
 786         </label>
 787
 788       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 789         <label class="md-nav__title" for="__nav_4">
 790           <span class="md-nav__icon md-icon"></span>
 791           TypeScript and JavaScript API
 792         </label>
 793         <ul class="md-nav__list" data-md-scrollfix>
 794
 795
 796
 797
 798
 799
 800     <li class="md-nav__item">
 801       <a href="../../javascript/general-usage/" class="md-nav__link">
 802         General Usage
 803       </a>
 804     </li>
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814     <li class="md-nav__item">
 815       <a href="../../javascript/typescript/" class="md-nav__link">
 816         TypeScript
 817       </a>
 818     </li>
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829     <li class="md-nav__item md-nav__item--nested">
 830
 831
 832
 833
 834       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 835
 836
 837
 838         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 839           Components
 840           <span class="md-nav__icon md-icon"></span>
 841         </label>
 842
 843       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 844         <label class="md-nav__title" for="__nav_4_3">
 845           <span class="md-nav__icon md-icon"></span>
 846           Components
 847         </label>
 848         <ul class="md-nav__list" data-md-scrollfix>
 849
 850
 851
 852
 853
 854
 855     <li class="md-nav__item">
 856       <a href="../../javascript/components_confirmation/" class="md-nav__link">
 857         Confirmation
 858       </a>
 859     </li>
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869     <li class="md-nav__item">
 870       <a href="../../javascript/components_dialog/" class="md-nav__link">
 871         Dialog
 872       </a>
 873     </li>
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883     <li class="md-nav__item">
 884       <a href="../../javascript/components_google_maps/" class="md-nav__link">
 885         Google Maps
 886       </a>
 887     </li>
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897     <li class="md-nav__item">
 898       <a href="../../javascript/components_pagination/" class="md-nav__link">
 899         Pagination
 900       </a>
 901     </li>
 902
 903
 904
 905
 906         </ul>
 907       </nav>
 908     </li>
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919     <li class="md-nav__item md-nav__item--nested">
 920
 921
 922
 923
 924       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
 925
 926
 927
 928         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
 929           New API
 930           <span class="md-nav__icon md-icon"></span>
 931         </label>
 932
 933       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
 934         <label class="md-nav__title" for="__nav_4_4">
 935           <span class="md-nav__icon md-icon"></span>
 936           New API
 937         </label>
 938         <ul class="md-nav__list" data-md-scrollfix>
 939
 940
 941
 942
 943
 944
 945     <li class="md-nav__item">
 946       <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
 947         Writing a module
 948       </a>
 949     </li>
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959     <li class="md-nav__item">
 960       <a href="../../javascript/new-api_core/" class="md-nav__link">
 961         Core Functions
 962       </a>
 963     </li>
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973     <li class="md-nav__item">
 974       <a href="../../javascript/new-api_dom/" class="md-nav__link">
 975         DOM
 976       </a>
 977     </li>
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987     <li class="md-nav__item">
 988       <a href="../../javascript/new-api_events/" class="md-nav__link">
 989         Event Handling
 990       </a>
 991     </li>
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001     <li class="md-nav__item">
1002       <a href="../../javascript/new-api_ajax/" class="md-nav__link">
1003         Ajax
1004       </a>
1005     </li>
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015     <li class="md-nav__item">
1016       <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
1017         Dialogs
1018       </a>
1019     </li>
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029     <li class="md-nav__item">
1030       <a href="../../javascript/new-api_browser/" class="md-nav__link">
1031         Browser and Screen Sizes
1032       </a>
1033     </li>
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043     <li class="md-nav__item">
1044       <a href="../../javascript/new-api_ui/" class="md-nav__link">
1045         User Interface
1046       </a>
1047     </li>
1048
1049
1050
1051
1052         </ul>
1053       </nav>
1054     </li>
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064     <li class="md-nav__item">
1065       <a href="../../javascript/legacy-api/" class="md-nav__link">
1066         Legacy API
1067       </a>
1068     </li>
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078     <li class="md-nav__item">
1079       <a href="../../javascript/code-snippets/" class="md-nav__link">
1080         Code Snippets
1081       </a>
1082     </li>
1083
1084
1085
1086
1087         </ul>
1088       </nav>
1089     </li>
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101     <li class="md-nav__item md-nav__item--nested">
1102
1103
1104
1105
1106       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1107
1108
1109
1110         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1111           Package Components
1112           <span class="md-nav__icon md-icon"></span>
1113         </label>
1114
1115       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1116         <label class="md-nav__title" for="__nav_5">
1117           <span class="md-nav__icon md-icon"></span>
1118           Package Components
1119         </label>
1120         <ul class="md-nav__list" data-md-scrollfix>
1121
1122
1123
1124
1125
1126
1127     <li class="md-nav__item">
1128       <a href="../../package/package-xml/" class="md-nav__link">
1129         package.xml
1130       </a>
1131     </li>
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142     <li class="md-nav__item md-nav__item--nested">
1143
1144
1145
1146
1147       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1148
1149
1150
1151         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1152           PIPs
1153           <span class="md-nav__icon md-icon"></span>
1154         </label>
1155
1156       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1157         <label class="md-nav__title" for="__nav_5_2">
1158           <span class="md-nav__icon md-icon"></span>
1159           PIPs
1160         </label>
1161         <ul class="md-nav__list" data-md-scrollfix>
1162
1163
1164
1165
1166
1167
1168     <li class="md-nav__item">
1169       <a href="../../package/pip/" class="md-nav__link">
1170         Overview
1171       </a>
1172     </li>
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182     <li class="md-nav__item">
1183       <a href="../../package/pip/acl-option/" class="md-nav__link">
1184         aclOption
1185       </a>
1186     </li>
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196     <li class="md-nav__item">
1197       <a href="../../package/pip/acp-menu/" class="md-nav__link">
1198         acpMenu
1199       </a>
1200     </li>
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210     <li class="md-nav__item">
1211       <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1212         acpSearchProvider
1213       </a>
1214     </li>
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224     <li class="md-nav__item">
1225       <a href="../../package/pip/acp-template/" class="md-nav__link">
1226         acpTemplate
1227       </a>
1228     </li>
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238     <li class="md-nav__item">
1239       <a href="../../package/pip/acp-template-delete/" class="md-nav__link">
1240         acpTemplateDelete
1241       </a>
1242     </li>
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252     <li class="md-nav__item">
1253       <a href="../../package/pip/bbcode/" class="md-nav__link">
1254         bbcode
1255       </a>
1256     </li>
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266     <li class="md-nav__item">
1267       <a href="../../package/pip/box/" class="md-nav__link">
1268         box
1269       </a>
1270     </li>
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280     <li class="md-nav__item">
1281       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1282         clipboardAction
1283       </a>
1284     </li>
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294     <li class="md-nav__item">
1295       <a href="../../package/pip/core-object/" class="md-nav__link">
1296         coreObject
1297       </a>
1298     </li>
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308     <li class="md-nav__item">
1309       <a href="../../package/pip/cronjob/" class="md-nav__link">
1310         cronjob
1311       </a>
1312     </li>
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322     <li class="md-nav__item">
1323       <a href="../../package/pip/database/" class="md-nav__link">
1324         database
1325       </a>
1326     </li>
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336     <li class="md-nav__item">
1337       <a href="../../package/pip/event-listener/" class="md-nav__link">
1338         eventListener
1339       </a>
1340     </li>
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350     <li class="md-nav__item">
1351       <a href="../../package/pip/file/" class="md-nav__link">
1352         file
1353       </a>
1354     </li>
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364     <li class="md-nav__item">
1365       <a href="../../package/pip/file-delete/" class="md-nav__link">
1366         fileDelete
1367       </a>
1368     </li>
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378     <li class="md-nav__item">
1379       <a href="../../package/pip/language/" class="md-nav__link">
1380         language
1381       </a>
1382     </li>
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392     <li class="md-nav__item">
1393       <a href="../../package/pip/media-provider/" class="md-nav__link">
1394         mediaProvider
1395       </a>
1396     </li>
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406     <li class="md-nav__item">
1407       <a href="../../package/pip/menu/" class="md-nav__link">
1408         menu
1409       </a>
1410     </li>
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420     <li class="md-nav__item">
1421       <a href="../../package/pip/menu-item/" class="md-nav__link">
1422         menuItem
1423       </a>
1424     </li>
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434     <li class="md-nav__item">
1435       <a href="../../package/pip/object-type/" class="md-nav__link">
1436         objectType
1437       </a>
1438     </li>
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448     <li class="md-nav__item">
1449       <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1450         objectTypeDefinition
1451       </a>
1452     </li>
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462     <li class="md-nav__item">
1463       <a href="../../package/pip/option/" class="md-nav__link">
1464         option
1465       </a>
1466     </li>
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476     <li class="md-nav__item">
1477       <a href="../../package/pip/page/" class="md-nav__link">
1478         page
1479       </a>
1480     </li>
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490     <li class="md-nav__item">
1491       <a href="../../package/pip/pip/" class="md-nav__link">
1492         pip
1493       </a>
1494     </li>
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504     <li class="md-nav__item">
1505       <a href="../../package/pip/script/" class="md-nav__link">
1506         script
1507       </a>
1508     </li>
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518     <li class="md-nav__item">
1519       <a href="../../package/pip/smiley/" class="md-nav__link">
1520         smiley
1521       </a>
1522     </li>
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532     <li class="md-nav__item">
1533       <a href="../../package/pip/sql/" class="md-nav__link">
1534         sql
1535       </a>
1536     </li>
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546     <li class="md-nav__item">
1547       <a href="../../package/pip/style/" class="md-nav__link">
1548         style
1549       </a>
1550     </li>
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560     <li class="md-nav__item">
1561       <a href="../../package/pip/template/" class="md-nav__link">
1562         template
1563       </a>
1564     </li>
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574     <li class="md-nav__item">
1575       <a href="../../package/pip/template-delete/" class="md-nav__link">
1576         templateDelete
1577       </a>
1578     </li>
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588     <li class="md-nav__item">
1589       <a href="../../package/pip/template-listener/" class="md-nav__link">
1590         templateListener
1591       </a>
1592     </li>
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602     <li class="md-nav__item">
1603       <a href="../../package/pip/user-group-option/" class="md-nav__link">
1604         userGroupOption
1605       </a>
1606     </li>
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616     <li class="md-nav__item">
1617       <a href="../../package/pip/user-menu/" class="md-nav__link">
1618         userMenu
1619       </a>
1620     </li>
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630     <li class="md-nav__item">
1631       <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1632         userNotificationEvent
1633       </a>
1634     </li>
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644     <li class="md-nav__item">
1645       <a href="../../package/pip/user-option/" class="md-nav__link">
1646         userOption
1647       </a>
1648     </li>
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658     <li class="md-nav__item">
1659       <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1660         userProfileMenu
1661       </a>
1662     </li>
1663
1664
1665
1666
1667         </ul>
1668       </nav>
1669     </li>
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679     <li class="md-nav__item">
1680       <a href="../../package/database-php-api/" class="md-nav__link">
1681         Database PHP API
1682       </a>
1683     </li>
1684
1685
1686
1687
1688         </ul>
1689       </nav>
1690     </li>
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702     <li class="md-nav__item md-nav__item--nested">
1703
1704
1705
1706
1707       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1708
1709
1710
1711         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1712           Migration
1713           <span class="md-nav__icon md-icon"></span>
1714         </label>
1715
1716       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1717         <label class="md-nav__title" for="__nav_6">
1718           <span class="md-nav__icon md-icon"></span>
1719           Migration
1720         </label>
1721         <ul class="md-nav__list" data-md-scrollfix>
1722
1723
1724
1725
1726
1727
1728
1729     <li class="md-nav__item md-nav__item--nested">
1730
1731
1732
1733
1734       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1735
1736
1737
1738         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1739           From WoltLab Suite 5.5
1740           <span class="md-nav__icon md-icon"></span>
1741         </label>
1742
1743       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1744         <label class="md-nav__title" for="__nav_6_1">
1745           <span class="md-nav__icon md-icon"></span>
1746           From WoltLab Suite 5.5
1747         </label>
1748         <ul class="md-nav__list" data-md-scrollfix>
1749
1750
1751
1752
1753
1754
1755     <li class="md-nav__item">
1756       <a href="../../migration/wsc55/php/" class="md-nav__link">
1757         PHP API
1758       </a>
1759     </li>
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769     <li class="md-nav__item">
1770       <a href="../../migration/wsc55/javascript/" class="md-nav__link">
1771         TypeScript and JavaScript
1772       </a>
1773     </li>
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783     <li class="md-nav__item">
1784       <a href="../../migration/wsc55/templates/" class="md-nav__link">
1785         Templates
1786       </a>
1787     </li>
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797     <li class="md-nav__item">
1798       <a href="../../migration/wsc55/icons/" class="md-nav__link">
1799         Icons
1800       </a>
1801     </li>
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811     <li class="md-nav__item">
1812       <a href="../../migration/wsc55/dialogs/" class="md-nav__link">
1813         Dialogs
1814       </a>
1815     </li>
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825     <li class="md-nav__item">
1826       <a href="../../migration/wsc55/libraries/" class="md-nav__link">
1827         Third Party Libraries
1828       </a>
1829     </li>
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839     <li class="md-nav__item">
1840       <a href="../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1841         Deprecations and Removals
1842       </a>
1843     </li>
1844
1845
1846
1847
1848         </ul>
1849       </nav>
1850     </li>
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861     <li class="md-nav__item md-nav__item--nested">
1862
1863
1864
1865
1866       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
1867
1868
1869
1870         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
1871           From WoltLab Suite 5.4
1872           <span class="md-nav__icon md-icon"></span>
1873         </label>
1874
1875       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
1876         <label class="md-nav__title" for="__nav_6_2">
1877           <span class="md-nav__icon md-icon"></span>
1878           From WoltLab Suite 5.4
1879         </label>
1880         <ul class="md-nav__list" data-md-scrollfix>
1881
1882
1883
1884
1885
1886
1887     <li class="md-nav__item">
1888       <a href="../../migration/wsc54/php/" class="md-nav__link">
1889         PHP API
1890       </a>
1891     </li>
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901     <li class="md-nav__item">
1902       <a href="../../migration/wsc54/javascript/" class="md-nav__link">
1903         TypeScript and JavaScript
1904       </a>
1905     </li>
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915     <li class="md-nav__item">
1916       <a href="../../migration/wsc54/templates/" class="md-nav__link">
1917         Templates
1918       </a>
1919     </li>
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929     <li class="md-nav__item">
1930       <a href="../../migration/wsc54/libraries/" class="md-nav__link">
1931         Third Party Libraries
1932       </a>
1933     </li>
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943     <li class="md-nav__item">
1944       <a href="../../migration/wsc54/deprecations_removals/" class="md-nav__link">
1945         Deprecations and Removals
1946       </a>
1947     </li>
1948
1949
1950
1951
1952         </ul>
1953       </nav>
1954     </li>
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965     <li class="md-nav__item md-nav__item--nested">
1966
1967
1968
1969
1970       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
1971
1972
1973
1974         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
1975           From WoltLab Suite 5.3
1976           <span class="md-nav__icon md-icon"></span>
1977         </label>
1978
1979       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
1980         <label class="md-nav__title" for="__nav_6_3">
1981           <span class="md-nav__icon md-icon"></span>
1982           From WoltLab Suite 5.3
1983         </label>
1984         <ul class="md-nav__list" data-md-scrollfix>
1985
1986
1987
1988
1989
1990
1991     <li class="md-nav__item">
1992       <a href="../../migration/wsc53/php/" class="md-nav__link">
1993         PHP API
1994       </a>
1995     </li>
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005     <li class="md-nav__item">
2006       <a href="../../migration/wsc53/session/" class="md-nav__link">
2007         Session Handling and Authentication
2008       </a>
2009     </li>
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019     <li class="md-nav__item">
2020       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
2021         TypeScript and JavaScript
2022       </a>
2023     </li>
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033     <li class="md-nav__item">
2034       <a href="../../migration/wsc53/templates/" class="md-nav__link">
2035         Templates
2036       </a>
2037     </li>
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047     <li class="md-nav__item">
2048       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
2049         Third Party Libraries
2050       </a>
2051     </li>
2052
2053
2054
2055
2056         </ul>
2057       </nav>
2058     </li>
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069     <li class="md-nav__item md-nav__item--nested">
2070
2071
2072
2073
2074       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2075
2076
2077
2078         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2079           From WoltLab Suite 5.2
2080           <span class="md-nav__icon md-icon"></span>
2081         </label>
2082
2083       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2084         <label class="md-nav__title" for="__nav_6_4">
2085           <span class="md-nav__icon md-icon"></span>
2086           From WoltLab Suite 5.2
2087         </label>
2088         <ul class="md-nav__list" data-md-scrollfix>
2089
2090
2091
2092
2093
2094
2095     <li class="md-nav__item">
2096       <a href="../../migration/wsc52/php/" class="md-nav__link">
2097         PHP API
2098       </a>
2099     </li>
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109     <li class="md-nav__item">
2110       <a href="../../migration/wsc52/templates/" class="md-nav__link">
2111         Templates and Languages
2112       </a>
2113     </li>
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123     <li class="md-nav__item">
2124       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
2125         Third Party Libraries
2126       </a>
2127     </li>
2128
2129
2130
2131
2132         </ul>
2133       </nav>
2134     </li>
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145     <li class="md-nav__item md-nav__item--nested">
2146
2147
2148
2149
2150       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2151
2152
2153
2154         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2155           From WoltLab Suite 3.1
2156           <span class="md-nav__icon md-icon"></span>
2157         </label>
2158
2159       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2160         <label class="md-nav__title" for="__nav_6_5">
2161           <span class="md-nav__icon md-icon"></span>
2162           From WoltLab Suite 3.1
2163         </label>
2164         <ul class="md-nav__list" data-md-scrollfix>
2165
2166
2167
2168
2169
2170
2171     <li class="md-nav__item">
2172       <a href="../../migration/wsc31/php/" class="md-nav__link">
2173         PHP API
2174       </a>
2175     </li>
2176
2177
2178
2179
2180         </ul>
2181       </nav>
2182     </li>
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193     <li class="md-nav__item md-nav__item--nested">
2194
2195
2196
2197
2198       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2199
2200
2201
2202         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2203           From WoltLab Suite 3.0
2204           <span class="md-nav__icon md-icon"></span>
2205         </label>
2206
2207       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2208         <label class="md-nav__title" for="__nav_6_6">
2209           <span class="md-nav__icon md-icon"></span>
2210           From WoltLab Suite 3.0
2211         </label>
2212         <ul class="md-nav__list" data-md-scrollfix>
2213
2214
2215
2216
2217
2218
2219     <li class="md-nav__item">
2220       <a href="../../migration/wsc30/php/" class="md-nav__link">
2221         PHP API
2222       </a>
2223     </li>
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233     <li class="md-nav__item">
2234       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
2235         JavaScript API
2236       </a>
2237     </li>
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247     <li class="md-nav__item">
2248       <a href="../../migration/wsc30/templates/" class="md-nav__link">
2249         Templates
2250       </a>
2251     </li>
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261     <li class="md-nav__item">
2262       <a href="../../migration/wsc30/css/" class="md-nav__link">
2263         CSS
2264       </a>
2265     </li>
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275     <li class="md-nav__item">
2276       <a href="../../migration/wsc30/package/" class="md-nav__link">
2277         Package Components
2278       </a>
2279     </li>
2280
2281
2282
2283
2284         </ul>
2285       </nav>
2286     </li>
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297     <li class="md-nav__item md-nav__item--nested">
2298
2299
2300
2301
2302       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2303
2304
2305
2306         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2307           From WCF 2.1
2308           <span class="md-nav__icon md-icon"></span>
2309         </label>
2310
2311       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2312         <label class="md-nav__title" for="__nav_6_7">
2313           <span class="md-nav__icon md-icon"></span>
2314           From WCF 2.1
2315         </label>
2316         <ul class="md-nav__list" data-md-scrollfix>
2317
2318
2319
2320
2321
2322
2323     <li class="md-nav__item">
2324       <a href="../../migration/wcf21/php/" class="md-nav__link">
2325         PHP API
2326       </a>
2327     </li>
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337     <li class="md-nav__item">
2338       <a href="../../migration/wcf21/templates/" class="md-nav__link">
2339         Templates
2340       </a>
2341     </li>
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351     <li class="md-nav__item">
2352       <a href="../../migration/wcf21/css/" class="md-nav__link">
2353         CSS
2354       </a>
2355     </li>
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365     <li class="md-nav__item">
2366       <a href="../../migration/wcf21/package/" class="md-nav__link">
2367         Package Components
2368       </a>
2369     </li>
2370
2371
2372
2373
2374         </ul>
2375       </nav>
2376     </li>
2377
2378
2379
2380
2381         </ul>
2382       </nav>
2383     </li>
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395     <li class="md-nav__item md-nav__item--nested">
2396
2397
2398
2399
2400       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2401
2402
2403
2404         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2405           Tutorials
2406           <span class="md-nav__icon md-icon"></span>
2407         </label>
2408
2409       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2410         <label class="md-nav__title" for="__nav_7">
2411           <span class="md-nav__icon md-icon"></span>
2412           Tutorials
2413         </label>
2414         <ul class="md-nav__list" data-md-scrollfix>
2415
2416
2417
2418
2419
2420
2421
2422     <li class="md-nav__item md-nav__item--nested">
2423
2424
2425
2426
2427       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2428
2429
2430
2431         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2432           Tutorial Series
2433           <span class="md-nav__icon md-icon"></span>
2434         </label>
2435
2436       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2437         <label class="md-nav__title" for="__nav_7_1">
2438           <span class="md-nav__icon md-icon"></span>
2439           Tutorial Series
2440         </label>
2441         <ul class="md-nav__list" data-md-scrollfix>
2442
2443
2444
2445
2446
2447
2448     <li class="md-nav__item">
2449       <a href="../../tutorial/series/overview/" class="md-nav__link">
2450         Overview
2451       </a>
2452     </li>
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462     <li class="md-nav__item">
2463       <a href="../../tutorial/series/part_1/" class="md-nav__link">
2464         Part 1
2465       </a>
2466     </li>
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476     <li class="md-nav__item">
2477       <a href="../../tutorial/series/part_2/" class="md-nav__link">
2478         Part 2
2479       </a>
2480     </li>
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490     <li class="md-nav__item">
2491       <a href="../../tutorial/series/part_3/" class="md-nav__link">
2492         Part 3
2493       </a>
2494     </li>
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504     <li class="md-nav__item">
2505       <a href="../../tutorial/series/part_4/" class="md-nav__link">
2506         Part 4
2507       </a>
2508     </li>
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518     <li class="md-nav__item">
2519       <a href="../../tutorial/series/part_5/" class="md-nav__link">
2520         Part 5
2521       </a>
2522     </li>
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532     <li class="md-nav__item">
2533       <a href="../../tutorial/series/part_6/" class="md-nav__link">
2534         Part 6
2535       </a>
2536     </li>
2537
2538
2539
2540
2541         </ul>
2542       </nav>
2543     </li>
2544
2545
2546
2547
2548         </ul>
2549       </nav>
2550     </li>
2551
2552
2553
2554   </ul>
2555 </nav>
2556                   </div>
2557                 </div>
2558               </div>
2559
2560
2561
2562               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2563                 <div class="md-sidebar__scrollwrap">
2564                   <div class="md-sidebar__inner">
2565
2566
2567 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2568
2569
2570
2571
2572
2573
2574     <label class="md-nav__title" for="__toc">
2575       <span class="md-nav__icon md-icon"></span>
2576       Table of contents
2577     </label>
2578     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2579
2580         <li class="md-nav__item">
2581   <a href="#forms" class="md-nav__link">
2582     Forms
2583   </a>
2584
2585     <nav class="md-nav" aria-label="Forms">
2586       <ul class="md-nav__list">
2587
2588           <li class="md-nav__item">
2589   <a href="#fields" class="md-nav__link">
2590     Fields
2591   </a>
2592
2593 </li>
2594
2595           <li class="md-nav__item">
2596   <a href="#error-texts" class="md-nav__link">
2597     Error Texts
2598   </a>
2599
2600     <nav class="md-nav" aria-label="Error Texts">
2601       <ul class="md-nav__list">
2602
2603           <li class="md-nav__item">
2604   <a href="#naming-conventions" class="md-nav__link">
2605     Naming Conventions
2606   </a>
2607
2608 </li>
2609
2610       </ul>
2611     </nav>
2612
2613 </li>
2614
2615       </ul>
2616     </nav>
2617
2618 </li>
2619
2620         <li class="md-nav__item">
2621   <a href="#confirmation-messages" class="md-nav__link">
2622     Confirmation messages
2623   </a>
2624
2625     <nav class="md-nav" aria-label="Confirmation messages">
2626       <ul class="md-nav__list">
2627
2628           <li class="md-nav__item">
2629   <a href="#type-specific-deletion-confirmation-message" class="md-nav__link">
2630     Type-Specific Deletion Confirmation Message
2631   </a>
2632
2633     <nav class="md-nav" aria-label="Type-Specific Deletion Confirmation Message">
2634       <ul class="md-nav__list">
2635
2636           <li class="md-nav__item">
2637   <a href="#german" class="md-nav__link">
2638     German
2639   </a>
2640
2641 </li>
2642
2643           <li class="md-nav__item">
2644   <a href="#english" class="md-nav__link">
2645     English
2646   </a>
2647
2648 </li>
2649
2650       </ul>
2651     </nav>
2652
2653 </li>
2654
2655           <li class="md-nav__item">
2656   <a href="#object-specific-deletion-confirmation-message" class="md-nav__link">
2657     Object-Specific Deletion Confirmation Message
2658   </a>
2659
2660     <nav class="md-nav" aria-label="Object-Specific Deletion Confirmation Message">
2661       <ul class="md-nav__list">
2662
2663           <li class="md-nav__item">
2664   <a href="#german_1" class="md-nav__link">
2665     German
2666   </a>
2667
2668 </li>
2669
2670           <li class="md-nav__item">
2671   <a href="#english_1" class="md-nav__link">
2672     English
2673   </a>
2674
2675 </li>
2676
2677       </ul>
2678     </nav>
2679
2680 </li>
2681
2682       </ul>
2683     </nav>
2684
2685 </li>
2686
2687         <li class="md-nav__item">
2688   <a href="#user-group-options" class="md-nav__link">
2689     User Group Options
2690   </a>
2691
2692     <nav class="md-nav" aria-label="User Group Options">
2693       <ul class="md-nav__list">
2694
2695           <li class="md-nav__item">
2696   <a href="#comments" class="md-nav__link">
2697     Comments
2698   </a>
2699
2700     <nav class="md-nav" aria-label="Comments">
2701       <ul class="md-nav__list">
2702
2703           <li class="md-nav__item">
2704   <a href="#german_2" class="md-nav__link">
2705     German
2706   </a>
2707
2708 </li>
2709
2710           <li class="md-nav__item">
2711   <a href="#english_2" class="md-nav__link">
2712     English
2713   </a>
2714
2715 </li>
2716
2717       </ul>
2718     </nav>
2719
2720 </li>
2721
2722       </ul>
2723     </nav>
2724
2725 </li>
2726
2727     </ul>
2728
2729 </nav>
2730                   </div>
2731                 </div>
2732               </div>
2733
2734
2735
2736             <div class="md-content" data-md-component="content">
2737               <article class="md-content__inner md-typeset">
2738
2739
2740
2741
2742
2743
2744
2745 <h1 id="language-naming-conventions">Language Naming Conventions<a class="headerlink" href="#language-naming-conventions" title="Permanent link">#</a></h1>
2746 <p>This page contains general rules for naming language items and for their values.
2747 API-specific rules are listed on the relevant API page:</p>
2748 <ul>
2749 <li><a href="../../php/api/comments/#language-items">Comments</a></li>
2750 </ul>
2751 <h2 id="forms">Forms<a class="headerlink" href="#forms" title="Permanent link">#</a></h2>
2752 <h3 id="fields">Fields<a class="headerlink" href="#fields" title="Permanent link">#</a></h3>
2753 <p>If you have an application <code>foo</code> and a database object <code>foo\data\bar\Bar</code> with a property <code>baz</code> that can be set via a form field, the name of the corresponding language item has to be <code>foo.bar.baz</code>.
2754 If you want to add an additional description below the field, use the language item <code>foo.bar.baz.description</code>.</p>
2755 <h3 id="error-texts">Error Texts<a class="headerlink" href="#error-texts" title="Permanent link">#</a></h3>
2756 <p>If an error of type <code>{error type}</code> for the previously mentioned form field occurs during validation, you have to use the language item <code>foo.bar.baz.error.{error type}</code> for the language item describing the error.</p>
2757 <p>Exception to this rule:
2758 There are several general error messages like <code>wcf.global.form.error.empty</code> that have to be used for general errors like an empty field that may not be empty to avoid duplication of the same error message text over and over again in different language items.</p>
2759 <h4 id="naming-conventions">Naming Conventions<a class="headerlink" href="#naming-conventions" title="Permanent link">#</a></h4>
2760 <ul>
2761 <li>If the entered text does not conform to some special rules, i.e. if the text is invalid, use <code>invalid</code> as error type.</li>
2762 <li>If the entered text is required to be unique but is already used for another object, use <code>notUnique</code> as error type.</li>
2763 </ul>
2764 <h2 id="confirmation-messages">Confirmation messages<a class="headerlink" href="#confirmation-messages" title="Permanent link">#</a></h2>
2765 <p>If the language item for an action is <code>foo.bar.action</code>, the language item for the confirmation message has to be <code>foo.bar.action.confirmMessage</code> instead of <code>foo.bar.action.sure</code> which is still used by some older language items.</p>
2766 <h3 id="type-specific-deletion-confirmation-message">Type-Specific Deletion Confirmation Message<a class="headerlink" href="#type-specific-deletion-confirmation-message" title="Permanent link">#</a></h3>
2767 <h4 id="german">German<a class="headerlink" href="#german" title="Permanent link">#</a></h4>
2768 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>{if LANGUAGE_USE_INFORMAL_VARIANT}Willst du{else}Wollen Sie{/if} {element type} wirklich löschen?
2769 </code></pre></div></td></tr></table></div>
2770 <p>Example:</p>
2771 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>{if LANGUAGE_USE_INFORMAL_VARIANT}Willst du{else}Wollen Sie{/if} das Icon wirklich löschen?
2772 </code></pre></div></td></tr></table></div>
2773 <h4 id="english">English<a class="headerlink" href="#english" title="Permanent link">#</a></h4>
2774 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>Do you really want delete the {element type}?
2775 </code></pre></div></td></tr></table></div>
2776 <p>Example:</p>
2777 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>Do you really want delete the icon?
2778 </code></pre></div></td></tr></table></div>
2779 <h3 id="object-specific-deletion-confirmation-message">Object-Specific Deletion Confirmation Message<a class="headerlink" href="#object-specific-deletion-confirmation-message" title="Permanent link">#</a></h3>
2780 <h4 id="german_1">German<a class="headerlink" href="#german_1" title="Permanent link">#</a></h4>
2781 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>{if LANGUAGE_USE_INFORMAL_VARIANT}Willst du{else}Wollen Sie{/if} {element type} &lt;span class=&quot;confirmationObject&quot;&gt;{object name}&lt;/span&gt; wirklich löschen?
2782 </code></pre></div></td></tr></table></div>
2783 <p>Example:</p>
2784 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>{if LANGUAGE_USE_INFORMAL_VARIANT}Willst du{else}Wollen Sie{/if} den Artikel &lt;span class=&quot;confirmationObject&quot;&gt;{$article-&gt;getTitle()}&lt;/span&gt; wirklich löschen?
2785 </code></pre></div></td></tr></table></div>
2786 <h4 id="english_1">English<a class="headerlink" href="#english_1" title="Permanent link">#</a></h4>
2787 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>Do you really want to delete the {element type} &lt;span class=&quot;confirmationObject&quot;&gt;{object name}&lt;/span&gt;?
2788 </code></pre></div></td></tr></table></div>
2789 <p>Example:</p>
2790 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>Do you really want to delete the article &lt;span class=&quot;confirmationObject&quot;&gt;{$article-&gt;getTitle()}&lt;/span&gt;?
2791 </code></pre></div></td></tr></table></div>
2792 <h2 id="user-group-options">User Group Options<a class="headerlink" href="#user-group-options" title="Permanent link">#</a></h2>
2793 <h3 id="comments">Comments<a class="headerlink" href="#comments" title="Permanent link">#</a></h3>
2794 <h4 id="german_2">German<a class="headerlink" href="#german_2" title="Permanent link">#</a></h4>
2795 <table>
2796 <thead>
2797 <tr>
2798 <th>group type</th>
2799 <th>action</th>
2800 <th>example permission name</th>
2801 <th>language item</th>
2802 </tr>
2803 </thead>
2804 <tbody>
2805 <tr>
2806 <td>user</td>
2807 <td>adding</td>
2808 <td><code>user.foo.canAddComment</code></td>
2809 <td><code>Kann Kommentare erstellen</code></td>
2810 </tr>
2811 <tr>
2812 <td>user</td>
2813 <td>deleting</td>
2814 <td><code>user.foo.canDeleteComment</code></td>
2815 <td><code>Kann eigene Kommentare löschen</code></td>
2816 </tr>
2817 <tr>
2818 <td>user</td>
2819 <td>editing</td>
2820 <td><code>user.foo.canEditComment</code></td>
2821 <td><code>Kann eigene Kommentare bearbeiten</code></td>
2822 </tr>
2823 <tr>
2824 <td>moderator</td>
2825 <td>deleting</td>
2826 <td><code>mod.foo.canDeleteComment</code></td>
2827 <td><code>Kann Kommentare löschen</code></td>
2828 </tr>
2829 <tr>
2830 <td>moderator</td>
2831 <td>editing</td>
2832 <td><code>mod.foo.canEditComment</code></td>
2833 <td><code>Kann Kommentare bearbeiten</code></td>
2834 </tr>
2835 <tr>
2836 <td>moderator</td>
2837 <td>moderating</td>
2838 <td><code>mod.foo.canModerateComment</code></td>
2839 <td><code>Kann Kommentare moderieren</code></td>
2840 </tr>
2841 </tbody>
2842 </table>
2843 <h4 id="english_2">English<a class="headerlink" href="#english_2" title="Permanent link">#</a></h4>
2844 <table>
2845 <thead>
2846 <tr>
2847 <th>group type</th>
2848 <th>action</th>
2849 <th>example permission name</th>
2850 <th>language item</th>
2851 </tr>
2852 </thead>
2853 <tbody>
2854 <tr>
2855 <td>user</td>
2856 <td>adding</td>
2857 <td><code>user.foo.canAddComment</code></td>
2858 <td><code>Can create comments</code></td>
2859 </tr>
2860 <tr>
2861 <td>user</td>
2862 <td>deleting</td>
2863 <td><code>user.foo.canDeleteComment</code></td>
2864 <td><code>Can delete their comments</code></td>
2865 </tr>
2866 <tr>
2867 <td>user</td>
2868 <td>editing</td>
2869 <td><code>user.foo.canEditComment</code></td>
2870 <td><code>Can edit their comments</code></td>
2871 </tr>
2872 <tr>
2873 <td>moderator</td>
2874 <td>deleting</td>
2875 <td><code>mod.foo.canDeleteComment</code></td>
2876 <td><code>Can delete comments</code></td>
2877 </tr>
2878 <tr>
2879 <td>moderator</td>
2880 <td>editing</td>
2881 <td><code>mod.foo.canEditComment</code></td>
2882 <td><code>Can edit comments</code></td>
2883 </tr>
2884 <tr>
2885 <td>moderator</td>
2886 <td>moderating</td>
2887 <td><code>mod.foo.canModerateComment</code></td>
2888 <td><code>Can moderate comments</code></td>
2889 </tr>
2890 </tbody>
2891 </table>
2892
2893   <hr>
2894 <div class="md-source-file">
2895   <small>
2896
2897       Last update:
2898       2021-01-08
2899
2900   </small>
2901 </div>
2902
2903
2904
2905
2906
2907
2908               </article>
2909             </div>
2910
2911
2912         </div>
2913
2914       </main>
2915
2916         <footer class="md-footer">
2917
2918   <div class="md-footer-meta md-typeset">
2919     <div class="md-footer-meta__inner md-grid">
2920       <div class="md-copyright">
2921
2922     <div class="md-copyright__highlight">
2923       Copyright © 2020 WoltLab GmbH
2924     </div>
2925
2926
2927     Made with
2928     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2929       Material for MkDocs
2930     </a>
2931
2932 </div>
2933
2934         <div class="md-copyright">
2935         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2936         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2937 </div>
2938
2939     </div>
2940   </div>
2941 </footer>
2942
2943     </div>
2944     <div class="md-dialog" data-md-component="dialog">
2945       <div class="md-dialog__inner md-typeset"></div>
2946     </div>
2947
2948     <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tracking"], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
2949
2950
2951       <script src="../../assets/javascripts/bundle.51198bba.min.js"></script>
2952
2953
2954   </body>
2955 </html>