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