Deployed 2f13e501 to 6.0 with MkDocs 1.4.3 and mike 1.1.2
[GitHub/WoltLab/woltlab.github.io.git] / 6.0 / migration / wsc52 / templates / index.html
CommitLineData
9aa5da67
WG
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 <link rel="canonical" href="https://docs.woltlab.com/6.0/migration/wsc52/templates/">
12
e02609d6
WG
13
14 <link rel="prev" href="../php/">
15
16
17 <link rel="next" href="../libraries/">
18
9aa5da67 19 <link rel="icon" href="../../../assets/default.favicon.ico">
9d185e89 20 <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.15">
9aa5da67
WG
21
22
23
24 <title>Templates and Languages - WoltLab Suite Documentation</title>
25
26
27
9d185e89 28 <link rel="stylesheet" href="../../../assets/stylesheets/main.26e3688c.min.css">
9aa5da67
WG
29
30
9d185e89 31 <link rel="stylesheet" href="../../../assets/stylesheets/palette.ecc896b0.min.css">
9aa5da67
WG
32
33
7f9945cf 34
9aa5da67
WG
35
36
37
38
39
40
41 <link rel="stylesheet" href="../../../stylesheets/extra.css">
42
a06fd3b1 43 <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
9aa5da67
WG
44
45
46
47
48
7f9945cf 49
9aa5da67
WG
50 </head>
51
52
53
54
55
56
57
94fa7b1e 58 <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
9aa5da67
WG
59
60
61
62 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
63 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
64 <label class="md-overlay" for="__drawer"></label>
65 <div data-md-component="skip">
66
67
68 <a href="#migrating-woltlab-suite-52-templates-and-languages" class="md-skip">
69 Skip to content
70 </a>
71
72 </div>
73 <div data-md-component="announce">
74
75 <aside class="md-banner">
76 <div class="md-banner__inner md-grid md-typeset">
77
a06fd3b1 78
9aa5da67
WG
79 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
80
81 </div>
a06fd3b1 82
9aa5da67
WG
83 </aside>
84
85 </div>
86
6f2e8f13 87 <div data-md-color-scheme="default" data-md-component="outdated" hidden>
a06fd3b1 88
9aa5da67
WG
89 </div>
90
91
92
93
781975eb
WG
94
95
96<header class="md-header md-header--shadow" data-md-component="header">
9aa5da67
WG
97 <nav class="md-header__inner md-grid" aria-label="Header">
98 <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
99
100 <img src="../../../assets/logo.png" alt="logo">
101
102 </a>
103 <label class="md-header__button md-icon" for="__drawer">
104 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
105 </label>
106 <div class="md-header__title" data-md-component="header-title">
107 <div class="md-header__ellipsis">
108 <div class="md-header__topic">
109 <span class="md-ellipsis">
110 WoltLab Suite Documentation
111 </span>
112 </div>
113 <div class="md-header__topic" data-md-component="header-topic">
114 <span class="md-ellipsis">
115
116 Templates and Languages
117
118 </span>
119 </div>
120 </div>
121 </div>
122
94fa7b1e
WG
123
124
9aa5da67
WG
125
126
127 <label class="md-header__button md-icon" for="__search">
128 <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>
129 </label>
130 <div class="md-search" data-md-component="search" role="dialog">
131 <label class="md-search__overlay" for="__search"></label>
132 <div class="md-search__inner" role="search">
133 <form class="md-search__form" name="search">
134 <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" required>
135 <label class="md-search__icon md-icon" for="__search">
136 <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>
137 <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>
138 </label>
139 <nav class="md-search__options" aria-label="Search">
140
7f9945cf 141 <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
9aa5da67
WG
142 <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>
143 </button>
144 </nav>
145
146 </form>
147 <div class="md-search__output">
148 <div class="md-search__scrollwrap" data-md-scrollfix>
149 <div class="md-search-result" data-md-component="search-result">
150 <div class="md-search-result__meta">
151 Initializing search
152 </div>
7b2c751c 153 <ol class="md-search-result__list" role="presentation"></ol>
9aa5da67
WG
154 </div>
155 </div>
156 </div>
157 </div>
158</div>
159
160
161 <div class="md-header__source">
162 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
163 <div class="md-source__icon md-icon">
164
94fa7b1e 165 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
9aa5da67
WG
166 </div>
167 <div class="md-source__repository">
168 GitHub
169 </div>
170</a>
171 </div>
172
173 </nav>
174
175</header>
176
177 <div class="md-container" data-md-component="container">
178
179
180
181
182
183
184 <main class="md-main" data-md-component="main">
185 <div class="md-main__inner md-grid">
186
187
188
189 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
190 <div class="md-sidebar__scrollwrap">
191 <div class="md-sidebar__inner">
192
193
194
195<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
196 <label class="md-nav__title" for="__drawer">
197 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
198
199 <img src="../../../assets/logo.png" alt="logo">
200
201 </a>
202 WoltLab Suite Documentation
203 </label>
204
205 <div class="md-nav__source">
206 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
207 <div class="md-source__icon md-icon">
208
94fa7b1e 209 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
9aa5da67
WG
210 </div>
211 <div class="md-source__repository">
212 GitHub
213 </div>
214</a>
215 </div>
216
217 <ul class="md-nav__list" data-md-scrollfix>
218
219
220
221
222
223
224
225
226 <li class="md-nav__item">
227 <a href="../../../getting-started/" class="md-nav__link">
228 Getting Started
229 </a>
230 </li>
231
232
233
234
235
236
237
238
239
240
241
242 <li class="md-nav__item md-nav__item--nested">
243
244
9aa5da67
WG
245
246
51b70eee 247 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
e02609d6 248
9aa5da67
WG
249
250
51b70eee 251 <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
9aa5da67
WG
252 PHP API
253 <span class="md-nav__icon md-icon"></span>
254 </label>
255
51b70eee 256 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
9aa5da67
WG
257 <label class="md-nav__title" for="__nav_2">
258 <span class="md-nav__icon md-icon"></span>
259 PHP API
260 </label>
261 <ul class="md-nav__list" data-md-scrollfix>
262
263
264
265
266
267
268 <li class="md-nav__item">
269 <a href="../../../php/pages/" class="md-nav__link">
270 Pages
271 </a>
272 </li>
273
274
275
276
277
278
279
280
281
282 <li class="md-nav__item">
283 <a href="../../../php/database-objects/" class="md-nav__link">
284 Database Objects
285 </a>
286 </li>
287
288
289
290
291
292
293
294
295
296 <li class="md-nav__item">
297 <a href="../../../php/database-access/" class="md-nav__link">
298 Database Access
299 </a>
300 </li>
301
302
303
304
305
306
307
308
309
310 <li class="md-nav__item">
311 <a href="../../../php/exceptions/" class="md-nav__link">
312 Exceptions
313 </a>
314 </li>
315
316
317
318
319
320
321
322
323
324
325 <li class="md-nav__item md-nav__item--nested">
326
327
9aa5da67
WG
328
329
51b70eee 330 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
e02609d6 331
9aa5da67
WG
332
333
51b70eee 334 <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
9aa5da67
WG
335 API
336 <span class="md-nav__icon md-icon"></span>
337 </label>
338
51b70eee 339 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
9aa5da67
WG
340 <label class="md-nav__title" for="__nav_2_5">
341 <span class="md-nav__icon md-icon"></span>
342 API
343 </label>
344 <ul class="md-nav__list" data-md-scrollfix>
345
346
347
348
349
350
351
352 <li class="md-nav__item md-nav__item--nested">
353
354
9aa5da67
WG
355
356
51b70eee 357 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
9aa5da67
WG
358
359
e02609d6 360
51b70eee 361 <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
9aa5da67
WG
362 Caches
363 <span class="md-nav__icon md-icon"></span>
364 </label>
365
51b70eee 366 <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
9aa5da67
WG
367 <label class="md-nav__title" for="__nav_2_5_1">
368 <span class="md-nav__icon md-icon"></span>
369 Caches
370 </label>
371 <ul class="md-nav__list" data-md-scrollfix>
372
373
374
375
376
377
378 <li class="md-nav__item">
379 <a href="../../../php/api/caches/" class="md-nav__link">
380 Overview
381 </a>
382 </li>
383
384
385
386
387
388
389
390
391
392 <li class="md-nav__item">
393 <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
394 Persistent Caches
395 </a>
396 </li>
397
398
399
400
401
402
403
404
405
406 <li class="md-nav__item">
407 <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
408 Runtime Caches
409 </a>
410 </li>
411
412
413
414
415 </ul>
416 </nav>
417 </li>
418
419
420
421
422
423
424
425
426
427 <li class="md-nav__item">
428 <a href="../../../php/api/comments/" class="md-nav__link">
429 Comments
430 </a>
431 </li>
432
433
434
435
436
437
438
439
440
441 <li class="md-nav__item">
442 <a href="../../../php/api/cronjobs/" class="md-nav__link">
443 Cronjobs
444 </a>
445 </li>
446
447
448
449
450
451
452
453
454
455 <li class="md-nav__item">
456 <a href="../../../php/api/events/" class="md-nav__link">
457 Events
458 </a>
459 </li>
460
461
462
463
464
465
466
467
468
469
470 <li class="md-nav__item md-nav__item--nested">
471
472
9aa5da67
WG
473
474
51b70eee 475 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
e02609d6 476
9aa5da67
WG
477
478
51b70eee 479 <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
9aa5da67
WG
480 Form Builder
481 <span class="md-nav__icon md-icon"></span>
482 </label>
483
51b70eee 484 <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
9aa5da67
WG
485 <label class="md-nav__title" for="__nav_2_5_5">
486 <span class="md-nav__icon md-icon"></span>
487 Form Builder
488 </label>
489 <ul class="md-nav__list" data-md-scrollfix>
490
491
492
493
494
495
496 <li class="md-nav__item">
497 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
498 Overview
499 </a>
500 </li>
501
502
503
504
505
506
507
508
509
510 <li class="md-nav__item">
511 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
512 Structure
513 </a>
514 </li>
515
516
517
518
519
520
521
522
523
524 <li class="md-nav__item">
525 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
526 Fields
527 </a>
528 </li>
529
530
531
532
533
534
535
536
537
538 <li class="md-nav__item">
539 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
540 Validation and Data
541 </a>
542 </li>
543
544
545
546
547
548
549
550
551
552 <li class="md-nav__item">
553 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
554 Dependencies
555 </a>
556 </li>
557
558
559
560
561 </ul>
562 </nav>
563 </li>
564
565
566
567
568
569
570
571
572
573 <li class="md-nav__item">
574 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
575 Package Installation Plugins
576 </a>
577 </li>
578
579
580
581
582
583
584
585
586
587 <li class="md-nav__item">
588 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
589 User Activity Points
590 </a>
591 </li>
592
593
594
595
596
597
598
599
600
601 <li class="md-nav__item">
602 <a href="../../../php/api/user_notifications/" class="md-nav__link">
603 User Notifications
604 </a>
605 </li>
606
607
608
609
610
611
612
613
614
615 <li class="md-nav__item">
616 <a href="../../../php/api/sitemaps/" class="md-nav__link">
617 Sitemaps
618 </a>
619 </li>
620
621
622
623
624 </ul>
625 </nav>
626 </li>
627
628
629
630
631
632
633
634
635
636 <li class="md-nav__item">
637 <a href="../../../php/code-style/" class="md-nav__link">
638 Code Style
639 </a>
640 </li>
641
642
643
644
645
646
647
648
649
650 <li class="md-nav__item">
651 <a href="../../../php/apps/" class="md-nav__link">
652 Apps
653 </a>
654 </li>
655
656
657
658
659
660
661
662
663
664 <li class="md-nav__item">
665 <a href="../../../php/gdpr/" class="md-nav__link">
666 GDPR
667 </a>
668 </li>
669
670
671
672
673 </ul>
674 </nav>
675 </li>
676
677
678
679
680
681
682
683
684
685
686
687 <li class="md-nav__item md-nav__item--nested">
688
689
9aa5da67
WG
690
691
51b70eee 692 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
e02609d6 693
9aa5da67
WG
694
695
51b70eee 696 <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
9aa5da67
WG
697 Languages, Templates & CSS
698 <span class="md-nav__icon md-icon"></span>
699 </label>
700
51b70eee 701 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
9aa5da67
WG
702 <label class="md-nav__title" for="__nav_3">
703 <span class="md-nav__icon md-icon"></span>
704 Languages, Templates & CSS
705 </label>
706 <ul class="md-nav__list" data-md-scrollfix>
707
708
709
710
711
712
713 <li class="md-nav__item">
714 <a href="../../../view/languages/" class="md-nav__link">
715 Languages
716 </a>
717 </li>
718
719
720
721
722
723
724
725
726
727 <li class="md-nav__item">
728 <a href="../../../view/templates/" class="md-nav__link">
729 Templates
730 </a>
731 </li>
732
733
734
735
736
737
738
739
740
3c22ac76
WG
741 <li class="md-nav__item">
742 <a href="../../../view/template-modifiers/" class="md-nav__link">
743 Template Modifiers
744 </a>
745 </li>
746
747
748
749
750
751
752
753
754
9aa5da67
WG
755 <li class="md-nav__item">
756 <a href="../../../view/template-plugins/" class="md-nav__link">
757 Template Plugins
758 </a>
759 </li>
760
761
762
763
764
765
766
767
768
769 <li class="md-nav__item">
770 <a href="../../../view/css/" class="md-nav__link">
771 CSS
772 </a>
773 </li>
774
775
776
777
778 </ul>
779 </nav>
780 </li>
781
782
783
784
785
786
787
788
789
790
791
792 <li class="md-nav__item md-nav__item--nested">
793
794
9aa5da67
WG
795
796
51b70eee 797 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
9aa5da67
WG
798
799
e02609d6 800
51b70eee 801 <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
9aa5da67
WG
802 TypeScript and JavaScript API
803 <span class="md-nav__icon md-icon"></span>
804 </label>
805
51b70eee 806 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
9aa5da67
WG
807 <label class="md-nav__title" for="__nav_4">
808 <span class="md-nav__icon md-icon"></span>
809 TypeScript and JavaScript API
810 </label>
811 <ul class="md-nav__list" data-md-scrollfix>
812
813
814
815
816
817
818 <li class="md-nav__item">
819 <a href="../../../javascript/general-usage/" class="md-nav__link">
820 General Usage
821 </a>
822 </li>
823
824
825
826
827
828
829
830
831
832 <li class="md-nav__item">
833 <a href="../../../javascript/typescript/" class="md-nav__link">
834 TypeScript
835 </a>
836 </li>
837
838
839
840
841
842
843
844
845
846
847 <li class="md-nav__item md-nav__item--nested">
848
849
9aa5da67
WG
850
851
51b70eee 852 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
e02609d6 853
9aa5da67
WG
854
855
51b70eee 856 <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
9f399714
WG
857 Components
858 <span class="md-nav__icon md-icon"></span>
859 </label>
860
51b70eee 861 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
9f399714
WG
862 <label class="md-nav__title" for="__nav_4_3">
863 <span class="md-nav__icon md-icon"></span>
864 Components
865 </label>
866 <ul class="md-nav__list" data-md-scrollfix>
867
868
869
870
871
872
873 <li class="md-nav__item">
874 <a href="../../../javascript/components_confirmation/" class="md-nav__link">
875 Confirmation
876 </a>
877 </li>
878
879
880
881
882
883
884
885
886
887 <li class="md-nav__item">
888 <a href="../../../javascript/components_dialog/" class="md-nav__link">
889 Dialog
890 </a>
891 </li>
892
893
894
895
f2d0508c
WG
896
897
898
899
900
816a45a9
WG
901 <li class="md-nav__item">
902 <a href="../../../javascript/components_google_maps/" class="md-nav__link">
903 Google Maps
904 </a>
905 </li>
906
907
908
909
910
911
912
913
914
f2d0508c
WG
915 <li class="md-nav__item">
916 <a href="../../../javascript/components_pagination/" class="md-nav__link">
917 Pagination
918 </a>
919 </li>
920
921
922
923
9f399714
WG
924 </ul>
925 </nav>
926 </li>
927
928
929
930
931
932
933
934
935
936
937 <li class="md-nav__item md-nav__item--nested">
938
939
9f399714
WG
940
941
51b70eee 942 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
e02609d6 943
9f399714
WG
944
945
51b70eee 946 <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
9aa5da67
WG
947 New API
948 <span class="md-nav__icon md-icon"></span>
949 </label>
950
51b70eee 951 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
9f399714 952 <label class="md-nav__title" for="__nav_4_4">
9aa5da67
WG
953 <span class="md-nav__icon md-icon"></span>
954 New API
955 </label>
956 <ul class="md-nav__list" data-md-scrollfix>
957
958
959
960
961
962
963 <li class="md-nav__item">
964 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
965 Writing a module
966 </a>
967 </li>
968
969
970
971
972
973
974
975
976
9aa5da67
WG
977 <li class="md-nav__item">
978 <a href="../../../javascript/new-api_core/" class="md-nav__link">
979 Core Functions
980 </a>
981 </li>
982
983
984
985
986
987
988
989
990
991 <li class="md-nav__item">
992 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
993 DOM
994 </a>
995 </li>
996
997
998
999
1000
1001
1002
1003
1004
1005 <li class="md-nav__item">
1006 <a href="../../../javascript/new-api_events/" class="md-nav__link">
1007 Event Handling
1008 </a>
1009 </li>
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019 <li class="md-nav__item">
1020 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1021 Ajax
1022 </a>
1023 </li>
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033 <li class="md-nav__item">
1034 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1035 Dialogs
1036 </a>
1037 </li>
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047 <li class="md-nav__item">
1048 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1049 Browser and Screen Sizes
1050 </a>
1051 </li>
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061 <li class="md-nav__item">
1062 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1063 User Interface
1064 </a>
1065 </li>
1066
1067
1068
1069
1070 </ul>
1071 </nav>
1072 </li>
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082 <li class="md-nav__item">
1083 <a href="../../../javascript/legacy-api/" class="md-nav__link">
1084 Legacy API
1085 </a>
1086 </li>
1087
1088
1089
1090
1091
1092
1093
1094
1095
9aa5da67
WG
1096 <li class="md-nav__item">
1097 <a href="../../../javascript/code-snippets/" class="md-nav__link">
1098 Code Snippets
1099 </a>
1100 </li>
1101
1102
1103
1104
1105 </ul>
1106 </nav>
1107 </li>
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119 <li class="md-nav__item md-nav__item--nested">
1120
1121
9aa5da67
WG
1122
1123
51b70eee 1124 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
9aa5da67
WG
1125
1126
e02609d6 1127
51b70eee 1128 <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
9aa5da67
WG
1129 Package Components
1130 <span class="md-nav__icon md-icon"></span>
1131 </label>
1132
51b70eee 1133 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
9aa5da67
WG
1134 <label class="md-nav__title" for="__nav_5">
1135 <span class="md-nav__icon md-icon"></span>
1136 Package Components
1137 </label>
1138 <ul class="md-nav__list" data-md-scrollfix>
1139
1140
1141
1142
1143
1144
1145 <li class="md-nav__item">
1146 <a href="../../../package/package-xml/" class="md-nav__link">
1147 package.xml
1148 </a>
1149 </li>
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160 <li class="md-nav__item md-nav__item--nested">
1161
1162
9aa5da67
WG
1163
1164
51b70eee 1165 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
e02609d6 1166
9aa5da67
WG
1167
1168
51b70eee 1169 <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
9aa5da67
WG
1170 PIPs
1171 <span class="md-nav__icon md-icon"></span>
1172 </label>
1173
51b70eee 1174 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
9aa5da67
WG
1175 <label class="md-nav__title" for="__nav_5_2">
1176 <span class="md-nav__icon md-icon"></span>
1177 PIPs
1178 </label>
1179 <ul class="md-nav__list" data-md-scrollfix>
1180
1181
1182
1183
1184
1185
1186 <li class="md-nav__item">
1187 <a href="../../../package/pip/" class="md-nav__link">
1188 Overview
1189 </a>
1190 </li>
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200 <li class="md-nav__item">
1201 <a href="../../../package/pip/acl-option/" class="md-nav__link">
1202 aclOption
1203 </a>
1204 </li>
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214 <li class="md-nav__item">
1215 <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1216 acpMenu
1217 </a>
1218 </li>
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228 <li class="md-nav__item">
1229 <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1230 acpSearchProvider
1231 </a>
1232 </li>
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242 <li class="md-nav__item">
1243 <a href="../../../package/pip/acp-template/" class="md-nav__link">
1244 acpTemplate
1245 </a>
1246 </li>
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256 <li class="md-nav__item">
1257 <a href="../../../package/pip/acp-template-delete/" class="md-nav__link">
1258 acpTemplateDelete
1259 </a>
1260 </li>
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270 <li class="md-nav__item">
1271 <a href="../../../package/pip/bbcode/" class="md-nav__link">
1272 bbcode
1273 </a>
1274 </li>
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284 <li class="md-nav__item">
1285 <a href="../../../package/pip/box/" class="md-nav__link">
1286 box
1287 </a>
1288 </li>
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298 <li class="md-nav__item">
1299 <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1300 clipboardAction
1301 </a>
1302 </li>
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312 <li class="md-nav__item">
1313 <a href="../../../package/pip/core-object/" class="md-nav__link">
1314 coreObject
1315 </a>
1316 </li>
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326 <li class="md-nav__item">
1327 <a href="../../../package/pip/cronjob/" class="md-nav__link">
1328 cronjob
1329 </a>
1330 </li>
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340 <li class="md-nav__item">
1341 <a href="../../../package/pip/database/" class="md-nav__link">
1342 database
1343 </a>
1344 </li>
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354 <li class="md-nav__item">
1355 <a href="../../../package/pip/event-listener/" class="md-nav__link">
1356 eventListener
1357 </a>
1358 </li>
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368 <li class="md-nav__item">
1369 <a href="../../../package/pip/file/" class="md-nav__link">
1370 file
1371 </a>
1372 </li>
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382 <li class="md-nav__item">
1383 <a href="../../../package/pip/file-delete/" class="md-nav__link">
1384 fileDelete
1385 </a>
1386 </li>
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396 <li class="md-nav__item">
1397 <a href="../../../package/pip/language/" class="md-nav__link">
1398 language
1399 </a>
1400 </li>
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410 <li class="md-nav__item">
1411 <a href="../../../package/pip/media-provider/" class="md-nav__link">
1412 mediaProvider
1413 </a>
1414 </li>
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424 <li class="md-nav__item">
1425 <a href="../../../package/pip/menu/" class="md-nav__link">
1426 menu
1427 </a>
1428 </li>
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438 <li class="md-nav__item">
1439 <a href="../../../package/pip/menu-item/" class="md-nav__link">
1440 menuItem
1441 </a>
1442 </li>
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452 <li class="md-nav__item">
1453 <a href="../../../package/pip/object-type/" class="md-nav__link">
1454 objectType
1455 </a>
1456 </li>
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466 <li class="md-nav__item">
1467 <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1468 objectTypeDefinition
1469 </a>
1470 </li>
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480 <li class="md-nav__item">
1481 <a href="../../../package/pip/option/" class="md-nav__link">
1482 option
1483 </a>
1484 </li>
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494 <li class="md-nav__item">
1495 <a href="../../../package/pip/page/" class="md-nav__link">
1496 page
1497 </a>
1498 </li>
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508 <li class="md-nav__item">
1509 <a href="../../../package/pip/pip/" class="md-nav__link">
1510 pip
1511 </a>
1512 </li>
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522 <li class="md-nav__item">
1523 <a href="../../../package/pip/script/" class="md-nav__link">
1524 script
1525 </a>
1526 </li>
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536 <li class="md-nav__item">
1537 <a href="../../../package/pip/smiley/" class="md-nav__link">
1538 smiley
1539 </a>
1540 </li>
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550 <li class="md-nav__item">
1551 <a href="../../../package/pip/sql/" class="md-nav__link">
1552 sql
1553 </a>
1554 </li>
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564 <li class="md-nav__item">
1565 <a href="../../../package/pip/style/" class="md-nav__link">
1566 style
1567 </a>
1568 </li>
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578 <li class="md-nav__item">
1579 <a href="../../../package/pip/template/" class="md-nav__link">
1580 template
1581 </a>
1582 </li>
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592 <li class="md-nav__item">
1593 <a href="../../../package/pip/template-delete/" class="md-nav__link">
1594 templateDelete
1595 </a>
1596 </li>
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606 <li class="md-nav__item">
1607 <a href="../../../package/pip/template-listener/" class="md-nav__link">
1608 templateListener
1609 </a>
1610 </li>
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620 <li class="md-nav__item">
1621 <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1622 userGroupOption
1623 </a>
1624 </li>
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634 <li class="md-nav__item">
1635 <a href="../../../package/pip/user-menu/" class="md-nav__link">
1636 userMenu
1637 </a>
1638 </li>
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648 <li class="md-nav__item">
1649 <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1650 userNotificationEvent
1651 </a>
1652 </li>
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662 <li class="md-nav__item">
1663 <a href="../../../package/pip/user-option/" class="md-nav__link">
1664 userOption
1665 </a>
1666 </li>
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676 <li class="md-nav__item">
1677 <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1678 userProfileMenu
1679 </a>
1680 </li>
1681
1682
1683
1684
1685 </ul>
1686 </nav>
1687 </li>
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697 <li class="md-nav__item">
1698 <a href="../../../package/database-php-api/" class="md-nav__link">
1699 Database PHP API
1700 </a>
1701 </li>
1702
1703
1704
1705
1706 </ul>
1707 </nav>
1708 </li>
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1723
1724
9aa5da67
WG
1725
1726
51b70eee 1727 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
e02609d6 1728
9aa5da67
WG
1729
1730
51b70eee 1731 <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
9aa5da67
WG
1732 Migration
1733 <span class="md-nav__icon md-icon"></span>
1734 </label>
1735
51b70eee 1736 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
9aa5da67
WG
1737 <label class="md-nav__title" for="__nav_6">
1738 <span class="md-nav__icon md-icon"></span>
1739 Migration
1740 </label>
1741 <ul class="md-nav__list" data-md-scrollfix>
1742
1743
1744
1745
1746
1747
1748
1749 <li class="md-nav__item md-nav__item--nested">
1750
1751
9aa5da67
WG
1752
1753
51b70eee 1754 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
9aa5da67
WG
1755
1756
e02609d6 1757
51b70eee 1758 <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
9aa5da67
WG
1759 From WoltLab Suite 5.5
1760 <span class="md-nav__icon md-icon"></span>
1761 </label>
1762
51b70eee 1763 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
9aa5da67
WG
1764 <label class="md-nav__title" for="__nav_6_1">
1765 <span class="md-nav__icon md-icon"></span>
1766 From WoltLab Suite 5.5
1767 </label>
1768 <ul class="md-nav__list" data-md-scrollfix>
1769
1770
1771
1772
1773
1774
1775 <li class="md-nav__item">
1776 <a href="../../wsc55/php/" class="md-nav__link">
1777 PHP API
1778 </a>
1779 </li>
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789 <li class="md-nav__item">
1790 <a href="../../wsc55/javascript/" class="md-nav__link">
1791 TypeScript and JavaScript
1792 </a>
1793 </li>
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803 <li class="md-nav__item">
1804 <a href="../../wsc55/templates/" class="md-nav__link">
1805 Templates
1806 </a>
1807 </li>
1808
1809
1810
1811
1812
1813
1814
1815
1816
024038ef
WG
1817 <li class="md-nav__item">
1818 <a href="../../wsc55/icons/" class="md-nav__link">
1819 Icons
1820 </a>
1821 </li>
1822
1823
1824
1825
1826
1827
1828
1829
1830
6d611e8a
WG
1831 <li class="md-nav__item">
1832 <a href="../../wsc55/dialogs/" class="md-nav__link">
1833 Dialogs
1834 </a>
1835 </li>
1836
1837
1838
1839
1840
1841
1842
1843
1844
9aa5da67
WG
1845 <li class="md-nav__item">
1846 <a href="../../wsc55/libraries/" class="md-nav__link">
1847 Third Party Libraries
1848 </a>
1849 </li>
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859 <li class="md-nav__item">
1860 <a href="../../wsc55/deprecations_removals/" class="md-nav__link">
1861 Deprecations and Removals
1862 </a>
1863 </li>
1864
1865
1866
1867
1868 </ul>
1869 </nav>
1870 </li>
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881 <li class="md-nav__item md-nav__item--nested">
1882
1883
9aa5da67
WG
1884
1885
51b70eee 1886 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
e02609d6 1887
9aa5da67
WG
1888
1889
51b70eee 1890 <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
9aa5da67
WG
1891 From WoltLab Suite 5.4
1892 <span class="md-nav__icon md-icon"></span>
1893 </label>
1894
51b70eee 1895 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
9aa5da67
WG
1896 <label class="md-nav__title" for="__nav_6_2">
1897 <span class="md-nav__icon md-icon"></span>
1898 From WoltLab Suite 5.4
1899 </label>
1900 <ul class="md-nav__list" data-md-scrollfix>
1901
1902
1903
1904
1905
1906
1907 <li class="md-nav__item">
1908 <a href="../../wsc54/php/" class="md-nav__link">
1909 PHP API
1910 </a>
1911 </li>
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921 <li class="md-nav__item">
1922 <a href="../../wsc54/javascript/" class="md-nav__link">
1923 TypeScript and JavaScript
1924 </a>
1925 </li>
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935 <li class="md-nav__item">
1936 <a href="../../wsc54/templates/" class="md-nav__link">
1937 Templates
1938 </a>
1939 </li>
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949 <li class="md-nav__item">
1950 <a href="../../wsc54/libraries/" class="md-nav__link">
1951 Third Party Libraries
1952 </a>
1953 </li>
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963 <li class="md-nav__item">
1964 <a href="../../wsc54/deprecations_removals/" class="md-nav__link">
1965 Deprecations and Removals
1966 </a>
1967 </li>
1968
1969
1970
1971
1972 </ul>
1973 </nav>
1974 </li>
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985 <li class="md-nav__item md-nav__item--nested">
1986
1987
9aa5da67
WG
1988
1989
51b70eee 1990 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
e02609d6 1991
9aa5da67
WG
1992
1993
51b70eee 1994 <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
9aa5da67
WG
1995 From WoltLab Suite 5.3
1996 <span class="md-nav__icon md-icon"></span>
1997 </label>
1998
51b70eee 1999 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
9aa5da67
WG
2000 <label class="md-nav__title" for="__nav_6_3">
2001 <span class="md-nav__icon md-icon"></span>
2002 From WoltLab Suite 5.3
2003 </label>
2004 <ul class="md-nav__list" data-md-scrollfix>
2005
2006
2007
2008
2009
2010
2011 <li class="md-nav__item">
2012 <a href="../../wsc53/php/" class="md-nav__link">
2013 PHP API
2014 </a>
2015 </li>
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025 <li class="md-nav__item">
2026 <a href="../../wsc53/session/" class="md-nav__link">
2027 Session Handling and Authentication
2028 </a>
2029 </li>
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039 <li class="md-nav__item">
2040 <a href="../../wsc53/javascript/" class="md-nav__link">
2041 TypeScript and JavaScript
2042 </a>
2043 </li>
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053 <li class="md-nav__item">
2054 <a href="../../wsc53/templates/" class="md-nav__link">
2055 Templates
2056 </a>
2057 </li>
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067 <li class="md-nav__item">
2068 <a href="../../wsc53/libraries/" class="md-nav__link">
2069 Third Party Libraries
2070 </a>
2071 </li>
2072
2073
2074
2075
2076 </ul>
2077 </nav>
2078 </li>
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
2092
2093
9aa5da67
WG
2094
2095
51b70eee 2096 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" checked>
9aa5da67
WG
2097
2098
e02609d6 2099
51b70eee 2100 <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
9aa5da67
WG
2101 From WoltLab Suite 5.2
2102 <span class="md-nav__icon md-icon"></span>
2103 </label>
2104
51b70eee 2105 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="true">
9aa5da67
WG
2106 <label class="md-nav__title" for="__nav_6_4">
2107 <span class="md-nav__icon md-icon"></span>
2108 From WoltLab Suite 5.2
2109 </label>
2110 <ul class="md-nav__list" data-md-scrollfix>
2111
2112
2113
2114
2115
2116
2117 <li class="md-nav__item">
2118 <a href="../php/" class="md-nav__link">
2119 PHP API
2120 </a>
2121 </li>
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133 <li class="md-nav__item md-nav__item--active">
2134
51b70eee 2135 <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
9aa5da67
WG
2136
2137
2138
2139
2140
2141 <label class="md-nav__link md-nav__link--active" for="__toc">
2142 Templates and Languages
2143 <span class="md-nav__icon md-icon"></span>
2144 </label>
2145
2146 <a href="./" class="md-nav__link md-nav__link--active">
2147 Templates and Languages
2148 </a>
2149
2150
2151
2152<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2153
2154
2155
2156
2157
2158
2159 <label class="md-nav__title" for="__toc">
2160 <span class="md-nav__icon md-icon"></span>
2161 Table of contents
2162 </label>
2163 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2164
2165 <li class="md-nav__item">
2166 <a href="#jslang" class="md-nav__link">
2167 {jslang}
2168 </a>
2169
2170</li>
2171
2172 <li class="md-nav__item">
2173 <a href="#template-plugins" class="md-nav__link">
2174 Template Plugins
2175 </a>
2176
2177</li>
2178
2179 <li class="md-nav__item">
2180 <a href="#notification-language-items" class="md-nav__link">
2181 Notification Language Items
2182 </a>
2183
2184</li>
2185
2186 <li class="md-nav__item">
2187 <a href="#popovers" class="md-nav__link">
2188 Popovers
2189 </a>
2190
2191</li>
2192
2193 </ul>
2194
2195</nav>
2196
2197 </li>
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207 <li class="md-nav__item">
2208 <a href="../libraries/" class="md-nav__link">
2209 Third Party Libraries
2210 </a>
2211 </li>
2212
2213
2214
2215
2216 </ul>
2217 </nav>
2218 </li>
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229 <li class="md-nav__item md-nav__item--nested">
2230
2231
9aa5da67
WG
2232
2233
51b70eee 2234 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
e02609d6 2235
9aa5da67
WG
2236
2237
51b70eee 2238 <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
9aa5da67
WG
2239 From WoltLab Suite 3.1
2240 <span class="md-nav__icon md-icon"></span>
2241 </label>
2242
51b70eee 2243 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
9aa5da67
WG
2244 <label class="md-nav__title" for="__nav_6_5">
2245 <span class="md-nav__icon md-icon"></span>
2246 From WoltLab Suite 3.1
2247 </label>
2248 <ul class="md-nav__list" data-md-scrollfix>
2249
2250
2251
2252
2253
2254
2255 <li class="md-nav__item">
2256 <a href="../../wsc31/php/" class="md-nav__link">
2257 PHP API
2258 </a>
2259 </li>
2260
2261
2262
2263
2264 </ul>
2265 </nav>
2266 </li>
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277 <li class="md-nav__item md-nav__item--nested">
2278
2279
9aa5da67
WG
2280
2281
51b70eee 2282 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
e02609d6 2283
9aa5da67
WG
2284
2285
51b70eee 2286 <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
9aa5da67
WG
2287 From WoltLab Suite 3.0
2288 <span class="md-nav__icon md-icon"></span>
2289 </label>
2290
51b70eee 2291 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
9aa5da67
WG
2292 <label class="md-nav__title" for="__nav_6_6">
2293 <span class="md-nav__icon md-icon"></span>
2294 From WoltLab Suite 3.0
2295 </label>
2296 <ul class="md-nav__list" data-md-scrollfix>
2297
2298
2299
2300
2301
2302
2303 <li class="md-nav__item">
2304 <a href="../../wsc30/php/" class="md-nav__link">
2305 PHP API
2306 </a>
2307 </li>
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317 <li class="md-nav__item">
2318 <a href="../../wsc30/javascript/" class="md-nav__link">
2319 JavaScript API
2320 </a>
2321 </li>
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331 <li class="md-nav__item">
2332 <a href="../../wsc30/templates/" class="md-nav__link">
2333 Templates
2334 </a>
2335 </li>
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345 <li class="md-nav__item">
2346 <a href="../../wsc30/css/" class="md-nav__link">
2347 CSS
2348 </a>
2349 </li>
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359 <li class="md-nav__item">
2360 <a href="../../wsc30/package/" class="md-nav__link">
2361 Package Components
2362 </a>
2363 </li>
2364
2365
2366
2367
2368 </ul>
2369 </nav>
2370 </li>
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381 <li class="md-nav__item md-nav__item--nested">
2382
2383
9aa5da67
WG
2384
2385
51b70eee 2386 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
9aa5da67
WG
2387
2388
e02609d6 2389
51b70eee 2390 <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
9aa5da67
WG
2391 From WCF 2.1
2392 <span class="md-nav__icon md-icon"></span>
2393 </label>
2394
51b70eee 2395 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
9aa5da67
WG
2396 <label class="md-nav__title" for="__nav_6_7">
2397 <span class="md-nav__icon md-icon"></span>
2398 From WCF 2.1
2399 </label>
2400 <ul class="md-nav__list" data-md-scrollfix>
2401
2402
2403
2404
2405
2406
2407 <li class="md-nav__item">
2408 <a href="../../wcf21/php/" class="md-nav__link">
2409 PHP API
2410 </a>
2411 </li>
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421 <li class="md-nav__item">
2422 <a href="../../wcf21/templates/" class="md-nav__link">
2423 Templates
2424 </a>
2425 </li>
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435 <li class="md-nav__item">
2436 <a href="../../wcf21/css/" class="md-nav__link">
2437 CSS
2438 </a>
2439 </li>
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449 <li class="md-nav__item">
2450 <a href="../../wcf21/package/" class="md-nav__link">
2451 Package Components
2452 </a>
2453 </li>
2454
2455
2456
2457
2458 </ul>
2459 </nav>
2460 </li>
2461
2462
2463
2464
2465 </ul>
2466 </nav>
2467 </li>
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479 <li class="md-nav__item md-nav__item--nested">
2480
2481
9aa5da67
WG
2482
2483
51b70eee 2484 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
e02609d6 2485
9aa5da67
WG
2486
2487
51b70eee 2488 <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
9aa5da67
WG
2489 Tutorials
2490 <span class="md-nav__icon md-icon"></span>
2491 </label>
2492
51b70eee 2493 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
9aa5da67
WG
2494 <label class="md-nav__title" for="__nav_7">
2495 <span class="md-nav__icon md-icon"></span>
2496 Tutorials
2497 </label>
2498 <ul class="md-nav__list" data-md-scrollfix>
2499
2500
2501
2502
2503
2504
2505
2506 <li class="md-nav__item md-nav__item--nested">
2507
2508
9aa5da67
WG
2509
2510
51b70eee 2511 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
9aa5da67
WG
2512
2513
e02609d6 2514
51b70eee 2515 <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
9aa5da67
WG
2516 Tutorial Series
2517 <span class="md-nav__icon md-icon"></span>
2518 </label>
2519
51b70eee 2520 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
9aa5da67
WG
2521 <label class="md-nav__title" for="__nav_7_1">
2522 <span class="md-nav__icon md-icon"></span>
2523 Tutorial Series
2524 </label>
2525 <ul class="md-nav__list" data-md-scrollfix>
2526
2527
2528
2529
2530
2531
2532 <li class="md-nav__item">
2533 <a href="../../../tutorial/series/overview/" class="md-nav__link">
2534 Overview
2535 </a>
2536 </li>
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546 <li class="md-nav__item">
2547 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2548 Part 1
2549 </a>
2550 </li>
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560 <li class="md-nav__item">
2561 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2562 Part 2
2563 </a>
2564 </li>
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574 <li class="md-nav__item">
2575 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2576 Part 3
2577 </a>
2578 </li>
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588 <li class="md-nav__item">
2589 <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2590 Part 4
2591 </a>
2592 </li>
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602 <li class="md-nav__item">
2603 <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2604 Part 5
2605 </a>
2606 </li>
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616 <li class="md-nav__item">
2617 <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2618 Part 6
2619 </a>
2620 </li>
2621
2622
2623
2624
2625 </ul>
2626 </nav>
2627 </li>
2628
2629
2630
2631
2632 </ul>
2633 </nav>
2634 </li>
2635
2636
2637
2638 </ul>
2639</nav>
2640 </div>
2641 </div>
2642 </div>
2643
2644
2645
2646 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2647 <div class="md-sidebar__scrollwrap">
2648 <div class="md-sidebar__inner">
2649
2650
2651<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2652
2653
2654
2655
2656
2657
2658 <label class="md-nav__title" for="__toc">
2659 <span class="md-nav__icon md-icon"></span>
2660 Table of contents
2661 </label>
2662 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2663
2664 <li class="md-nav__item">
2665 <a href="#jslang" class="md-nav__link">
2666 {jslang}
2667 </a>
2668
2669</li>
2670
2671 <li class="md-nav__item">
2672 <a href="#template-plugins" class="md-nav__link">
2673 Template Plugins
2674 </a>
2675
2676</li>
2677
2678 <li class="md-nav__item">
2679 <a href="#notification-language-items" class="md-nav__link">
2680 Notification Language Items
2681 </a>
2682
2683</li>
2684
2685 <li class="md-nav__item">
2686 <a href="#popovers" class="md-nav__link">
2687 Popovers
2688 </a>
2689
2690</li>
2691
2692 </ul>
2693
2694</nav>
2695 </div>
2696 </div>
2697 </div>
2698
2699
7f9945cf
WG
2700
2701 <div class="md-content" data-md-component="content">
2702 <article class="md-content__inner md-typeset">
9aa5da67 2703
7f9945cf
WG
2704
2705
e02609d6
WG
2706
2707
2708
9aa5da67 2709
9aa5da67
WG
2710<h1 id="migrating-woltlab-suite-52-templates-and-languages">Migrating WoltLab Suite 5.2 - Templates and Languages<a class="headerlink" href="#migrating-woltlab-suite-52-templates-and-languages" title="Permanent link">#</a></h1>
2711<h2 id="jslang"><code>{jslang}</code><a class="headerlink" href="#jslang" title="Permanent link">#</a></h2>
2712<p>Starting with WoltLab Suite 5.3 the <code>{jslang}</code> template plugin is available.
2713<code>{jslang}</code> works like <code>{lang}</code>, with the difference that the result is automatically encoded for use within a single quoted JavaScript string.</p>
2714<p>Before:</p>
2715<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2716<span class="normal">2</span>
2717<span class="normal">3</span>
2718<span class="normal">4</span>
2719<span class="normal">5</span>
2720<span class="normal">6</span>
2721<span class="normal">7</span>
2722<span class="normal">8</span>
2723<span class="normal">9</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="x">&lt;script&gt;</span>
2724<span class="x">require([&#39;Language&#39;, /* … */], function(Language, /* … */) </span><span class="cp">{</span>
2725 <span class="na">Language</span><span class="o">.</span><span class="na">addObject</span><span class="o">(</span><span class="cp">{</span>
2726 <span class="s1">&#39;app.foo.bar&#39;</span><span class="o">:</span> <span class="s1">&#39;{lang}app.foo.bar{/lang}&#39;</span><span class="o">,</span>
2727 <span class="cp">}</span><span class="o">);</span>
2728
2729 <span class="o">//</span> <span class="err">…</span>
2730<span class="cp">}</span><span class="x">);</span>
2731<span class="x">&lt;/script&gt;</span>
2732</code></pre></div></td></tr></table></div>
2733<p>After:</p>
2734<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2735<span class="normal">2</span>
2736<span class="normal">3</span>
2737<span class="normal">4</span>
2738<span class="normal">5</span>
2739<span class="normal">6</span>
2740<span class="normal">7</span>
2741<span class="normal">8</span>
2742<span class="normal">9</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="x">&lt;script&gt;</span>
2743<span class="x">require([&#39;Language&#39;, /* … */], function(Language, /* … */) </span><span class="cp">{</span>
2744 <span class="na">Language</span><span class="o">.</span><span class="na">addObject</span><span class="o">(</span><span class="cp">{</span>
2745 <span class="s1">&#39;app.foo.bar&#39;</span><span class="o">:</span> <span class="s1">&#39;{jslang}app.foo.bar{/jslang}&#39;</span><span class="o">,</span>
2746 <span class="cp">}</span><span class="o">);</span>
2747
2748 <span class="o">//</span> <span class="err">…</span>
2749<span class="cp">}</span><span class="x">);</span>
2750<span class="x">&lt;/script&gt;</span>
2751</code></pre></div></td></tr></table></div>
2752<h2 id="template-plugins">Template Plugins<a class="headerlink" href="#template-plugins" title="Permanent link">#</a></h2>
2753<p>The <a href="../../../view/template-plugins/#53-anchor"><code>{anchor}</code></a>, <a href="../../../view/template-plugins/#53-plural"><code>{plural}</code></a>, and <a href="../../../view/template-plugins/#53-user"><code>{user}</code></a> template plugins have been added.</p>
2754<h2 id="notification-language-items">Notification Language Items<a class="headerlink" href="#notification-language-items" title="Permanent link">#</a></h2>
2755<p>In addition to using the new template plugins mentioned above, language items for notifications have been further simplified.</p>
2756<p>As the whole notification is clickable now, all <code>a</code> elements have been replaced with <code>strong</code> elements in notification messages.</p>
2757<p>The template code to output reactions has been simplified by introducing helper methods:</p>
2758<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2759<span class="normal">2</span>
2760<span class="normal">3</span>
2761<span class="normal">4</span>
2762<span class="normal">5</span>
2763<span class="normal">6</span>
2764<span class="normal">7</span>
2765<span class="normal">8</span>
c708394c
WG
2766<span class="normal">9</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="c">* old *</span><span class="cp">}</span>
2767<span class="cp">{</span><span class="nf">implode</span> <span class="na">from</span><span class="o">=</span><span class="nv">$reactions</span> <span class="na">key</span><span class="o">=</span><span class="na">reactionID</span> <span class="na">item</span><span class="o">=</span><span class="na">count</span><span class="cp">}{</span><span class="o">@</span><span class="nv">$__wcf</span><span class="o">-&gt;</span><span class="na">getReactionHandler</span><span class="o">()-&gt;</span><span class="na">getReactionTypeByID</span><span class="o">(</span><span class="nv">$reactionID</span><span class="o">)-&gt;</span><span class="na">renderIcon</span><span class="o">()</span><span class="cp">}</span><span class="x">×</span><span class="cp">{</span><span class="err">#</span><span class="nv">$count</span><span class="cp">}{</span><span class="nf">/implode</span><span class="cp">}</span>
2768<span class="cp">{</span><span class="c">* new *</span><span class="cp">}</span>
2769<span class="cp">{</span><span class="o">@</span><span class="nv">$__wcf</span><span class="o">-&gt;</span><span class="na">getReactionHandler</span><span class="o">()-&gt;</span><span class="na">renderInlineList</span><span class="o">(</span><span class="nv">$reactions</span><span class="o">)</span><span class="cp">}</span>
9aa5da67 2770
c708394c 2771<span class="cp">{</span><span class="c">* old *</span><span class="cp">}</span>
9aa5da67 2772<span class="x">&lt;span title=&quot;</span><span class="cp">{</span><span class="nv">$like</span><span class="o">-&gt;</span><span class="na">getReactionType</span><span class="o">()-&gt;</span><span class="na">getTitle</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot; class=&quot;jsTooltip&quot;&gt;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$like</span><span class="o">-&gt;</span><span class="na">getReactionType</span><span class="o">()-&gt;</span><span class="na">renderIcon</span><span class="o">()</span><span class="cp">}</span><span class="x">&lt;/span&gt;</span>
c708394c
WG
2773<span class="cp">{</span><span class="c">* new *</span><span class="cp">}</span>
2774<span class="cp">{</span><span class="o">@</span><span class="nv">$like</span><span class="o">-&gt;</span><span class="na">render</span><span class="o">()</span><span class="cp">}</span>
9aa5da67
WG
2775</code></pre></div></td></tr></table></div>
2776<p>Similarly, showing labels is now also easier due to the new <code>render</code> method:</p>
2777<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2778<span class="normal">2</span>
2779<span class="normal">3</span>
c708394c 2780<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="c">* old *</span><span class="cp">}</span>
9aa5da67 2781<span class="x">&lt;span class=&quot;label badge</span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$label</span><span class="o">-&gt;</span><span class="na">getClassNames</span><span class="o">()</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="nv">$label</span><span class="o">-&gt;</span><span class="na">getClassNames</span><span class="o">()</span><span class="cp">}{</span><span class="nf">/if</span><span class="cp">}</span><span class="x">&quot;&gt;</span><span class="cp">{</span><span class="nv">$label</span><span class="o">-&gt;</span><span class="na">getTitle</span><span class="o">()</span><span class="cp">}</span><span class="x">&lt;/span&gt;</span>
c708394c
WG
2782<span class="cp">{</span><span class="c">* new *</span><span class="cp">}</span>
2783<span class="cp">{</span><span class="o">@</span><span class="nv">$label</span><span class="o">-&gt;</span><span class="na">render</span><span class="o">()</span><span class="cp">}</span>
9aa5da67
WG
2784</code></pre></div></td></tr></table></div>
2785<p>The commonly used template code</p>
c708394c 2786<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nf">if</span> <span class="nv">$count</span> <span class="o">&lt;</span> <span class="m">4</span><span class="cp">}{</span><span class="o">@</span><span class="nv">$authors</span><span class="o">[</span><span class="m">0</span><span class="o">]-&gt;</span><span class="na">getAnchorTag</span><span class="o">()</span><span class="cp">}{</span><span class="nf">if</span> <span class="nv">$count</span> <span class="o">!=</span> <span class="m">1</span><span class="cp">}{</span><span class="nf">if</span> <span class="nv">$count</span> <span class="o">==</span> <span class="m">2</span> <span class="o">&amp;&amp;</span> <span class="o">!</span><span class="nv">$guestTimesTriggered</span><span class="cp">}</span><span class="x"> and </span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span><span class="x">, </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}{</span><span class="o">@</span><span class="nv">$authors</span><span class="o">[</span><span class="m">1</span><span class="o">]-&gt;</span><span class="na">getAnchorTag</span><span class="o">()</span><span class="cp">}{</span><span class="nf">if</span> <span class="nv">$count</span> <span class="o">==</span> <span class="m">3</span><span class="cp">}{</span><span class="nf">if</span> <span class="o">!</span><span class="nv">$guestTimesTriggered</span><span class="cp">}</span><span class="x"> and </span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span><span class="x">, </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="o">@</span><span class="nv">$authors</span><span class="o">[</span><span class="m">2</span><span class="o">]-&gt;</span><span class="na">getAnchorTag</span><span class="o">()</span><span class="cp">}{</span><span class="nf">/if</span><span class="cp">}{</span><span class="nf">/if</span><span class="cp">}{</span><span class="nf">if</span> <span class="nv">$guestTimesTriggered</span><span class="cp">}</span><span class="x"> and </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$guestTimesTriggered</span> <span class="o">==</span> <span class="m">1</span><span class="cp">}</span><span class="x">a guest</span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span><span class="x">guests</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}{</span><span class="nf">/if</span><span class="cp">}{</span><span class="nf">else</span><span class="cp">}{</span><span class="o">@</span><span class="nv">$authors</span><span class="o">[</span><span class="m">0</span><span class="o">]-&gt;</span><span class="na">getAnchorTag</span><span class="o">()</span><span class="cp">}{</span><span class="nf">if</span> <span class="nv">$guestTimesTriggered</span><span class="cp">}</span><span class="x">,</span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span><span class="x"> and</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="err">#</span><span class="nv">$others</span><span class="cp">}</span><span class="x"> other users </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$guestTimesTriggered</span><span class="cp">}</span><span class="x">and </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$guestTimesTriggered</span> <span class="o">==</span> <span class="m">1</span><span class="cp">}</span><span class="x">a guest</span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span><span class="x">guests</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}{</span><span class="nf">/if</span><span class="cp">}{</span><span class="nf">/if</span><span class="cp">}</span>
9aa5da67
WG
2787</code></pre></div></td></tr></table></div>
2788<p>in stacked notification messages can be replaced with a new language item:</p>
c708394c 2789<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="o">@</span><span class="s1">&#39;wcf.user.notification.stacked.authorList&#39;</span><span class="o">|</span><span class="na">language</span><span class="cp">}</span>
9aa5da67
WG
2790</code></pre></div></td></tr></table></div>
2791<h2 id="popovers">Popovers<a class="headerlink" href="#popovers" title="Permanent link">#</a></h2>
2792<p>Popovers provide additional information of the linked object when a user hovers over a link.
2793We unified the approach for such links:</p>
2794<ol>
2795<li>The relevant DBO class implements <code>wcf\data\IPopoverObject</code>.</li>
2796<li>The relevant DBO action class implements <code>wcf\data\IPopoverAction</code> and the <code>getPopover()</code> method returns an array with popover content.</li>
2797<li>Globally available, <code>WoltLabSuite/Core/Controller/Popover</code> is initialized with the relevant data.</li>
2798<li>Links are created with the <code>anchor</code> template plugin with an additional <code>class</code> attribute whose value is the return value of <code>IPopoverObject::getPopoverLinkClass()</code>.</li>
2799</ol>
2800<p>Example:</p>
2801<div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/data/foo/Foo.class.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2802<span class="normal">2</span>
2803<span class="normal">3</span>
2804<span class="normal">4</span>
2805<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">Foo</span> <span class="k">extends</span> <span class="nx">DatabaseObject</span> <span class="k">implements</span> <span class="nx">IPopoverObject</span> <span class="p">{</span>
2806 <span class="k">public</span> <span class="k">function</span> <span class="nf">getPopoverLinkClass</span><span class="p">()</span> <span class="p">{</span>
2807 <span class="k">return</span> <span class="s1">&#39;fooLink&#39;</span><span class="p">;</span>
2808 <span class="p">}</span>
2809<span class="p">}</span>
2810</code></pre></div></td></tr></table></div>
2811<div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/data/foo/FooAction.class.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2812<span class="normal"> 2</span>
2813<span class="normal"> 3</span>
2814<span class="normal"> 4</span>
2815<span class="normal"> 5</span>
2816<span class="normal"> 6</span>
2817<span class="normal"> 7</span>
2818<span class="normal"> 8</span>
2819<span class="normal"> 9</span>
2820<span class="normal">10</span>
2821<span class="normal">11</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">FooAction</span> <span class="k">extends</span> <span class="nx">AbstractDatabaseObjectAction</span> <span class="k">implements</span> <span class="nx">IPopoverAction</span> <span class="p">{</span>
2822 <span class="k">public</span> <span class="k">function</span> <span class="nf">validateGetPopover</span><span class="p">()</span> <span class="p">{</span>
2823 <span class="c1">// …</span>
2824 <span class="p">}</span>
2825
2826 <span class="k">public</span> <span class="k">function</span> <span class="nf">getPopover</span><span class="p">()</span> <span class="p">{</span>
2827 <span class="k">return</span> <span class="p">[</span>
2828 <span class="s1">&#39;template&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;…&#39;</span><span class="p">,</span>
2829 <span class="p">];</span>
2830 <span class="p">}</span>
2831<span class="p">}</span>
2832</code></pre></div></td></tr></table></div>
2833<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2834<span class="normal">2</span>
2835<span class="normal">3</span>
2836<span class="normal">4</span>
2837<span class="normal">5</span>
2838<span class="normal">6</span>
c708394c
WG
2839<span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nx">require</span><span class="p">([</span><span class="s1">&#39;WoltLabSuite/Core/Controller/Popover&#39;</span><span class="p">],</span><span class="w"> </span><span class="kd">function</span><span class="p">(</span><span class="nx">ControllerPopover</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
2840<span class="w"> </span><span class="nx">ControllerPopover</span><span class="p">.</span><span class="nx">init</span><span class="p">({</span>
2841<span class="w"> </span><span class="nx">className</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;fooLink&#39;</span><span class="p">,</span>
2842<span class="w"> </span><span class="nx">dboAction</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;wcf\\data\\foo\\FooAction&#39;</span><span class="p">,</span>
2843<span class="w"> </span><span class="nx">identifier</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;com.woltlab.wcf.foo&#39;</span>
2844<span class="w"> </span><span class="p">});</span>
2845<span class="p">});</span>
9aa5da67 2846</code></pre></div></td></tr></table></div>
c708394c 2847<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nf">anchor</span> <span class="na">object</span><span class="o">=</span><span class="nv">$foo</span> <span class="na">class</span><span class="o">=</span><span class="s1">&#39;fooLink&#39;</span><span class="cp">}</span>
9aa5da67
WG
2848</code></pre></div></td></tr></table></div>
2849
2850 <hr>
2851<div class="md-source-file">
2852 <small>
2853
2854 Last update:
2855 2022-05-13
2856
2857 </small>
2858</div>
2859
a06fd3b1
WG
2860
2861
2862
7f9945cf
WG
2863
2864
2865 </article>
2866 </div>
2867
2868
9aa5da67
WG
2869 </div>
2870
2871 </main>
2872
2873 <footer class="md-footer">
2874
9aa5da67
WG
2875 <div class="md-footer-meta md-typeset">
2876 <div class="md-footer-meta__inner md-grid">
2877 <div class="md-copyright">
2878
2879 <div class="md-copyright__highlight">
2880 Copyright © 2020 WoltLab GmbH
2881 </div>
2882
2883
2884 Made with
2885 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2886 Material for MkDocs
2887 </a>
2888
2889</div>
2890
2891 <div class="md-copyright">
2892 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2893 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2894</div>
2895
2896 </div>
2897 </div>
2898</footer>
2899
2900 </div>
2901 <div class="md-dialog" data-md-component="dialog">
2902 <div class="md-dialog__inner md-typeset"></div>
2903 </div>
a06fd3b1 2904
6f2e8f13 2905 <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
9aa5da67
WG
2906
2907
ea01e590 2908 <script src="../../../assets/javascripts/bundle.b4d07000.min.js"></script>
9aa5da67
WG
2909
2910
2911 </body>
2912</html>