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