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