Commit | Line | Data |
---|---|---|
45ca63d0 TD |
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 | ||
fb962f09 | 12 | <link rel="icon" href="../../assets/default.favicon.ico"> |
a4835aa6 | 13 | <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.2"> |
45ca63d0 TD |
14 | |
15 | ||
16 | ||
17 | <title>Apps - WoltLab Suite Documentation</title> | |
18 | ||
19 | ||
20 | ||
a4835aa6 | 21 | <link rel="stylesheet" href="../../assets/stylesheets/main.6f955dcd.min.css"> |
45ca63d0 TD |
22 | |
23 | ||
fb962f09 | 24 | <link rel="stylesheet" href="../../assets/stylesheets/palette.ef6f36e2.min.css"> |
45ca63d0 TD |
25 | |
26 | ||
27 | ||
28 | <meta name="theme-color" content="#009485"> | |
29 | ||
30 | ||
31 | ||
32 | ||
33 | ||
fd8430cb WG |
34 | |
35 | ||
45ca63d0 TD |
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=""> | |
45ca63d0 TD |
53 | |
54 | ||
fb962f09 WG |
55 | <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script> |
56 | ||
45ca63d0 TD |
57 | <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
58 | <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> | |
59 | <label class="md-overlay" for="__drawer"></label> | |
60 | <div data-md-component="skip"> | |
61 | ||
62 | ||
63 | <a href="#apps-for-woltlab-suite" class="md-skip"> | |
64 | Skip to content | |
65 | </a> | |
66 | ||
67 | </div> | |
68 | <div data-md-component="announce"> | |
69 | ||
70 | <aside class="md-announce"> | |
71 | <div class="md-announce__inner md-grid md-typeset"> | |
72 | ||
73 | <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a> | |
74 | ||
75 | </div> | |
76 | </aside> | |
77 | ||
78 | </div> | |
79 | ||
fb962f09 | 80 | <header class="md-header" data-md-component="header"> |
45ca63d0 | 81 | <nav class="md-header__inner md-grid" aria-label="Header"> |
fb962f09 | 82 | <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo"> |
45ca63d0 TD |
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 | Apps | |
101 | ||
102 | </span> | |
103 | </div> | |
104 | </div> | |
45ca63d0 TD |
105 | </div> |
106 | ||
fb962f09 WG |
107 | |
108 | ||
a3639e76 WG |
109 | <label class="md-header__button md-icon" for="__search"> |
110 | <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> | |
111 | </label> | |
112 | ||
113 | <div class="md-search" data-md-component="search" role="dialog"> | |
114 | <label class="md-search__overlay" for="__search"></label> | |
115 | <div class="md-search__inner" role="search"> | |
116 | <form class="md-search__form" name="search"> | |
117 | <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> | |
118 | <label class="md-search__icon md-icon" for="__search"> | |
119 | <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> | |
120 | <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> | |
121 | </label> | |
122 | <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> | |
fb962f09 | 123 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.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> |
a3639e76 WG |
124 | </button> |
125 | </form> | |
126 | <div class="md-search__output"> | |
127 | <div class="md-search__scrollwrap" data-md-scrollfix> | |
128 | <div class="md-search-result" data-md-component="search-result"> | |
129 | <div class="md-search-result__meta"> | |
130 | Initializing search | |
131 | </div> | |
132 | <ol class="md-search-result__list"></ol> | |
133 | </div> | |
134 | </div> | |
135 | </div> | |
136 | </div> | |
137 | </div> | |
138 | ||
45ca63d0 | 139 | |
7124f4cb WG |
140 | <div class="md-header__source"> |
141 | ||
142 | <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source"> | |
143 | <div class="md-source__icon md-icon"> | |
144 | ||
fb962f09 | 145 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 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> |
7124f4cb WG |
146 | </div> |
147 | <div class="md-source__repository"> | |
148 | GitHub | |
149 | </div> | |
150 | </a> | |
151 | </div> | |
152 | ||
45ca63d0 TD |
153 | </nav> |
154 | </header> | |
155 | ||
156 | <div class="md-container" data-md-component="container"> | |
157 | ||
158 | ||
159 | ||
160 | ||
161 | <main class="md-main" data-md-component="main"> | |
162 | <div class="md-main__inner md-grid"> | |
163 | ||
164 | ||
165 | ||
166 | <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > | |
167 | <div class="md-sidebar__scrollwrap"> | |
168 | <div class="md-sidebar__inner"> | |
169 | ||
170 | ||
171 | ||
45ca63d0 TD |
172 | <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> |
173 | <label class="md-nav__title" for="__drawer"> | |
fb962f09 | 174 | <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo"> |
45ca63d0 TD |
175 | |
176 | <img src="../../assets/logo.png" alt="logo"> | |
177 | ||
178 | </a> | |
179 | WoltLab Suite Documentation | |
180 | </label> | |
181 | ||
7124f4cb WG |
182 | <div class="md-nav__source"> |
183 | ||
184 | <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source"> | |
185 | <div class="md-source__icon md-icon"> | |
186 | ||
fb962f09 | 187 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 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> |
7124f4cb WG |
188 | </div> |
189 | <div class="md-source__repository"> | |
190 | GitHub | |
191 | </div> | |
192 | </a> | |
193 | </div> | |
194 | ||
45ca63d0 TD |
195 | <ul class="md-nav__list" data-md-scrollfix> |
196 | ||
197 | ||
198 | ||
199 | ||
200 | ||
201 | ||
202 | ||
203 | ||
204 | <li class="md-nav__item"> | |
205 | <a href="../../getting-started/" class="md-nav__link"> | |
206 | Getting Started | |
207 | </a> | |
208 | </li> | |
209 | ||
210 | ||
211 | ||
212 | ||
213 | ||
214 | ||
215 | ||
216 | ||
217 | ||
218 | ||
219 | ||
220 | ||
221 | ||
222 | <li class="md-nav__item md-nav__item--active md-nav__item--nested"> | |
223 | ||
224 | ||
225 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked> | |
226 | ||
227 | <label class="md-nav__link" for="__nav_2"> | |
228 | PHP API | |
229 | <span class="md-nav__icon md-icon"></span> | |
230 | </label> | |
231 | <nav class="md-nav" aria-label="PHP API" data-md-level="1"> | |
232 | <label class="md-nav__title" for="__nav_2"> | |
233 | <span class="md-nav__icon md-icon"></span> | |
234 | PHP API | |
235 | </label> | |
236 | <ul class="md-nav__list" data-md-scrollfix> | |
237 | ||
238 | ||
239 | ||
240 | ||
241 | ||
242 | <li class="md-nav__item"> | |
243 | <a href="../pages/" class="md-nav__link"> | |
244 | Pages | |
245 | </a> | |
246 | </li> | |
247 | ||
248 | ||
249 | ||
250 | ||
251 | ||
252 | ||
253 | ||
254 | <li class="md-nav__item"> | |
255 | <a href="../database-objects/" class="md-nav__link"> | |
256 | Database Objects | |
257 | </a> | |
258 | </li> | |
259 | ||
260 | ||
261 | ||
262 | ||
263 | ||
264 | ||
265 | ||
266 | <li class="md-nav__item"> | |
267 | <a href="../database-access/" class="md-nav__link"> | |
268 | Database Access | |
269 | </a> | |
270 | </li> | |
271 | ||
272 | ||
273 | ||
274 | ||
275 | ||
276 | ||
277 | ||
278 | <li class="md-nav__item"> | |
279 | <a href="../exceptions/" class="md-nav__link"> | |
280 | Exceptions | |
281 | </a> | |
282 | </li> | |
283 | ||
284 | ||
285 | ||
286 | ||
287 | ||
288 | ||
289 | ||
290 | ||
291 | <li class="md-nav__item md-nav__item--nested"> | |
292 | ||
293 | ||
294 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" > | |
295 | ||
296 | <label class="md-nav__link" for="__nav_2_5"> | |
297 | API | |
298 | <span class="md-nav__icon md-icon"></span> | |
299 | </label> | |
300 | <nav class="md-nav" aria-label="API" data-md-level="2"> | |
301 | <label class="md-nav__title" for="__nav_2_5"> | |
302 | <span class="md-nav__icon md-icon"></span> | |
303 | API | |
304 | </label> | |
305 | <ul class="md-nav__list" data-md-scrollfix> | |
306 | ||
307 | ||
308 | ||
309 | ||
310 | ||
6923e968 WG |
311 | |
312 | <li class="md-nav__item md-nav__item--nested"> | |
313 | ||
314 | ||
315 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" > | |
316 | ||
317 | <label class="md-nav__link" for="__nav_2_5_1"> | |
318 | Caches | |
319 | <span class="md-nav__icon md-icon"></span> | |
320 | </label> | |
321 | <nav class="md-nav" aria-label="Caches" data-md-level="3"> | |
322 | <label class="md-nav__title" for="__nav_2_5_1"> | |
323 | <span class="md-nav__icon md-icon"></span> | |
324 | Caches | |
325 | </label> | |
326 | <ul class="md-nav__list" data-md-scrollfix> | |
327 | ||
328 | ||
329 | ||
330 | ||
331 | ||
45ca63d0 TD |
332 | <li class="md-nav__item"> |
333 | <a href="../api/caches/" class="md-nav__link"> | |
6923e968 WG |
334 | Overview |
335 | </a> | |
336 | </li> | |
337 | ||
338 | ||
339 | ||
340 | ||
341 | ||
342 | ||
343 | ||
344 | <li class="md-nav__item"> | |
345 | <a href="../api/caches_persistent-caches/" class="md-nav__link"> | |
346 | Persistent Caches | |
347 | </a> | |
348 | </li> | |
349 | ||
350 | ||
351 | ||
352 | ||
353 | ||
354 | ||
355 | ||
356 | <li class="md-nav__item"> | |
357 | <a href="../api/caches_runtime-caches/" class="md-nav__link"> | |
358 | Runtime Caches | |
45ca63d0 TD |
359 | </a> |
360 | </li> | |
361 | ||
362 | ||
363 | ||
6923e968 WG |
364 | </ul> |
365 | </nav> | |
366 | </li> | |
367 | ||
368 | ||
369 | ||
45ca63d0 TD |
370 | |
371 | ||
372 | ||
373 | ||
374 | <li class="md-nav__item"> | |
375 | <a href="../api/comments/" class="md-nav__link"> | |
376 | Comments | |
377 | </a> | |
378 | </li> | |
379 | ||
380 | ||
381 | ||
382 | ||
383 | ||
384 | ||
385 | ||
386 | <li class="md-nav__item"> | |
387 | <a href="../api/cronjobs/" class="md-nav__link"> | |
388 | Cronjobs | |
389 | </a> | |
390 | </li> | |
391 | ||
392 | ||
393 | ||
394 | ||
395 | ||
396 | ||
397 | ||
398 | <li class="md-nav__item"> | |
399 | <a href="../api/events/" class="md-nav__link"> | |
400 | Events | |
401 | </a> | |
402 | </li> | |
403 | ||
404 | ||
405 | ||
406 | ||
407 | ||
408 | ||
409 | ||
410 | ||
411 | <li class="md-nav__item md-nav__item--nested"> | |
412 | ||
413 | ||
414 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" > | |
415 | ||
416 | <label class="md-nav__link" for="__nav_2_5_5"> | |
417 | Form Builder | |
418 | <span class="md-nav__icon md-icon"></span> | |
419 | </label> | |
420 | <nav class="md-nav" aria-label="Form Builder" data-md-level="3"> | |
421 | <label class="md-nav__title" for="__nav_2_5_5"> | |
422 | <span class="md-nav__icon md-icon"></span> | |
423 | Form Builder | |
424 | </label> | |
425 | <ul class="md-nav__list" data-md-scrollfix> | |
426 | ||
427 | ||
428 | ||
429 | ||
430 | ||
431 | <li class="md-nav__item"> | |
432 | <a href="../api/form_builder/overview/" class="md-nav__link"> | |
433 | Overview | |
434 | </a> | |
435 | </li> | |
436 | ||
437 | ||
438 | ||
439 | ||
440 | ||
441 | ||
442 | ||
443 | <li class="md-nav__item"> | |
444 | <a href="../api/form_builder/structure/" class="md-nav__link"> | |
445 | Structure | |
446 | </a> | |
447 | </li> | |
448 | ||
449 | ||
450 | ||
451 | ||
452 | ||
453 | ||
454 | ||
455 | <li class="md-nav__item"> | |
456 | <a href="../api/form_builder/form_fields/" class="md-nav__link"> | |
457 | Fields | |
458 | </a> | |
459 | </li> | |
460 | ||
461 | ||
462 | ||
463 | ||
464 | ||
465 | ||
466 | ||
467 | <li class="md-nav__item"> | |
468 | <a href="../api/form_builder/validation_data/" class="md-nav__link"> | |
469 | Validation and Data | |
470 | </a> | |
471 | </li> | |
472 | ||
473 | ||
474 | ||
475 | ||
476 | ||
477 | ||
478 | ||
479 | <li class="md-nav__item"> | |
480 | <a href="../api/form_builder/dependencies/" class="md-nav__link"> | |
481 | Dependencies | |
482 | </a> | |
483 | </li> | |
484 | ||
485 | ||
486 | ||
487 | </ul> | |
488 | </nav> | |
489 | </li> | |
490 | ||
491 | ||
492 | ||
493 | ||
494 | ||
495 | ||
496 | ||
497 | <li class="md-nav__item"> | |
498 | <a href="../api/package_installation_plugins/" class="md-nav__link"> | |
499 | Package Installation Plugins | |
500 | </a> | |
501 | </li> | |
502 | ||
503 | ||
504 | ||
505 | ||
506 | ||
507 | ||
508 | ||
509 | <li class="md-nav__item"> | |
510 | <a href="../api/user_activity_points/" class="md-nav__link"> | |
511 | User Activity Points | |
512 | </a> | |
513 | </li> | |
514 | ||
515 | ||
516 | ||
517 | ||
518 | ||
519 | ||
520 | ||
521 | <li class="md-nav__item"> | |
522 | <a href="../api/user_notifications/" class="md-nav__link"> | |
523 | User Notifications | |
524 | </a> | |
525 | </li> | |
526 | ||
527 | ||
528 | ||
529 | ||
530 | ||
531 | ||
532 | ||
533 | <li class="md-nav__item"> | |
534 | <a href="../api/sitemaps/" class="md-nav__link"> | |
535 | Sitemaps | |
536 | </a> | |
537 | </li> | |
538 | ||
539 | ||
540 | ||
541 | </ul> | |
542 | </nav> | |
543 | </li> | |
544 | ||
545 | ||
546 | ||
547 | ||
548 | ||
549 | ||
550 | ||
551 | <li class="md-nav__item"> | |
552 | <a href="../code-style/" class="md-nav__link"> | |
553 | Code Style | |
554 | </a> | |
555 | </li> | |
556 | ||
557 | ||
558 | ||
559 | ||
560 | ||
561 | ||
562 | ||
563 | ||
564 | ||
565 | <li class="md-nav__item md-nav__item--active"> | |
566 | ||
567 | <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> | |
568 | ||
a4835aa6 | 569 | |
45ca63d0 TD |
570 | |
571 | ||
572 | ||
573 | <label class="md-nav__link md-nav__link--active" for="__toc"> | |
574 | Apps | |
575 | <span class="md-nav__icon md-icon"></span> | |
576 | </label> | |
577 | ||
578 | <a href="./" class="md-nav__link md-nav__link--active"> | |
579 | Apps | |
580 | </a> | |
581 | ||
582 | ||
583 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
584 | ||
585 | ||
a4835aa6 | 586 | |
45ca63d0 TD |
587 | |
588 | ||
589 | ||
590 | <label class="md-nav__title" for="__toc"> | |
591 | <span class="md-nav__icon md-icon"></span> | |
592 | Table of contents | |
593 | </label> | |
594 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
595 | ||
596 | <li class="md-nav__item"> | |
597 | <a href="#introduction" class="md-nav__link"> | |
598 | Introduction | |
599 | </a> | |
600 | ||
601 | </li> | |
602 | ||
603 | <li class="md-nav__item"> | |
604 | <a href="#differences-to-plugins" class="md-nav__link"> | |
605 | Differences to Plugins | |
606 | </a> | |
607 | ||
608 | <nav class="md-nav" aria-label="Differences to Plugins"> | |
609 | <ul class="md-nav__list"> | |
610 | ||
611 | <li class="md-nav__item"> | |
612 | <a href="#unique-namespace" class="md-nav__link"> | |
613 | Unique Namespace | |
614 | </a> | |
615 | ||
616 | </li> | |
617 | ||
618 | <li class="md-nav__item"> | |
619 | <a href="#unique-database-table-prefix" class="md-nav__link"> | |
620 | Unique Database Table Prefix | |
621 | </a> | |
622 | ||
623 | </li> | |
624 | ||
625 | <li class="md-nav__item"> | |
626 | <a href="#separate-domain-and-path-configuration" class="md-nav__link"> | |
627 | Separate Domain and Path Configuration | |
628 | </a> | |
629 | ||
630 | </li> | |
631 | ||
632 | </ul> | |
633 | </nav> | |
634 | ||
635 | </li> | |
636 | ||
637 | <li class="md-nav__item"> | |
638 | <a href="#creating-an-app" class="md-nav__link"> | |
639 | Creating an App | |
640 | </a> | |
641 | ||
642 | <nav class="md-nav" aria-label="Creating an App"> | |
643 | <ul class="md-nav__list"> | |
644 | ||
645 | <li class="md-nav__item"> | |
646 | <a href="#packagexml" class="md-nav__link"> | |
647 | package.xml | |
648 | </a> | |
649 | ||
650 | <nav class="md-nav" aria-label="package.xml"> | |
651 | <ul class="md-nav__list"> | |
652 | ||
653 | <li class="md-nav__item"> | |
654 | <a href="#isapplication1isapplication" class="md-nav__link"> | |
655 | <isapplication>1</isapplication> | |
656 | </a> | |
657 | ||
658 | </li> | |
659 | ||
660 | <li class="md-nav__item"> | |
661 | <a href="#applicationdirectoryexampleapplicationdirectory" class="md-nav__link"> | |
662 | <applicationdirectory>example</applicationdirectory> | |
663 | </a> | |
664 | ||
665 | </li> | |
666 | ||
667 | </ul> | |
668 | </nav> | |
669 | ||
670 | </li> | |
671 | ||
672 | <li class="md-nav__item"> | |
673 | <a href="#minimum-required-files" class="md-nav__link"> | |
674 | Minimum Required Files | |
675 | </a> | |
676 | ||
677 | </li> | |
678 | ||
679 | </ul> | |
680 | </nav> | |
681 | ||
682 | </li> | |
683 | ||
684 | </ul> | |
685 | ||
686 | </nav> | |
687 | ||
688 | </li> | |
689 | ||
690 | ||
691 | ||
692 | ||
693 | ||
694 | ||
695 | ||
696 | <li class="md-nav__item"> | |
697 | <a href="../gdpr/" class="md-nav__link"> | |
698 | GDPR | |
699 | </a> | |
700 | </li> | |
701 | ||
702 | ||
703 | ||
704 | </ul> | |
705 | </nav> | |
706 | </li> | |
707 | ||
708 | ||
709 | ||
710 | ||
711 | ||
712 | ||
713 | ||
714 | ||
715 | ||
716 | ||
717 | ||
718 | <li class="md-nav__item md-nav__item--nested"> | |
719 | ||
720 | ||
721 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" > | |
722 | ||
723 | <label class="md-nav__link" for="__nav_3"> | |
724 | Languages, Templates & CSS | |
725 | <span class="md-nav__icon md-icon"></span> | |
726 | </label> | |
727 | <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1"> | |
728 | <label class="md-nav__title" for="__nav_3"> | |
729 | <span class="md-nav__icon md-icon"></span> | |
730 | Languages, Templates & CSS | |
731 | </label> | |
732 | <ul class="md-nav__list" data-md-scrollfix> | |
733 | ||
734 | ||
735 | ||
736 | ||
737 | ||
738 | <li class="md-nav__item"> | |
739 | <a href="../../view/languages/" class="md-nav__link"> | |
740 | Languages | |
741 | </a> | |
742 | </li> | |
743 | ||
744 | ||
745 | ||
746 | ||
747 | ||
748 | ||
749 | ||
750 | <li class="md-nav__item"> | |
751 | <a href="../../view/templates/" class="md-nav__link"> | |
752 | Templates | |
753 | </a> | |
754 | </li> | |
755 | ||
756 | ||
757 | ||
758 | ||
759 | ||
760 | ||
761 | ||
6923e968 WG |
762 | <li class="md-nav__item"> |
763 | <a href="../../view/template-plugins/" class="md-nav__link"> | |
764 | Template Plugins | |
765 | </a> | |
766 | </li> | |
767 | ||
768 | ||
769 | ||
770 | ||
771 | ||
772 | ||
773 | ||
45ca63d0 TD |
774 | <li class="md-nav__item"> |
775 | <a href="../../view/css/" class="md-nav__link"> | |
776 | CSS | |
777 | </a> | |
778 | </li> | |
779 | ||
780 | ||
781 | ||
782 | </ul> | |
783 | </nav> | |
784 | </li> | |
785 | ||
786 | ||
787 | ||
788 | ||
789 | ||
790 | ||
791 | ||
792 | ||
793 | ||
794 | ||
795 | ||
796 | <li class="md-nav__item md-nav__item--nested"> | |
797 | ||
798 | ||
799 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > | |
800 | ||
801 | <label class="md-nav__link" for="__nav_4"> | |
77efcd46 | 802 | TypeScript and JavaScript API |
45ca63d0 TD |
803 | <span class="md-nav__icon md-icon"></span> |
804 | </label> | |
77efcd46 | 805 | <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1"> |
45ca63d0 TD |
806 | <label class="md-nav__title" for="__nav_4"> |
807 | <span class="md-nav__icon md-icon"></span> | |
77efcd46 | 808 | TypeScript and JavaScript API |
45ca63d0 TD |
809 | </label> |
810 | <ul class="md-nav__list" data-md-scrollfix> | |
811 | ||
812 | ||
813 | ||
814 | ||
815 | ||
816 | <li class="md-nav__item"> | |
817 | <a href="../../javascript/general-usage/" class="md-nav__link"> | |
818 | General Usage | |
819 | </a> | |
820 | </li> | |
821 | ||
822 | ||
823 | ||
824 | ||
825 | ||
826 | ||
827 | ||
77efcd46 WG |
828 | <li class="md-nav__item"> |
829 | <a href="../../javascript/typescript/" class="md-nav__link"> | |
830 | TypeScript | |
831 | </a> | |
832 | </li> | |
833 | ||
834 | ||
835 | ||
836 | ||
837 | ||
838 | ||
839 | ||
45ca63d0 TD |
840 | |
841 | <li class="md-nav__item md-nav__item--nested"> | |
842 | ||
843 | ||
77efcd46 | 844 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" > |
45ca63d0 | 845 | |
77efcd46 | 846 | <label class="md-nav__link" for="__nav_4_3"> |
45ca63d0 TD |
847 | New API |
848 | <span class="md-nav__icon md-icon"></span> | |
849 | </label> | |
850 | <nav class="md-nav" aria-label="New API" data-md-level="2"> | |
77efcd46 | 851 | <label class="md-nav__title" for="__nav_4_3"> |
45ca63d0 TD |
852 | <span class="md-nav__icon md-icon"></span> |
853 | New API | |
854 | </label> | |
855 | <ul class="md-nav__list" data-md-scrollfix> | |
856 | ||
857 | ||
858 | ||
859 | ||
860 | ||
861 | <li class="md-nav__item"> | |
862 | <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link"> | |
863 | Writing a module | |
864 | </a> | |
865 | </li> | |
866 | ||
867 | ||
868 | ||
869 | ||
870 | ||
871 | ||
872 | ||
873 | <li class="md-nav__item"> | |
874 | <a href="../../javascript/new-api_data-structures/" class="md-nav__link"> | |
875 | Data Structures | |
876 | </a> | |
877 | </li> | |
878 | ||
879 | ||
880 | ||
881 | ||
882 | ||
883 | ||
884 | ||
885 | <li class="md-nav__item"> | |
886 | <a href="../../javascript/new-api_core/" class="md-nav__link"> | |
887 | Core Functions | |
888 | </a> | |
889 | </li> | |
890 | ||
891 | ||
892 | ||
893 | ||
894 | ||
895 | ||
896 | ||
897 | <li class="md-nav__item"> | |
898 | <a href="../../javascript/new-api_dom/" class="md-nav__link"> | |
899 | DOM | |
900 | </a> | |
901 | </li> | |
902 | ||
903 | ||
904 | ||
905 | ||
906 | ||
907 | ||
908 | ||
909 | <li class="md-nav__item"> | |
910 | <a href="../../javascript/new-api_events/" class="md-nav__link"> | |
911 | Event Handling | |
912 | </a> | |
913 | </li> | |
914 | ||
915 | ||
916 | ||
917 | ||
918 | ||
919 | ||
920 | ||
921 | <li class="md-nav__item"> | |
922 | <a href="../../javascript/new-api_ajax/" class="md-nav__link"> | |
923 | Ajax | |
924 | </a> | |
925 | </li> | |
926 | ||
927 | ||
928 | ||
929 | ||
930 | ||
931 | ||
932 | ||
933 | <li class="md-nav__item"> | |
934 | <a href="../../javascript/new-api_dialogs/" class="md-nav__link"> | |
935 | Dialogs | |
936 | </a> | |
937 | </li> | |
938 | ||
939 | ||
940 | ||
941 | ||
942 | ||
943 | ||
944 | ||
945 | <li class="md-nav__item"> | |
946 | <a href="../../javascript/new-api_browser/" class="md-nav__link"> | |
947 | Browser and Screen Sizes | |
948 | </a> | |
949 | </li> | |
950 | ||
951 | ||
952 | ||
953 | ||
954 | ||
955 | ||
956 | ||
957 | <li class="md-nav__item"> | |
958 | <a href="../../javascript/new-api_ui/" class="md-nav__link"> | |
959 | User Interface | |
960 | </a> | |
961 | </li> | |
962 | ||
963 | ||
964 | ||
965 | </ul> | |
966 | </nav> | |
967 | </li> | |
968 | ||
969 | ||
970 | ||
971 | ||
972 | ||
973 | ||
974 | ||
975 | <li class="md-nav__item"> | |
976 | <a href="../../javascript/legacy-api/" class="md-nav__link"> | |
977 | Legacy API | |
978 | </a> | |
979 | </li> | |
980 | ||
981 | ||
982 | ||
983 | ||
984 | ||
985 | ||
986 | ||
987 | <li class="md-nav__item"> | |
988 | <a href="../../javascript/helper-functions/" class="md-nav__link"> | |
989 | Helper Functions | |
990 | </a> | |
991 | </li> | |
992 | ||
993 | ||
994 | ||
995 | ||
996 | ||
997 | ||
998 | ||
999 | <li class="md-nav__item"> | |
1000 | <a href="../../javascript/code-snippets/" class="md-nav__link"> | |
1001 | Code Snippets | |
1002 | </a> | |
1003 | </li> | |
1004 | ||
1005 | ||
1006 | ||
1007 | </ul> | |
1008 | </nav> | |
1009 | </li> | |
1010 | ||
1011 | ||
1012 | ||
1013 | ||
1014 | ||
1015 | ||
1016 | ||
1017 | ||
1018 | ||
1019 | ||
1020 | ||
1021 | <li class="md-nav__item md-nav__item--nested"> | |
1022 | ||
1023 | ||
1024 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > | |
1025 | ||
1026 | <label class="md-nav__link" for="__nav_5"> | |
1027 | Package Components | |
1028 | <span class="md-nav__icon md-icon"></span> | |
1029 | </label> | |
1030 | <nav class="md-nav" aria-label="Package Components" data-md-level="1"> | |
1031 | <label class="md-nav__title" for="__nav_5"> | |
1032 | <span class="md-nav__icon md-icon"></span> | |
1033 | Package Components | |
1034 | </label> | |
1035 | <ul class="md-nav__list" data-md-scrollfix> | |
1036 | ||
1037 | ||
1038 | ||
1039 | ||
1040 | ||
1041 | <li class="md-nav__item"> | |
1042 | <a href="../../package/package-xml/" class="md-nav__link"> | |
1043 | package.xml | |
1044 | </a> | |
1045 | </li> | |
1046 | ||
1047 | ||
1048 | ||
1049 | ||
1050 | ||
1051 | ||
1052 | ||
1053 | ||
1054 | <li class="md-nav__item md-nav__item--nested"> | |
1055 | ||
1056 | ||
1057 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" > | |
1058 | ||
1059 | <label class="md-nav__link" for="__nav_5_2"> | |
1060 | PIPs | |
1061 | <span class="md-nav__icon md-icon"></span> | |
1062 | </label> | |
1063 | <nav class="md-nav" aria-label="PIPs" data-md-level="2"> | |
1064 | <label class="md-nav__title" for="__nav_5_2"> | |
1065 | <span class="md-nav__icon md-icon"></span> | |
1066 | PIPs | |
1067 | </label> | |
1068 | <ul class="md-nav__list" data-md-scrollfix> | |
1069 | ||
1070 | ||
1071 | ||
1072 | ||
1073 | ||
1074 | <li class="md-nav__item"> | |
1075 | <a href="../../package/pip/" class="md-nav__link"> | |
1076 | Overview | |
1077 | </a> | |
1078 | </li> | |
1079 | ||
1080 | ||
1081 | ||
1082 | ||
1083 | ||
1084 | ||
1085 | ||
1086 | <li class="md-nav__item"> | |
1087 | <a href="../../package/pip/acl-option/" class="md-nav__link"> | |
1088 | aclOption | |
1089 | </a> | |
1090 | </li> | |
1091 | ||
1092 | ||
1093 | ||
1094 | ||
1095 | ||
1096 | ||
1097 | ||
1098 | <li class="md-nav__item"> | |
1099 | <a href="../../package/pip/acp-menu/" class="md-nav__link"> | |
1100 | acpMenu | |
1101 | </a> | |
1102 | </li> | |
1103 | ||
1104 | ||
1105 | ||
1106 | ||
1107 | ||
1108 | ||
1109 | ||
1110 | <li class="md-nav__item"> | |
1111 | <a href="../../package/pip/acp-search-provider/" class="md-nav__link"> | |
1112 | acpSearchProvider | |
1113 | </a> | |
1114 | </li> | |
1115 | ||
1116 | ||
1117 | ||
1118 | ||
1119 | ||
1120 | ||
1121 | ||
1122 | <li class="md-nav__item"> | |
1123 | <a href="../../package/pip/acp-template/" class="md-nav__link"> | |
1124 | acpTemplate | |
1125 | </a> | |
1126 | </li> | |
1127 | ||
1128 | ||
1129 | ||
1130 | ||
1131 | ||
1132 | ||
1133 | ||
1134 | <li class="md-nav__item"> | |
1135 | <a href="../../package/pip/bbcode/" class="md-nav__link"> | |
1136 | bbcode | |
1137 | </a> | |
1138 | </li> | |
1139 | ||
1140 | ||
1141 | ||
1142 | ||
1143 | ||
1144 | ||
1145 | ||
1146 | <li class="md-nav__item"> | |
1147 | <a href="../../package/pip/box/" class="md-nav__link"> | |
1148 | box | |
1149 | </a> | |
1150 | </li> | |
1151 | ||
1152 | ||
1153 | ||
1154 | ||
1155 | ||
1156 | ||
1157 | ||
1158 | <li class="md-nav__item"> | |
1159 | <a href="../../package/pip/clipboard-action/" class="md-nav__link"> | |
1160 | clipboardAction | |
1161 | </a> | |
1162 | </li> | |
1163 | ||
1164 | ||
1165 | ||
1166 | ||
1167 | ||
1168 | ||
1169 | ||
1170 | <li class="md-nav__item"> | |
1171 | <a href="../../package/pip/core-object/" class="md-nav__link"> | |
1172 | coreObject | |
1173 | </a> | |
1174 | </li> | |
1175 | ||
1176 | ||
1177 | ||
1178 | ||
1179 | ||
1180 | ||
1181 | ||
1182 | <li class="md-nav__item"> | |
1183 | <a href="../../package/pip/cronjob/" class="md-nav__link"> | |
1184 | cronjob | |
1185 | </a> | |
1186 | </li> | |
1187 | ||
1188 | ||
1189 | ||
1190 | ||
1191 | ||
1192 | ||
1193 | ||
6923e968 WG |
1194 | <li class="md-nav__item"> |
1195 | <a href="../../package/pip/database/" class="md-nav__link"> | |
1196 | database | |
1197 | </a> | |
1198 | </li> | |
1199 | ||
1200 | ||
1201 | ||
1202 | ||
1203 | ||
1204 | ||
1205 | ||
45ca63d0 TD |
1206 | <li class="md-nav__item"> |
1207 | <a href="../../package/pip/event-listener/" class="md-nav__link"> | |
1208 | eventListener | |
1209 | </a> | |
1210 | </li> | |
1211 | ||
1212 | ||
1213 | ||
1214 | ||
1215 | ||
1216 | ||
1217 | ||
1218 | <li class="md-nav__item"> | |
1219 | <a href="../../package/pip/file/" class="md-nav__link"> | |
1220 | file | |
1221 | </a> | |
1222 | </li> | |
1223 | ||
1224 | ||
1225 | ||
1226 | ||
1227 | ||
1228 | ||
1229 | ||
1230 | <li class="md-nav__item"> | |
1231 | <a href="../../package/pip/language/" class="md-nav__link"> | |
1232 | language | |
1233 | </a> | |
1234 | </li> | |
1235 | ||
1236 | ||
1237 | ||
1238 | ||
1239 | ||
1240 | ||
1241 | ||
1242 | <li class="md-nav__item"> | |
1243 | <a href="../../package/pip/media-provider/" class="md-nav__link"> | |
1244 | mediaProvider | |
1245 | </a> | |
1246 | </li> | |
1247 | ||
1248 | ||
1249 | ||
1250 | ||
1251 | ||
1252 | ||
1253 | ||
1254 | <li class="md-nav__item"> | |
1255 | <a href="../../package/pip/menu/" class="md-nav__link"> | |
1256 | menu | |
1257 | </a> | |
1258 | </li> | |
1259 | ||
1260 | ||
1261 | ||
1262 | ||
1263 | ||
1264 | ||
1265 | ||
1266 | <li class="md-nav__item"> | |
1267 | <a href="../../package/pip/menu-item/" class="md-nav__link"> | |
1268 | menuItem | |
1269 | </a> | |
1270 | </li> | |
1271 | ||
1272 | ||
1273 | ||
1274 | ||
1275 | ||
1276 | ||
1277 | ||
1278 | <li class="md-nav__item"> | |
1279 | <a href="../../package/pip/object-type/" class="md-nav__link"> | |
1280 | objectType | |
1281 | </a> | |
1282 | </li> | |
1283 | ||
1284 | ||
1285 | ||
1286 | ||
1287 | ||
1288 | ||
1289 | ||
1290 | <li class="md-nav__item"> | |
1291 | <a href="../../package/pip/object-type-definition/" class="md-nav__link"> | |
1292 | objectTypeDefinition | |
1293 | </a> | |
1294 | </li> | |
1295 | ||
1296 | ||
1297 | ||
1298 | ||
1299 | ||
1300 | ||
1301 | ||
1302 | <li class="md-nav__item"> | |
1303 | <a href="../../package/pip/option/" class="md-nav__link"> | |
1304 | option | |
1305 | </a> | |
1306 | </li> | |
1307 | ||
1308 | ||
1309 | ||
1310 | ||
1311 | ||
1312 | ||
1313 | ||
1314 | <li class="md-nav__item"> | |
1315 | <a href="../../package/pip/page/" class="md-nav__link"> | |
1316 | page | |
1317 | </a> | |
1318 | </li> | |
1319 | ||
1320 | ||
1321 | ||
1322 | ||
1323 | ||
1324 | ||
1325 | ||
1326 | <li class="md-nav__item"> | |
1327 | <a href="../../package/pip/pip/" class="md-nav__link"> | |
1328 | pip | |
1329 | </a> | |
1330 | </li> | |
1331 | ||
1332 | ||
1333 | ||
1334 | ||
1335 | ||
1336 | ||
1337 | ||
1338 | <li class="md-nav__item"> | |
1339 | <a href="../../package/pip/script/" class="md-nav__link"> | |
1340 | script | |
1341 | </a> | |
1342 | </li> | |
1343 | ||
1344 | ||
1345 | ||
1346 | ||
1347 | ||
1348 | ||
1349 | ||
1350 | <li class="md-nav__item"> | |
1351 | <a href="../../package/pip/smiley/" class="md-nav__link"> | |
1352 | smiley | |
1353 | </a> | |
1354 | </li> | |
1355 | ||
1356 | ||
1357 | ||
1358 | ||
1359 | ||
1360 | ||
1361 | ||
1362 | <li class="md-nav__item"> | |
1363 | <a href="../../package/pip/sql/" class="md-nav__link"> | |
1364 | sql | |
1365 | </a> | |
1366 | </li> | |
1367 | ||
1368 | ||
1369 | ||
1370 | ||
1371 | ||
1372 | ||
1373 | ||
1374 | <li class="md-nav__item"> | |
1375 | <a href="../../package/pip/style/" class="md-nav__link"> | |
1376 | style | |
1377 | </a> | |
1378 | </li> | |
1379 | ||
1380 | ||
1381 | ||
1382 | ||
1383 | ||
1384 | ||
1385 | ||
1386 | <li class="md-nav__item"> | |
1387 | <a href="../../package/pip/template/" class="md-nav__link"> | |
1388 | template | |
1389 | </a> | |
1390 | </li> | |
1391 | ||
1392 | ||
1393 | ||
1394 | ||
1395 | ||
1396 | ||
1397 | ||
1398 | <li class="md-nav__item"> | |
1399 | <a href="../../package/pip/template-listener/" class="md-nav__link"> | |
1400 | templateListener | |
1401 | </a> | |
1402 | </li> | |
1403 | ||
1404 | ||
1405 | ||
1406 | ||
1407 | ||
1408 | ||
1409 | ||
1410 | <li class="md-nav__item"> | |
1411 | <a href="../../package/pip/user-group-option/" class="md-nav__link"> | |
1412 | userGroupOption | |
1413 | </a> | |
1414 | </li> | |
1415 | ||
1416 | ||
1417 | ||
1418 | ||
1419 | ||
1420 | ||
1421 | ||
1422 | <li class="md-nav__item"> | |
1423 | <a href="../../package/pip/user-menu/" class="md-nav__link"> | |
1424 | userMenu | |
1425 | </a> | |
1426 | </li> | |
1427 | ||
1428 | ||
1429 | ||
1430 | ||
1431 | ||
1432 | ||
1433 | ||
1434 | <li class="md-nav__item"> | |
1435 | <a href="../../package/pip/user-notification-event/" class="md-nav__link"> | |
1436 | userNotificationEvent | |
1437 | </a> | |
1438 | </li> | |
1439 | ||
1440 | ||
1441 | ||
1442 | ||
1443 | ||
1444 | ||
1445 | ||
1446 | <li class="md-nav__item"> | |
1447 | <a href="../../package/pip/user-option/" class="md-nav__link"> | |
1448 | userOption | |
1449 | </a> | |
1450 | </li> | |
1451 | ||
1452 | ||
1453 | ||
1454 | ||
1455 | ||
1456 | ||
1457 | ||
1458 | <li class="md-nav__item"> | |
1459 | <a href="../../package/pip/user-profile-menu/" class="md-nav__link"> | |
1460 | userProfileMenu | |
1461 | </a> | |
1462 | </li> | |
1463 | ||
1464 | ||
1465 | ||
1466 | </ul> | |
1467 | </nav> | |
1468 | </li> | |
1469 | ||
1470 | ||
1471 | ||
1472 | ||
1473 | ||
1474 | ||
1475 | ||
1476 | <li class="md-nav__item"> | |
1477 | <a href="../../package/database-php-api/" class="md-nav__link"> | |
1478 | Database PHP API | |
1479 | </a> | |
1480 | </li> | |
1481 | ||
1482 | ||
1483 | ||
1484 | </ul> | |
1485 | </nav> | |
1486 | </li> | |
1487 | ||
1488 | ||
1489 | ||
1490 | ||
1491 | ||
1492 | ||
1493 | ||
1494 | ||
1495 | ||
1496 | ||
1497 | ||
1498 | <li class="md-nav__item md-nav__item--nested"> | |
1499 | ||
1500 | ||
1501 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > | |
1502 | ||
1503 | <label class="md-nav__link" for="__nav_6"> | |
1504 | Migration | |
1505 | <span class="md-nav__icon md-icon"></span> | |
1506 | </label> | |
1507 | <nav class="md-nav" aria-label="Migration" data-md-level="1"> | |
1508 | <label class="md-nav__title" for="__nav_6"> | |
1509 | <span class="md-nav__icon md-icon"></span> | |
1510 | Migration | |
1511 | </label> | |
1512 | <ul class="md-nav__list" data-md-scrollfix> | |
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_1" type="checkbox" id="__nav_6_1" > | |
1523 | ||
1524 | <label class="md-nav__link" for="__nav_6_1"> | |
1525 | Migrating from WSC 5.3 | |
1526 | <span class="md-nav__icon md-icon"></span> | |
1527 | </label> | |
1528 | <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2"> | |
1529 | <label class="md-nav__title" for="__nav_6_1"> | |
1530 | <span class="md-nav__icon md-icon"></span> | |
1531 | Migrating from WSC 5.3 | |
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/wsc53/php/" class="md-nav__link"> | |
1541 | PHP API | |
1542 | </a> | |
1543 | </li> | |
1544 | ||
1545 | ||
1546 | ||
1547 | ||
1548 | ||
1549 | ||
1550 | ||
1551 | <li class="md-nav__item"> | |
1552 | <a href="../../migration/wsc53/session/" class="md-nav__link"> | |
1553 | Session Handling and Authentication | |
1554 | </a> | |
1555 | </li> | |
1556 | ||
1557 | ||
1558 | ||
1559 | ||
1560 | ||
1561 | ||
1562 | ||
1563 | <li class="md-nav__item"> | |
1564 | <a href="../../migration/wsc53/javascript/" class="md-nav__link"> | |
77efcd46 | 1565 | TypeScript and JavaScript |
45ca63d0 TD |
1566 | </a> |
1567 | </li> | |
1568 | ||
1569 | ||
1570 | ||
1571 | ||
1572 | ||
1573 | ||
1574 | ||
1575 | <li class="md-nav__item"> | |
1576 | <a href="../../migration/wsc53/templates/" class="md-nav__link"> | |
1577 | Templates | |
1578 | </a> | |
1579 | </li> | |
1580 | ||
1581 | ||
1582 | ||
1583 | ||
1584 | ||
1585 | ||
1586 | ||
1587 | <li class="md-nav__item"> | |
1588 | <a href="../../migration/wsc53/libraries/" class="md-nav__link"> | |
1589 | Third Party Libraries | |
1590 | </a> | |
1591 | </li> | |
1592 | ||
1593 | ||
1594 | ||
1595 | </ul> | |
1596 | </nav> | |
1597 | </li> | |
1598 | ||
1599 | ||
1600 | ||
1601 | ||
1602 | ||
1603 | ||
1604 | ||
1605 | ||
1606 | <li class="md-nav__item md-nav__item--nested"> | |
1607 | ||
1608 | ||
1609 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" > | |
1610 | ||
1611 | <label class="md-nav__link" for="__nav_6_2"> | |
1612 | Migrating from WSC 5.2 | |
1613 | <span class="md-nav__icon md-icon"></span> | |
1614 | </label> | |
1615 | <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2"> | |
1616 | <label class="md-nav__title" for="__nav_6_2"> | |
1617 | <span class="md-nav__icon md-icon"></span> | |
1618 | Migrating from WSC 5.2 | |
1619 | </label> | |
1620 | <ul class="md-nav__list" data-md-scrollfix> | |
1621 | ||
1622 | ||
1623 | ||
1624 | ||
1625 | ||
1626 | <li class="md-nav__item"> | |
1627 | <a href="../../migration/wsc52/php/" class="md-nav__link"> | |
1628 | PHP API | |
1629 | </a> | |
1630 | </li> | |
1631 | ||
1632 | ||
1633 | ||
1634 | ||
1635 | ||
1636 | ||
1637 | ||
1638 | <li class="md-nav__item"> | |
1639 | <a href="../../migration/wsc52/templates/" class="md-nav__link"> | |
1640 | Templates and Languages | |
1641 | </a> | |
1642 | </li> | |
1643 | ||
1644 | ||
1645 | ||
1646 | ||
1647 | ||
1648 | ||
1649 | ||
1650 | <li class="md-nav__item"> | |
1651 | <a href="../../migration/wsc52/libraries/" class="md-nav__link"> | |
1652 | Third Party Libraries | |
1653 | </a> | |
1654 | </li> | |
1655 | ||
1656 | ||
1657 | ||
1658 | </ul> | |
1659 | </nav> | |
1660 | </li> | |
1661 | ||
1662 | ||
1663 | ||
1664 | ||
1665 | ||
1666 | ||
1667 | ||
1668 | ||
1669 | <li class="md-nav__item md-nav__item--nested"> | |
1670 | ||
1671 | ||
1672 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" > | |
1673 | ||
1674 | <label class="md-nav__link" for="__nav_6_3"> | |
1675 | Migrating from WSC 3.1 | |
1676 | <span class="md-nav__icon md-icon"></span> | |
1677 | </label> | |
1678 | <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2"> | |
1679 | <label class="md-nav__title" for="__nav_6_3"> | |
1680 | <span class="md-nav__icon md-icon"></span> | |
1681 | Migrating from WSC 3.1 | |
1682 | </label> | |
1683 | <ul class="md-nav__list" data-md-scrollfix> | |
1684 | ||
1685 | ||
1686 | ||
1687 | ||
1688 | ||
1689 | <li class="md-nav__item"> | |
1690 | <a href="../../migration/wsc31/php/" class="md-nav__link"> | |
1691 | PHP API | |
1692 | </a> | |
1693 | </li> | |
1694 | ||
1695 | ||
1696 | ||
1697 | </ul> | |
1698 | </nav> | |
1699 | </li> | |
1700 | ||
1701 | ||
1702 | ||
1703 | ||
1704 | ||
1705 | ||
1706 | ||
1707 | ||
1708 | <li class="md-nav__item md-nav__item--nested"> | |
1709 | ||
1710 | ||
1711 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" > | |
1712 | ||
1713 | <label class="md-nav__link" for="__nav_6_4"> | |
1714 | Migrating from WSC 3.0 | |
1715 | <span class="md-nav__icon md-icon"></span> | |
1716 | </label> | |
1717 | <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2"> | |
1718 | <label class="md-nav__title" for="__nav_6_4"> | |
1719 | <span class="md-nav__icon md-icon"></span> | |
1720 | Migrating from WSC 3.0 | |
1721 | </label> | |
1722 | <ul class="md-nav__list" data-md-scrollfix> | |
1723 | ||
1724 | ||
1725 | ||
1726 | ||
1727 | ||
1728 | <li class="md-nav__item"> | |
1729 | <a href="../../migration/wsc30/php/" class="md-nav__link"> | |
1730 | PHP API | |
1731 | </a> | |
1732 | </li> | |
1733 | ||
1734 | ||
1735 | ||
1736 | ||
1737 | ||
1738 | ||
1739 | ||
1740 | <li class="md-nav__item"> | |
1741 | <a href="../../migration/wsc30/javascript/" class="md-nav__link"> | |
1742 | JavaScript API | |
1743 | </a> | |
1744 | </li> | |
1745 | ||
1746 | ||
1747 | ||
1748 | ||
1749 | ||
1750 | ||
1751 | ||
1752 | <li class="md-nav__item"> | |
1753 | <a href="../../migration/wsc30/templates/" class="md-nav__link"> | |
1754 | Templates | |
1755 | </a> | |
1756 | </li> | |
1757 | ||
1758 | ||
1759 | ||
1760 | ||
1761 | ||
1762 | ||
1763 | ||
1764 | <li class="md-nav__item"> | |
1765 | <a href="../../migration/wsc30/css/" class="md-nav__link"> | |
1766 | CSS | |
1767 | </a> | |
1768 | </li> | |
1769 | ||
1770 | ||
1771 | ||
1772 | ||
1773 | ||
1774 | ||
1775 | ||
1776 | <li class="md-nav__item"> | |
1777 | <a href="../../migration/wsc30/package/" class="md-nav__link"> | |
1778 | Package Components | |
1779 | </a> | |
1780 | </li> | |
1781 | ||
1782 | ||
1783 | ||
1784 | </ul> | |
1785 | </nav> | |
1786 | </li> | |
1787 | ||
1788 | ||
1789 | ||
1790 | ||
1791 | ||
1792 | ||
1793 | ||
1794 | ||
1795 | <li class="md-nav__item md-nav__item--nested"> | |
1796 | ||
1797 | ||
1798 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" > | |
1799 | ||
1800 | <label class="md-nav__link" for="__nav_6_5"> | |
1801 | Migrating from WCF 2.1 | |
1802 | <span class="md-nav__icon md-icon"></span> | |
1803 | </label> | |
1804 | <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2"> | |
1805 | <label class="md-nav__title" for="__nav_6_5"> | |
1806 | <span class="md-nav__icon md-icon"></span> | |
1807 | Migrating from WCF 2.1 | |
1808 | </label> | |
1809 | <ul class="md-nav__list" data-md-scrollfix> | |
1810 | ||
1811 | ||
1812 | ||
1813 | ||
1814 | ||
1815 | <li class="md-nav__item"> | |
1816 | <a href="../../migration/wcf21/php/" class="md-nav__link"> | |
1817 | PHP API | |
1818 | </a> | |
1819 | </li> | |
1820 | ||
1821 | ||
1822 | ||
1823 | ||
1824 | ||
1825 | ||
1826 | ||
1827 | <li class="md-nav__item"> | |
1828 | <a href="../../migration/wcf21/templates/" class="md-nav__link"> | |
1829 | Templates | |
1830 | </a> | |
1831 | </li> | |
1832 | ||
1833 | ||
1834 | ||
1835 | ||
1836 | ||
1837 | ||
1838 | ||
1839 | <li class="md-nav__item"> | |
1840 | <a href="../../migration/wcf21/css/" class="md-nav__link"> | |
1841 | CSS | |
1842 | </a> | |
1843 | </li> | |
1844 | ||
1845 | ||
1846 | ||
1847 | ||
1848 | ||
1849 | ||
1850 | ||
1851 | <li class="md-nav__item"> | |
1852 | <a href="../../migration/wcf21/package/" class="md-nav__link"> | |
1853 | Package Components | |
1854 | </a> | |
1855 | </li> | |
1856 | ||
1857 | ||
1858 | ||
1859 | </ul> | |
1860 | </nav> | |
1861 | </li> | |
1862 | ||
1863 | ||
1864 | ||
1865 | </ul> | |
1866 | </nav> | |
1867 | </li> | |
1868 | ||
1869 | ||
1870 | ||
1871 | ||
1872 | ||
1873 | ||
1874 | ||
1875 | ||
1876 | ||
1877 | ||
1878 | ||
1879 | <li class="md-nav__item md-nav__item--nested"> | |
1880 | ||
1881 | ||
1882 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > | |
1883 | ||
1884 | <label class="md-nav__link" for="__nav_7"> | |
1885 | Tutorials | |
1886 | <span class="md-nav__icon md-icon"></span> | |
1887 | </label> | |
1888 | <nav class="md-nav" aria-label="Tutorials" data-md-level="1"> | |
1889 | <label class="md-nav__title" for="__nav_7"> | |
1890 | <span class="md-nav__icon md-icon"></span> | |
1891 | Tutorials | |
1892 | </label> | |
1893 | <ul class="md-nav__list" data-md-scrollfix> | |
1894 | ||
1895 | ||
1896 | ||
1897 | ||
1898 | ||
1899 | ||
1900 | <li class="md-nav__item md-nav__item--nested"> | |
1901 | ||
1902 | ||
1903 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" > | |
1904 | ||
1905 | <label class="md-nav__link" for="__nav_7_1"> | |
1906 | Tutorial Series | |
1907 | <span class="md-nav__icon md-icon"></span> | |
1908 | </label> | |
1909 | <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2"> | |
1910 | <label class="md-nav__title" for="__nav_7_1"> | |
1911 | <span class="md-nav__icon md-icon"></span> | |
1912 | Tutorial Series | |
1913 | </label> | |
1914 | <ul class="md-nav__list" data-md-scrollfix> | |
1915 | ||
1916 | ||
1917 | ||
1918 | ||
1919 | ||
1920 | <li class="md-nav__item"> | |
1921 | <a href="../../tutorial/series/overview/" class="md-nav__link"> | |
1922 | Overview | |
1923 | </a> | |
1924 | </li> | |
1925 | ||
1926 | ||
1927 | ||
1928 | ||
1929 | ||
1930 | ||
1931 | ||
1932 | <li class="md-nav__item"> | |
1933 | <a href="../../tutorial/series/part_1/" class="md-nav__link"> | |
1934 | Part 1 | |
1935 | </a> | |
1936 | </li> | |
1937 | ||
1938 | ||
1939 | ||
1940 | ||
1941 | ||
1942 | ||
1943 | ||
1944 | <li class="md-nav__item"> | |
1945 | <a href="../../tutorial/series/part_2/" class="md-nav__link"> | |
1946 | Part 2 | |
1947 | </a> | |
1948 | </li> | |
1949 | ||
1950 | ||
1951 | ||
1952 | ||
1953 | ||
1954 | ||
1955 | ||
1956 | <li class="md-nav__item"> | |
1957 | <a href="../../tutorial/series/part_3/" class="md-nav__link"> | |
1958 | Part 3 | |
1959 | </a> | |
1960 | </li> | |
1961 | ||
1962 | ||
1963 | ||
41eda543 WG |
1964 | |
1965 | ||
1966 | ||
1967 | ||
1968 | <li class="md-nav__item"> | |
1969 | <a href="../../tutorial/series/part_4/" class="md-nav__link"> | |
1970 | Part 4 | |
1971 | </a> | |
1972 | </li> | |
1973 | ||
1974 | ||
1975 | ||
716a4ab6 WG |
1976 | |
1977 | ||
1978 | ||
1979 | ||
1980 | <li class="md-nav__item"> | |
1981 | <a href="../../tutorial/series/part_5/" class="md-nav__link"> | |
1982 | Part 5 | |
1983 | </a> | |
1984 | </li> | |
1985 | ||
1986 | ||
1987 | ||
45ca63d0 TD |
1988 | </ul> |
1989 | </nav> | |
1990 | </li> | |
1991 | ||
1992 | ||
1993 | ||
1994 | </ul> | |
1995 | </nav> | |
1996 | </li> | |
1997 | ||
1998 | ||
1999 | ||
2000 | </ul> | |
2001 | </nav> | |
2002 | </div> | |
2003 | </div> | |
2004 | </div> | |
2005 | ||
2006 | ||
2007 | ||
2008 | <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > | |
2009 | <div class="md-sidebar__scrollwrap"> | |
2010 | <div class="md-sidebar__inner"> | |
2011 | ||
2012 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
2013 | ||
2014 | ||
a4835aa6 | 2015 | |
45ca63d0 TD |
2016 | |
2017 | ||
2018 | ||
2019 | <label class="md-nav__title" for="__toc"> | |
2020 | <span class="md-nav__icon md-icon"></span> | |
2021 | Table of contents | |
2022 | </label> | |
2023 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
2024 | ||
2025 | <li class="md-nav__item"> | |
2026 | <a href="#introduction" class="md-nav__link"> | |
2027 | Introduction | |
2028 | </a> | |
2029 | ||
2030 | </li> | |
2031 | ||
2032 | <li class="md-nav__item"> | |
2033 | <a href="#differences-to-plugins" class="md-nav__link"> | |
2034 | Differences to Plugins | |
2035 | </a> | |
2036 | ||
2037 | <nav class="md-nav" aria-label="Differences to Plugins"> | |
2038 | <ul class="md-nav__list"> | |
2039 | ||
2040 | <li class="md-nav__item"> | |
2041 | <a href="#unique-namespace" class="md-nav__link"> | |
2042 | Unique Namespace | |
2043 | </a> | |
2044 | ||
2045 | </li> | |
2046 | ||
2047 | <li class="md-nav__item"> | |
2048 | <a href="#unique-database-table-prefix" class="md-nav__link"> | |
2049 | Unique Database Table Prefix | |
2050 | </a> | |
2051 | ||
2052 | </li> | |
2053 | ||
2054 | <li class="md-nav__item"> | |
2055 | <a href="#separate-domain-and-path-configuration" class="md-nav__link"> | |
2056 | Separate Domain and Path Configuration | |
2057 | </a> | |
2058 | ||
2059 | </li> | |
2060 | ||
2061 | </ul> | |
2062 | </nav> | |
2063 | ||
2064 | </li> | |
2065 | ||
2066 | <li class="md-nav__item"> | |
2067 | <a href="#creating-an-app" class="md-nav__link"> | |
2068 | Creating an App | |
2069 | </a> | |
2070 | ||
2071 | <nav class="md-nav" aria-label="Creating an App"> | |
2072 | <ul class="md-nav__list"> | |
2073 | ||
2074 | <li class="md-nav__item"> | |
2075 | <a href="#packagexml" class="md-nav__link"> | |
2076 | package.xml | |
2077 | </a> | |
2078 | ||
2079 | <nav class="md-nav" aria-label="package.xml"> | |
2080 | <ul class="md-nav__list"> | |
2081 | ||
2082 | <li class="md-nav__item"> | |
2083 | <a href="#isapplication1isapplication" class="md-nav__link"> | |
2084 | <isapplication>1</isapplication> | |
2085 | </a> | |
2086 | ||
2087 | </li> | |
2088 | ||
2089 | <li class="md-nav__item"> | |
2090 | <a href="#applicationdirectoryexampleapplicationdirectory" class="md-nav__link"> | |
2091 | <applicationdirectory>example</applicationdirectory> | |
2092 | </a> | |
2093 | ||
2094 | </li> | |
2095 | ||
2096 | </ul> | |
2097 | </nav> | |
2098 | ||
2099 | </li> | |
2100 | ||
2101 | <li class="md-nav__item"> | |
2102 | <a href="#minimum-required-files" class="md-nav__link"> | |
2103 | Minimum Required Files | |
2104 | </a> | |
2105 | ||
2106 | </li> | |
2107 | ||
2108 | </ul> | |
2109 | </nav> | |
2110 | ||
2111 | </li> | |
2112 | ||
2113 | </ul> | |
2114 | ||
2115 | </nav> | |
2116 | </div> | |
2117 | </div> | |
2118 | </div> | |
2119 | ||
2120 | ||
2121 | <div class="md-content" data-md-component="content"> | |
2122 | <article class="md-content__inner md-typeset"> | |
2123 | ||
2124 | ||
9b8bddda | 2125 | <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/apps.md" title="Edit this page" class="md-content__button md-icon"> |
7124f4cb WG |
2126 | <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> |
2127 | </a> | |
2128 | ||
45ca63d0 TD |
2129 | |
2130 | <h1 id="apps-for-woltlab-suite">Apps for WoltLab Suite<a class="headerlink" href="#apps-for-woltlab-suite" title="Permanent link">#</a></h1> | |
2131 | <h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">#</a></h2> | |
2132 | <p>Apps are among the most powerful components in WoltLab Suite. Unlike plugins | |
2133 | that extend an existing functionality and pages, apps have their own frontend | |
2134 | with a dedicated namespace, database table prefixes and template locations.</p> | |
2135 | <p>However, apps are meant to be a logical (and to some extent physical) separation | |
2136 | from other parts of the framework, including other installed apps. They offer | |
2137 | an additional layer of isolation and enable you to re-use class and template | |
2138 | names that are already in use by the Core itself.</p> | |
2139 | <p>If you've come here, thinking about the question if your next package should be | |
2140 | an app instead of a regular plugin, the result is almost always: <em>No.</em></p> | |
2141 | <h2 id="differences-to-plugins">Differences to Plugins<a class="headerlink" href="#differences-to-plugins" title="Permanent link">#</a></h2> | |
2142 | <p>Apps do offer a couple of unique features that are not available to plugins and | |
2143 | there are valid reasons to use one instead of a plugin, but they also increase | |
2144 | both the code and system complexity. There is a performance penalty for each | |
2145 | installed app, regardless if it is actively used in a request or not, simplying | |
2146 | being there forces the Core to include it in many places, for example, class | |
2147 | resolution or even simple tasks such as constructing a link.</p> | |
2148 | <h3 id="unique-namespace">Unique Namespace<a class="headerlink" href="#unique-namespace" title="Permanent link">#</a></h3> | |
2149 | <p>Each app has its own unique namespace that is entirely separated from the Core | |
2150 | and any other installed apps. The namespace is derived from the last part of the | |
2151 | package identifier, for example, <code>com.example.foo</code> will yield the namespace <code>foo</code>.</p> | |
2152 | <p>The namespace is always relative to the installation directory of the app, it | |
2153 | doesn't matter if the app is installed on <code>example.com/foo/</code> or in <code>example.com/bar/</code>, | |
2154 | the namespace will always resolve to the right directory.</p> | |
2155 | <p>This app namespace is also used for ACP templates, frontend templates and files:</p> | |
704cbc4a WG |
2156 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2157 | <span class="normal">2</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="c"><!-- somewhere in the package.xml --></span> | |
45ca63d0 TD |
2158 | <span class="nt"><instructions</span> <span class="na">type=</span><span class="s">"file"</span> <span class="na">application=</span><span class="s">"foo"</span> <span class="nt">/></span> |
2159 | </code></pre></div> | |
704cbc4a | 2160 | </td></tr></table> |
45ca63d0 TD |
2161 | <h3 id="unique-database-table-prefix">Unique Database Table Prefix<a class="headerlink" href="#unique-database-table-prefix" title="Permanent link">#</a></h3> |
2162 | <p>All database tables make use of a generic prefix that is derived from one of the | |
2163 | installed apps, including <code>wcf</code> which resolves to the Core itself. Following the | |
2164 | aforementioned example, the new prefix <code>fooN_</code> will be automatically registered | |
2165 | and recognized in any generated statement.</p> | |
2166 | <p>Any <code>DatabaseObject</code> that uses the app's namespace is automatically assumed to | |
2167 | use the app's database prefix. For instance, <code>foo\data\bar\Bar</code> is implicitly | |
2168 | mapped to the database table <code>fooN_bar</code>.</p> | |
2169 | <p>The app prefix is recognized in SQL-PIPs and statements that reference one of | |
2170 | its database tables are automatically rewritten to use the Core's instance number.</p> | |
2171 | <h3 id="separate-domain-and-path-configuration">Separate Domain and Path Configuration<a class="headerlink" href="#separate-domain-and-path-configuration" title="Permanent link">#</a></h3> | |
2172 | <p>Any controller that is provided by a plugin is served from the configured domain | |
2173 | and path of the corresponding app, such as plugins for the Core are always | |
2174 | served from the Core's directory. Apps are different and use their own domain | |
2175 | and/or path to present their content, additionally, this allows the app to re-use | |
2176 | a controller name that is already provided by the Core or any other app itself.</p> | |
2177 | <h2 id="creating-an-app">Creating an App<a class="headerlink" href="#creating-an-app" title="Permanent link">#</a></h2> | |
2178 | <div class="admonition danger"> | |
2179 | <p class="admonition-title">This is a non-reversible operation! Once a package has been installed, its type cannot be changed without uninstalling and reinstalling the entire package, an app will always be an app and vice versa.</p> | |
2180 | </div> | |
2181 | <h3 id="packagexml"><code>package.xml</code><a class="headerlink" href="#packagexml" title="Permanent link">#</a></h3> | |
2182 | <p>The <code>package.xml</code> supports two additional elements in the <code><packageinformation></code> | |
2183 | block that are unique to applications.</p> | |
2184 | <h4 id="isapplication1isapplication"><code><isapplication>1</isapplication></code><a class="headerlink" href="#isapplication1isapplication" title="Permanent link">#</a></h4> | |
2185 | <p>This element is responsible to flag a package as an app.</p> | |
2186 | <h4 id="applicationdirectoryexampleapplicationdirectory"><code><applicationdirectory>example</applicationdirectory></code><a class="headerlink" href="#applicationdirectoryexampleapplicationdirectory" title="Permanent link">#</a></h4> | |
2187 | <p>Sets the suggested name of the application directory when installing it, the | |
2188 | path result in <code><path-to-the-core>/example/</code>. If you leave this element out, | |
2189 | the app identifier (<code>com.example.foo -> foo</code>) will be used instead.</p> | |
2190 | <h3 id="minimum-required-files">Minimum Required Files<a class="headerlink" href="#minimum-required-files" title="Permanent link">#</a></h3> | |
e3413d1b | 2191 | <p>An example project with the <a href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/basic-app/">source code can be found on GitHub</a>, |
45ca63d0 TD |
2192 | it includes everything that is required for a basic app.</p> |
2193 | ||
4a5c32e1 WG |
2194 | |
2195 | ||
2196 | ||
2197 | <hr> | |
2198 | <div class="md-source-date"> | |
2199 | <small> | |
2200 | ||
e3413d1b | 2201 | Last update: 2021-04-07 |
4a5c32e1 WG |
2202 | |
2203 | </small> | |
2204 | </div> | |
2205 | ||
2206 | ||
45ca63d0 TD |
2207 | |
2208 | ||
2209 | ||
2210 | ||
2211 | ||
2212 | ||
2213 | </article> | |
2214 | </div> | |
2215 | </div> | |
fb962f09 | 2216 | |
45ca63d0 TD |
2217 | </main> |
2218 | ||
2219 | ||
2220 | <footer class="md-footer"> | |
2221 | ||
2222 | <nav class="md-footer__inner md-grid" aria-label="Footer"> | |
2223 | ||
2224 | <a href="../code-style/" class="md-footer__link md-footer__link--prev" rel="prev"> | |
2225 | <div class="md-footer__button md-icon"> | |
2226 | <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> | |
2227 | </div> | |
2228 | <div class="md-footer__title"> | |
2229 | <div class="md-ellipsis"> | |
2230 | <span class="md-footer__direction"> | |
2231 | Previous | |
2232 | </span> | |
2233 | Code Style | |
2234 | </div> | |
2235 | </div> | |
2236 | </a> | |
2237 | ||
2238 | ||
2239 | <a href="../gdpr/" class="md-footer__link md-footer__link--next" rel="next"> | |
2240 | <div class="md-footer__title"> | |
2241 | <div class="md-ellipsis"> | |
2242 | <span class="md-footer__direction"> | |
2243 | Next | |
2244 | </span> | |
2245 | GDPR | |
2246 | </div> | |
2247 | </div> | |
2248 | <div class="md-footer__button md-icon"> | |
2249 | <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> | |
2250 | </div> | |
2251 | </a> | |
2252 | ||
2253 | </nav> | |
2254 | ||
2255 | <div class="md-footer-meta md-typeset"> | |
2256 | <div class="md-footer-meta__inner md-grid"> | |
2257 | <div class="md-footer-copyright"> | |
2258 | ||
2259 | <div class="md-footer-copyright__highlight"> | |
2260 | Copyright © 2020 WoltLab GmbH | |
2261 | </div> | |
2262 | ||
2263 | Made with | |
2264 | <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> | |
2265 | Material for MkDocs | |
2266 | </a> | |
fb88dc6e | 2267 | |
45ca63d0 TD |
2268 | </div> |
2269 | <div class="md-footer-copyright"> | |
2270 | <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a> | |
2271 | <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a> | |
2272 | </div> | |
2273 | </div> | |
2274 | </div> | |
2275 | </footer> | |
2276 | ||
2277 | </div> | |
2278 | <div class="md-dialog" data-md-component="dialog"> | |
2279 | <div class="md-dialog__inner md-typeset"></div> | |
2280 | </div> | |
fb962f09 | 2281 | <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.fe42c31b.min.js", "version": {"provider": "mike"}}</script> |
45ca63d0 TD |
2282 | |
2283 | ||
a4835aa6 | 2284 | <script src="../../assets/javascripts/bundle.4ea5477f.min.js"></script> |
45ca63d0 TD |
2285 | |
2286 | ||
2287 | </body> | |
2288 | </html> |