6.0/getting-started/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/getting-started/">
  12
  13
  14
  15         <link rel="next" href="../php/pages/">
  16
  17       <link rel="icon" href="../assets/default.favicon.ico">
  18       <meta name="generator" content="mkdocs-1.5.1, mkdocs-material-9.1.21">
  19
  20
  21
  22         <title>Getting Started - WoltLab Suite Documentation</title>
  23
  24
  25
  26       <link rel="stylesheet" href="../assets/stylesheets/main.eebd395e.min.css">
  27
  28
  29         <link rel="stylesheet" href="../assets/stylesheets/palette.ecc896b0.min.css">
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39       <link rel="stylesheet" href="../stylesheets/extra.css">
  40
  41     <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>
  42
  43
  44
  45
  46
  47
  48   </head>
  49
  50
  51
  52
  53
  54
  55
  56     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  57
  58
  59
  60     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  61     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  62     <label class="md-overlay" for="__drawer"></label>
  63     <div data-md-component="skip">
  64
  65
  66         <a href="#creating-a-simple-package" class="md-skip">
  67           Skip to content
  68         </a>
  69
  70     </div>
  71     <div data-md-component="announce">
  72
  73         <aside class="md-banner">
  74           <div class="md-banner__inner md-grid md-typeset">
  75
  76
  77     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  78
  79           </div>
  80
  81         </aside>
  82
  83     </div>
  84
  85       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  86
  87       </div>
  88
  89
  90
  91
  92
  93
  94 <header class="md-header md-header--shadow" data-md-component="header">
  95   <nav class="md-header__inner md-grid" aria-label="Header">
  96     <a href=".." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  97
  98   <img src="../assets/logo.png" alt="logo">
  99
 100     </a>
 101     <label class="md-header__button md-icon" for="__drawer">
 102       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 103     </label>
 104     <div class="md-header__title" data-md-component="header-title">
 105       <div class="md-header__ellipsis">
 106         <div class="md-header__topic">
 107           <span class="md-ellipsis">
 108             WoltLab Suite Documentation
 109           </span>
 110         </div>
 111         <div class="md-header__topic" data-md-component="header-topic">
 112           <span class="md-ellipsis">
 113
 114               Getting Started
 115
 116           </span>
 117         </div>
 118       </div>
 119     </div>
 120
 121
 122
 123
 124
 125       <label class="md-header__button md-icon" for="__search">
 126         <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>
 127       </label>
 128       <div class="md-search" data-md-component="search" role="dialog">
 129   <label class="md-search__overlay" for="__search"></label>
 130   <div class="md-search__inner" role="search">
 131     <form class="md-search__form" name="search">
 132       <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>
 133       <label class="md-search__icon md-icon" for="__search">
 134         <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>
 135         <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>
 136       </label>
 137       <nav class="md-search__options" aria-label="Search">
 138
 139         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 140           <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>
 141         </button>
 142       </nav>
 143
 144     </form>
 145     <div class="md-search__output">
 146       <div class="md-search__scrollwrap" data-md-scrollfix>
 147         <div class="md-search-result" data-md-component="search-result">
 148           <div class="md-search-result__meta">
 149             Initializing search
 150           </div>
 151           <ol class="md-search-result__list" role="presentation"></ol>
 152         </div>
 153       </div>
 154     </div>
 155   </div>
 156 </div>
 157
 158
 159       <div class="md-header__source">
 160         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 161   <div class="md-source__icon md-icon">
 162
 163     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 164   </div>
 165   <div class="md-source__repository">
 166     GitHub
 167   </div>
 168 </a>
 169       </div>
 170
 171   </nav>
 172
 173 </header>
 174
 175     <div class="md-container" data-md-component="container">
 176
 177
 178
 179
 180
 181
 182       <main class="md-main" data-md-component="main">
 183         <div class="md-main__inner md-grid">
 184
 185
 186
 187               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 188                 <div class="md-sidebar__scrollwrap">
 189                   <div class="md-sidebar__inner">
 190
 191
 192
 193 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 194   <label class="md-nav__title" for="__drawer">
 195     <a href=".." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 196
 197   <img src="../assets/logo.png" alt="logo">
 198
 199     </a>
 200     WoltLab Suite Documentation
 201   </label>
 202
 203     <div class="md-nav__source">
 204       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 205   <div class="md-source__icon md-icon">
 206
 207     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 208   </div>
 209   <div class="md-source__repository">
 210     GitHub
 211   </div>
 212 </a>
 213     </div>
 214
 215   <ul class="md-nav__list" data-md-scrollfix>
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226     <li class="md-nav__item md-nav__item--active">
 227
 228       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
 229
 230
 231
 232
 233
 234         <label class="md-nav__link md-nav__link--active" for="__toc">
 235           Getting Started
 236           <span class="md-nav__icon md-icon"></span>
 237         </label>
 238
 239       <a href="./" class="md-nav__link md-nav__link--active">
 240         Getting Started
 241       </a>
 242
 243
 244
 245 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 246
 247
 248
 249
 250
 251
 252     <label class="md-nav__title" for="__toc">
 253       <span class="md-nav__icon md-icon"></span>
 254       Table of contents
 255     </label>
 256     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 257
 258         <li class="md-nav__item">
 259   <a href="#setup-and-requirements" class="md-nav__link">
 260     Setup and Requirements
 261   </a>
 262
 263 </li>
 264
 265         <li class="md-nav__item">
 266   <a href="#the-packagexml-file" class="md-nav__link">
 267     The package.xml File
 268   </a>
 269
 270 </li>
 271
 272         <li class="md-nav__item">
 273   <a href="#the-php-class" class="md-nav__link">
 274     The PHP Class
 275   </a>
 276
 277 </li>
 278
 279         <li class="md-nav__item">
 280   <a href="#the-template" class="md-nav__link">
 281     The Template
 282   </a>
 283
 284 </li>
 285
 286         <li class="md-nav__item">
 287   <a href="#the-page-definition" class="md-nav__link">
 288     The Page Definition
 289   </a>
 290
 291 </li>
 292
 293         <li class="md-nav__item">
 294   <a href="#building-the-package" class="md-nav__link">
 295     Building the Package
 296   </a>
 297
 298 </li>
 299
 300         <li class="md-nav__item">
 301   <a href="#installation" class="md-nav__link">
 302     Installation
 303   </a>
 304
 305 </li>
 306
 307         <li class="md-nav__item">
 308   <a href="#developer-tools" class="md-nav__link">
 309     Developer Tools
 310   </a>
 311
 312     <nav class="md-nav" aria-label="Developer Tools">
 313       <ul class="md-nav__list">
 314
 315           <li class="md-nav__item">
 316   <a href="#registering-a-project" class="md-nav__link">
 317     Registering a Project
 318   </a>
 319
 320 </li>
 321
 322           <li class="md-nav__item">
 323   <a href="#synchronizing" class="md-nav__link">
 324     Synchronizing
 325   </a>
 326
 327 </li>
 328
 329       </ul>
 330     </nav>
 331
 332 </li>
 333
 334         <li class="md-nav__item">
 335   <a href="#appendix" class="md-nav__link">
 336     Appendix
 337   </a>
 338
 339     <nav class="md-nav" aria-label="Appendix">
 340       <ul class="md-nav__list">
 341
 342           <li class="md-nav__item">
 343   <a href="#template-guessing" class="md-nav__link">
 344     Template Guessing
 345   </a>
 346
 347 </li>
 348
 349       </ul>
 350     </nav>
 351
 352 </li>
 353
 354     </ul>
 355
 356 </nav>
 357
 358     </li>
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370     <li class="md-nav__item md-nav__item--nested">
 371
 372
 373
 374
 375       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 376
 377
 378
 379         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 380           PHP API
 381           <span class="md-nav__icon md-icon"></span>
 382         </label>
 383
 384       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 385         <label class="md-nav__title" for="__nav_2">
 386           <span class="md-nav__icon md-icon"></span>
 387           PHP API
 388         </label>
 389         <ul class="md-nav__list" data-md-scrollfix>
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../php/pages/" class="md-nav__link">
 398         Pages
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410     <li class="md-nav__item">
 411       <a href="../php/database-objects/" class="md-nav__link">
 412         Database Objects
 413       </a>
 414     </li>
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424     <li class="md-nav__item">
 425       <a href="../php/database-access/" class="md-nav__link">
 426         Database Access
 427       </a>
 428     </li>
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438     <li class="md-nav__item">
 439       <a href="../php/exceptions/" class="md-nav__link">
 440         Exceptions
 441       </a>
 442     </li>
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item md-nav__item--nested">
 454
 455
 456
 457
 458       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 459
 460
 461
 462         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 463           API
 464           <span class="md-nav__icon md-icon"></span>
 465         </label>
 466
 467       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 468         <label class="md-nav__title" for="__nav_2_5">
 469           <span class="md-nav__icon md-icon"></span>
 470           API
 471         </label>
 472         <ul class="md-nav__list" data-md-scrollfix>
 473
 474
 475
 476
 477
 478
 479
 480     <li class="md-nav__item md-nav__item--nested">
 481
 482
 483
 484
 485       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 486
 487
 488
 489         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 490           Caches
 491           <span class="md-nav__icon md-icon"></span>
 492         </label>
 493
 494       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 495         <label class="md-nav__title" for="__nav_2_5_1">
 496           <span class="md-nav__icon md-icon"></span>
 497           Caches
 498         </label>
 499         <ul class="md-nav__list" data-md-scrollfix>
 500
 501
 502
 503
 504
 505
 506     <li class="md-nav__item">
 507       <a href="../php/api/caches/" class="md-nav__link">
 508         Overview
 509       </a>
 510     </li>
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520     <li class="md-nav__item">
 521       <a href="../php/api/caches_persistent-caches/" class="md-nav__link">
 522         Persistent Caches
 523       </a>
 524     </li>
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534     <li class="md-nav__item">
 535       <a href="../php/api/caches_runtime-caches/" class="md-nav__link">
 536         Runtime Caches
 537       </a>
 538     </li>
 539
 540
 541
 542
 543         </ul>
 544       </nav>
 545     </li>
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555     <li class="md-nav__item">
 556       <a href="../php/api/comments/" class="md-nav__link">
 557         Comments
 558       </a>
 559     </li>
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569     <li class="md-nav__item">
 570       <a href="../php/api/cronjobs/" class="md-nav__link">
 571         Cronjobs
 572       </a>
 573     </li>
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583     <li class="md-nav__item">
 584       <a href="../php/api/events/" class="md-nav__link">
 585         Events
 586       </a>
 587     </li>
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598     <li class="md-nav__item md-nav__item--nested">
 599
 600
 601
 602
 603       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 604
 605
 606
 607         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 608           Form Builder
 609           <span class="md-nav__icon md-icon"></span>
 610         </label>
 611
 612       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 613         <label class="md-nav__title" for="__nav_2_5_5">
 614           <span class="md-nav__icon md-icon"></span>
 615           Form Builder
 616         </label>
 617         <ul class="md-nav__list" data-md-scrollfix>
 618
 619
 620
 621
 622
 623
 624     <li class="md-nav__item">
 625       <a href="../php/api/form_builder/overview/" class="md-nav__link">
 626         Overview
 627       </a>
 628     </li>
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638     <li class="md-nav__item">
 639       <a href="../php/api/form_builder/structure/" class="md-nav__link">
 640         Structure
 641       </a>
 642     </li>
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652     <li class="md-nav__item">
 653       <a href="../php/api/form_builder/form_fields/" class="md-nav__link">
 654         Fields
 655       </a>
 656     </li>
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666     <li class="md-nav__item">
 667       <a href="../php/api/form_builder/validation_data/" class="md-nav__link">
 668         Validation and Data
 669       </a>
 670     </li>
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680     <li class="md-nav__item">
 681       <a href="../php/api/form_builder/dependencies/" class="md-nav__link">
 682         Dependencies
 683       </a>
 684     </li>
 685
 686
 687
 688
 689         </ul>
 690       </nav>
 691     </li>
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701     <li class="md-nav__item">
 702       <a href="../php/api/package_installation_plugins/" class="md-nav__link">
 703         Package Installation Plugins
 704       </a>
 705     </li>
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715     <li class="md-nav__item">
 716       <a href="../php/api/user_activity_points/" class="md-nav__link">
 717         User Activity Points
 718       </a>
 719     </li>
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729     <li class="md-nav__item">
 730       <a href="../php/api/user_notifications/" class="md-nav__link">
 731         User Notifications
 732       </a>
 733     </li>
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743     <li class="md-nav__item">
 744       <a href="../php/api/sitemaps/" class="md-nav__link">
 745         Sitemaps
 746       </a>
 747     </li>
 748
 749
 750
 751
 752         </ul>
 753       </nav>
 754     </li>
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764     <li class="md-nav__item">
 765       <a href="../php/code-style/" class="md-nav__link">
 766         Code Style
 767       </a>
 768     </li>
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778     <li class="md-nav__item">
 779       <a href="../php/apps/" class="md-nav__link">
 780         Apps
 781       </a>
 782     </li>
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792     <li class="md-nav__item">
 793       <a href="../php/gdpr/" class="md-nav__link">
 794         GDPR
 795       </a>
 796     </li>
 797
 798
 799
 800
 801         </ul>
 802       </nav>
 803     </li>
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815     <li class="md-nav__item md-nav__item--nested">
 816
 817
 818
 819
 820       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 821
 822
 823
 824         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 825           Languages, Templates & CSS
 826           <span class="md-nav__icon md-icon"></span>
 827         </label>
 828
 829       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 830         <label class="md-nav__title" for="__nav_3">
 831           <span class="md-nav__icon md-icon"></span>
 832           Languages, Templates & CSS
 833         </label>
 834         <ul class="md-nav__list" data-md-scrollfix>
 835
 836
 837
 838
 839
 840
 841     <li class="md-nav__item">
 842       <a href="../view/languages/" class="md-nav__link">
 843         Languages
 844       </a>
 845     </li>
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855     <li class="md-nav__item">
 856       <a href="../view/templates/" class="md-nav__link">
 857         Templates
 858       </a>
 859     </li>
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869     <li class="md-nav__item">
 870       <a href="../view/template-modifiers/" class="md-nav__link">
 871         Template Modifiers
 872       </a>
 873     </li>
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883     <li class="md-nav__item">
 884       <a href="../view/template-plugins/" class="md-nav__link">
 885         Template Plugins
 886       </a>
 887     </li>
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897     <li class="md-nav__item">
 898       <a href="../view/css/" class="md-nav__link">
 899         CSS
 900       </a>
 901     </li>
 902
 903
 904
 905
 906         </ul>
 907       </nav>
 908     </li>
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920     <li class="md-nav__item md-nav__item--nested">
 921
 922
 923
 924
 925       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 926
 927
 928
 929         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 930           TypeScript and JavaScript API
 931           <span class="md-nav__icon md-icon"></span>
 932         </label>
 933
 934       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 935         <label class="md-nav__title" for="__nav_4">
 936           <span class="md-nav__icon md-icon"></span>
 937           TypeScript and JavaScript API
 938         </label>
 939         <ul class="md-nav__list" data-md-scrollfix>
 940
 941
 942
 943
 944
 945
 946     <li class="md-nav__item">
 947       <a href="../javascript/general-usage/" class="md-nav__link">
 948         General Usage
 949       </a>
 950     </li>
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960     <li class="md-nav__item">
 961       <a href="../javascript/typescript/" class="md-nav__link">
 962         TypeScript
 963       </a>
 964     </li>
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975     <li class="md-nav__item md-nav__item--nested">
 976
 977
 978
 979
 980       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 981
 982
 983
 984         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 985           Components
 986           <span class="md-nav__icon md-icon"></span>
 987         </label>
 988
 989       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 990         <label class="md-nav__title" for="__nav_4_3">
 991           <span class="md-nav__icon md-icon"></span>
 992           Components
 993         </label>
 994         <ul class="md-nav__list" data-md-scrollfix>
 995
 996
 997
 998
 999
