Deployed 506b5bb to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / 5.4 / package / pip / smiley / 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>smiley - 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 <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="#smiley-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 smiley
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 <li class="md-nav__item">
1002 <a href="../language/" class="md-nav__link">
1003 language
1004 </a>
1005 </li>
1006
1007
1008
1009
1010
1011
1012
1013 <li class="md-nav__item">
1014 <a href="../media-provider/" class="md-nav__link">
1015 mediaProvider
1016 </a>
1017 </li>
1018
1019
1020
1021
1022
1023
1024
1025 <li class="md-nav__item">
1026 <a href="../menu/" class="md-nav__link">
1027 menu
1028 </a>
1029 </li>
1030
1031
1032
1033
1034
1035
1036
1037 <li class="md-nav__item">
1038 <a href="../menu-item/" class="md-nav__link">
1039 menuItem
1040 </a>
1041 </li>
1042
1043
1044
1045
1046
1047
1048
1049 <li class="md-nav__item">
1050 <a href="../object-type/" class="md-nav__link">
1051 objectType
1052 </a>
1053 </li>
1054
1055
1056
1057
1058
1059
1060
1061 <li class="md-nav__item">
1062 <a href="../object-type-definition/" class="md-nav__link">
1063 objectTypeDefinition
1064 </a>
1065 </li>
1066
1067
1068
1069
1070
1071
1072
1073 <li class="md-nav__item">
1074 <a href="../option/" class="md-nav__link">
1075 option
1076 </a>
1077 </li>
1078
1079
1080
1081
1082
1083
1084
1085 <li class="md-nav__item">
1086 <a href="../page/" class="md-nav__link">
1087 page
1088 </a>
1089 </li>
1090
1091
1092
1093
1094
1095
1096
1097 <li class="md-nav__item">
1098 <a href="../pip/" class="md-nav__link">
1099 pip
1100 </a>
1101 </li>
1102
1103
1104
1105
1106
1107
1108
1109 <li class="md-nav__item">
1110 <a href="../script/" class="md-nav__link">
1111 script
1112 </a>
1113 </li>
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123 <li class="md-nav__item md-nav__item--active">
1124
1125 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1126
1127
1128
1129
1130 <label class="md-nav__link md-nav__link--active" for="__toc">
1131 smiley
1132 <span class="md-nav__icon md-icon"></span>
1133 </label>
1134
1135 <a href="./" class="md-nav__link md-nav__link--active">
1136 smiley
1137 </a>
1138
1139
1140 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1141
1142
1143
1144
1145
1146 <label class="md-nav__title" for="__toc">
1147 <span class="md-nav__icon md-icon"></span>
1148 Table of contents
1149 </label>
1150 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1151
1152 <li class="md-nav__item">
1153 <a href="#components" class="md-nav__link">
1154 Components
1155 </a>
1156
1157 <nav class="md-nav" aria-label="Components">
1158 <ul class="md-nav__list">
1159
1160 <li class="md-nav__item">
1161 <a href="#title" class="md-nav__link">
1162 &lt;title&gt;
1163 </a>
1164
1165 </li>
1166
1167 <li class="md-nav__item">
1168 <a href="#path2x" class="md-nav__link">
1169 &lt;path(2x)?&gt;
1170 </a>
1171
1172 </li>
1173
1174 <li class="md-nav__item">
1175 <a href="#aliases" class="md-nav__link">
1176 &lt;aliases&gt;
1177 </a>
1178
1179 </li>
1180
1181 <li class="md-nav__item">
1182 <a href="#showorder" class="md-nav__link">
1183 &lt;showorder&gt;
1184 </a>
1185
1186 </li>
1187
1188 </ul>
1189 </nav>
1190
1191 </li>
1192
1193 <li class="md-nav__item">
1194 <a href="#example" class="md-nav__link">
1195 Example
1196 </a>
1197
1198 </li>
1199
1200 </ul>
1201
1202 </nav>
1203
1204 </li>
1205
1206
1207
1208
1209
1210
1211
1212 <li class="md-nav__item">
1213 <a href="../sql/" class="md-nav__link">
1214 sql
1215 </a>
1216 </li>
1217
1218
1219
1220
1221
1222
1223
1224 <li class="md-nav__item">
1225 <a href="../style/" class="md-nav__link">
1226 style
1227 </a>
1228 </li>
1229
1230
1231
1232
1233
1234
1235
1236 <li class="md-nav__item">
1237 <a href="../template/" class="md-nav__link">
1238 template
1239 </a>
1240 </li>
1241
1242
1243
1244
1245
1246
1247
1248 <li class="md-nav__item">
1249 <a href="../template-listener/" class="md-nav__link">
1250 templateListener
1251 </a>
1252 </li>
1253
1254
1255
1256
1257
1258
1259
1260 <li class="md-nav__item">
1261 <a href="../user-group-option/" class="md-nav__link">
1262 userGroupOption
1263 </a>
1264 </li>
1265
1266
1267
1268
1269
1270
1271
1272 <li class="md-nav__item">
1273 <a href="../user-menu/" class="md-nav__link">
1274 userMenu
1275 </a>
1276 </li>
1277
1278
1279
1280
1281
1282
1283
1284 <li class="md-nav__item">
1285 <a href="../user-notification-event/" class="md-nav__link">
1286 userNotificationEvent
1287 </a>
1288 </li>
1289
1290
1291
1292
1293
1294
1295
1296 <li class="md-nav__item">
1297 <a href="../user-option/" class="md-nav__link">
1298 userOption
1299 </a>
1300 </li>
1301
1302
1303
1304
1305
1306
1307
1308 <li class="md-nav__item">
1309 <a href="../user-profile-menu/" class="md-nav__link">
1310 userProfileMenu
1311 </a>
1312 </li>
1313
1314
1315
1316 </ul>
1317 </nav>
1318 </li>
1319
1320
1321
1322
1323
1324
1325
1326 <li class="md-nav__item">
1327 <a href="../../database-php-api/" class="md-nav__link">
1328 Database PHP API
1329 </a>
1330 </li>
1331
1332
1333
1334 </ul>
1335 </nav>
1336 </li>
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348 <li class="md-nav__item md-nav__item--nested">
1349
1350
1351 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1352
1353 <label class="md-nav__link" for="__nav_6">
1354 Migration
1355 <span class="md-nav__icon md-icon"></span>
1356 </label>
1357 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1358 <label class="md-nav__title" for="__nav_6">
1359 <span class="md-nav__icon md-icon"></span>
1360 Migration
1361 </label>
1362 <ul class="md-nav__list" data-md-scrollfix>
1363
1364
1365
1366
1367
1368
1369 <li class="md-nav__item md-nav__item--nested">
1370
1371
1372 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1373
1374 <label class="md-nav__link" for="__nav_6_1">
1375 Migrating from WSC 5.3
1376 <span class="md-nav__icon md-icon"></span>
1377 </label>
1378 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1379 <label class="md-nav__title" for="__nav_6_1">
1380 <span class="md-nav__icon md-icon"></span>
1381 Migrating from WSC 5.3
1382 </label>
1383 <ul class="md-nav__list" data-md-scrollfix>
1384
1385
1386
1387
1388
1389 <li class="md-nav__item">
1390 <a href="../../../migration/wsc53/php/" class="md-nav__link">
1391 PHP API
1392 </a>
1393 </li>
1394
1395
1396
1397
1398
1399
1400
1401 <li class="md-nav__item">
1402 <a href="../../../migration/wsc53/session/" class="md-nav__link">
1403 Session Handling and Authentication
1404 </a>
1405 </li>
1406
1407
1408
1409
1410
1411
1412
1413 <li class="md-nav__item">
1414 <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1415 JavaScript
1416 </a>
1417 </li>
1418
1419
1420
1421
1422
1423
1424
1425 <li class="md-nav__item">
1426 <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1427 Templates
1428 </a>
1429 </li>
1430
1431
1432
1433
1434
1435
1436
1437 <li class="md-nav__item">
1438 <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1439 Third Party Libraries
1440 </a>
1441 </li>
1442
1443
1444
1445 </ul>
1446 </nav>
1447 </li>
1448
1449
1450
1451
1452
1453
1454
1455
1456 <li class="md-nav__item md-nav__item--nested">
1457
1458
1459 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1460
1461 <label class="md-nav__link" for="__nav_6_2">
1462 Migrating from WSC 5.2
1463 <span class="md-nav__icon md-icon"></span>
1464 </label>
1465 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1466 <label class="md-nav__title" for="__nav_6_2">
1467 <span class="md-nav__icon md-icon"></span>
1468 Migrating from WSC 5.2
1469 </label>
1470 <ul class="md-nav__list" data-md-scrollfix>
1471
1472
1473
1474
1475
1476 <li class="md-nav__item">
1477 <a href="../../../migration/wsc52/php/" class="md-nav__link">
1478 PHP API
1479 </a>
1480 </li>
1481
1482
1483
1484
1485
1486
1487
1488 <li class="md-nav__item">
1489 <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1490 Templates and Languages
1491 </a>
1492 </li>
1493
1494
1495
1496
1497
1498
1499
1500 <li class="md-nav__item">
1501 <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1502 Third Party Libraries
1503 </a>
1504 </li>
1505
1506
1507
1508 </ul>
1509 </nav>
1510 </li>
1511
1512
1513
1514
1515
1516
1517
1518
1519 <li class="md-nav__item md-nav__item--nested">
1520
1521
1522 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1523
1524 <label class="md-nav__link" for="__nav_6_3">
1525 Migrating from WSC 3.1
1526 <span class="md-nav__icon md-icon"></span>
1527 </label>
1528 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1529 <label class="md-nav__title" for="__nav_6_3">
1530 <span class="md-nav__icon md-icon"></span>
1531 Migrating from WSC 3.1
1532 </label>
1533 <ul class="md-nav__list" data-md-scrollfix>
1534
1535
1536
1537
1538
1539 <li class="md-nav__item">
1540 <a href="../../../migration/wsc31/php/" class="md-nav__link">
1541 PHP API
1542 </a>
1543 </li>
1544
1545
1546
1547 </ul>
1548 </nav>
1549 </li>
1550
1551
1552
1553
1554
1555
1556
1557
1558 <li class="md-nav__item md-nav__item--nested">
1559
1560
1561 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1562
1563 <label class="md-nav__link" for="__nav_6_4">
1564 Migrating from WSC 3.0
1565 <span class="md-nav__icon md-icon"></span>
1566 </label>
1567 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1568 <label class="md-nav__title" for="__nav_6_4">
1569 <span class="md-nav__icon md-icon"></span>
1570 Migrating from WSC 3.0
1571 </label>
1572 <ul class="md-nav__list" data-md-scrollfix>
1573
1574
1575
1576
1577
1578 <li class="md-nav__item">
1579 <a href="../../../migration/wsc30/php/" class="md-nav__link">
1580 PHP API
1581 </a>
1582 </li>
1583
1584
1585
1586
1587
1588
1589
1590 <li class="md-nav__item">
1591 <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1592 JavaScript API
1593 </a>
1594 </li>
1595
1596
1597
1598
1599
1600
1601
1602 <li class="md-nav__item">
1603 <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1604 Templates
1605 </a>
1606 </li>
1607
1608
1609
1610
1611
1612
1613
1614 <li class="md-nav__item">
1615 <a href="../../../migration/wsc30/css/" class="md-nav__link">
1616 CSS
1617 </a>
1618 </li>
1619
1620
1621
1622
1623
1624
1625
1626 <li class="md-nav__item">
1627 <a href="../../../migration/wsc30/package/" class="md-nav__link">
1628 Package Components
1629 </a>
1630 </li>
1631
1632
1633
1634 </ul>
1635 </nav>
1636 </li>
1637
1638
1639
1640
1641
1642
1643
1644
1645 <li class="md-nav__item md-nav__item--nested">
1646
1647
1648 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1649
1650 <label class="md-nav__link" for="__nav_6_5">
1651 Migrating from WCF 2.1
1652 <span class="md-nav__icon md-icon"></span>
1653 </label>
1654 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1655 <label class="md-nav__title" for="__nav_6_5">
1656 <span class="md-nav__icon md-icon"></span>
1657 Migrating from WCF 2.1
1658 </label>
1659 <ul class="md-nav__list" data-md-scrollfix>
1660
1661
1662
1663
1664
1665 <li class="md-nav__item">
1666 <a href="../../../migration/wcf21/php/" class="md-nav__link">
1667 PHP API
1668 </a>
1669 </li>
1670
1671
1672
1673
1674
1675
1676
1677 <li class="md-nav__item">
1678 <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1679 Templates
1680 </a>
1681 </li>
1682
1683
1684
1685
1686
1687
1688
1689 <li class="md-nav__item">
1690 <a href="../../../migration/wcf21/css/" class="md-nav__link">
1691 CSS
1692 </a>
1693 </li>
1694
1695
1696
1697
1698
1699
1700
1701 <li class="md-nav__item">
1702 <a href="../../../migration/wcf21/package/" class="md-nav__link">
1703 Package Components
1704 </a>
1705 </li>
1706
1707
1708
1709 </ul>
1710 </nav>
1711 </li>
1712
1713
1714
1715 </ul>
1716 </nav>
1717 </li>
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729 <li class="md-nav__item md-nav__item--nested">
1730
1731
1732 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1733
1734 <label class="md-nav__link" for="__nav_7">
1735 Tutorials
1736 <span class="md-nav__icon md-icon"></span>
1737 </label>
1738 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1739 <label class="md-nav__title" for="__nav_7">
1740 <span class="md-nav__icon md-icon"></span>
1741 Tutorials
1742 </label>
1743 <ul class="md-nav__list" data-md-scrollfix>
1744
1745
1746
1747
1748
1749
1750 <li class="md-nav__item md-nav__item--nested">
1751
1752
1753 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1754
1755 <label class="md-nav__link" for="__nav_7_1">
1756 Tutorial Series
1757 <span class="md-nav__icon md-icon"></span>
1758 </label>
1759 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1760 <label class="md-nav__title" for="__nav_7_1">
1761 <span class="md-nav__icon md-icon"></span>
1762 Tutorial Series
1763 </label>
1764 <ul class="md-nav__list" data-md-scrollfix>
1765
1766
1767
1768
1769
1770 <li class="md-nav__item">
1771 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1772 Overview
1773 </a>
1774 </li>
1775
1776
1777
1778
1779
1780
1781
1782 <li class="md-nav__item">
1783 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1784 Part 1
1785 </a>
1786 </li>
1787
1788
1789
1790
1791
1792
1793
1794 <li class="md-nav__item">
1795 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1796 Part 2
1797 </a>
1798 </li>
1799
1800
1801
1802
1803
1804
1805
1806 <li class="md-nav__item">
1807 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1808 Part 3
1809 </a>
1810 </li>
1811
1812
1813
1814 </ul>
1815 </nav>
1816 </li>
1817
1818
1819
1820 </ul>
1821 </nav>
1822 </li>
1823
1824
1825
1826 </ul>
1827 </nav>
1828 </div>
1829 </div>
1830 </div>
1831
1832
1833
1834 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1835 <div class="md-sidebar__scrollwrap">
1836 <div class="md-sidebar__inner">
1837
1838 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1839
1840
1841
1842
1843
1844 <label class="md-nav__title" for="__toc">
1845 <span class="md-nav__icon md-icon"></span>
1846 Table of contents
1847 </label>
1848 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1849
1850 <li class="md-nav__item">
1851 <a href="#components" class="md-nav__link">
1852 Components
1853 </a>
1854
1855 <nav class="md-nav" aria-label="Components">
1856 <ul class="md-nav__list">
1857
1858 <li class="md-nav__item">
1859 <a href="#title" class="md-nav__link">
1860 &lt;title&gt;
1861 </a>
1862
1863 </li>
1864
1865 <li class="md-nav__item">
1866 <a href="#path2x" class="md-nav__link">
1867 &lt;path(2x)?&gt;
1868 </a>
1869
1870 </li>
1871
1872 <li class="md-nav__item">
1873 <a href="#aliases" class="md-nav__link">
1874 &lt;aliases&gt;
1875 </a>
1876
1877 </li>
1878
1879 <li class="md-nav__item">
1880 <a href="#showorder" class="md-nav__link">
1881 &lt;showorder&gt;
1882 </a>
1883
1884 </li>
1885
1886 </ul>
1887 </nav>
1888
1889 </li>
1890
1891 <li class="md-nav__item">
1892 <a href="#example" class="md-nav__link">
1893 Example
1894 </a>
1895
1896 </li>
1897
1898 </ul>
1899
1900 </nav>
1901 </div>
1902 </div>
1903 </div>
1904
1905
1906 <div class="md-content" data-md-component="content">
1907 <article class="md-content__inner md-typeset">
1908
1909
1910
1911 <h1 id="smiley-package-installation-plugin">Smiley Package Installation Plugin<a class="headerlink" href="#smiley-package-installation-plugin" title="Permanent link">#</a></h1>
1912 <p>Installs new smileys.</p>
1913 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
1914 <p>Each smiley is described as an <code>&lt;smiley&gt;</code> element with the mandatory attribute <code>name</code>.</p>
1915 <h3 id="title"><code>&lt;title&gt;</code><a class="headerlink" href="#title" title="Permanent link">#</a></h3>
1916 <p>Short human readable description of the smiley.</p>
1917 <h3 id="path2x"><code>&lt;path(2x)?&gt;</code><a class="headerlink" href="#path2x" title="Permanent link">#</a></h3>
1918 <div class="admonition warning">
1919 <p class="admonition-title">The files must be installed using the <a href="../file/">file</a> PIP.</p>
1920 </div>
1921 <p>File path relative to the root of WoltLab Suite Core.
1922 <code>path2x</code> is optional and being used for High-DPI screens.</p>
1923 <h3 id="aliases"><code>&lt;aliases&gt;</code><a class="headerlink" href="#aliases" title="Permanent link">#</a></h3>
1924 <p><span class="label label-info">Optional</span></p>
1925 <p>List of smiley aliases.
1926 Aliases must be separated by a line feed character (<code>\n</code>, U+000A).</p>
1927 <h3 id="showorder"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3>
1928 <p><span class="label label-info">Optional</span></p>
1929 <p>Determines at which position of the smiley list the smiley is shown.</p>
1930 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
1931 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
1932 <span class="nt">&lt;data</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/smiley.xsd&quot;</span><span class="nt">&gt;</span>
1933 <span class="nt">&lt;import&gt;</span>
1934 <span class="nt">&lt;smiley</span> <span class="na">name=</span><span class="s">&quot;:example:&quot;</span><span class="nt">&gt;</span>
1935 <span class="nt">&lt;title&gt;</span>example<span class="nt">&lt;/title&gt;</span>
1936 <span class="nt">&lt;path&gt;</span>images/smilies/example.png<span class="nt">&lt;/path&gt;</span>
1937 <span class="nt">&lt;path2x&gt;</span>images/smilies/example@2x.png<span class="nt">&lt;/path2x&gt;</span>
1938 <span class="nt">&lt;aliases&gt;</span><span class="cp">&lt;![CDATA[:alias:</span>
1939 <span class="cp">:more_aliases:]]&gt;</span><span class="nt">&lt;/aliases&gt;</span>
1940 <span class="nt">&lt;/smiley&gt;</span>
1941 <span class="nt">&lt;/import&gt;</span>
1942 <span class="nt">&lt;/data&gt;</span>
1943 </code></pre></div>
1944
1945
1946
1947
1948
1949
1950
1951 </article>
1952 </div>
1953 </div>
1954 </main>
1955
1956
1957 <footer class="md-footer">
1958
1959 <nav class="md-footer__inner md-grid" aria-label="Footer">
1960
1961 <a href="../script/" class="md-footer__link md-footer__link--prev" rel="prev">
1962 <div class="md-footer__button md-icon">
1963 <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>
1964 </div>
1965 <div class="md-footer__title">
1966 <div class="md-ellipsis">
1967 <span class="md-footer__direction">
1968 Previous
1969 </span>
1970 script
1971 </div>
1972 </div>
1973 </a>
1974
1975
1976 <a href="../sql/" class="md-footer__link md-footer__link--next" rel="next">
1977 <div class="md-footer__title">
1978 <div class="md-ellipsis">
1979 <span class="md-footer__direction">
1980 Next
1981 </span>
1982 sql
1983 </div>
1984 </div>
1985 <div class="md-footer__button md-icon">
1986 <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>
1987 </div>
1988 </a>
1989
1990 </nav>
1991
1992 <div class="md-footer-meta md-typeset">
1993 <div class="md-footer-meta__inner md-grid">
1994 <div class="md-footer-copyright">
1995
1996 <div class="md-footer-copyright__highlight">
1997 Copyright © 2020 WoltLab GmbH
1998 </div>
1999
2000 Made with
2001 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2002 Material for MkDocs
2003 </a>
2004
2005 </div>
2006 <div class="md-footer-copyright">
2007 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2008 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2009 </div>
2010 </div>
2011 </div>
2012 </footer>
2013
2014 </div>
2015 <div class="md-dialog" data-md-component="dialog">
2016 <div class="md-dialog__inner md-typeset"></div>
2017 </div>
2018 <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>
2019
2020
2021 <script src="../../../assets/javascripts/bundle.5cf3e710.min.js"></script>
2022
2023
2024 </body>
2025 </html>