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