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