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