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