1000
1001     <li class="md-nav__item">
1002       <a href="../javascript/components_ckeditor5/" class="md-nav__link">
1003         CKEditor 5
1004       </a>
1005     </li>
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015     <li class="md-nav__item">
1016       <a href="../javascript/components_confirmation/" class="md-nav__link">
1017         Confirmation
1018       </a>
1019     </li>
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029     <li class="md-nav__item">
1030       <a href="../javascript/components_dialog/" class="md-nav__link">
1031         Dialog
1032       </a>
1033     </li>
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043     <li class="md-nav__item">
1044       <a href="../javascript/components_google_maps/" class="md-nav__link">
1045         Google Maps
1046       </a>
1047     </li>
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057     <li class="md-nav__item">
1058       <a href="../javascript/components_pagination/" class="md-nav__link">
1059         Pagination
1060       </a>
1061     </li>
1062
1063
1064
1065
1066         </ul>
1067       </nav>
1068     </li>
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079     <li class="md-nav__item md-nav__item--nested">
1080
1081
1082
1083
1084       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
1085
1086
1087
1088         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
1089           New API
1090           <span class="md-nav__icon md-icon"></span>
1091         </label>
1092
1093       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
1094         <label class="md-nav__title" for="__nav_4_4">
1095           <span class="md-nav__icon md-icon"></span>
1096           New API
1097         </label>
1098         <ul class="md-nav__list" data-md-scrollfix>
1099
1100
1101
1102
1103
1104
1105     <li class="md-nav__item">
1106       <a href="../javascript/new-api_writing-a-module/" class="md-nav__link">
1107         Writing a module
1108       </a>
1109     </li>
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119     <li class="md-nav__item">
1120       <a href="../javascript/new-api_core/" class="md-nav__link">
1121         Core Functions
1122       </a>
1123     </li>
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133     <li class="md-nav__item">
1134       <a href="../javascript/new-api_dom/" class="md-nav__link">
1135         DOM
1136       </a>
1137     </li>
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147     <li class="md-nav__item">
1148       <a href="../javascript/new-api_events/" class="md-nav__link">
1149         Event Handling
1150       </a>
1151     </li>
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161     <li class="md-nav__item">
1162       <a href="../javascript/new-api_ajax/" class="md-nav__link">
1163         Ajax
1164       </a>
1165     </li>
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175     <li class="md-nav__item">
1176       <a href="../javascript/new-api_dialogs/" class="md-nav__link">
1177         Dialogs
1178       </a>
1179     </li>
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189     <li class="md-nav__item">
1190       <a href="../javascript/new-api_browser/" class="md-nav__link">
1191         Browser and Screen Sizes
1192       </a>
1193     </li>
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203     <li class="md-nav__item">
1204       <a href="../javascript/new-api_ui/" class="md-nav__link">
1205         User Interface
1206       </a>
1207     </li>
1208
1209
1210
1211
1212         </ul>
1213       </nav>
1214     </li>
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224     <li class="md-nav__item">
1225       <a href="../javascript/legacy-api/" class="md-nav__link">
1226         Legacy API
1227       </a>
1228     </li>
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238     <li class="md-nav__item">
1239       <a href="../javascript/code-snippets/" class="md-nav__link">
1240         Code Snippets
1241       </a>
1242     </li>
1243
1244
1245
1246
1247         </ul>
1248       </nav>
1249     </li>
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261     <li class="md-nav__item md-nav__item--nested">
1262
1263
1264
1265
1266       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1267
1268
1269
1270         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1271           Package Components
1272           <span class="md-nav__icon md-icon"></span>
1273         </label>
1274
1275       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1276         <label class="md-nav__title" for="__nav_5">
1277           <span class="md-nav__icon md-icon"></span>
1278           Package Components
1279         </label>
1280         <ul class="md-nav__list" data-md-scrollfix>
1281
1282
1283
1284
1285
1286
1287     <li class="md-nav__item">
1288       <a href="../package/package-xml/" class="md-nav__link">
1289         package.xml
1290       </a>
1291     </li>
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302     <li class="md-nav__item md-nav__item--nested">
1303
1304
1305
1306
1307       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1308
1309
1310
1311         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1312           PIPs
1313           <span class="md-nav__icon md-icon"></span>
1314         </label>
1315
1316       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1317         <label class="md-nav__title" for="__nav_5_2">
1318           <span class="md-nav__icon md-icon"></span>
1319           PIPs
1320         </label>
1321         <ul class="md-nav__list" data-md-scrollfix>
1322
1323
1324
1325
1326
1327
1328     <li class="md-nav__item">
1329       <a href="../package/pip/" class="md-nav__link">
1330         Overview
1331       </a>
1332     </li>
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342     <li class="md-nav__item">
1343       <a href="../package/pip/acl-option/" class="md-nav__link">
1344         aclOption
1345       </a>
1346     </li>
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356     <li class="md-nav__item">
1357       <a href="../package/pip/acp-menu/" class="md-nav__link">
1358         acpMenu
1359       </a>
1360     </li>
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370     <li class="md-nav__item">
1371       <a href="../package/pip/acp-search-provider/" class="md-nav__link">
1372         acpSearchProvider
1373       </a>
1374     </li>
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384     <li class="md-nav__item">
1385       <a href="../package/pip/acp-template/" class="md-nav__link">
1386         acpTemplate
1387       </a>
1388     </li>
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398     <li class="md-nav__item">
1399       <a href="../package/pip/acp-template-delete/" class="md-nav__link">
1400         acpTemplateDelete
1401       </a>
1402     </li>
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412     <li class="md-nav__item">
1413       <a href="../package/pip/bbcode/" class="md-nav__link">
1414         bbcode
1415       </a>
1416     </li>
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426     <li class="md-nav__item">
1427       <a href="../package/pip/box/" class="md-nav__link">
1428         box
1429       </a>
1430     </li>
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440     <li class="md-nav__item">
1441       <a href="../package/pip/clipboard-action/" class="md-nav__link">
1442         clipboardAction
1443       </a>
1444     </li>
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454     <li class="md-nav__item">
1455       <a href="../package/pip/core-object/" class="md-nav__link">
1456         coreObject
1457       </a>
1458     </li>
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468     <li class="md-nav__item">
1469       <a href="../package/pip/cronjob/" class="md-nav__link">
1470         cronjob
1471       </a>
1472     </li>
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482     <li class="md-nav__item">
1483       <a href="../package/pip/database/" class="md-nav__link">
1484         database
1485       </a>
1486     </li>
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496     <li class="md-nav__item">
1497       <a href="../package/pip/event-listener/" class="md-nav__link">
1498         eventListener
1499       </a>
1500     </li>
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510     <li class="md-nav__item">
1511       <a href="../package/pip/file/" class="md-nav__link">
1512         file
1513       </a>
1514     </li>
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524     <li class="md-nav__item">
1525       <a href="../package/pip/file-delete/" class="md-nav__link">
1526         fileDelete
1527       </a>
1528     </li>
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538     <li class="md-nav__item">
1539       <a href="../package/pip/language/" class="md-nav__link">
1540         language
1541       </a>
1542     </li>
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552     <li class="md-nav__item">
1553       <a href="../package/pip/media-provider/" class="md-nav__link">
1554         mediaProvider
1555       </a>
1556     </li>
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566     <li class="md-nav__item">
1567       <a href="../package/pip/menu/" class="md-nav__link">
1568         menu
1569       </a>
1570     </li>
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580     <li class="md-nav__item">
1581       <a href="../package/pip/menu-item/" class="md-nav__link">
1582         menuItem
1583       </a>
1584     </li>
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594     <li class="md-nav__item">
1595       <a href="../package/pip/object-type/" class="md-nav__link">
1596         objectType
1597       </a>
1598     </li>
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608     <li class="md-nav__item">
1609       <a href="../package/pip/object-type-definition/" class="md-nav__link">
1610         objectTypeDefinition
1611       </a>
1612     </li>
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622     <li class="md-nav__item">
1623       <a href="../package/pip/option/" class="md-nav__link">
1624         option
1625       </a>
1626     </li>
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636     <li class="md-nav__item">
1637       <a href="../package/pip/page/" class="md-nav__link">
1638         page
1639       </a>
1640     </li>
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650     <li class="md-nav__item">
1651       <a href="../package/pip/pip/" class="md-nav__link">
1652         pip
1653       </a>
1654     </li>
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664     <li class="md-nav__item">
1665       <a href="../package/pip/script/" class="md-nav__link">
1666         script
1667       </a>
1668     </li>
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678     <li class="md-nav__item">
1679       <a href="../package/pip/smiley/" class="md-nav__link">
1680         smiley
1681       </a>
1682     </li>
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692     <li class="md-nav__item">
1693       <a href="../package/pip/sql/" class="md-nav__link">
1694         sql
1695       </a>
1696     </li>
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706     <li class="md-nav__item">
1707       <a href="../package/pip/style/" class="md-nav__link">
1708         style
1709       </a>
1710     </li>
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720     <li class="md-nav__item">
1721       <a href="../package/pip/template/" class="md-nav__link">
1722         template
1723       </a>
1724     </li>
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734     <li class="md-nav__item">
1735       <a href="../package/pip/template-delete/" class="md-nav__link">
1736         templateDelete
1737       </a>
1738     </li>
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748     <li class="md-nav__item">
1749       <a href="../package/pip/template-listener/" class="md-nav__link">
1750         templateListener
1751       </a>
1752     </li>
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762     <li class="md-nav__item">
1763       <a href="../package/pip/user-group-option/" class="md-nav__link">
1764         userGroupOption
1765       </a>
1766     </li>
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776     <li class="md-nav__item">
1777       <a href="../package/pip/user-menu/" class="md-nav__link">
1778         userMenu
1779       </a>
1780     </li>
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790     <li class="md-nav__item">
1791       <a href="../package/pip/user-notification-event/" class="md-nav__link">
1792         userNotificationEvent
1793       </a>
1794     </li>
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804     <li class="md-nav__item">
1805       <a href="../package/pip/user-option/" class="md-nav__link">
1806         userOption
1807       </a>
1808     </li>
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818     <li class="md-nav__item">
1819       <a href="../package/pip/user-profile-menu/" class="md-nav__link">
1820         userProfileMenu
1821       </a>
1822     </li>
1823
1824
1825
1826
1827         </ul>
1828       </nav>
1829     </li>
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839     <li class="md-nav__item">
1840       <a href="../package/database-php-api/" class="md-nav__link">
1841         Database PHP API
1842       </a>
1843     </li>
1844
1845
1846
1847
1848         </ul>
1849       </nav>
1850     </li>
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862     <li class="md-nav__item md-nav__item--nested">
1863
1864
1865
1866
1867       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1868
1869
1870
1871         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1872           Migration
1873           <span class="md-nav__icon md-icon"></span>
1874         </label>
1875
1876       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1877         <label class="md-nav__title" for="__nav_6">
1878           <span class="md-nav__icon md-icon"></span>
1879           Migration
1880         </label>
1881         <ul class="md-nav__list" data-md-scrollfix>
1882
1883
1884
1885
1886
1887
1888
1889     <li class="md-nav__item md-nav__item--nested">
1890
1891
1892
1893
1894       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1895
1896
1897
1898         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1899           From WoltLab Suite 5.5
1900           <span class="md-nav__icon md-icon"></span>
1901         </label>
1902
1903       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1904         <label class="md-nav__title" for="__nav_6_1">
1905           <span class="md-nav__icon md-icon"></span>
1906           From WoltLab Suite 5.5
1907         </label>
1908         <ul class="md-nav__list" data-md-scrollfix>
1909
1910
1911
1912
1913
1914
1915     <li class="md-nav__item">
1916       <a href="../migration/wsc55/php/" class="md-nav__link">
1917         PHP API
1918       </a>
1919     </li>
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929     <li class="md-nav__item">
1930       <a href="../migration/wsc55/javascript/" class="md-nav__link">
1931         TypeScript and JavaScript
1932       </a>
1933     </li>
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943     <li class="md-nav__item">
1944       <a href="../migration/wsc55/templates/" class="md-nav__link">
1945         Templates
1946       </a>
1947     </li>
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957     <li class="md-nav__item">
1958       <a href="../migration/wsc55/icons/" class="md-nav__link">
1959         Icons
1960       </a>
1961     </li>
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971     <li class="md-nav__item">
1972       <a href="../migration/wsc55/dialogs/" class="md-nav__link">
1973         Dialogs
1974       </a>
1975     </li>
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985     <li class="md-nav__item">
1986       <a href="../migration/wsc55/libraries/" class="md-nav__link">
1987         Third Party Libraries
1988       </a>
1989     </li>
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999     <li class="md-nav__item">
2000       <a href="../migration/wsc55/deprecations_removals/" class="md-nav__link">
2001         Deprecations and Removals
2002       </a>
2003     </li>
2004
2005
2006
2007
2008         </ul>
2009       </nav>
2010     </li>
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021     <li class="md-nav__item md-nav__item--nested">
2022
2023
2024
2025
2026       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
2027
2028
2029
2030         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
2031           From WoltLab Suite 5.4
2032           <span class="md-nav__icon md-icon"></span>
2033         </label>
2034
2035       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
2036         <label class="md-nav__title" for="__nav_6_2">
2037           <span class="md-nav__icon md-icon"></span>
2038           From WoltLab Suite 5.4
2039         </label>
2040         <ul class="md-nav__list" data-md-scrollfix>
2041
2042
2043
2044
2045
2046
2047     <li class="md-nav__item">
2048       <a href="../migration/wsc54/php/" class="md-nav__link">
2049         PHP API
2050       </a>
2051     </li>
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061     <li class="md-nav__item">
2062       <a href="../migration/wsc54/javascript/" class="md-nav__link">
2063         TypeScript and JavaScript
2064       </a>
2065     </li>
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075     <li class="md-nav__item">
2076       <a href="../migration/wsc54/templates/" class="md-nav__link">
2077         Templates
2078       </a>
2079     </li>
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089     <li class="md-nav__item">
2090       <a href="../migration/wsc54/libraries/" class="md-nav__link">
2091         Third Party Libraries
2092       </a>
2093     </li>
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103     <li class="md-nav__item">
2104       <a href="../migration/wsc54/deprecations_removals/" class="md-nav__link">
2105         Deprecations and Removals
2106       </a>
2107     </li>
2108
2109
2110
2111
2112         </ul>
2113       </nav>
2114     </li>
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125     <li class="md-nav__item md-nav__item--nested">
2126
2127
2128
2129
2130       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2131
2132
2133
2134         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2135           From WoltLab Suite 5.3
2136           <span class="md-nav__icon md-icon"></span>
2137         </label>
2138
2139       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2140         <label class="md-nav__title" for="__nav_6_3">
2141           <span class="md-nav__icon md-icon"></span>
2142           From WoltLab Suite 5.3
2143         </label>
2144         <ul class="md-nav__list" data-md-scrollfix>
2145
2146
2147
2148
2149
2150
2151     <li class="md-nav__item">
2152       <a href="../migration/wsc53/php/" class="md-nav__link">
2153         PHP API
2154       </a>
2155     </li>
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165     <li class="md-nav__item">
2166       <a href="../migration/wsc53/session/" class="md-nav__link">
2167         Session Handling and Authentication
2168       </a>
2169     </li>
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179     <li class="md-nav__item">
2180       <a href="../migration/wsc53/javascript/" class="md-nav__link">
2181         TypeScript and JavaScript
2182       </a>
2183     </li>
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193     <li class="md-nav__item">
2194       <a href="../migration/wsc53/templates/" class="md-nav__link">
2195         Templates
2196       </a>
2197     </li>
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207     <li class="md-nav__item">
2208       <a href="../migration/wsc53/libraries/" class="md-nav__link">
2209         Third Party Libraries
2210       </a>
2211     </li>
2212
2213
2214
2215
2216         </ul>
2217       </nav>
2218     </li>
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229     <li class="md-nav__item md-nav__item--nested">
2230
2231
2232
2233
2234       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2235
2236
2237
2238         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2239           From WoltLab Suite 5.2
2240           <span class="md-nav__icon md-icon"></span>
2241         </label>
2242
2243       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2244         <label class="md-nav__title" for="__nav_6_4">
2245           <span class="md-nav__icon md-icon"></span>
2246           From WoltLab Suite 5.2
2247         </label>
2248         <ul class="md-nav__list" data-md-scrollfix>
2249
2250
2251
2252
2253
2254
2255     <li class="md-nav__item">
2256       <a href="../migration/wsc52/php/" class="md-nav__link">
2257         PHP API
2258       </a>
2259     </li>
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269     <li class="md-nav__item">
2270       <a href="../migration/wsc52/templates/" class="md-nav__link">
2271         Templates and Languages
2272       </a>
2273     </li>
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283     <li class="md-nav__item">
2284       <a href="../migration/wsc52/libraries/" class="md-nav__link">
2285         Third Party Libraries
2286       </a>
2287     </li>
2288
2289
2290
2291
2292         </ul>
2293       </nav>
2294     </li>
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305     <li class="md-nav__item md-nav__item--nested">
2306
2307
2308
2309
2310       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2311
2312
2313
2314         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2315           From WoltLab Suite 3.1
2316           <span class="md-nav__icon md-icon"></span>
2317         </label>
2318
2319       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2320         <label class="md-nav__title" for="__nav_6_5">
2321           <span class="md-nav__icon md-icon"></span>
2322           From WoltLab Suite 3.1
2323         </label>
2324         <ul class="md-nav__list" data-md-scrollfix>
2325
2326
2327
2328
2329
2330
2331     <li class="md-nav__item">
2332       <a href="../migration/wsc31/php/" class="md-nav__link">
2333         PHP API
2334       </a>
2335     </li>
2336
2337
2338
2339
2340         </ul>
2341       </nav>
2342     </li>
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353     <li class="md-nav__item md-nav__item--nested">
2354
2355
2356
2357
2358       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2359
2360
2361
2362         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2363           From WoltLab Suite 3.0
2364           <span class="md-nav__icon md-icon"></span>
2365         </label>
2366
2367       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2368         <label class="md-nav__title" for="__nav_6_6">
2369           <span class="md-nav__icon md-icon"></span>
2370           From WoltLab Suite 3.0
2371         </label>
2372         <ul class="md-nav__list" data-md-scrollfix>
2373
2374
2375
2376
2377
2378
2379     <li class="md-nav__item">
2380       <a href="../migration/wsc30/php/" class="md-nav__link">
2381         PHP API
2382       </a>
2383     </li>
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393     <li class="md-nav__item">
2394       <a href="../migration/wsc30/javascript/" class="md-nav__link">
2395         JavaScript API
2396       </a>
2397     </li>
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407     <li class="md-nav__item">
2408       <a href="../migration/wsc30/templates/" class="md-nav__link">
2409         Templates
2410       </a>
2411     </li>
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421     <li class="md-nav__item">
2422       <a href="../migration/wsc30/css/" class="md-nav__link">
2423         CSS
2424       </a>
2425     </li>
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435     <li class="md-nav__item">
2436       <a href="../migration/wsc30/package/" class="md-nav__link">
2437         Package Components
2438       </a>
2439     </li>
2440
2441
2442
2443
2444         </ul>
2445       </nav>
2446     </li>
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457     <li class="md-nav__item md-nav__item--nested">
2458
2459
2460
2461
2462       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2463
2464
2465
2466         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2467           From WCF 2.1
2468           <span class="md-nav__icon md-icon"></span>
2469         </label>
2470
2471       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2472         <label class="md-nav__title" for="__nav_6_7">
2473           <span class="md-nav__icon md-icon"></span>
2474           From WCF 2.1
2475         </label>
2476         <ul class="md-nav__list" data-md-scrollfix>
2477
2478
2479
2480
2481
2482
2483     <li class="md-nav__item">
2484       <a href="../migration/wcf21/php/" class="md-nav__link">
2485         PHP API
2486       </a>
2487     </li>
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497     <li class="md-nav__item">
2498       <a href="../migration/wcf21/templates/" class="md-nav__link">
2499         Templates
2500       </a>
2501     </li>
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511     <li class="md-nav__item">
2512       <a href="../migration/wcf21/css/" class="md-nav__link">
2513         CSS
2514       </a>
2515     </li>
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525     <li class="md-nav__item">
2526       <a href="../migration/wcf21/package/" class="md-nav__link">
2527         Package Components
2528       </a>
2529     </li>
2530
2531
2532
2533
2534         </ul>
2535       </nav>
2536     </li>
2537
2538
2539
2540
2541         </ul>
2542       </nav>
2543     </li>
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555     <li class="md-nav__item md-nav__item--nested">
2556
2557
2558
2559
2560       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2561
2562
2563
2564         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2565           Tutorials
2566           <span class="md-nav__icon md-icon"></span>
2567         </label>
2568
2569       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2570         <label class="md-nav__title" for="__nav_7">
2571           <span class="md-nav__icon md-icon"></span>
2572           Tutorials
2573         </label>
2574         <ul class="md-nav__list" data-md-scrollfix>
2575
2576
2577
2578
2579
2580
2581
2582     <li class="md-nav__item md-nav__item--nested">
2583
2584
2585
2586
2587       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2588
2589
2590
2591         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2592           Tutorial Series
2593           <span class="md-nav__icon md-icon"></span>
2594         </label>
2595
2596       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2597         <label class="md-nav__title" for="__nav_7_1">
2598           <span class="md-nav__icon md-icon"></span>
2599           Tutorial Series
2600         </label>
2601         <ul class="md-nav__list" data-md-scrollfix>
2602
2603
2604
2605
2606
2607
2608     <li class="md-nav__item">
2609       <a href="../tutorial/series/overview/" class="md-nav__link">
2610         Overview
2611       </a>
2612     </li>
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622     <li class="md-nav__item">
2623       <a href="../tutorial/series/part_1/" class="md-nav__link">
2624         Part 1
2625       </a>
2626     </li>
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636     <li class="md-nav__item">
2637       <a href="../tutorial/series/part_2/" class="md-nav__link">
2638         Part 2
2639       </a>
2640     </li>
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650     <li class="md-nav__item">
2651       <a href="../tutorial/series/part_3/" class="md-nav__link">
2652         Part 3
2653       </a>
2654     </li>
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664     <li class="md-nav__item">
2665       <a href="../tutorial/series/part_4/" class="md-nav__link">
2666         Part 4
2667       </a>
2668     </li>
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678     <li class="md-nav__item">
2679       <a href="../tutorial/series/part_5/" class="md-nav__link">
2680         Part 5
2681       </a>
2682     </li>
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692     <li class="md-nav__item">
2693       <a href="../tutorial/series/part_6/" class="md-nav__link">
2694         Part 6
2695       </a>
2696     </li>
2697
2698
2699
2700
2701         </ul>
2702       </nav>
2703     </li>
2704
2705
2706
2707
2708         </ul>
2709       </nav>
2710     </li>
2711
2712
2713
2714   </ul>
2715 </nav>
2716                   </div>
2717                 </div>
2718               </div>
2719
2720
2721
2722               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2723                 <div class="md-sidebar__scrollwrap">
2724                   <div class="md-sidebar__inner">
2725
2726
2727 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2728
2729
2730
2731
2732
2733
2734     <label class="md-nav__title" for="__toc">
2735       <span class="md-nav__icon md-icon"></span>
2736       Table of contents
2737     </label>
2738     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2739
2740         <li class="md-nav__item">
2741   <a href="#setup-and-requirements" class="md-nav__link">
2742     Setup and Requirements
2743   </a>
2744
2745 </li>
2746
2747         <li class="md-nav__item">
2748   <a href="#the-packagexml-file" class="md-nav__link">
2749     The package.xml File
2750   </a>
2751
2752 </li>
2753
2754         <li class="md-nav__item">
2755   <a href="#the-php-class" class="md-nav__link">
2756     The PHP Class
2757   </a>
2758
2759 </li>
2760
2761         <li class="md-nav__item">
2762   <a href="#the-template" class="md-nav__link">
2763     The Template
2764   </a>
2765
2766 </li>
2767
2768         <li class="md-nav__item">
2769   <a href="#the-page-definition" class="md-nav__link">
2770     The Page Definition
2771   </a>
2772
2773 </li>
2774
2775         <li class="md-nav__item">
2776   <a href="#building-the-package" class="md-nav__link">
2777     Building the Package
2778   </a>
2779
2780 </li>
2781
2782         <li class="md-nav__item">
2783   <a href="#installation" class="md-nav__link">
2784     Installation
2785   </a>
2786
2787 </li>
2788
2789         <li class="md-nav__item">
2790   <a href="#developer-tools" class="md-nav__link">
2791     Developer Tools
2792   </a>
2793
2794     <nav class="md-nav" aria-label="Developer Tools">
2795       <ul class="md-nav__list">
2796
2797           <li class="md-nav__item">
2798   <a href="#registering-a-project" class="md-nav__link">
2799     Registering a Project
2800   </a>
2801
2802 </li>
2803
2804           <li class="md-nav__item">
2805   <a href="#synchronizing" class="md-nav__link">
2806     Synchronizing
2807   </a>
2808
2809 </li>
2810
2811       </ul>
2812     </nav>
2813
2814 </li>
2815
2816         <li class="md-nav__item">
2817   <a href="#appendix" class="md-nav__link">
2818     Appendix
2819   </a>
2820
2821     <nav class="md-nav" aria-label="Appendix">
2822       <ul class="md-nav__list">
2823
2824           <li class="md-nav__item">
2825   <a href="#template-guessing" class="md-nav__link">
2826     Template Guessing
2827   </a>
2828
2829 </li>
2830
2831       </ul>
2832     </nav>
2833
2834 </li>
2835
2836     </ul>
2837
2838 </nav>
2839                   </div>
2840                 </div>
2841               </div>
2842
2843
2844
2845             <div class="md-content" data-md-component="content">
2846               <article class="md-content__inner md-typeset">
2847
2848
2849
2850
2851
2852
2853
2854 <h1 id="creating-a-simple-package">Creating a simple package<a class="headerlink" href="#creating-a-simple-package" title="Permanent link">#</a></h1>
2855 <h2 id="setup-and-requirements">Setup and Requirements<a class="headerlink" href="#setup-and-requirements" title="Permanent link">#</a></h2>
2856 <p>This guide will help you to create a simple package that provides a simple test
2857 page. It is nothing too fancy, but you can use it as the foundation for your
2858 next project.</p>
2859 <p>There are some requirements you should met before starting:</p>
2860 <ul>
2861 <li>Text editor with syntax highlighting for PHP, <a href="https://notepad-plus-plus.org/">Notepad++</a> is a solid pick</li>
2862 <li><code>*.php</code> and <code>*.tpl</code> should be encoded with ANSI/ASCII</li>
2863 <li><code>*.xml</code> are always encoded with UTF-8, but omit the BOM (byte-order-mark)</li>
2864 <li>Use tabs instead of spaces to indent lines</li>
2865 <li>It is recommended to set the tab width to <code>8</code> spaces, this is used in the entire software and will ease reading the source files</li>
2866 <li>An active installation of WoltLab Suite</li>
2867 <li>An application to create <code>*.tar</code> archives, e.g. <a href="http://www.7-zip.org/">7-Zip</a> on Windows</li>
2868 </ul>
2869 <h2 id="the-packagexml-file">The package.xml File<a class="headerlink" href="#the-packagexml-file" title="Permanent link">#</a></h2>
2870 <p>We want to create a simple page that will display the sentence "Hello World" embedded
2871 into the application frame. Create an empty directory in the workspace of your choice
2872 to start with.</p>
2873 <p>Create a new file called <code>package.xml</code> and insert the code below:</p>
2874 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2875 <span class="normal"> 2</span>
2876 <span class="normal"> 3</span>
2877 <span class="normal"> 4</span>
2878 <span class="normal"> 5</span>
2879 <span class="normal"> 6</span>
2880 <span class="normal"> 7</span>
2881 <span class="normal"> 8</span>
2882 <span class="normal"> 9</span>
2883 <span class="normal">10</span>
2884 <span class="normal">11</span>
2885 <span class="normal">12</span>
2886 <span class="normal">13</span>
2887 <span class="normal">14</span>
2888 <span class="normal">15</span>
2889 <span class="normal">16</span>
2890 <span class="normal">17</span>
2891 <span class="normal">18</span>
2892 <span class="normal">19</span>
2893 <span class="normal">20</span>
2894 <span class="normal">21</span>
2895 <span class="normal">22</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2896 <span class="nt">&lt;package</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/package.xsd&quot;</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;com.example.test&quot;</span><span class="nt">&gt;</span>
2897 <span class="w">    </span><span class="nt">&lt;packageinformation&gt;</span>
2898 <span class="w">        </span><span class="cm">&lt;!-- com.example.test --&gt;</span>
2899 <span class="w">        </span><span class="nt">&lt;packagename&gt;</span>Simple<span class="w"> </span>Package<span class="nt">&lt;/packagename&gt;</span>
2900 <span class="w">        </span><span class="nt">&lt;packagedescription&gt;</span>A<span class="w"> </span>simple<span class="w"> </span>package<span class="w"> </span>to<span class="w"> </span>demonstrate<span class="w"> </span>the<span class="w"> </span>package<span class="w"> </span>system<span class="w"> </span>of<span class="w"> </span>WoltLab<span class="w"> </span>Suite<span class="w"> </span>Core<span class="nt">&lt;/packagedescription&gt;</span>
2901 <span class="w">        </span><span class="nt">&lt;version&gt;</span>1.0.0<span class="nt">&lt;/version&gt;</span>
2902 <span class="w">        </span><span class="nt">&lt;date&gt;</span>2019-04-28<span class="nt">&lt;/date&gt;</span>
2903 <span class="w">    </span><span class="nt">&lt;/packageinformation&gt;</span>
2904 <span class="w">    </span><span class="nt">&lt;authorinformation&gt;</span>
2905 <span class="w">        </span><span class="nt">&lt;author&gt;</span>Your<span class="w"> </span>Name<span class="nt">&lt;/author&gt;</span>
2906 <span class="w">        </span><span class="nt">&lt;authorurl&gt;</span>http://www.example.com<span class="nt">&lt;/authorurl&gt;</span>
2907 <span class="w">    </span><span class="nt">&lt;/authorinformation&gt;</span>
2908 <span class="w">    </span><span class="nt">&lt;excludedpackages&gt;</span>
2909 <span class="w">        </span><span class="nt">&lt;excludedpackage</span><span class="w"> </span><span class="na">version=</span><span class="s">&quot;6.0.0 Alpha 1&quot;</span><span class="nt">&gt;</span>com.woltlab.wcf<span class="nt">&lt;/excludedpackage&gt;</span>
2910 <span class="w">    </span><span class="nt">&lt;/excludedpackages&gt;</span>
2911 <span class="w">    </span><span class="nt">&lt;instructions</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;install&quot;</span><span class="nt">&gt;</span>
2912 <span class="w">        </span><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;file&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
2913 <span class="w">        </span><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;template&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
2914 <span class="w">        </span><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;page&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
2915 <span class="w">    </span><span class="nt">&lt;/instructions&gt;</span>
2916 <span class="nt">&lt;/package&gt;</span>
2917 </code></pre></div></td></tr></table></div>
2918 <p>There is an <a href="../package/package-xml/">entire chapter</a> on the package system that explains what the code above
2919 does and how you can adjust it to fit your needs. For now we'll keep it as it is.</p>
2920 <h2 id="the-php-class">The PHP Class<a class="headerlink" href="#the-php-class" title="Permanent link">#</a></h2>
2921 <p>The next step is to create the PHP class which will serve our page:</p>
2922 <ol>
2923 <li>Create the directory <code>files</code> in the same directory where <code>package.xml</code> is located</li>
2924 <li>Open <code>files</code> and create the directory <code>lib</code></li>
2925 <li>Open <code>lib</code> and create the directory <code>page</code></li>
2926 <li>Within the directory <code>page</code>, please create the file <code>TestPage.class.php</code></li>
2927 </ol>
2928 <p>Copy and paste the following code into the <code>TestPage.class.php</code>:</p>
2929 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2930 <span class="normal"> 2</span>
2931 <span class="normal"> 3</span>
2932 <span class="normal"> 4</span>
2933 <span class="normal"> 5</span>
2934 <span class="normal"> 6</span>
2935 <span class="normal"> 7</span>
2936 <span class="normal"> 8</span>
2937 <span class="normal"> 9</span>
2938 <span class="normal">10</span>
2939 <span class="normal">11</span>
2940 <span class="normal">12</span>
2941 <span class="normal">13</span>
2942 <span class="normal">14</span>
2943 <span class="normal">15</span>
2944 <span class="normal">16</span>
2945 <span class="normal">17</span>
2946 <span class="normal">18</span>
2947 <span class="normal">19</span>
2948 <span class="normal">20</span>
2949 <span class="normal">21</span>
2950 <span class="normal">22</span>
2951 <span class="normal">23</span>
2952 <span class="normal">24</span>
2953 <span class="normal">25</span>
2954 <span class="normal">26</span>
2955 <span class="normal">27</span>
2956 <span class="normal">28</span>
2957 <span class="normal">29</span>
2958 <span class="normal">30</span>
2959 <span class="normal">31</span>
2960 <span class="normal">32</span>
2961 <span class="normal">33</span>
2962 <span class="normal">34</span>
2963 <span class="normal">35</span>
2964 <span class="normal">36</span>
2965 <span class="normal">37</span>
2966 <span class="normal">38</span>
2967 <span class="normal">39</span>
2968 <span class="normal">40</span>
2969 <span class="normal">41</span>
2970 <span class="normal">42</span>
2971 <span class="normal">43</span>
2972 <span class="normal">44</span>
2973 <span class="normal">45</span>
2974 <span class="normal">46</span>
2975 <span class="normal">47</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2976 <span class="k">namespace</span> <span class="nx">wcf\page</span><span class="p">;</span>
2977 <span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span>
2978
2979 <span class="sd">/**</span>
2980 <span class="sd"> * A simple test page for demonstration purposes.</span>
2981 <span class="sd"> *</span>
2982 <span class="sd"> * @author  YOUR NAME</span>
2983 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2984 <span class="sd"> */</span>
2985 <span class="k">class</span> <span class="nc">TestPage</span> <span class="k">extends</span> <span class="nx">AbstractPage</span> <span class="p">{</span>
2986     <span class="sd">/**</span>
2987 <span class="sd">     * @var string</span>
2988 <span class="sd">     */</span>
2989     <span class="k">protected</span> <span class="nv">$greet</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
2990
2991     <span class="sd">/**</span>
2992 <span class="sd">     * @inheritDoc</span>
2993 <span class="sd">     */</span>
2994     <span class="k">public</span> <span class="k">function</span> <span class="nf">readParameters</span><span class="p">()</span> <span class="p">{</span>
2995         <span class="k">parent</span><span class="o">::</span><span class="na">readParameters</span><span class="p">();</span>
2996
2997         <span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$_GET</span><span class="p">[</span><span class="s1">&#39;greet&#39;</span><span class="p">]))</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">greet</span> <span class="o">=</span> <span class="nv">$_GET</span><span class="p">[</span><span class="s1">&#39;greet&#39;</span><span class="p">];</span>
2998     <span class="p">}</span>
2999
3000     <span class="sd">/**</span>
3001 <span class="sd">     * @inheritDoc</span>
3002 <span class="sd">     */</span>
3003     <span class="k">public</span> <span class="k">function</span> <span class="nf">readData</span><span class="p">()</span> <span class="p">{</span>
3004         <span class="k">parent</span><span class="o">::</span><span class="na">readData</span><span class="p">();</span>
3005
3006         <span class="k">if</span> <span class="p">(</span><span class="k">empty</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">greet</span><span class="p">))</span> <span class="p">{</span>
3007             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">greet</span> <span class="o">=</span> <span class="s1">&#39;World&#39;</span><span class="p">;</span>
3008         <span class="p">}</span>
3009     <span class="p">}</span>
3010
3011     <span class="sd">/**</span>
3012 <span class="sd">     * @inheritDoc</span>
3013 <span class="sd">     */</span>
3014     <span class="k">public</span> <span class="k">function</span> <span class="nf">assignVariables</span><span class="p">()</span> <span class="p">{</span>
3015         <span class="k">parent</span><span class="o">::</span><span class="na">assignVariables</span><span class="p">();</span>
3016
3017         <span class="nx">WCF</span><span class="o">::</span><span class="na">getTPL</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">assign</span><span class="p">([</span>
3018             <span class="s1">&#39;greet&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">greet</span>
3019         <span class="p">]);</span>
3020     <span class="p">}</span>
3021 <span class="p">}</span>
3022 </code></pre></div></td></tr></table></div>
3023 <p>The class inherits from <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/page/AbstractPage.class.php">wcf\page\AbstractPage</a>, the default implementation of pages without form controls. It
3024 defines quite a few methods that will be automatically invoked in a specific order, for example <code>readParameters()</code> before <code>readData()</code> and finally <code>assignVariables()</code> to pass arbitrary values to the template.</p>
3025 <p>The property <code>$greet</code> is defined as <code>World</code>, but can optionally be populated through a GET variable (<code>index.php?test/&amp;greet=You</code> would output <code>Hello You!</code>). This extra code illustrates the separation of data
3026 processing that takes place within all sort of pages, where all user-supplied data is read from within a single method. It helps organizing the code, but most of all it enforces a clean class logic that does not
3027 start reading user input at random places, including the risk to only escape the input of variable <code>$_GET['foo']</code> 4 out of 5 times.</p>
3028 <p>Reading and processing the data is only half the story, now we need a template to display the actual content for our page. You don't need to specify it yourself, it will be automatically guessed based on your
3029 namespace and class name, you can <a href="#template-guessing">read more about it later</a>.</p>
3030 <p>Last but not least, you must not include the closing PHP tag <code>?&gt;</code> at the end, it can cause PHP to break on whitespaces and is not required at all.</p>
3031 <h2 id="the-template">The Template<a class="headerlink" href="#the-template" title="Permanent link">#</a></h2>
3032 <p>Navigate back to the root directory of your package until you see both the <code>files</code> directory and the <code>package.xml</code>. Now create a directory called <code>templates</code>, open it and create the file <code>test.tpl</code>.</p>
3033 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3034 <span class="normal">2</span>
3035 <span class="normal">3</span>
3036 <span class="normal">4</span>
3037 <span class="normal">5</span>
3038 <span class="normal">6</span>
3039 <span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;header&#39;</span><span class="cp">}</span>
3040
3041 <span class="x">&lt;div class=&quot;section&quot;&gt;</span>
3042 <span class="x">    Hello </span><span class="cp">{</span><span class="nv">$greet</span><span class="cp">}</span><span class="x">!</span>
3043 <span class="x">&lt;/div&gt;</span>
3044
3045 <span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;footer&#39;</span><span class="cp">}</span>
3046 </code></pre></div></td></tr></table></div>
3047 <p>Templates are a mixture of HTML and Smarty-like template scripting to overcome the static nature of raw HTML. The above code will display the phrase <code>Hello World!</code> in the application frame, just as any other
3048 page would render. The included templates <code>header</code> and <code>footer</code> are responsible for the majority of the overall page functionality, but offer a whole lot of customization abilities to influence their behavior and appearance.</p>
3049 <h2 id="the-page-definition">The Page Definition<a class="headerlink" href="#the-page-definition" title="Permanent link">#</a></h2>
3050 <p>The package now contains the PHP class and the matching template, but it is still missing the page definition. Please create the file <code>page.xml</code> in your project's root directory, thus on the same level as the <code>package.xml</code>.</p>
3051 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3052 <span class="normal"> 2</span>
3053 <span class="normal"> 3</span>
3054 <span class="normal"> 4</span>
3055 <span class="normal"> 5</span>
3056 <span class="normal"> 6</span>
3057 <span class="normal"> 7</span>
3058 <span class="normal"> 8</span>
3059 <span class="normal"> 9</span>
3060 <span class="normal">10</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
3061 <span class="nt">&lt;data</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/page.xsd&quot;</span><span class="nt">&gt;</span>
3062 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
3063 <span class="w">        </span><span class="nt">&lt;page</span><span class="w"> </span><span class="na">identifier=</span><span class="s">&quot;com.example.test.Test&quot;</span><span class="nt">&gt;</span>
3064 <span class="w">            </span><span class="nt">&lt;controller&gt;</span>wcf\page\TestPage<span class="nt">&lt;/controller&gt;</span>
3065 <span class="w">            </span><span class="nt">&lt;name</span><span class="w"> </span><span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>Test<span class="w"> </span>Page<span class="nt">&lt;/name&gt;</span>
3066 <span class="w">            </span><span class="nt">&lt;pageType&gt;</span>system<span class="nt">&lt;/pageType&gt;</span>
3067 <span class="w">        </span><span class="nt">&lt;/page&gt;</span>
3068 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
3069 <span class="nt">&lt;/data&gt;</span>
3070 </code></pre></div></td></tr></table></div>
3071 <p>You can provide a lot more data for a page, including logical nesting and dedicated handler classes for display in menus.</p>
3072 <h2 id="building-the-package">Building the Package<a class="headerlink" href="#building-the-package" title="Permanent link">#</a></h2>
3073 <p>If you have followed the above guidelines carefully, your package directory should now look like this:</p>
3074 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3075 <span class="normal">2</span>
3076 <span class="normal">3</span>
3077 <span class="normal">4</span>
3078 <span class="normal">5</span>
3079 <span class="normal">6</span>
3080 <span class="normal">7</span>
3081 <span class="normal">8</span></pre></div></td><td class="code"><div><pre><span></span><code>├── files
3082 │   └── lib
3083 │       └── page
3084 │           └── TestPage.class.php
3085 ├── package.xml
3086 ├── page.xml
3087 └── templates
3088     └── test.tpl
3089 </code></pre></div></td></tr></table></div>
3090 <p>Both files and templates are archive-based package components, that deploy their payload using tar archives rather than adding the raw files to the package file. Please create the archive <code>files.tar</code> and add the contents of the <code>files/*</code> directory, but not the directory <code>files/</code> itself. Repeat the same process for the <code>templates</code> directory, but this time with the file name <code>templates.tar</code>. Place both files in the root of your project.</p>
3091 <p>Last but not least, create the package archive <code>com.example.test.tar</code> and add all the files listed below.</p>
3092 <ul>
3093 <li><code>files.tar</code></li>
3094 <li><code>package.xml</code></li>
3095 <li><code>page.xml</code></li>
3096 <li><code>templates.tar</code></li>
3097 </ul>
3098 <p>The archive's filename can be anything you want, all though it is the general convention to use the package name itself for easier recognition.</p>
3099 <h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">#</a></h2>
3100 <p>Open the Administration Control Panel and navigate to <code>Configuration &gt; Packages &gt; Install Package</code>, click on <code>Upload Package</code> and select the file <code>com.example.test.tar</code> from your disk. Follow the on-screen instructions until it has been successfully installed.</p>
3101 <p>Open a new browser tab and navigate to your newly created page. If WoltLab Suite is installed at <code>https://example.com/wsc/</code>, then the URL should read <code>https://example.com/wsc/index.php?test/</code>.</p>
3102 <p>Congratulations, you have just created your first package!</p>
3103 <h2 id="developer-tools">Developer Tools<a class="headerlink" href="#developer-tools" title="Permanent link">#</a></h2>
3104 <p>The developer tools provide an interface to synchronize the data of an installed package with a bare repository on the local disk. You can re-import most PIPs at any time and have the changes applied without crafting a manual update. This process simulates a regular package update with a single PIP only, and resets the cache after the import has been completed.</p>
3105 <h3 id="registering-a-project">Registering a Project<a class="headerlink" href="#registering-a-project" title="Permanent link">#</a></h3>
3106 <p>Projects require the absolute path to the package directory, that is, the directory where it can find the <code>package.xml</code>. It is not required to install an package to register it as a project, but you have to install it in order to work with it. It does not install the package by itself!</p>
3107 <p>There is a special button on the project list that allows for a mass-import of projects based on a search path. Each direct child directory of the provided path will be tested and projects created this way will use the identifier extracted from the <code>package.xml</code>.</p>
3108 <h3 id="synchronizing">Synchronizing<a class="headerlink" href="#synchronizing" title="Permanent link">#</a></h3>
3109 <p>The install instructions in the <code>package.xml</code> are ignored when offering the PIP imports, the detection works entirely based on the default filename for each PIP. On top of that, only PIPs that implement the interface <code>wcf\system\devtools\pip\IIdempotentPackageInstallationPlugin</code> are valid for import, as it indicates that importing the PIP multiple times will have no side-effects and that the result is deterministic regardless of the number of times it has been imported.</p>
3110 <p>Some built-in PIPs, such as <code>sql</code> or <code>script</code>, do not qualify for this step and remain unavailable at all times. However, you can still craft and perform an actual package update to have these PIPs executed.</p>
3111 <h2 id="appendix">Appendix<a class="headerlink" href="#appendix" title="Permanent link">#</a></h2>
3112 <h3 id="template-guessing">Template Guessing<a class="headerlink" href="#template-guessing" title="Permanent link">#</a></h3>
3113 <p>The class name including the namespace is used to automatically determine the path to the template and its name. The example above used the page class name <code>wcf\page\TestPage</code> that is then split into four distinct parts:</p>
3114 <ol>
3115 <li><code>wcf</code>, the internal abbreviation of WoltLab Suite Core (previously known as WoltLab Community Framework)</li>
3116 <li><code>\page\</code> (ignored)</li>
3117 <li><code>Test</code>, the actual name that is used for both the template and the URL</li>
3118 <li><code>Page</code> (page type, ignored)</li>
3119 </ol>
3120 <p>The fragments <code>1.</code> and <code>3.</code> from above are used to construct the path to the template: <code>&lt;installDirOfWSC&gt;/templates/test.tpl</code> (the first letter of <code>Test</code> is being converted to lower-case).</p>
3121
3122   <hr>
3123 <div class="md-source-file">
3124   <small>
3125
3126       Last update:
3127       2022-02-23
3128
3129   </small>
3130 </div>
3131
3132
3133
3134
3135
3136
3137               </article>
3138             </div>
3139
3140
3141         </div>
3142
3143       </main>
3144
3145         <footer class="md-footer">
3146
3147   <div class="md-footer-meta md-typeset">
3148     <div class="md-footer-meta__inner md-grid">
3149       <div class="md-copyright">
3150
3151     <div class="md-copyright__highlight">
3152       Copyright © 2020 WoltLab GmbH
3153     </div>
3154
3155
3156     Made with
3157     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3158       Material for MkDocs
3159     </a>
3160
3161 </div>
3162
3163         <div class="md-copyright">
3164         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
3165         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
3166 </div>
3167
3168     </div>
3169   </div>
3170 </footer>
3171
3172     </div>
3173     <div class="md-dialog" data-md-component="dialog">
3174       <div class="md-dialog__inner md-typeset"></div>
3175     </div>
3176
3177     <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tracking"], "search": "../assets/javascripts/workers/search.74e28a9f.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>
3178
3179
3180       <script src="../assets/javascripts/bundle.220ee61c.min.js"></script>
3181
3182
3183   </body>
3184 </html>