5.4/package/pip/bbcode/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11
  12       <link rel="icon" href="../../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0">
  14
  15
  16
  17         <title>bbcode - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../assets/stylesheets/main.33e2939f.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  39
  40
  41
  42
  43
  44   </head>
  45
  46
  47
  48
  49
  50
  51
  52     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  53
  54
  55     <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  56
  57     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  58     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  59     <label class="md-overlay" for="__drawer"></label>
  60     <div data-md-component="skip">
  61
  62
  63         <a href="#bbcode-package-installation-plugin" class="md-skip">
  64           Skip to content
  65         </a>
  66
  67     </div>
  68     <div data-md-component="announce">
  69
  70         <aside class="md-announce">
  71           <div class="md-announce__inner md-grid md-typeset">
  72
  73     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  74
  75           </div>
  76         </aside>
  77
  78     </div>
  79
  80       <header class="md-header" data-md-component="header">
  81   <nav class="md-header__inner md-grid" aria-label="Header">
  82     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  83
  84   <img src="../../../assets/logo.png" alt="logo">
  85
  86     </a>
  87     <label class="md-header__button md-icon" for="__drawer">
  88       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  89     </label>
  90     <div class="md-header__title" data-md-component="header-title">
  91       <div class="md-header__ellipsis">
  92         <div class="md-header__topic">
  93           <span class="md-ellipsis">
  94             WoltLab Suite Documentation
  95           </span>
  96         </div>
  97         <div class="md-header__topic" data-md-component="header-topic">
  98           <span class="md-ellipsis">
  99
 100               bbcode
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106
 107
 108
 109       <label class="md-header__button md-icon" for="__search">
 110         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 111       </label>
 112
 113 <div class="md-search" data-md-component="search" role="dialog">
 114   <label class="md-search__overlay" for="__search"></label>
 115   <div class="md-search__inner" role="search">
 116     <form class="md-search__form" name="search">
 117       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
 118       <label class="md-search__icon md-icon" for="__search">
 119         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 120         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
 121       </label>
 122       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 123         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
 124       </button>
 125     </form>
 126     <div class="md-search__output">
 127       <div class="md-search__scrollwrap" data-md-scrollfix>
 128         <div class="md-search-result" data-md-component="search-result">
 129           <div class="md-search-result__meta">
 130             Initializing search
 131           </div>
 132           <ol class="md-search-result__list"></ol>
 133         </div>
 134       </div>
 135     </div>
 136   </div>
 137 </div>
 138
 139
 140       <div class="md-header__source">
 141
 142 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 143   <div class="md-source__icon md-icon">
 144
 145     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 146   </div>
 147   <div class="md-source__repository">
 148     GitHub
 149   </div>
 150 </a>
 151       </div>
 152
 153   </nav>
 154 </header>
 155
 156     <div class="md-container" data-md-component="container">
 157
 158
 159
 160
 161       <main class="md-main" data-md-component="main">
 162         <div class="md-main__inner md-grid">
 163
 164
 165
 166               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 167                 <div class="md-sidebar__scrollwrap">
 168                   <div class="md-sidebar__inner">
 169
 170
 171
 172 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 173   <label class="md-nav__title" for="__drawer">
 174     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 175
 176   <img src="../../../assets/logo.png" alt="logo">
 177
 178     </a>
 179     WoltLab Suite Documentation
 180   </label>
 181
 182     <div class="md-nav__source">
 183
 184 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 185   <div class="md-source__icon md-icon">
 186
 187     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 188   </div>
 189   <div class="md-source__repository">
 190     GitHub
 191   </div>
 192 </a>
 193     </div>
 194
 195   <ul class="md-nav__list" data-md-scrollfix>
 196
 197
 198
 199
 200
 201
 202
 203
 204     <li class="md-nav__item">
 205       <a href="../../../getting-started/" class="md-nav__link">
 206         Getting Started
 207       </a>
 208     </li>
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220     <li class="md-nav__item md-nav__item--nested">
 221
 222
 223         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 224
 225       <label class="md-nav__link" for="__nav_2">
 226         PHP API
 227         <span class="md-nav__icon md-icon"></span>
 228       </label>
 229       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 230         <label class="md-nav__title" for="__nav_2">
 231           <span class="md-nav__icon md-icon"></span>
 232           PHP API
 233         </label>
 234         <ul class="md-nav__list" data-md-scrollfix>
 235
 236
 237
 238
 239
 240     <li class="md-nav__item">
 241       <a href="../../../php/pages/" class="md-nav__link">
 242         Pages
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252     <li class="md-nav__item">
 253       <a href="../../../php/database-objects/" class="md-nav__link">
 254         Database Objects
 255       </a>
 256     </li>
 257
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../../php/database-access/" class="md-nav__link">
 266         Database Access
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276     <li class="md-nav__item">
 277       <a href="../../../php/exceptions/" class="md-nav__link">
 278         Exceptions
 279       </a>
 280     </li>
 281
 282
 283
 284
 285
 286
 287
 288
 289     <li class="md-nav__item md-nav__item--nested">
 290
 291
 292         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 293
 294       <label class="md-nav__link" for="__nav_2_5">
 295         API
 296         <span class="md-nav__icon md-icon"></span>
 297       </label>
 298       <nav class="md-nav" aria-label="API" data-md-level="2">
 299         <label class="md-nav__title" for="__nav_2_5">
 300           <span class="md-nav__icon md-icon"></span>
 301           API
 302         </label>
 303         <ul class="md-nav__list" data-md-scrollfix>
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item md-nav__item--nested">
 311
 312
 313         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 314
 315       <label class="md-nav__link" for="__nav_2_5_1">
 316         Caches
 317         <span class="md-nav__icon md-icon"></span>
 318       </label>
 319       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 320         <label class="md-nav__title" for="__nav_2_5_1">
 321           <span class="md-nav__icon md-icon"></span>
 322           Caches
 323         </label>
 324         <ul class="md-nav__list" data-md-scrollfix>
 325
 326
 327
 328
 329
 330     <li class="md-nav__item">
 331       <a href="../../../php/api/caches/" class="md-nav__link">
 332         Overview
 333       </a>
 334     </li>
 335
 336
 337
 338
 339
 340
 341
 342     <li class="md-nav__item">
 343       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 344         Persistent Caches
 345       </a>
 346     </li>
 347
 348
 349
 350
 351
 352
 353
 354     <li class="md-nav__item">
 355       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 356         Runtime Caches
 357       </a>
 358     </li>
 359
 360
 361
 362         </ul>
 363       </nav>
 364     </li>
 365
 366
 367
 368
 369
 370
 371
 372     <li class="md-nav__item">
 373       <a href="../../../php/api/comments/" class="md-nav__link">
 374         Comments
 375       </a>
 376     </li>
 377
 378
 379
 380
 381
 382
 383
 384     <li class="md-nav__item">
 385       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 386         Cronjobs
 387       </a>
 388     </li>
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../../php/api/events/" class="md-nav__link">
 398         Events
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409     <li class="md-nav__item md-nav__item--nested">
 410
 411
 412         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 413
 414       <label class="md-nav__link" for="__nav_2_5_5">
 415         Form Builder
 416         <span class="md-nav__icon md-icon"></span>
 417       </label>
 418       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 419         <label class="md-nav__title" for="__nav_2_5_5">
 420           <span class="md-nav__icon md-icon"></span>
 421           Form Builder
 422         </label>
 423         <ul class="md-nav__list" data-md-scrollfix>
 424
 425
 426
 427
 428
 429     <li class="md-nav__item">
 430       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 431         Overview
 432       </a>
 433     </li>
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 443         Structure
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item">
 454       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 455         Fields
 456       </a>
 457     </li>
 458
 459
 460
 461
 462
 463
 464
 465     <li class="md-nav__item">
 466       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 467         Validation and Data
 468       </a>
 469     </li>
 470
 471
 472
 473
 474
 475
 476
 477     <li class="md-nav__item">
 478       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 479         Dependencies
 480       </a>
 481     </li>
 482
 483
 484
 485         </ul>
 486       </nav>
 487     </li>
 488
 489
 490
 491
 492
 493
 494
 495     <li class="md-nav__item">
 496       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 497         Package Installation Plugins
 498       </a>
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507     <li class="md-nav__item">
 508       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 509         User Activity Points
 510       </a>
 511     </li>
 512
 513
 514
 515
 516
 517
 518
 519     <li class="md-nav__item">
 520       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 521         User Notifications
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531     <li class="md-nav__item">
 532       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 533         Sitemaps
 534       </a>
 535     </li>
 536
 537
 538
 539         </ul>
 540       </nav>
 541     </li>
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../../php/code-style/" class="md-nav__link">
 551         Code Style
 552       </a>
 553     </li>
 554
 555
 556
 557
 558
 559
 560
 561     <li class="md-nav__item">
 562       <a href="../../../php/apps/" class="md-nav__link">
 563         Apps
 564       </a>
 565     </li>
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/gdpr/" class="md-nav__link">
 575         GDPR
 576       </a>
 577     </li>
 578
 579
 580
 581         </ul>
 582       </nav>
 583     </li>
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595     <li class="md-nav__item md-nav__item--nested">
 596
 597
 598         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 599
 600       <label class="md-nav__link" for="__nav_3">
 601         Languages, Templates & CSS
 602         <span class="md-nav__icon md-icon"></span>
 603       </label>
 604       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 605         <label class="md-nav__title" for="__nav_3">
 606           <span class="md-nav__icon md-icon"></span>
 607           Languages, Templates & CSS
 608         </label>
 609         <ul class="md-nav__list" data-md-scrollfix>
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../view/languages/" class="md-nav__link">
 617         Languages
 618       </a>
 619     </li>
 620
 621
 622
 623
 624
 625
 626
 627     <li class="md-nav__item">
 628       <a href="../../../view/templates/" class="md-nav__link">
 629         Templates
 630       </a>
 631     </li>
 632
 633
 634
 635
 636
 637
 638
 639     <li class="md-nav__item">
 640       <a href="../../../view/template-plugins/" class="md-nav__link">
 641         Template Plugins
 642       </a>
 643     </li>
 644
 645
 646
 647
 648
 649
 650
 651     <li class="md-nav__item">
 652       <a href="../../../view/css/" class="md-nav__link">
 653         CSS
 654       </a>
 655     </li>
 656
 657
 658
 659         </ul>
 660       </nav>
 661     </li>
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673     <li class="md-nav__item md-nav__item--nested">
 674
 675
 676         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 677
 678       <label class="md-nav__link" for="__nav_4">
 679         TypeScript and JavaScript API
 680         <span class="md-nav__icon md-icon"></span>
 681       </label>
 682       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 683         <label class="md-nav__title" for="__nav_4">
 684           <span class="md-nav__icon md-icon"></span>
 685           TypeScript and JavaScript API
 686         </label>
 687         <ul class="md-nav__list" data-md-scrollfix>
 688
 689
 690
 691
 692
 693     <li class="md-nav__item">
 694       <a href="../../../javascript/general-usage/" class="md-nav__link">
 695         General Usage
 696       </a>
 697     </li>
 698
 699
 700
 701
 702
 703
 704
 705     <li class="md-nav__item">
 706       <a href="../../../javascript/typescript/" class="md-nav__link">
 707         TypeScript
 708       </a>
 709     </li>
 710
 711
 712
 713
 714
 715
 716
 717
 718     <li class="md-nav__item md-nav__item--nested">
 719
 720
 721         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 722
 723       <label class="md-nav__link" for="__nav_4_3">
 724         New API
 725         <span class="md-nav__icon md-icon"></span>
 726       </label>
 727       <nav class="md-nav" aria-label="New API" data-md-level="2">
 728         <label class="md-nav__title" for="__nav_4_3">
 729           <span class="md-nav__icon md-icon"></span>
 730           New API
 731         </label>
 732         <ul class="md-nav__list" data-md-scrollfix>
 733
 734
 735
 736
 737
 738     <li class="md-nav__item">
 739       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 740         Writing a module
 741       </a>
 742     </li>
 743
 744
 745
 746
 747
 748
 749
 750     <li class="md-nav__item">
 751       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 752         Data Structures
 753       </a>
 754     </li>
 755
 756
 757
 758
 759
 760
 761
 762     <li class="md-nav__item">
 763       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 764         Core Functions
 765       </a>
 766     </li>
 767
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item">
 775       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 776         DOM
 777       </a>
 778     </li>
 779
 780
 781
 782
 783
 784
 785
 786     <li class="md-nav__item">
 787       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 788         Event Handling
 789       </a>
 790     </li>
 791
 792
 793
 794
 795
 796
 797
 798     <li class="md-nav__item">
 799       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 800         Ajax
 801       </a>
 802     </li>
 803
 804
 805
 806
 807
 808
 809
 810     <li class="md-nav__item">
 811       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 812         Dialogs
 813       </a>
 814     </li>
 815
 816
 817
 818
 819
 820
 821
 822     <li class="md-nav__item">
 823       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 824         Browser and Screen Sizes
 825       </a>
 826     </li>
 827
 828
 829
 830
 831
 832
 833
 834     <li class="md-nav__item">
 835       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 836         User Interface
 837       </a>
 838     </li>
 839
 840
 841
 842         </ul>
 843       </nav>
 844     </li>
 845
 846
 847
 848
 849
 850
 851
 852     <li class="md-nav__item">
 853       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 854         Legacy API
 855       </a>
 856     </li>
 857
 858
 859
 860
 861
 862
 863
 864     <li class="md-nav__item">
 865       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 866         Helper Functions
 867       </a>
 868     </li>
 869
 870
 871
 872
 873
 874
 875
 876     <li class="md-nav__item">
 877       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 878         Code Snippets
 879       </a>
 880     </li>
 881
 882
 883
 884         </ul>
 885       </nav>
 886     </li>
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 901
 902
 903         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 904
 905       <label class="md-nav__link" for="__nav_5">
 906         Package Components
 907         <span class="md-nav__icon md-icon"></span>
 908       </label>
 909       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 910         <label class="md-nav__title" for="__nav_5">
 911           <span class="md-nav__icon md-icon"></span>
 912           Package Components
 913         </label>
 914         <ul class="md-nav__list" data-md-scrollfix>
 915
 916
 917
 918
 919
 920     <li class="md-nav__item">
 921       <a href="../../package-xml/" class="md-nav__link">
 922         package.xml
 923       </a>
 924     </li>
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 936
 937
 938         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 939
 940       <label class="md-nav__link" for="__nav_5_2">
 941         PIPs
 942         <span class="md-nav__icon md-icon"></span>
 943       </label>
 944       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 945         <label class="md-nav__title" for="__nav_5_2">
 946           <span class="md-nav__icon md-icon"></span>
 947           PIPs
 948         </label>
 949         <ul class="md-nav__list" data-md-scrollfix>
 950
 951
 952
 953
 954
 955     <li class="md-nav__item">
 956       <a href="../" class="md-nav__link">
 957         Overview
 958       </a>
 959     </li>
 960
 961
 962
 963
 964
 965
 966
 967     <li class="md-nav__item">
 968       <a href="../acl-option/" class="md-nav__link">
 969         aclOption
 970       </a>
 971     </li>
 972
 973
 974
 975
 976
 977
 978
 979     <li class="md-nav__item">
 980       <a href="../acp-menu/" class="md-nav__link">
 981         acpMenu
 982       </a>
 983     </li>
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../acp-search-provider/" class="md-nav__link">
 993         acpSearchProvider
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003     <li class="md-nav__item">
1004       <a href="../acp-template/" class="md-nav__link">
1005         acpTemplate
1006       </a>
1007     </li>
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017     <li class="md-nav__item md-nav__item--active">
1018
1019       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1020
1021
1022
1023
1024         <label class="md-nav__link md-nav__link--active" for="__toc">
1025           bbcode
1026           <span class="md-nav__icon md-icon"></span>
1027         </label>
1028
1029       <a href="./" class="md-nav__link md-nav__link--active">
1030         bbcode
1031       </a>
1032
1033
1034 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1035
1036
1037
1038
1039
1040     <label class="md-nav__title" for="__toc">
1041       <span class="md-nav__icon md-icon"></span>
1042       Table of contents
1043     </label>
1044     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1045
1046         <li class="md-nav__item">
1047   <a href="#components" class="md-nav__link">
1048     Components
1049   </a>
1050
1051     <nav class="md-nav" aria-label="Components">
1052       <ul class="md-nav__list">
1053
1054           <li class="md-nav__item">
1055   <a href="#htmlopen" class="md-nav__link">
1056     &lt;htmlopen&gt;
1057   </a>
1058
1059 </li>
1060
1061           <li class="md-nav__item">
1062   <a href="#htmlclose" class="md-nav__link">
1063     &lt;htmlclose&gt;
1064   </a>
1065
1066 </li>
1067
1068           <li class="md-nav__item">
1069   <a href="#classname" class="md-nav__link">
1070     &lt;classname&gt;
1071   </a>
1072
1073 </li>
1074
1075           <li class="md-nav__item">
1076   <a href="#wysiwygicon" class="md-nav__link">
1077     &lt;wysiwygicon&gt;
1078   </a>
1079
1080 </li>
1081
1082           <li class="md-nav__item">
1083   <a href="#buttonlabel" class="md-nav__link">
1084     &lt;buttonlabel&gt;
1085   </a>
1086
1087 </li>
1088
1089           <li class="md-nav__item">
1090   <a href="#sourcecode" class="md-nav__link">
1091     &lt;sourcecode&gt;
1092   </a>
1093
1094 </li>
1095
1096           <li class="md-nav__item">
1097   <a href="#isblockelement" class="md-nav__link">
1098     &lt;isBlockElement&gt;
1099   </a>
1100
1101 </li>
1102
1103           <li class="md-nav__item">
1104   <a href="#attributes" class="md-nav__link">
1105     &lt;attributes&gt;
1106   </a>
1107
1108     <nav class="md-nav" aria-label="&lt;attributes&gt;">
1109       <ul class="md-nav__list">
1110
1111           <li class="md-nav__item">
1112   <a href="#html" class="md-nav__link">
1113     &lt;html&gt;
1114   </a>
1115
1116 </li>
1117
1118           <li class="md-nav__item">
1119   <a href="#validationpattern" class="md-nav__link">
1120     &lt;validationpattern&gt;
1121   </a>
1122
1123 </li>
1124
1125           <li class="md-nav__item">
1126   <a href="#required" class="md-nav__link">
1127     &lt;required&gt;
1128   </a>
1129
1130 </li>
1131
1132           <li class="md-nav__item">
1133   <a href="#usetext" class="md-nav__link">
1134     &lt;usetext&gt;
1135   </a>
1136
1137 </li>
1138
1139       </ul>
1140     </nav>
1141
1142 </li>
1143
1144       </ul>
1145     </nav>
1146
1147 </li>
1148
1149         <li class="md-nav__item">
1150   <a href="#example" class="md-nav__link">
1151     Example
1152   </a>
1153
1154 </li>
1155
1156     </ul>
1157
1158 </nav>
1159
1160     </li>
1161
1162
1163
1164
1165
1166
1167
1168     <li class="md-nav__item">
1169       <a href="../box/" class="md-nav__link">
1170         box
1171       </a>
1172     </li>
1173
1174
1175
1176
1177
1178
1179
1180     <li class="md-nav__item">
1181       <a href="../clipboard-action/" class="md-nav__link">
1182         clipboardAction
1183       </a>
1184     </li>
1185
1186
1187
1188
1189
1190
1191
1192     <li class="md-nav__item">
1193       <a href="../core-object/" class="md-nav__link">
1194         coreObject
1195       </a>
1196     </li>
1197
1198
1199
1200
1201
1202
1203
1204     <li class="md-nav__item">
1205       <a href="../cronjob/" class="md-nav__link">
1206         cronjob
1207       </a>
1208     </li>
1209
1210
1211
1212
1213
1214
1215
1216     <li class="md-nav__item">
1217       <a href="../database/" class="md-nav__link">
1218         database
1219       </a>
1220     </li>
1221
1222
1223
1224
1225
1226
1227
1228     <li class="md-nav__item">
1229       <a href="../event-listener/" class="md-nav__link">
1230         eventListener
1231       </a>
1232     </li>
1233
1234
1235
1236
1237
1238
1239
1240     <li class="md-nav__item">
1241       <a href="../file/" class="md-nav__link">
1242         file
1243       </a>
1244     </li>
1245
1246
1247
1248
1249
1250
1251
1252     <li class="md-nav__item">
1253       <a href="../language/" class="md-nav__link">
1254         language
1255       </a>
1256     </li>
1257
1258
1259
1260
1261
1262
1263
1264     <li class="md-nav__item">
1265       <a href="../media-provider/" class="md-nav__link">
1266         mediaProvider
1267       </a>
1268     </li>
1269
1270
1271
1272
1273
1274
1275
1276     <li class="md-nav__item">
1277       <a href="../menu/" class="md-nav__link">
1278         menu
1279       </a>
1280     </li>
1281
1282
1283
1284
1285
1286
1287
1288     <li class="md-nav__item">
1289       <a href="../menu-item/" class="md-nav__link">
1290         menuItem
1291       </a>
1292     </li>
1293
1294
1295
1296
1297
1298
1299
1300     <li class="md-nav__item">
1301       <a href="../object-type/" class="md-nav__link">
1302         objectType
1303       </a>
1304     </li>
1305
1306
1307
1308
1309
1310
1311
1312     <li class="md-nav__item">
1313       <a href="../object-type-definition/" class="md-nav__link">
1314         objectTypeDefinition
1315       </a>
1316     </li>
1317
1318
1319
1320
1321
1322
1323
1324     <li class="md-nav__item">
1325       <a href="../option/" class="md-nav__link">
1326         option
1327       </a>
1328     </li>
1329
1330
1331
1332
1333
1334
1335
1336     <li class="md-nav__item">
1337       <a href="../page/" class="md-nav__link">
1338         page
1339       </a>
1340     </li>
1341
1342
1343
1344
1345
1346
1347
1348     <li class="md-nav__item">
1349       <a href="../pip/" class="md-nav__link">
1350         pip
1351       </a>
1352     </li>
1353
1354
1355
1356
1357
1358
1359
1360     <li class="md-nav__item">
1361       <a href="../script/" class="md-nav__link">
1362         script
1363       </a>
1364     </li>
1365
1366
1367
1368
1369
1370
1371
1372     <li class="md-nav__item">
1373       <a href="../smiley/" class="md-nav__link">
1374         smiley
1375       </a>
1376     </li>
1377
1378
1379
1380
1381
1382
1383
1384     <li class="md-nav__item">
1385       <a href="../sql/" class="md-nav__link">
1386         sql
1387       </a>
1388     </li>
1389
1390
1391
1392
1393
1394
1395
1396     <li class="md-nav__item">
1397       <a href="../style/" class="md-nav__link">
1398         style
1399       </a>
1400     </li>
1401
1402
1403
1404
1405
1406
1407
1408     <li class="md-nav__item">
1409       <a href="../template/" class="md-nav__link">
1410         template
1411       </a>
1412     </li>
1413
1414
1415
1416
1417
1418
1419
1420     <li class="md-nav__item">
1421       <a href="../template-listener/" class="md-nav__link">
1422         templateListener
1423       </a>
1424     </li>
1425
1426
1427
1428
1429
1430
1431
1432     <li class="md-nav__item">
1433       <a href="../user-group-option/" class="md-nav__link">
1434         userGroupOption
1435       </a>
1436     </li>
1437
1438
1439
1440
1441
1442
1443
1444     <li class="md-nav__item">
1445       <a href="../user-menu/" class="md-nav__link">
1446         userMenu
1447       </a>
1448     </li>
1449
1450
1451
1452
1453
1454
1455
1456     <li class="md-nav__item">
1457       <a href="../user-notification-event/" class="md-nav__link">
1458         userNotificationEvent
1459       </a>
1460     </li>
1461
1462
1463
1464
1465
1466
1467
1468     <li class="md-nav__item">
1469       <a href="../user-option/" class="md-nav__link">
1470         userOption
1471       </a>
1472     </li>
1473
1474
1475
1476
1477
1478
1479
1480     <li class="md-nav__item">
1481       <a href="../user-profile-menu/" class="md-nav__link">
1482         userProfileMenu
1483       </a>
1484     </li>
1485
1486
1487
1488         </ul>
1489       </nav>
1490     </li>
1491
1492
1493
1494
1495
1496
1497
1498     <li class="md-nav__item">
1499       <a href="../../database-php-api/" class="md-nav__link">
1500         Database PHP API
1501       </a>
1502     </li>
1503
1504
1505
1506         </ul>
1507       </nav>
1508     </li>
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520     <li class="md-nav__item md-nav__item--nested">
1521
1522
1523         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1524
1525       <label class="md-nav__link" for="__nav_6">
1526         Migration
1527         <span class="md-nav__icon md-icon"></span>
1528       </label>
1529       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1530         <label class="md-nav__title" for="__nav_6">
1531           <span class="md-nav__icon md-icon"></span>
1532           Migration
1533         </label>
1534         <ul class="md-nav__list" data-md-scrollfix>
1535
1536
1537
1538
1539
1540
1541     <li class="md-nav__item md-nav__item--nested">
1542
1543
1544         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1545
1546       <label class="md-nav__link" for="__nav_6_1">
1547         Migrating from WSC 5.3
1548         <span class="md-nav__icon md-icon"></span>
1549       </label>
1550       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1551         <label class="md-nav__title" for="__nav_6_1">
1552           <span class="md-nav__icon md-icon"></span>
1553           Migrating from WSC 5.3
1554         </label>
1555         <ul class="md-nav__list" data-md-scrollfix>
1556
1557
1558
1559
1560
1561     <li class="md-nav__item">
1562       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1563         PHP API
1564       </a>
1565     </li>
1566
1567
1568
1569
1570
1571
1572
1573     <li class="md-nav__item">
1574       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1575         Session Handling and Authentication
1576       </a>
1577     </li>
1578
1579
1580
1581
1582
1583
1584
1585     <li class="md-nav__item">
1586       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1587         TypeScript and JavaScript
1588       </a>
1589     </li>
1590
1591
1592
1593
1594
1595
1596
1597     <li class="md-nav__item">
1598       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1599         Templates
1600       </a>
1601     </li>
1602
1603
1604
1605
1606
1607
1608
1609     <li class="md-nav__item">
1610       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1611         Third Party Libraries
1612       </a>
1613     </li>
1614
1615
1616
1617         </ul>
1618       </nav>
1619     </li>
1620
1621
1622
1623
1624
1625
1626
1627
1628     <li class="md-nav__item md-nav__item--nested">
1629
1630
1631         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1632
1633       <label class="md-nav__link" for="__nav_6_2">
1634         Migrating from WSC 5.2
1635         <span class="md-nav__icon md-icon"></span>
1636       </label>
1637       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1638         <label class="md-nav__title" for="__nav_6_2">
1639           <span class="md-nav__icon md-icon"></span>
1640           Migrating from WSC 5.2
1641         </label>
1642         <ul class="md-nav__list" data-md-scrollfix>
1643
1644
1645
1646
1647
1648     <li class="md-nav__item">
1649       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1650         PHP API
1651       </a>
1652     </li>
1653
1654
1655
1656
1657
1658
1659
1660     <li class="md-nav__item">
1661       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1662         Templates and Languages
1663       </a>
1664     </li>
1665
1666
1667
1668
1669
1670
1671
1672     <li class="md-nav__item">
1673       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1674         Third Party Libraries
1675       </a>
1676     </li>
1677
1678
1679
1680         </ul>
1681       </nav>
1682     </li>
1683
1684
1685
1686
1687
1688
1689
1690
1691     <li class="md-nav__item md-nav__item--nested">
1692
1693
1694         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1695
1696       <label class="md-nav__link" for="__nav_6_3">
1697         Migrating from WSC 3.1
1698         <span class="md-nav__icon md-icon"></span>
1699       </label>
1700       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1701         <label class="md-nav__title" for="__nav_6_3">
1702           <span class="md-nav__icon md-icon"></span>
1703           Migrating from WSC 3.1
1704         </label>
1705         <ul class="md-nav__list" data-md-scrollfix>
1706
1707
1708
1709
1710
1711     <li class="md-nav__item">
1712       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1713         PHP API
1714       </a>
1715     </li>
1716
1717
1718
1719         </ul>
1720       </nav>
1721     </li>
1722
1723
1724
1725
1726
1727
1728
1729
1730     <li class="md-nav__item md-nav__item--nested">
1731
1732
1733         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1734
1735       <label class="md-nav__link" for="__nav_6_4">
1736         Migrating from WSC 3.0
1737         <span class="md-nav__icon md-icon"></span>
1738       </label>
1739       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1740         <label class="md-nav__title" for="__nav_6_4">
1741           <span class="md-nav__icon md-icon"></span>
1742           Migrating from WSC 3.0
1743         </label>
1744         <ul class="md-nav__list" data-md-scrollfix>
1745
1746
1747
1748
1749
1750     <li class="md-nav__item">
1751       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1752         PHP API
1753       </a>
1754     </li>
1755
1756
1757
1758
1759
1760
1761
1762     <li class="md-nav__item">
1763       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1764         JavaScript API
1765       </a>
1766     </li>
1767
1768
1769
1770
1771
1772
1773
1774     <li class="md-nav__item">
1775       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1776         Templates
1777       </a>
1778     </li>
1779
1780
1781
1782
1783
1784
1785
1786     <li class="md-nav__item">
1787       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1788         CSS
1789       </a>
1790     </li>
1791
1792
1793
1794
1795
1796
1797
1798     <li class="md-nav__item">
1799       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1800         Package Components
1801       </a>
1802     </li>
1803
1804
1805
1806         </ul>
1807       </nav>
1808     </li>
1809
1810
1811
1812
1813
1814
1815
1816
1817     <li class="md-nav__item md-nav__item--nested">
1818
1819
1820         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1821
1822       <label class="md-nav__link" for="__nav_6_5">
1823         Migrating from WCF 2.1
1824         <span class="md-nav__icon md-icon"></span>
1825       </label>
1826       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1827         <label class="md-nav__title" for="__nav_6_5">
1828           <span class="md-nav__icon md-icon"></span>
1829           Migrating from WCF 2.1
1830         </label>
1831         <ul class="md-nav__list" data-md-scrollfix>
1832
1833
1834
1835
1836
1837     <li class="md-nav__item">
1838       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1839         PHP API
1840       </a>
1841     </li>
1842
1843
1844
1845
1846
1847
1848
1849     <li class="md-nav__item">
1850       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1851         Templates
1852       </a>
1853     </li>
1854
1855
1856
1857
1858
1859
1860
1861     <li class="md-nav__item">
1862       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1863         CSS
1864       </a>
1865     </li>
1866
1867
1868
1869
1870
1871
1872
1873     <li class="md-nav__item">
1874       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1875         Package Components
1876       </a>
1877     </li>
1878
1879
1880
1881         </ul>
1882       </nav>
1883     </li>
1884
1885
1886
1887         </ul>
1888       </nav>
1889     </li>
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901     <li class="md-nav__item md-nav__item--nested">
1902
1903
1904         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1905
1906       <label class="md-nav__link" for="__nav_7">
1907         Tutorials
1908         <span class="md-nav__icon md-icon"></span>
1909       </label>
1910       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1911         <label class="md-nav__title" for="__nav_7">
1912           <span class="md-nav__icon md-icon"></span>
1913           Tutorials
1914         </label>
1915         <ul class="md-nav__list" data-md-scrollfix>
1916
1917
1918
1919
1920
1921
1922     <li class="md-nav__item md-nav__item--nested">
1923
1924
1925         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1926
1927       <label class="md-nav__link" for="__nav_7_1">
1928         Tutorial Series
1929         <span class="md-nav__icon md-icon"></span>
1930       </label>
1931       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1932         <label class="md-nav__title" for="__nav_7_1">
1933           <span class="md-nav__icon md-icon"></span>
1934           Tutorial Series
1935         </label>
1936         <ul class="md-nav__list" data-md-scrollfix>
1937
1938
1939
1940
1941
1942     <li class="md-nav__item">
1943       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1944         Overview
1945       </a>
1946     </li>
1947
1948
1949
1950
1951
1952
1953
1954     <li class="md-nav__item">
1955       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1956         Part 1
1957       </a>
1958     </li>
1959
1960
1961
1962
1963
1964
1965
1966     <li class="md-nav__item">
1967       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1968         Part 2
1969       </a>
1970     </li>
1971
1972
1973
1974
1975
1976
1977
1978     <li class="md-nav__item">
1979       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1980         Part 3
1981       </a>
1982     </li>
1983
1984
1985
1986         </ul>
1987       </nav>
1988     </li>
1989
1990
1991
1992         </ul>
1993       </nav>
1994     </li>
1995
1996
1997
1998   </ul>
1999 </nav>
2000                   </div>
2001                 </div>
2002               </div>
2003
2004
2005
2006               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2007                 <div class="md-sidebar__scrollwrap">
2008                   <div class="md-sidebar__inner">
2009
2010 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2011
2012
2013
2014
2015
2016     <label class="md-nav__title" for="__toc">
2017       <span class="md-nav__icon md-icon"></span>
2018       Table of contents
2019     </label>
2020     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2021
2022         <li class="md-nav__item">
2023   <a href="#components" class="md-nav__link">
2024     Components
2025   </a>
2026
2027     <nav class="md-nav" aria-label="Components">
2028       <ul class="md-nav__list">
2029
2030           <li class="md-nav__item">
2031   <a href="#htmlopen" class="md-nav__link">
2032     &lt;htmlopen&gt;
2033   </a>
2034
2035 </li>
2036
2037           <li class="md-nav__item">
2038   <a href="#htmlclose" class="md-nav__link">
2039     &lt;htmlclose&gt;
2040   </a>
2041
2042 </li>
2043
2044           <li class="md-nav__item">
2045   <a href="#classname" class="md-nav__link">
2046     &lt;classname&gt;
2047   </a>
2048
2049 </li>
2050
2051           <li class="md-nav__item">
2052   <a href="#wysiwygicon" class="md-nav__link">
2053     &lt;wysiwygicon&gt;
2054   </a>
2055
2056 </li>
2057
2058           <li class="md-nav__item">
2059   <a href="#buttonlabel" class="md-nav__link">
2060     &lt;buttonlabel&gt;
2061   </a>
2062
2063 </li>
2064
2065           <li class="md-nav__item">
2066   <a href="#sourcecode" class="md-nav__link">
2067     &lt;sourcecode&gt;
2068   </a>
2069
2070 </li>
2071
2072           <li class="md-nav__item">
2073   <a href="#isblockelement" class="md-nav__link">
2074     &lt;isBlockElement&gt;
2075   </a>
2076
2077 </li>
2078
2079           <li class="md-nav__item">
2080   <a href="#attributes" class="md-nav__link">
2081     &lt;attributes&gt;
2082   </a>
2083
2084     <nav class="md-nav" aria-label="&lt;attributes&gt;">
2085       <ul class="md-nav__list">
2086
2087           <li class="md-nav__item">
2088   <a href="#html" class="md-nav__link">
2089     &lt;html&gt;
2090   </a>
2091
2092 </li>
2093
2094           <li class="md-nav__item">
2095   <a href="#validationpattern" class="md-nav__link">
2096     &lt;validationpattern&gt;
2097   </a>
2098
2099 </li>
2100
2101           <li class="md-nav__item">
2102   <a href="#required" class="md-nav__link">
2103     &lt;required&gt;
2104   </a>
2105
2106 </li>
2107
2108           <li class="md-nav__item">
2109   <a href="#usetext" class="md-nav__link">
2110     &lt;usetext&gt;
2111   </a>
2112
2113 </li>
2114
2115       </ul>
2116     </nav>
2117
2118 </li>
2119
2120       </ul>
2121     </nav>
2122
2123 </li>
2124
2125         <li class="md-nav__item">
2126   <a href="#example" class="md-nav__link">
2127     Example
2128   </a>
2129
2130 </li>
2131
2132     </ul>
2133
2134 </nav>
2135                   </div>
2136                 </div>
2137               </div>
2138
2139
2140           <div class="md-content" data-md-component="content">
2141             <article class="md-content__inner md-typeset">
2142
2143
2144                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/bbcode.md" title="Edit this page" class="md-content__button md-icon">
2145                     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
2146                   </a>
2147
2148
2149                 <h1 id="bbcode-package-installation-plugin">BBCode Package Installation Plugin<a class="headerlink" href="#bbcode-package-installation-plugin" title="Permanent link">#</a></h1>
2150 <p>Registers new BBCodes.</p>
2151 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
2152 <p>Each bbcode is described as an <code>&lt;bbcode&gt;</code> element with the mandatory attribute <code>name</code>.
2153 The <code>name</code> attribute must contain alphanumeric characters only and is exposed to the user.</p>
2154 <h3 id="htmlopen"><code>&lt;htmlopen&gt;</code><a class="headerlink" href="#htmlopen" title="Permanent link">#</a></h3>
2155 <div class="admonition info">
2156 <p class="admonition-title">Optional: Must not be provided if the BBCode is being processed a PHP class (<code>&lt;classname&gt;</code>).</p>
2157 </div>
2158 <p>The contents of this tag are literally copied into the opening tag of the bbcode.</p>
2159 <h3 id="htmlclose"><code>&lt;htmlclose&gt;</code><a class="headerlink" href="#htmlclose" title="Permanent link">#</a></h3>
2160 <div class="admonition info">
2161 <p class="admonition-title">Optional: Must not be provided if <code>&lt;htmlopen&gt;</code> is not given.</p>
2162 </div>
2163 <p>Must match the <code>&lt;htmlopen&gt;</code> tag.
2164 Do not provide for self-closing tags.</p>
2165 <h3 id="classname"><code>&lt;classname&gt;</code><a class="headerlink" href="#classname" title="Permanent link">#</a></h3>
2166 <p>The name of the class providing the bbcode output,
2167 the class has to implement the <code>wcf\system\bbcode\IBBCode</code> interface.</p>
2168 <p>BBCodes can be statically converted to HTML during input processing using a
2169 <code>wcf\system\html\metacode\converter\*MetaConverter</code> class. This class does not
2170 need to be registered.</p>
2171 <h3 id="wysiwygicon"><code>&lt;wysiwygicon&gt;</code><a class="headerlink" href="#wysiwygicon" title="Permanent link">#</a></h3>
2172 <p><span class="label label-info">Optional</span></p>
2173 <p>Name of the Font Awesome icon class or path to a <code>gif</code>, <code>jpg</code>, <code>jpeg</code>, <code>png</code>, or <code>svg</code> image (placed inside the <code>icon/</code> directory) to show in the editor toolbar.</p>
2174 <h3 id="buttonlabel"><code>&lt;buttonlabel&gt;</code><a class="headerlink" href="#buttonlabel" title="Permanent link">#</a></h3>
2175 <div class="admonition info">
2176 <p class="admonition-title">Optional: Must be provided if an icon is given.</p>
2177 </div>
2178 <p>Explanatory text to show when hovering the icon.</p>
2179 <h3 id="sourcecode"><code>&lt;sourcecode&gt;</code><a class="headerlink" href="#sourcecode" title="Permanent link">#</a></h3>
2180 <div class="admonition warning">
2181 <p class="admonition-title">Do not set this to <code>1</code> if you don't specify a PHP class for processing. You must perform XSS sanitizing yourself!</p>
2182 </div>
2183 <p>If set to <code>1</code> contents of this BBCode will not be interpreted,
2184 but literally passed through instead.</p>
2185 <h3 id="isblockelement"><code>&lt;isBlockElement&gt;</code><a class="headerlink" href="#isblockelement" title="Permanent link">#</a></h3>
2186 <p>Set to <code>1</code> if the output of this BBCode is a HTML block element (according to the HTML specification).</p>
2187 <h3 id="attributes"><code>&lt;attributes&gt;</code><a class="headerlink" href="#attributes" title="Permanent link">#</a></h3>
2188 <p>Each bbcode is described as an <code>&lt;attribute&gt;</code> element with the mandatory attribute <code>name</code>.
2189 The <code>name</code> attribute is a 0-indexed integer.</p>
2190 <h4 id="html"><code>&lt;html&gt;</code><a class="headerlink" href="#html" title="Permanent link">#</a></h4>
2191 <div class="admonition info">
2192 <p class="admonition-title">Optional: Must not be provided if the BBCode is being processed a PHP class (<code>&lt;classname&gt;</code>).</p>
2193 </div>
2194 <p>The contents of this tag are copied into the opening tag of the bbcode.
2195 <code>%s</code> is replaced by the attribute value.</p>
2196 <h4 id="validationpattern"><code>&lt;validationpattern&gt;</code><a class="headerlink" href="#validationpattern" title="Permanent link">#</a></h4>
2197 <p><span class="label label-info">Optional</span></p>
2198 <p>Defines a regular expression that is used to validate the value of the attribute.</p>
2199 <h4 id="required"><code>&lt;required&gt;</code><a class="headerlink" href="#required" title="Permanent link">#</a></h4>
2200 <p><span class="label label-info">Optional</span></p>
2201 <p>Specifies whether this attribute must be provided.</p>
2202 <h4 id="usetext"><code>&lt;usetext&gt;</code><a class="headerlink" href="#usetext" title="Permanent link">#</a></h4>
2203 <p><span class="label label-info">Optional</span></p>
2204 <div class="admonition info">
2205 <p class="admonition-title">Should only be set to <code>1</code> for the attribute with name <code>0</code>.</p>
2206 </div>
2207 <p>Specifies whether the text content of the BBCode should become this attribute's value.</p>
2208 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2209 <div class="highlight"><pre><span></span><code>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
2210 &lt;data xmlns=&quot;http://www.woltlab.com&quot; xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:schemaLocation=&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/bbcode.xsd&quot;&gt;
2211     &lt;import&gt;
2212         &lt;bbcode name=&quot;foo&quot;&gt;
2213             &lt;classname&gt;wcf\system\bbcode\FooBBCode&lt;/classname&gt;
2214             &lt;attributes&gt;
2215                 &lt;attribute name=&quot;0&quot;&gt;
2216                     &lt;validationpattern&gt;^\d+$&lt;/validationpattern&gt;
2217                     &lt;required&gt;1&lt;/required&gt;
2218                 &lt;/attribute&gt;
2219             &lt;/attributes&gt;
2220         &lt;/bbcode&gt;
2221
2222         &lt;bbcode name=&quot;example&quot;&gt;
2223             &lt;htmlopen&gt;div&lt;/htmlopen&gt;
2224             &lt;htmlclose&gt;div&lt;/htmlclose&gt;
2225             &lt;isBlockElement&gt;1&lt;/isBlockElement&gt;
2226             &lt;wysiwygicon&gt;fa-bath&lt;/wysiwygicon&gt;
2227             &lt;buttonlabel&gt;wcf.editor.button.example&lt;/buttonlabel&gt;
2228         &lt;/bbcode&gt;
2229     &lt;/import&gt;
2230 &lt;/data&gt;
2231 </code></pre></div>
2232
2233
2234
2235
2236 <hr>
2237 <div class="md-source-date">
2238   <small>
2239
2240       Last update: 2021-01-08
2241
2242   </small>
2243 </div>
2244
2245
2246
2247
2248
2249
2250
2251
2252             </article>
2253           </div>
2254         </div>
2255
2256       </main>
2257
2258
2259 <footer class="md-footer">
2260
2261     <nav class="md-footer__inner md-grid" aria-label="Footer">
2262
2263         <a href="../acp-template/" class="md-footer__link md-footer__link--prev" rel="prev">
2264           <div class="md-footer__button md-icon">
2265             <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>
2266           </div>
2267           <div class="md-footer__title">
2268             <div class="md-ellipsis">
2269               <span class="md-footer__direction">
2270                 Previous
2271               </span>
2272               acpTemplate
2273             </div>
2274           </div>
2275         </a>
2276
2277
2278         <a href="../box/" class="md-footer__link md-footer__link--next" rel="next">
2279           <div class="md-footer__title">
2280             <div class="md-ellipsis">
2281               <span class="md-footer__direction">
2282                 Next
2283               </span>
2284               box
2285             </div>
2286           </div>
2287           <div class="md-footer__button md-icon">
2288             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2289           </div>
2290         </a>
2291
2292     </nav>
2293
2294   <div class="md-footer-meta md-typeset">
2295     <div class="md-footer-meta__inner md-grid">
2296       <div class="md-footer-copyright">
2297
2298           <div class="md-footer-copyright__highlight">
2299             Copyright © 2020 WoltLab GmbH
2300           </div>
2301
2302         Made with
2303         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2304           Material for MkDocs
2305         </a>
2306
2307       </div>
2308       <div class="md-footer-copyright">
2309         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2310         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2311 </div>
2312     </div>
2313   </div>
2314 </footer>
2315
2316     </div>
2317     <div class="md-dialog" data-md-component="dialog">
2318       <div class="md-dialog__inner md-typeset"></div>
2319     </div>
2320     <script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
2321
2322
2323       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2324
2325
2326   </body>
2327 </html>