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