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