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