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