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