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