Commit | Line | Data |
---|---|---|
45ca63d0 TD |
1 | |
2 | <!doctype html> | |
3 | <html lang="en" class="no-js"> | |
4 | <head> | |
5 | ||
6 | <meta charset="utf-8"> | |
7 | <meta name="viewport" content="width=device-width,initial-scale=1"> | |
8 | ||
9 | ||
10 | ||
11 | ||
c8b4da45 WG |
12 | <link rel="canonical" href="https://docs.woltlab.com/5.4/view/template-plugins/"> |
13 | ||
fb962f09 | 14 | <link rel="icon" href="../../assets/default.favicon.ico"> |
a4835aa6 | 15 | <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.2"> |
45ca63d0 TD |
16 | |
17 | ||
18 | ||
19 | <title>Template Plugins - WoltLab Suite Documentation</title> | |
20 | ||
21 | ||
22 | ||
a4835aa6 | 23 | <link rel="stylesheet" href="../../assets/stylesheets/main.6f955dcd.min.css"> |
45ca63d0 TD |
24 | |
25 | ||
fb962f09 | 26 | <link rel="stylesheet" href="../../assets/stylesheets/palette.ef6f36e2.min.css"> |
45ca63d0 TD |
27 | |
28 | ||
29 | ||
30 | <meta name="theme-color" content="#009485"> | |
31 | ||
32 | ||
33 | ||
34 | ||
35 | ||
fd8430cb WG |
36 | |
37 | ||
45ca63d0 TD |
38 | |
39 | ||
40 | <link rel="stylesheet" href="../../stylesheets/extra.css"> | |
41 | ||
42 | ||
43 | ||
44 | ||
45 | ||
46 | </head> | |
47 | ||
48 | ||
49 | ||
50 | ||
51 | ||
52 | ||
53 | ||
54 | <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent=""> | |
45ca63d0 TD |
55 | |
56 | ||
fb962f09 WG |
57 | <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script> |
58 | ||
45ca63d0 TD |
59 | <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
60 | <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> | |
61 | <label class="md-overlay" for="__drawer"></label> | |
62 | <div data-md-component="skip"> | |
63 | ||
64 | ||
65 | <a href="#template-plugins" class="md-skip"> | |
66 | Skip to content | |
67 | </a> | |
68 | ||
69 | </div> | |
70 | <div data-md-component="announce"> | |
71 | ||
72 | <aside class="md-announce"> | |
73 | <div class="md-announce__inner md-grid md-typeset"> | |
74 | ||
75 | <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a> | |
76 | ||
77 | </div> | |
78 | </aside> | |
79 | ||
80 | </div> | |
81 | ||
fb962f09 | 82 | <header class="md-header" data-md-component="header"> |
45ca63d0 | 83 | <nav class="md-header__inner md-grid" aria-label="Header"> |
fb962f09 | 84 | <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo"> |
45ca63d0 TD |
85 | |
86 | <img src="../../assets/logo.png" alt="logo"> | |
87 | ||
88 | </a> | |
89 | <label class="md-header__button md-icon" for="__drawer"> | |
90 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg> | |
91 | </label> | |
92 | <div class="md-header__title" data-md-component="header-title"> | |
93 | <div class="md-header__ellipsis"> | |
94 | <div class="md-header__topic"> | |
95 | <span class="md-ellipsis"> | |
96 | WoltLab Suite Documentation | |
97 | </span> | |
98 | </div> | |
99 | <div class="md-header__topic" data-md-component="header-topic"> | |
100 | <span class="md-ellipsis"> | |
101 | ||
102 | Template Plugins | |
103 | ||
104 | </span> | |
105 | </div> | |
106 | </div> | |
45ca63d0 TD |
107 | </div> |
108 | ||
fb962f09 WG |
109 | |
110 | ||
a3639e76 WG |
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"> | |
fb962f09 | 125 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg> |
a3639e76 WG |
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 | ||
45ca63d0 | 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 | ||
fb962f09 | 147 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> |
7124f4cb WG |
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 | ||
45ca63d0 TD |
174 | <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> |
175 | <label class="md-nav__title" for="__drawer"> | |
fb962f09 | 176 | <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo"> |
45ca63d0 TD |
177 | |
178 | <img src="../../assets/logo.png" alt="logo"> | |
179 | ||
180 | </a> | |
181 | WoltLab Suite Documentation | |
182 | </label> | |
183 | ||
7124f4cb WG |
184 | <div class="md-nav__source"> |
185 | ||
186 | <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source"> | |
187 | <div class="md-source__icon md-icon"> | |
188 | ||
fb962f09 | 189 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> |
7124f4cb WG |
190 | </div> |
191 | <div class="md-source__repository"> | |
192 | GitHub | |
193 | </div> | |
194 | </a> | |
195 | </div> | |
196 | ||
45ca63d0 TD |
197 | <ul class="md-nav__list" data-md-scrollfix> |
198 | ||
199 | ||
200 | ||
201 | ||
202 | ||
203 | ||
204 | ||
205 | ||
206 | <li class="md-nav__item"> | |
207 | <a href="../../getting-started/" class="md-nav__link"> | |
208 | Getting Started | |
209 | </a> | |
210 | </li> | |
211 | ||
212 | ||
213 | ||
214 | ||
215 | ||
216 | ||
217 | ||
218 | ||
219 | ||
220 | ||
221 | ||
222 | <li class="md-nav__item md-nav__item--nested"> | |
223 | ||
224 | ||
225 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" > | |
226 | ||
227 | <label class="md-nav__link" for="__nav_2"> | |
228 | PHP API | |
229 | <span class="md-nav__icon md-icon"></span> | |
230 | </label> | |
231 | <nav class="md-nav" aria-label="PHP API" data-md-level="1"> | |
232 | <label class="md-nav__title" for="__nav_2"> | |
233 | <span class="md-nav__icon md-icon"></span> | |
234 | PHP API | |
235 | </label> | |
236 | <ul class="md-nav__list" data-md-scrollfix> | |
237 | ||
238 | ||
239 | ||
240 | ||
241 | ||
242 | <li class="md-nav__item"> | |
243 | <a href="../../php/pages/" class="md-nav__link"> | |
244 | Pages | |
245 | </a> | |
246 | </li> | |
247 | ||
248 | ||
249 | ||
250 | ||
251 | ||
252 | ||
253 | ||
254 | <li class="md-nav__item"> | |
255 | <a href="../../php/database-objects/" class="md-nav__link"> | |
256 | Database Objects | |
257 | </a> | |
258 | </li> | |
259 | ||
260 | ||
261 | ||
262 | ||
263 | ||
264 | ||
265 | ||
266 | <li class="md-nav__item"> | |
267 | <a href="../../php/database-access/" class="md-nav__link"> | |
268 | Database Access | |
269 | </a> | |
270 | </li> | |
271 | ||
272 | ||
273 | ||
274 | ||
275 | ||
276 | ||
277 | ||
278 | <li class="md-nav__item"> | |
279 | <a href="../../php/exceptions/" class="md-nav__link"> | |
280 | Exceptions | |
281 | </a> | |
282 | </li> | |
283 | ||
284 | ||
285 | ||
286 | ||
287 | ||
288 | ||
289 | ||
290 | ||
291 | <li class="md-nav__item md-nav__item--nested"> | |
292 | ||
293 | ||
294 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" > | |
295 | ||
296 | <label class="md-nav__link" for="__nav_2_5"> | |
297 | API | |
298 | <span class="md-nav__icon md-icon"></span> | |
299 | </label> | |
300 | <nav class="md-nav" aria-label="API" data-md-level="2"> | |
301 | <label class="md-nav__title" for="__nav_2_5"> | |
302 | <span class="md-nav__icon md-icon"></span> | |
303 | API | |
304 | </label> | |
305 | <ul class="md-nav__list" data-md-scrollfix> | |
306 | ||
307 | ||
308 | ||
309 | ||
310 | ||
6923e968 WG |
311 | |
312 | <li class="md-nav__item md-nav__item--nested"> | |
313 | ||
314 | ||
315 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" > | |
316 | ||
317 | <label class="md-nav__link" for="__nav_2_5_1"> | |
318 | Caches | |
319 | <span class="md-nav__icon md-icon"></span> | |
320 | </label> | |
321 | <nav class="md-nav" aria-label="Caches" data-md-level="3"> | |
322 | <label class="md-nav__title" for="__nav_2_5_1"> | |
323 | <span class="md-nav__icon md-icon"></span> | |
324 | Caches | |
325 | </label> | |
326 | <ul class="md-nav__list" data-md-scrollfix> | |
327 | ||
328 | ||
329 | ||
330 | ||
331 | ||
45ca63d0 TD |
332 | <li class="md-nav__item"> |
333 | <a href="../../php/api/caches/" class="md-nav__link"> | |
6923e968 | 334 | Overview |
45ca63d0 TD |
335 | </a> |
336 | </li> | |
337 | ||
338 | ||
339 | ||
340 | ||
341 | ||
342 | ||
343 | ||
6923e968 WG |
344 | <li class="md-nav__item"> |
345 | <a href="../../php/api/caches_persistent-caches/" class="md-nav__link"> | |
346 | Persistent Caches | |
347 | </a> | |
348 | </li> | |
349 | ||
350 | ||
351 | ||
352 | ||
353 | ||
354 | ||
355 | ||
356 | <li class="md-nav__item"> | |
357 | <a href="../../php/api/caches_runtime-caches/" class="md-nav__link"> | |
358 | Runtime Caches | |
359 | </a> | |
360 | </li> | |
361 | ||
362 | ||
363 | ||
364 | </ul> | |
365 | </nav> | |
366 | </li> | |
367 | ||
368 | ||
369 | ||
370 | ||
371 | ||
372 | ||
373 | ||
45ca63d0 TD |
374 | <li class="md-nav__item"> |
375 | <a href="../../php/api/comments/" class="md-nav__link"> | |
376 | Comments | |
377 | </a> | |
378 | </li> | |
379 | ||
380 | ||
381 | ||
382 | ||
383 | ||
384 | ||
385 | ||
386 | <li class="md-nav__item"> | |
387 | <a href="../../php/api/cronjobs/" class="md-nav__link"> | |
388 | Cronjobs | |
389 | </a> | |
390 | </li> | |
391 | ||
392 | ||
393 | ||
394 | ||
395 | ||
396 | ||
397 | ||
398 | <li class="md-nav__item"> | |
399 | <a href="../../php/api/events/" class="md-nav__link"> | |
400 | Events | |
401 | </a> | |
402 | </li> | |
403 | ||
404 | ||
405 | ||
406 | ||
407 | ||
408 | ||
409 | ||
410 | ||
411 | <li class="md-nav__item md-nav__item--nested"> | |
412 | ||
413 | ||
414 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" > | |
415 | ||
416 | <label class="md-nav__link" for="__nav_2_5_5"> | |
417 | Form Builder | |
418 | <span class="md-nav__icon md-icon"></span> | |
419 | </label> | |
420 | <nav class="md-nav" aria-label="Form Builder" data-md-level="3"> | |
421 | <label class="md-nav__title" for="__nav_2_5_5"> | |
422 | <span class="md-nav__icon md-icon"></span> | |
423 | Form Builder | |
424 | </label> | |
425 | <ul class="md-nav__list" data-md-scrollfix> | |
426 | ||
427 | ||
428 | ||
429 | ||
430 | ||
431 | <li class="md-nav__item"> | |
432 | <a href="../../php/api/form_builder/overview/" class="md-nav__link"> | |
433 | Overview | |
434 | </a> | |
435 | </li> | |
436 | ||
437 | ||
438 | ||
439 | ||
440 | ||
441 | ||
442 | ||
443 | <li class="md-nav__item"> | |
444 | <a href="../../php/api/form_builder/structure/" class="md-nav__link"> | |
445 | Structure | |
446 | </a> | |
447 | </li> | |
448 | ||
449 | ||
450 | ||
451 | ||
452 | ||
453 | ||
454 | ||
455 | <li class="md-nav__item"> | |
456 | <a href="../../php/api/form_builder/form_fields/" class="md-nav__link"> | |
457 | Fields | |
458 | </a> | |
459 | </li> | |
460 | ||
461 | ||
462 | ||
463 | ||
464 | ||
465 | ||
466 | ||
467 | <li class="md-nav__item"> | |
468 | <a href="../../php/api/form_builder/validation_data/" class="md-nav__link"> | |
469 | Validation and Data | |
470 | </a> | |
471 | </li> | |
472 | ||
473 | ||
474 | ||
475 | ||
476 | ||
477 | ||
478 | ||
479 | <li class="md-nav__item"> | |
480 | <a href="../../php/api/form_builder/dependencies/" class="md-nav__link"> | |
481 | Dependencies | |
482 | </a> | |
483 | </li> | |
484 | ||
485 | ||
486 | ||
487 | </ul> | |
488 | </nav> | |
489 | </li> | |
490 | ||
491 | ||
492 | ||
493 | ||
494 | ||
495 | ||
496 | ||
497 | <li class="md-nav__item"> | |
498 | <a href="../../php/api/package_installation_plugins/" class="md-nav__link"> | |
499 | Package Installation Plugins | |
500 | </a> | |
501 | </li> | |
502 | ||
503 | ||
504 | ||
505 | ||
506 | ||
507 | ||
508 | ||
509 | <li class="md-nav__item"> | |
510 | <a href="../../php/api/user_activity_points/" class="md-nav__link"> | |
511 | User Activity Points | |
512 | </a> | |
513 | </li> | |
514 | ||
515 | ||
516 | ||
517 | ||
518 | ||
519 | ||
520 | ||
521 | <li class="md-nav__item"> | |
522 | <a href="../../php/api/user_notifications/" class="md-nav__link"> | |
523 | User Notifications | |
524 | </a> | |
525 | </li> | |
526 | ||
527 | ||
528 | ||
529 | ||
530 | ||
531 | ||
532 | ||
533 | <li class="md-nav__item"> | |
534 | <a href="../../php/api/sitemaps/" class="md-nav__link"> | |
535 | Sitemaps | |
536 | </a> | |
537 | </li> | |
538 | ||
539 | ||
540 | ||
541 | </ul> | |
542 | </nav> | |
543 | </li> | |
544 | ||
545 | ||
546 | ||
547 | ||
548 | ||
549 | ||
550 | ||
551 | <li class="md-nav__item"> | |
552 | <a href="../../php/code-style/" class="md-nav__link"> | |
553 | Code Style | |
554 | </a> | |
555 | </li> | |
556 | ||
557 | ||
558 | ||
559 | ||
560 | ||
561 | ||
562 | ||
563 | <li class="md-nav__item"> | |
564 | <a href="../../php/apps/" class="md-nav__link"> | |
565 | Apps | |
566 | </a> | |
567 | </li> | |
568 | ||
569 | ||
570 | ||
571 | ||
572 | ||
573 | ||
574 | ||
575 | <li class="md-nav__item"> | |
576 | <a href="../../php/gdpr/" class="md-nav__link"> | |
577 | GDPR | |
578 | </a> | |
579 | </li> | |
580 | ||
581 | ||
582 | ||
583 | </ul> | |
584 | </nav> | |
585 | </li> | |
586 | ||
587 | ||
588 | ||
589 | ||
590 | ||
591 | ||
592 | ||
593 | ||
594 | ||
6923e968 WG |
595 | |
596 | ||
45ca63d0 TD |
597 | |
598 | ||
6923e968 | 599 | <li class="md-nav__item md-nav__item--active md-nav__item--nested"> |
45ca63d0 TD |
600 | |
601 | ||
6923e968 | 602 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked> |
45ca63d0 TD |
603 | |
604 | <label class="md-nav__link" for="__nav_3"> | |
605 | Languages, Templates & CSS | |
606 | <span class="md-nav__icon md-icon"></span> | |
607 | </label> | |
608 | <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1"> | |
609 | <label class="md-nav__title" for="__nav_3"> | |
610 | <span class="md-nav__icon md-icon"></span> | |
611 | Languages, Templates & CSS | |
612 | </label> | |
613 | <ul class="md-nav__list" data-md-scrollfix> | |
614 | ||
615 | ||
616 | ||
617 | ||
618 | ||
619 | <li class="md-nav__item"> | |
620 | <a href="../languages/" class="md-nav__link"> | |
621 | Languages | |
622 | </a> | |
623 | </li> | |
624 | ||
625 | ||
626 | ||
627 | ||
628 | ||
629 | ||
630 | ||
631 | <li class="md-nav__item"> | |
632 | <a href="../templates/" class="md-nav__link"> | |
633 | Templates | |
634 | </a> | |
635 | </li> | |
636 | ||
637 | ||
638 | ||
639 | ||
640 | ||
641 | ||
6923e968 WG |
642 | |
643 | ||
644 | ||
645 | <li class="md-nav__item md-nav__item--active"> | |
646 | ||
647 | <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> | |
648 | ||
a4835aa6 | 649 | |
6923e968 WG |
650 | |
651 | ||
652 | ||
653 | <label class="md-nav__link md-nav__link--active" for="__toc"> | |
654 | Template Plugins | |
655 | <span class="md-nav__icon md-icon"></span> | |
656 | </label> | |
657 | ||
658 | <a href="./" class="md-nav__link md-nav__link--active"> | |
659 | Template Plugins | |
660 | </a> | |
661 | ||
662 | ||
663 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
664 | ||
665 | ||
a4835aa6 | 666 | |
6923e968 WG |
667 | |
668 | ||
669 | ||
670 | <label class="md-nav__title" for="__toc"> | |
671 | <span class="md-nav__icon md-icon"></span> | |
672 | Table of contents | |
673 | </label> | |
674 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
675 | ||
676 | <li class="md-nav__item"> | |
677 | <a href="#53-anchor" class="md-nav__link"> | |
678 | 5.3+ anchor | |
679 | </a> | |
680 | ||
681 | </li> | |
682 | ||
683 | <li class="md-nav__item"> | |
684 | <a href="#53-anchorattributes" class="md-nav__link"> | |
685 | 5.3+ anchorAttributes | |
686 | </a> | |
687 | ||
688 | </li> | |
689 | ||
690 | <li class="md-nav__item"> | |
691 | <a href="#append" class="md-nav__link"> | |
692 | append | |
693 | </a> | |
694 | ||
695 | </li> | |
696 | ||
697 | <li class="md-nav__item"> | |
698 | <a href="#assign" class="md-nav__link"> | |
699 | assign | |
700 | </a> | |
701 | ||
702 | </li> | |
703 | ||
704 | <li class="md-nav__item"> | |
705 | <a href="#capture" class="md-nav__link"> | |
706 | capture | |
707 | </a> | |
708 | ||
709 | </li> | |
710 | ||
711 | <li class="md-nav__item"> | |
712 | <a href="#concat" class="md-nav__link"> | |
713 | concat | |
714 | </a> | |
715 | ||
716 | </li> | |
717 | ||
718 | <li class="md-nav__item"> | |
719 | <a href="#counter" class="md-nav__link"> | |
720 | counter | |
721 | </a> | |
722 | ||
723 | </li> | |
724 | ||
725 | <li class="md-nav__item"> | |
726 | <a href="#54-csrftoken" class="md-nav__link"> | |
727 | 5.4+ csrfToken | |
728 | </a> | |
729 | ||
730 | </li> | |
731 | ||
732 | <li class="md-nav__item"> | |
733 | <a href="#currency" class="md-nav__link"> | |
734 | currency | |
735 | </a> | |
736 | ||
737 | </li> | |
738 | ||
739 | <li class="md-nav__item"> | |
740 | <a href="#cycle" class="md-nav__link"> | |
741 | cycle | |
742 | </a> | |
743 | ||
744 | </li> | |
745 | ||
746 | <li class="md-nav__item"> | |
747 | <a href="#date" class="md-nav__link"> | |
748 | date | |
749 | </a> | |
750 | ||
751 | </li> | |
752 | ||
753 | <li class="md-nav__item"> | |
754 | <a href="#31-dateinterval" class="md-nav__link"> | |
755 | 3.1+ dateInterval | |
756 | </a> | |
757 | ||
758 | </li> | |
759 | ||
760 | <li class="md-nav__item"> | |
761 | <a href="#encodejs" class="md-nav__link"> | |
762 | encodeJS | |
763 | </a> | |
764 | ||
765 | </li> | |
766 | ||
767 | <li class="md-nav__item"> | |
768 | <a href="#encodejson" class="md-nav__link"> | |
769 | encodeJSON | |
770 | </a> | |
771 | ||
772 | </li> | |
773 | ||
774 | <li class="md-nav__item"> | |
775 | <a href="#escapecdata" class="md-nav__link"> | |
776 | escapeCDATA | |
777 | </a> | |
778 | ||
779 | </li> | |
780 | ||
781 | <li class="md-nav__item"> | |
782 | <a href="#event" class="md-nav__link"> | |
783 | event | |
784 | </a> | |
785 | ||
786 | </li> | |
787 | ||
788 | <li class="md-nav__item"> | |
789 | <a href="#fetch" class="md-nav__link"> | |
790 | fetch | |
791 | </a> | |
792 | ||
793 | </li> | |
794 | ||
795 | <li class="md-nav__item"> | |
796 | <a href="#filesizebinary" class="md-nav__link"> | |
797 | filesizeBinary | |
798 | </a> | |
799 | ||
800 | </li> | |
801 | ||
802 | <li class="md-nav__item"> | |
803 | <a href="#filesize" class="md-nav__link"> | |
804 | filesize | |
805 | </a> | |
806 | ||
807 | </li> | |
808 | ||
809 | <li class="md-nav__item"> | |
810 | <a href="#hascontent" class="md-nav__link"> | |
811 | hascontent | |
812 | </a> | |
813 | ||
814 | </li> | |
815 | ||
816 | <li class="md-nav__item"> | |
817 | <a href="#htmlcheckboxes" class="md-nav__link"> | |
818 | htmlCheckboxes | |
819 | </a> | |
820 | ||
821 | </li> | |
822 | ||
823 | <li class="md-nav__item"> | |
824 | <a href="#htmloptions" class="md-nav__link"> | |
825 | htmlOptions | |
826 | </a> | |
827 | ||
828 | </li> | |
829 | ||
830 | <li class="md-nav__item"> | |
831 | <a href="#implode" class="md-nav__link"> | |
832 | implode | |
833 | </a> | |
834 | ||
835 | </li> | |
836 | ||
837 | <li class="md-nav__item"> | |
838 | <a href="#52-ipsearch" class="md-nav__link"> | |
839 | 5.2+ ipSearch | |
840 | </a> | |
841 | ||
842 | </li> | |
843 | ||
844 | <li class="md-nav__item"> | |
845 | <a href="#30-js" class="md-nav__link"> | |
846 | 3.0+ js | |
847 | </a> | |
848 | ||
849 | </li> | |
850 | ||
851 | <li class="md-nav__item"> | |
852 | <a href="#53-jslang" class="md-nav__link"> | |
853 | 5.3+ jslang | |
854 | </a> | |
855 | ||
856 | </li> | |
857 | ||
858 | <li class="md-nav__item"> | |
859 | <a href="#lang" class="md-nav__link"> | |
860 | lang | |
861 | </a> | |
862 | ||
863 | </li> | |
864 | ||
865 | <li class="md-nav__item"> | |
866 | <a href="#language" class="md-nav__link"> | |
867 | language | |
868 | </a> | |
869 | ||
870 | </li> | |
871 | ||
872 | <li class="md-nav__item"> | |
873 | <a href="#link" class="md-nav__link"> | |
874 | link | |
875 | </a> | |
876 | ||
877 | </li> | |
878 | ||
879 | <li class="md-nav__item"> | |
880 | <a href="#newlinetobreak" class="md-nav__link"> | |
881 | newlineToBreak | |
882 | </a> | |
883 | ||
7d7c4daf WG |
884 | </li> |
885 | ||
886 | <li class="md-nav__item"> | |
887 | <a href="#54-objectaction" class="md-nav__link"> | |
888 | 5.4+ objectAction | |
889 | </a> | |
890 | ||
6923e968 WG |
891 | </li> |
892 | ||
893 | <li class="md-nav__item"> | |
894 | <a href="#30-page" class="md-nav__link"> | |
895 | 3.0+ page | |
896 | </a> | |
897 | ||
898 | </li> | |
899 | ||
900 | <li class="md-nav__item"> | |
901 | <a href="#pages" class="md-nav__link"> | |
902 | pages | |
903 | </a> | |
904 | ||
905 | </li> | |
906 | ||
907 | <li class="md-nav__item"> | |
908 | <a href="#plaintime" class="md-nav__link"> | |
909 | plainTime | |
910 | </a> | |
911 | ||
912 | </li> | |
913 | ||
914 | <li class="md-nav__item"> | |
915 | <a href="#53-plural" class="md-nav__link"> | |
916 | 5.3+ plural | |
917 | </a> | |
918 | ||
919 | </li> | |
920 | ||
921 | <li class="md-nav__item"> | |
922 | <a href="#prepend" class="md-nav__link"> | |
923 | prepend | |
924 | </a> | |
925 | ||
926 | </li> | |
927 | ||
928 | <li class="md-nav__item"> | |
929 | <a href="#shortunit" class="md-nav__link"> | |
930 | shortUnit | |
931 | </a> | |
932 | ||
933 | </li> | |
934 | ||
935 | <li class="md-nav__item"> | |
936 | <a href="#smallpages" class="md-nav__link"> | |
937 | smallpages | |
938 | </a> | |
939 | ||
940 | </li> | |
941 | ||
942 | <li class="md-nav__item"> | |
943 | <a href="#tablewordwrap" class="md-nav__link"> | |
944 | tableWordwrap | |
945 | </a> | |
946 | ||
947 | </li> | |
948 | ||
949 | <li class="md-nav__item"> | |
950 | <a href="#time" class="md-nav__link"> | |
951 | time | |
952 | </a> | |
953 | ||
954 | </li> | |
955 | ||
956 | <li class="md-nav__item"> | |
957 | <a href="#truncate" class="md-nav__link"> | |
958 | truncate | |
959 | </a> | |
960 | ||
961 | </li> | |
962 | ||
963 | <li class="md-nav__item"> | |
964 | <a href="#53-user" class="md-nav__link"> | |
965 | 5.3+ user | |
966 | </a> | |
967 | ||
968 | </li> | |
969 | ||
970 | </ul> | |
971 | ||
972 | </nav> | |
973 | ||
974 | </li> | |
975 | ||
976 | ||
977 | ||
978 | ||
979 | ||
980 | ||
45ca63d0 TD |
981 | |
982 | <li class="md-nav__item"> | |
983 | <a href="../css/" class="md-nav__link"> | |
984 | CSS | |
985 | </a> | |
986 | </li> | |
987 | ||
988 | ||
989 | ||
990 | </ul> | |
991 | </nav> | |
992 | </li> | |
993 | ||
994 | ||
995 | ||
996 | ||
997 | ||
998 | ||
999 | ||
1000 | ||
1001 | ||
1002 | ||
1003 | ||
1004 | <li class="md-nav__item md-nav__item--nested"> | |
1005 | ||
1006 | ||
1007 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > | |
1008 | ||
1009 | <label class="md-nav__link" for="__nav_4"> | |
77efcd46 | 1010 | TypeScript and JavaScript API |
45ca63d0 TD |
1011 | <span class="md-nav__icon md-icon"></span> |
1012 | </label> | |
77efcd46 | 1013 | <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1"> |
45ca63d0 TD |
1014 | <label class="md-nav__title" for="__nav_4"> |
1015 | <span class="md-nav__icon md-icon"></span> | |
77efcd46 | 1016 | TypeScript and JavaScript API |
45ca63d0 TD |
1017 | </label> |
1018 | <ul class="md-nav__list" data-md-scrollfix> | |
1019 | ||
1020 | ||
1021 | ||
1022 | ||
1023 | ||
1024 | <li class="md-nav__item"> | |
1025 | <a href="../../javascript/general-usage/" class="md-nav__link"> | |
1026 | General Usage | |
1027 | </a> | |
1028 | </li> | |
1029 | ||
1030 | ||
1031 | ||
1032 | ||
1033 | ||
1034 | ||
1035 | ||
77efcd46 WG |
1036 | <li class="md-nav__item"> |
1037 | <a href="../../javascript/typescript/" class="md-nav__link"> | |
1038 | TypeScript | |
1039 | </a> | |
1040 | </li> | |
1041 | ||
1042 | ||
1043 | ||
1044 | ||
1045 | ||
1046 | ||
1047 | ||
45ca63d0 TD |
1048 | |
1049 | <li class="md-nav__item md-nav__item--nested"> | |
1050 | ||
1051 | ||
77efcd46 | 1052 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" > |
45ca63d0 | 1053 | |
77efcd46 | 1054 | <label class="md-nav__link" for="__nav_4_3"> |
45ca63d0 TD |
1055 | New API |
1056 | <span class="md-nav__icon md-icon"></span> | |
1057 | </label> | |
1058 | <nav class="md-nav" aria-label="New API" data-md-level="2"> | |
77efcd46 | 1059 | <label class="md-nav__title" for="__nav_4_3"> |
45ca63d0 TD |
1060 | <span class="md-nav__icon md-icon"></span> |
1061 | New API | |
1062 | </label> | |
1063 | <ul class="md-nav__list" data-md-scrollfix> | |
1064 | ||
1065 | ||
1066 | ||
1067 | ||
1068 | ||
1069 | <li class="md-nav__item"> | |
1070 | <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link"> | |
1071 | Writing a module | |
1072 | </a> | |
1073 | </li> | |
1074 | ||
1075 | ||
1076 | ||
1077 | ||
1078 | ||
1079 | ||
1080 | ||
1081 | <li class="md-nav__item"> | |
1082 | <a href="../../javascript/new-api_data-structures/" class="md-nav__link"> | |
1083 | Data Structures | |
1084 | </a> | |
1085 | </li> | |
1086 | ||
1087 | ||
1088 | ||
1089 | ||
1090 | ||
1091 | ||
1092 | ||
1093 | <li class="md-nav__item"> | |
1094 | <a href="../../javascript/new-api_core/" class="md-nav__link"> | |
1095 | Core Functions | |
1096 | </a> | |
1097 | </li> | |
1098 | ||
1099 | ||
1100 | ||
1101 | ||
1102 | ||
1103 | ||
1104 | ||
1105 | <li class="md-nav__item"> | |
1106 | <a href="../../javascript/new-api_dom/" class="md-nav__link"> | |
1107 | DOM | |
1108 | </a> | |
1109 | </li> | |
1110 | ||
1111 | ||
1112 | ||
1113 | ||
1114 | ||
1115 | ||
1116 | ||
1117 | <li class="md-nav__item"> | |
1118 | <a href="../../javascript/new-api_events/" class="md-nav__link"> | |
1119 | Event Handling | |
1120 | </a> | |
1121 | </li> | |
1122 | ||
1123 | ||
1124 | ||
1125 | ||
1126 | ||
1127 | ||
1128 | ||
1129 | <li class="md-nav__item"> | |
1130 | <a href="../../javascript/new-api_ajax/" class="md-nav__link"> | |
1131 | Ajax | |
1132 | </a> | |
1133 | </li> | |
1134 | ||
1135 | ||
1136 | ||
1137 | ||
1138 | ||
1139 | ||
1140 | ||
1141 | <li class="md-nav__item"> | |
1142 | <a href="../../javascript/new-api_dialogs/" class="md-nav__link"> | |
1143 | Dialogs | |
1144 | </a> | |
1145 | </li> | |
1146 | ||
1147 | ||
1148 | ||
1149 | ||
1150 | ||
1151 | ||
1152 | ||
1153 | <li class="md-nav__item"> | |
1154 | <a href="../../javascript/new-api_browser/" class="md-nav__link"> | |
1155 | Browser and Screen Sizes | |
1156 | </a> | |
1157 | </li> | |
1158 | ||
1159 | ||
1160 | ||
1161 | ||
1162 | ||
1163 | ||
1164 | ||
1165 | <li class="md-nav__item"> | |
1166 | <a href="../../javascript/new-api_ui/" class="md-nav__link"> | |
1167 | User Interface | |
1168 | </a> | |
1169 | </li> | |
1170 | ||
1171 | ||
1172 | ||
1173 | </ul> | |
1174 | </nav> | |
1175 | </li> | |
1176 | ||
1177 | ||
1178 | ||
1179 | ||
1180 | ||
1181 | ||
1182 | ||
1183 | <li class="md-nav__item"> | |
1184 | <a href="../../javascript/legacy-api/" class="md-nav__link"> | |
1185 | Legacy API | |
1186 | </a> | |
1187 | </li> | |
1188 | ||
1189 | ||
1190 | ||
1191 | ||
1192 | ||
1193 | ||
1194 | ||
1195 | <li class="md-nav__item"> | |
1196 | <a href="../../javascript/helper-functions/" class="md-nav__link"> | |
1197 | Helper Functions | |
1198 | </a> | |
1199 | </li> | |
1200 | ||
1201 | ||
1202 | ||
1203 | ||
1204 | ||
1205 | ||
1206 | ||
1207 | <li class="md-nav__item"> | |
1208 | <a href="../../javascript/code-snippets/" class="md-nav__link"> | |
1209 | Code Snippets | |
1210 | </a> | |
1211 | </li> | |
1212 | ||
1213 | ||
1214 | ||
1215 | </ul> | |
1216 | </nav> | |
1217 | </li> | |
1218 | ||
1219 | ||
1220 | ||
1221 | ||
1222 | ||
1223 | ||
1224 | ||
1225 | ||
1226 | ||
1227 | ||
1228 | ||
1229 | <li class="md-nav__item md-nav__item--nested"> | |
1230 | ||
1231 | ||
1232 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > | |
1233 | ||
1234 | <label class="md-nav__link" for="__nav_5"> | |
1235 | Package Components | |
1236 | <span class="md-nav__icon md-icon"></span> | |
1237 | </label> | |
1238 | <nav class="md-nav" aria-label="Package Components" data-md-level="1"> | |
1239 | <label class="md-nav__title" for="__nav_5"> | |
1240 | <span class="md-nav__icon md-icon"></span> | |
1241 | Package Components | |
1242 | </label> | |
1243 | <ul class="md-nav__list" data-md-scrollfix> | |
1244 | ||
1245 | ||
1246 | ||
1247 | ||
1248 | ||
1249 | <li class="md-nav__item"> | |
1250 | <a href="../../package/package-xml/" class="md-nav__link"> | |
1251 | package.xml | |
1252 | </a> | |
1253 | </li> | |
1254 | ||
1255 | ||
1256 | ||
1257 | ||
1258 | ||
1259 | ||
1260 | ||
1261 | ||
1262 | <li class="md-nav__item md-nav__item--nested"> | |
1263 | ||
1264 | ||
1265 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" > | |
1266 | ||
1267 | <label class="md-nav__link" for="__nav_5_2"> | |
1268 | PIPs | |
1269 | <span class="md-nav__icon md-icon"></span> | |
1270 | </label> | |
1271 | <nav class="md-nav" aria-label="PIPs" data-md-level="2"> | |
1272 | <label class="md-nav__title" for="__nav_5_2"> | |
1273 | <span class="md-nav__icon md-icon"></span> | |
1274 | PIPs | |
1275 | </label> | |
1276 | <ul class="md-nav__list" data-md-scrollfix> | |
1277 | ||
1278 | ||
1279 | ||
1280 | ||
1281 | ||
1282 | <li class="md-nav__item"> | |
1283 | <a href="../../package/pip/" class="md-nav__link"> | |
1284 | Overview | |
1285 | </a> | |
1286 | </li> | |
1287 | ||
1288 | ||
1289 | ||
1290 | ||
1291 | ||
1292 | ||
1293 | ||
1294 | <li class="md-nav__item"> | |
1295 | <a href="../../package/pip/acl-option/" class="md-nav__link"> | |
1296 | aclOption | |
1297 | </a> | |
1298 | </li> | |
1299 | ||
1300 | ||
1301 | ||
1302 | ||
1303 | ||
1304 | ||
1305 | ||
1306 | <li class="md-nav__item"> | |
1307 | <a href="../../package/pip/acp-menu/" class="md-nav__link"> | |
1308 | acpMenu | |
1309 | </a> | |
1310 | </li> | |
1311 | ||
1312 | ||
1313 | ||
1314 | ||
1315 | ||
1316 | ||
1317 | ||
1318 | <li class="md-nav__item"> | |
1319 | <a href="../../package/pip/acp-search-provider/" class="md-nav__link"> | |
1320 | acpSearchProvider | |
1321 | </a> | |
1322 | </li> | |
1323 | ||
1324 | ||
1325 | ||
1326 | ||
1327 | ||
1328 | ||
1329 | ||
1330 | <li class="md-nav__item"> | |
1331 | <a href="../../package/pip/acp-template/" class="md-nav__link"> | |
1332 | acpTemplate | |
1333 | </a> | |
1334 | </li> | |
1335 | ||
1336 | ||
1337 | ||
1338 | ||
1339 | ||
1340 | ||
1341 | ||
1342 | <li class="md-nav__item"> | |
1343 | <a href="../../package/pip/bbcode/" class="md-nav__link"> | |
1344 | bbcode | |
1345 | </a> | |
1346 | </li> | |
1347 | ||
1348 | ||
1349 | ||
1350 | ||
1351 | ||
1352 | ||
1353 | ||
1354 | <li class="md-nav__item"> | |
1355 | <a href="../../package/pip/box/" class="md-nav__link"> | |
1356 | box | |
1357 | </a> | |
1358 | </li> | |
1359 | ||
1360 | ||
1361 | ||
1362 | ||
1363 | ||
1364 | ||
1365 | ||
1366 | <li class="md-nav__item"> | |
1367 | <a href="../../package/pip/clipboard-action/" class="md-nav__link"> | |
1368 | clipboardAction | |
1369 | </a> | |
1370 | </li> | |
1371 | ||
1372 | ||
1373 | ||
1374 | ||
1375 | ||
1376 | ||
1377 | ||
1378 | <li class="md-nav__item"> | |
1379 | <a href="../../package/pip/core-object/" class="md-nav__link"> | |
1380 | coreObject | |
1381 | </a> | |
1382 | </li> | |
1383 | ||
1384 | ||
1385 | ||
1386 | ||
1387 | ||
1388 | ||
1389 | ||
1390 | <li class="md-nav__item"> | |
1391 | <a href="../../package/pip/cronjob/" class="md-nav__link"> | |
1392 | cronjob | |
1393 | </a> | |
1394 | </li> | |
1395 | ||
1396 | ||
1397 | ||
1398 | ||
1399 | ||
1400 | ||
1401 | ||
6923e968 WG |
1402 | <li class="md-nav__item"> |
1403 | <a href="../../package/pip/database/" class="md-nav__link"> | |
1404 | database | |
1405 | </a> | |
1406 | </li> | |
1407 | ||
1408 | ||
1409 | ||
1410 | ||
1411 | ||
1412 | ||
1413 | ||
45ca63d0 TD |
1414 | <li class="md-nav__item"> |
1415 | <a href="../../package/pip/event-listener/" class="md-nav__link"> | |
1416 | eventListener | |
1417 | </a> | |
1418 | </li> | |
1419 | ||
1420 | ||
1421 | ||
1422 | ||
1423 | ||
1424 | ||
1425 | ||
1426 | <li class="md-nav__item"> | |
1427 | <a href="../../package/pip/file/" class="md-nav__link"> | |
1428 | file | |
1429 | </a> | |
1430 | </li> | |
1431 | ||
1432 | ||
1433 | ||
1434 | ||
1435 | ||
1436 | ||
1437 | ||
1438 | <li class="md-nav__item"> | |
1439 | <a href="../../package/pip/language/" class="md-nav__link"> | |
1440 | language | |
1441 | </a> | |
1442 | </li> | |
1443 | ||
1444 | ||
1445 | ||
1446 | ||
1447 | ||
1448 | ||
1449 | ||
1450 | <li class="md-nav__item"> | |
1451 | <a href="../../package/pip/media-provider/" class="md-nav__link"> | |
1452 | mediaProvider | |
1453 | </a> | |
1454 | </li> | |
1455 | ||
1456 | ||
1457 | ||
1458 | ||
1459 | ||
1460 | ||
1461 | ||
1462 | <li class="md-nav__item"> | |
1463 | <a href="../../package/pip/menu/" class="md-nav__link"> | |
1464 | menu | |
1465 | </a> | |
1466 | </li> | |
1467 | ||
1468 | ||
1469 | ||
1470 | ||
1471 | ||
1472 | ||
1473 | ||
1474 | <li class="md-nav__item"> | |
1475 | <a href="../../package/pip/menu-item/" class="md-nav__link"> | |
1476 | menuItem | |
1477 | </a> | |
1478 | </li> | |
1479 | ||
1480 | ||
1481 | ||
1482 | ||
1483 | ||
1484 | ||
1485 | ||
1486 | <li class="md-nav__item"> | |
1487 | <a href="../../package/pip/object-type/" class="md-nav__link"> | |
1488 | objectType | |
1489 | </a> | |
1490 | </li> | |
1491 | ||
1492 | ||
1493 | ||
1494 | ||
1495 | ||
1496 | ||
1497 | ||
1498 | <li class="md-nav__item"> | |
1499 | <a href="../../package/pip/object-type-definition/" class="md-nav__link"> | |
1500 | objectTypeDefinition | |
1501 | </a> | |
1502 | </li> | |
1503 | ||
1504 | ||
1505 | ||
1506 | ||
1507 | ||
1508 | ||
1509 | ||
1510 | <li class="md-nav__item"> | |
1511 | <a href="../../package/pip/option/" class="md-nav__link"> | |
1512 | option | |
1513 | </a> | |
1514 | </li> | |
1515 | ||
1516 | ||
1517 | ||
1518 | ||
1519 | ||
1520 | ||
1521 | ||
1522 | <li class="md-nav__item"> | |
1523 | <a href="../../package/pip/page/" class="md-nav__link"> | |
1524 | page | |
1525 | </a> | |
1526 | </li> | |
1527 | ||
1528 | ||
1529 | ||
1530 | ||
1531 | ||
1532 | ||
1533 | ||
1534 | <li class="md-nav__item"> | |
1535 | <a href="../../package/pip/pip/" class="md-nav__link"> | |
1536 | pip | |
1537 | </a> | |
1538 | </li> | |
1539 | ||
1540 | ||
1541 | ||
1542 | ||
1543 | ||
1544 | ||
1545 | ||
1546 | <li class="md-nav__item"> | |
1547 | <a href="../../package/pip/script/" class="md-nav__link"> | |
1548 | script | |
1549 | </a> | |
1550 | </li> | |
1551 | ||
1552 | ||
1553 | ||
1554 | ||
1555 | ||
1556 | ||
1557 | ||
1558 | <li class="md-nav__item"> | |
1559 | <a href="../../package/pip/smiley/" class="md-nav__link"> | |
1560 | smiley | |
1561 | </a> | |
1562 | </li> | |
1563 | ||
1564 | ||
1565 | ||
1566 | ||
1567 | ||
1568 | ||
1569 | ||
1570 | <li class="md-nav__item"> | |
1571 | <a href="../../package/pip/sql/" class="md-nav__link"> | |
1572 | sql | |
1573 | </a> | |
1574 | </li> | |
1575 | ||
1576 | ||
1577 | ||
1578 | ||
1579 | ||
1580 | ||
1581 | ||
1582 | <li class="md-nav__item"> | |
1583 | <a href="../../package/pip/style/" class="md-nav__link"> | |
1584 | style | |
1585 | </a> | |
1586 | </li> | |
1587 | ||
1588 | ||
1589 | ||
1590 | ||
1591 | ||
1592 | ||
1593 | ||
1594 | <li class="md-nav__item"> | |
1595 | <a href="../../package/pip/template/" class="md-nav__link"> | |
1596 | template | |
1597 | </a> | |
1598 | </li> | |
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 | <li class="md-nav__item"> | |
1619 | <a href="../../package/pip/user-group-option/" class="md-nav__link"> | |
1620 | userGroupOption | |
1621 | </a> | |
1622 | </li> | |
1623 | ||
1624 | ||
1625 | ||
1626 | ||
1627 | ||
1628 | ||
1629 | ||
1630 | <li class="md-nav__item"> | |
1631 | <a href="../../package/pip/user-menu/" class="md-nav__link"> | |
1632 | userMenu | |
1633 | </a> | |
1634 | </li> | |
1635 | ||
1636 | ||
1637 | ||
1638 | ||
1639 | ||
1640 | ||
1641 | ||
1642 | <li class="md-nav__item"> | |
1643 | <a href="../../package/pip/user-notification-event/" class="md-nav__link"> | |
1644 | userNotificationEvent | |
1645 | </a> | |
1646 | </li> | |
1647 | ||
1648 | ||
1649 | ||
1650 | ||
1651 | ||
1652 | ||
1653 | ||
1654 | <li class="md-nav__item"> | |
1655 | <a href="../../package/pip/user-option/" class="md-nav__link"> | |
1656 | userOption | |
1657 | </a> | |
1658 | </li> | |
1659 | ||
1660 | ||
1661 | ||
1662 | ||
1663 | ||
1664 | ||
1665 | ||
1666 | <li class="md-nav__item"> | |
1667 | <a href="../../package/pip/user-profile-menu/" class="md-nav__link"> | |
1668 | userProfileMenu | |
1669 | </a> | |
1670 | </li> | |
1671 | ||
1672 | ||
1673 | ||
1674 | </ul> | |
1675 | </nav> | |
1676 | </li> | |
1677 | ||
1678 | ||
1679 | ||
1680 | ||
1681 | ||
1682 | ||
1683 | ||
1684 | <li class="md-nav__item"> | |
1685 | <a href="../../package/database-php-api/" class="md-nav__link"> | |
1686 | Database PHP API | |
1687 | </a> | |
1688 | </li> | |
1689 | ||
1690 | ||
1691 | ||
1692 | </ul> | |
1693 | </nav> | |
1694 | </li> | |
1695 | ||
1696 | ||
1697 | ||
1698 | ||
1699 | ||
1700 | ||
1701 | ||
1702 | ||
1703 | ||
1704 | ||
1705 | ||
1706 | <li class="md-nav__item md-nav__item--nested"> | |
1707 | ||
1708 | ||
1709 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > | |
1710 | ||
1711 | <label class="md-nav__link" for="__nav_6"> | |
1712 | Migration | |
1713 | <span class="md-nav__icon md-icon"></span> | |
1714 | </label> | |
1715 | <nav class="md-nav" aria-label="Migration" data-md-level="1"> | |
1716 | <label class="md-nav__title" for="__nav_6"> | |
1717 | <span class="md-nav__icon md-icon"></span> | |
1718 | Migration | |
1719 | </label> | |
1720 | <ul class="md-nav__list" data-md-scrollfix> | |
1721 | ||
1722 | ||
1723 | ||
1724 | ||
1725 | ||
1726 | ||
1727 | <li class="md-nav__item md-nav__item--nested"> | |
1728 | ||
1729 | ||
1730 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" > | |
1731 | ||
1732 | <label class="md-nav__link" for="__nav_6_1"> | |
1733 | Migrating from WSC 5.3 | |
1734 | <span class="md-nav__icon md-icon"></span> | |
1735 | </label> | |
1736 | <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2"> | |
1737 | <label class="md-nav__title" for="__nav_6_1"> | |
1738 | <span class="md-nav__icon md-icon"></span> | |
1739 | Migrating from WSC 5.3 | |
1740 | </label> | |
1741 | <ul class="md-nav__list" data-md-scrollfix> | |
1742 | ||
1743 | ||
1744 | ||
1745 | ||
1746 | ||
1747 | <li class="md-nav__item"> | |
1748 | <a href="../../migration/wsc53/php/" class="md-nav__link"> | |
1749 | PHP API | |
1750 | </a> | |
1751 | </li> | |
1752 | ||
1753 | ||
1754 | ||
1755 | ||
1756 | ||
1757 | ||
1758 | ||
1759 | <li class="md-nav__item"> | |
1760 | <a href="../../migration/wsc53/session/" class="md-nav__link"> | |
1761 | Session Handling and Authentication | |
1762 | </a> | |
1763 | </li> | |
1764 | ||
1765 | ||
1766 | ||
1767 | ||
1768 | ||
1769 | ||
1770 | ||
1771 | <li class="md-nav__item"> | |
1772 | <a href="../../migration/wsc53/javascript/" class="md-nav__link"> | |
77efcd46 | 1773 | TypeScript and JavaScript |
45ca63d0 TD |
1774 | </a> |
1775 | </li> | |
1776 | ||
1777 | ||
1778 | ||
1779 | ||
1780 | ||
1781 | ||
1782 | ||
1783 | <li class="md-nav__item"> | |
1784 | <a href="../../migration/wsc53/templates/" class="md-nav__link"> | |
1785 | Templates | |
1786 | </a> | |
1787 | </li> | |
1788 | ||
1789 | ||
1790 | ||
1791 | ||
1792 | ||
1793 | ||
1794 | ||
1795 | <li class="md-nav__item"> | |
1796 | <a href="../../migration/wsc53/libraries/" class="md-nav__link"> | |
1797 | Third Party Libraries | |
1798 | </a> | |
1799 | </li> | |
1800 | ||
1801 | ||
1802 | ||
1803 | </ul> | |
1804 | </nav> | |
1805 | </li> | |
1806 | ||
1807 | ||
1808 | ||
1809 | ||
1810 | ||
1811 | ||
1812 | ||
1813 | ||
1814 | <li class="md-nav__item md-nav__item--nested"> | |
1815 | ||
1816 | ||
1817 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" > | |
1818 | ||
1819 | <label class="md-nav__link" for="__nav_6_2"> | |
1820 | Migrating from WSC 5.2 | |
1821 | <span class="md-nav__icon md-icon"></span> | |
1822 | </label> | |
1823 | <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2"> | |
1824 | <label class="md-nav__title" for="__nav_6_2"> | |
1825 | <span class="md-nav__icon md-icon"></span> | |
1826 | Migrating from WSC 5.2 | |
1827 | </label> | |
1828 | <ul class="md-nav__list" data-md-scrollfix> | |
1829 | ||
1830 | ||
1831 | ||
1832 | ||
1833 | ||
1834 | <li class="md-nav__item"> | |
1835 | <a href="../../migration/wsc52/php/" class="md-nav__link"> | |
1836 | PHP API | |
1837 | </a> | |
1838 | </li> | |
1839 | ||
1840 | ||
1841 | ||
1842 | ||
1843 | ||
1844 | ||
1845 | ||
1846 | <li class="md-nav__item"> | |
1847 | <a href="../../migration/wsc52/templates/" class="md-nav__link"> | |
1848 | Templates and Languages | |
1849 | </a> | |
1850 | </li> | |
1851 | ||
1852 | ||
1853 | ||
1854 | ||
1855 | ||
1856 | ||
1857 | ||
1858 | <li class="md-nav__item"> | |
1859 | <a href="../../migration/wsc52/libraries/" class="md-nav__link"> | |
1860 | Third Party Libraries | |
1861 | </a> | |
1862 | </li> | |
1863 | ||
1864 | ||
1865 | ||
1866 | </ul> | |
1867 | </nav> | |
1868 | </li> | |
1869 | ||
1870 | ||
1871 | ||
1872 | ||
1873 | ||
1874 | ||
1875 | ||
1876 | ||
1877 | <li class="md-nav__item md-nav__item--nested"> | |
1878 | ||
1879 | ||
1880 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" > | |
1881 | ||
1882 | <label class="md-nav__link" for="__nav_6_3"> | |
1883 | Migrating from WSC 3.1 | |
1884 | <span class="md-nav__icon md-icon"></span> | |
1885 | </label> | |
1886 | <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2"> | |
1887 | <label class="md-nav__title" for="__nav_6_3"> | |
1888 | <span class="md-nav__icon md-icon"></span> | |
1889 | Migrating from WSC 3.1 | |
1890 | </label> | |
1891 | <ul class="md-nav__list" data-md-scrollfix> | |
1892 | ||
1893 | ||
1894 | ||
1895 | ||
1896 | ||
1897 | <li class="md-nav__item"> | |
1898 | <a href="../../migration/wsc31/php/" class="md-nav__link"> | |
1899 | PHP API | |
1900 | </a> | |
1901 | </li> | |
1902 | ||
1903 | ||
1904 | ||
1905 | </ul> | |
1906 | </nav> | |
1907 | </li> | |
1908 | ||
1909 | ||
1910 | ||
1911 | ||
1912 | ||
1913 | ||
1914 | ||
1915 | ||
1916 | <li class="md-nav__item md-nav__item--nested"> | |
1917 | ||
1918 | ||
1919 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" > | |
1920 | ||
1921 | <label class="md-nav__link" for="__nav_6_4"> | |
1922 | Migrating from WSC 3.0 | |
1923 | <span class="md-nav__icon md-icon"></span> | |
1924 | </label> | |
1925 | <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2"> | |
1926 | <label class="md-nav__title" for="__nav_6_4"> | |
1927 | <span class="md-nav__icon md-icon"></span> | |
1928 | Migrating from WSC 3.0 | |
1929 | </label> | |
1930 | <ul class="md-nav__list" data-md-scrollfix> | |
1931 | ||
1932 | ||
1933 | ||
1934 | ||
1935 | ||
1936 | <li class="md-nav__item"> | |
1937 | <a href="../../migration/wsc30/php/" class="md-nav__link"> | |
1938 | PHP API | |
1939 | </a> | |
1940 | </li> | |
1941 | ||
1942 | ||
1943 | ||
1944 | ||
1945 | ||
1946 | ||
1947 | ||
1948 | <li class="md-nav__item"> | |
1949 | <a href="../../migration/wsc30/javascript/" class="md-nav__link"> | |
1950 | JavaScript API | |
1951 | </a> | |
1952 | </li> | |
1953 | ||
1954 | ||
1955 | ||
1956 | ||
1957 | ||
1958 | ||
1959 | ||
1960 | <li class="md-nav__item"> | |
1961 | <a href="../../migration/wsc30/templates/" class="md-nav__link"> | |
1962 | Templates | |
1963 | </a> | |
1964 | </li> | |
1965 | ||
1966 | ||
1967 | ||
1968 | ||
1969 | ||
1970 | ||
1971 | ||
1972 | <li class="md-nav__item"> | |
1973 | <a href="../../migration/wsc30/css/" class="md-nav__link"> | |
1974 | CSS | |
1975 | </a> | |
1976 | </li> | |
1977 | ||
1978 | ||
1979 | ||
1980 | ||
1981 | ||
1982 | ||
1983 | ||
1984 | <li class="md-nav__item"> | |
1985 | <a href="../../migration/wsc30/package/" class="md-nav__link"> | |
1986 | Package Components | |
1987 | </a> | |
1988 | </li> | |
1989 | ||
1990 | ||
1991 | ||
1992 | </ul> | |
1993 | </nav> | |
1994 | </li> | |
1995 | ||
1996 | ||
1997 | ||
1998 | ||
1999 | ||
2000 | ||
2001 | ||
2002 | ||
2003 | <li class="md-nav__item md-nav__item--nested"> | |
2004 | ||
2005 | ||
2006 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" > | |
2007 | ||
2008 | <label class="md-nav__link" for="__nav_6_5"> | |
2009 | Migrating from WCF 2.1 | |
2010 | <span class="md-nav__icon md-icon"></span> | |
2011 | </label> | |
2012 | <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2"> | |
2013 | <label class="md-nav__title" for="__nav_6_5"> | |
2014 | <span class="md-nav__icon md-icon"></span> | |
2015 | Migrating from WCF 2.1 | |
2016 | </label> | |
2017 | <ul class="md-nav__list" data-md-scrollfix> | |
2018 | ||
2019 | ||
2020 | ||
2021 | ||
2022 | ||
2023 | <li class="md-nav__item"> | |
2024 | <a href="../../migration/wcf21/php/" class="md-nav__link"> | |
2025 | PHP API | |
2026 | </a> | |
2027 | </li> | |
2028 | ||
2029 | ||
2030 | ||
2031 | ||
2032 | ||
2033 | ||
2034 | ||
2035 | <li class="md-nav__item"> | |
2036 | <a href="../../migration/wcf21/templates/" class="md-nav__link"> | |
2037 | Templates | |
2038 | </a> | |
2039 | </li> | |
2040 | ||
2041 | ||
2042 | ||
2043 | ||
2044 | ||
2045 | ||
2046 | ||
2047 | <li class="md-nav__item"> | |
2048 | <a href="../../migration/wcf21/css/" class="md-nav__link"> | |
2049 | CSS | |
2050 | </a> | |
2051 | </li> | |
2052 | ||
2053 | ||
2054 | ||
2055 | ||
2056 | ||
2057 | ||
2058 | ||
2059 | <li class="md-nav__item"> | |
2060 | <a href="../../migration/wcf21/package/" class="md-nav__link"> | |
2061 | Package Components | |
2062 | </a> | |
2063 | </li> | |
2064 | ||
2065 | ||
2066 | ||
2067 | </ul> | |
2068 | </nav> | |
2069 | </li> | |
2070 | ||
2071 | ||
2072 | ||
2073 | </ul> | |
2074 | </nav> | |
2075 | </li> | |
2076 | ||
2077 | ||
2078 | ||
2079 | ||
2080 | ||
2081 | ||
2082 | ||
2083 | ||
2084 | ||
2085 | ||
2086 | ||
2087 | <li class="md-nav__item md-nav__item--nested"> | |
2088 | ||
2089 | ||
2090 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > | |
2091 | ||
2092 | <label class="md-nav__link" for="__nav_7"> | |
2093 | Tutorials | |
2094 | <span class="md-nav__icon md-icon"></span> | |
2095 | </label> | |
2096 | <nav class="md-nav" aria-label="Tutorials" data-md-level="1"> | |
2097 | <label class="md-nav__title" for="__nav_7"> | |
2098 | <span class="md-nav__icon md-icon"></span> | |
2099 | Tutorials | |
2100 | </label> | |
2101 | <ul class="md-nav__list" data-md-scrollfix> | |
2102 | ||
2103 | ||
2104 | ||
2105 | ||
2106 | ||
2107 | ||
2108 | <li class="md-nav__item md-nav__item--nested"> | |
2109 | ||
2110 | ||
2111 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" > | |
2112 | ||
2113 | <label class="md-nav__link" for="__nav_7_1"> | |
2114 | Tutorial Series | |
2115 | <span class="md-nav__icon md-icon"></span> | |
2116 | </label> | |
2117 | <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2"> | |
2118 | <label class="md-nav__title" for="__nav_7_1"> | |
2119 | <span class="md-nav__icon md-icon"></span> | |
2120 | Tutorial Series | |
2121 | </label> | |
2122 | <ul class="md-nav__list" data-md-scrollfix> | |
2123 | ||
2124 | ||
2125 | ||
2126 | ||
2127 | ||
2128 | <li class="md-nav__item"> | |
2129 | <a href="../../tutorial/series/overview/" class="md-nav__link"> | |
2130 | Overview | |
2131 | </a> | |
2132 | </li> | |
2133 | ||
2134 | ||
2135 | ||
2136 | ||
2137 | ||
2138 | ||
2139 | ||
2140 | <li class="md-nav__item"> | |
2141 | <a href="../../tutorial/series/part_1/" class="md-nav__link"> | |
2142 | Part 1 | |
2143 | </a> | |
2144 | </li> | |
2145 | ||
2146 | ||
2147 | ||
2148 | ||
2149 | ||
2150 | ||
2151 | ||
2152 | <li class="md-nav__item"> | |
2153 | <a href="../../tutorial/series/part_2/" class="md-nav__link"> | |
2154 | Part 2 | |
2155 | </a> | |
2156 | </li> | |
2157 | ||
2158 | ||
2159 | ||
2160 | ||
2161 | ||
2162 | ||
2163 | ||
2164 | <li class="md-nav__item"> | |
2165 | <a href="../../tutorial/series/part_3/" class="md-nav__link"> | |
2166 | Part 3 | |
2167 | </a> | |
2168 | </li> | |
2169 | ||
2170 | ||
2171 | ||
41eda543 WG |
2172 | |
2173 | ||
2174 | ||
2175 | ||
2176 | <li class="md-nav__item"> | |
2177 | <a href="../../tutorial/series/part_4/" class="md-nav__link"> | |
2178 | Part 4 | |
2179 | </a> | |
2180 | </li> | |
2181 | ||
2182 | ||
2183 | ||
716a4ab6 WG |
2184 | |
2185 | ||
2186 | ||
2187 | ||
2188 | <li class="md-nav__item"> | |
2189 | <a href="../../tutorial/series/part_5/" class="md-nav__link"> | |
2190 | Part 5 | |
2191 | </a> | |
2192 | </li> | |
2193 | ||
2194 | ||
2195 | ||
45ca63d0 TD |
2196 | </ul> |
2197 | </nav> | |
2198 | </li> | |
2199 | ||
2200 | ||
2201 | ||
2202 | </ul> | |
2203 | </nav> | |
2204 | </li> | |
2205 | ||
2206 | ||
2207 | ||
2208 | </ul> | |
2209 | </nav> | |
2210 | </div> | |
2211 | </div> | |
2212 | </div> | |
2213 | ||
2214 | ||
2215 | ||
2216 | <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > | |
2217 | <div class="md-sidebar__scrollwrap"> | |
2218 | <div class="md-sidebar__inner"> | |
2219 | ||
2220 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
2221 | ||
2222 | ||
a4835aa6 | 2223 | |
45ca63d0 TD |
2224 | |
2225 | ||
2226 | ||
2227 | <label class="md-nav__title" for="__toc"> | |
2228 | <span class="md-nav__icon md-icon"></span> | |
2229 | Table of contents | |
2230 | </label> | |
2231 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
2232 | ||
2233 | <li class="md-nav__item"> | |
2234 | <a href="#53-anchor" class="md-nav__link"> | |
2235 | 5.3+ anchor | |
2236 | </a> | |
2237 | ||
2238 | </li> | |
2239 | ||
2240 | <li class="md-nav__item"> | |
2241 | <a href="#53-anchorattributes" class="md-nav__link"> | |
2242 | 5.3+ anchorAttributes | |
2243 | </a> | |
2244 | ||
2245 | </li> | |
2246 | ||
2247 | <li class="md-nav__item"> | |
2248 | <a href="#append" class="md-nav__link"> | |
2249 | append | |
2250 | </a> | |
2251 | ||
2252 | </li> | |
2253 | ||
2254 | <li class="md-nav__item"> | |
2255 | <a href="#assign" class="md-nav__link"> | |
2256 | assign | |
2257 | </a> | |
2258 | ||
2259 | </li> | |
2260 | ||
2261 | <li class="md-nav__item"> | |
2262 | <a href="#capture" class="md-nav__link"> | |
2263 | capture | |
2264 | </a> | |
2265 | ||
2266 | </li> | |
2267 | ||
2268 | <li class="md-nav__item"> | |
2269 | <a href="#concat" class="md-nav__link"> | |
2270 | concat | |
2271 | </a> | |
2272 | ||
2273 | </li> | |
2274 | ||
2275 | <li class="md-nav__item"> | |
2276 | <a href="#counter" class="md-nav__link"> | |
2277 | counter | |
2278 | </a> | |
2279 | ||
2280 | </li> | |
2281 | ||
2282 | <li class="md-nav__item"> | |
2283 | <a href="#54-csrftoken" class="md-nav__link"> | |
2284 | 5.4+ csrfToken | |
2285 | </a> | |
2286 | ||
2287 | </li> | |
2288 | ||
2289 | <li class="md-nav__item"> | |
2290 | <a href="#currency" class="md-nav__link"> | |
2291 | currency | |
2292 | </a> | |
2293 | ||
2294 | </li> | |
2295 | ||
2296 | <li class="md-nav__item"> | |
2297 | <a href="#cycle" class="md-nav__link"> | |
2298 | cycle | |
2299 | </a> | |
2300 | ||
2301 | </li> | |
2302 | ||
2303 | <li class="md-nav__item"> | |
2304 | <a href="#date" class="md-nav__link"> | |
2305 | date | |
2306 | </a> | |
2307 | ||
2308 | </li> | |
2309 | ||
2310 | <li class="md-nav__item"> | |
2311 | <a href="#31-dateinterval" class="md-nav__link"> | |
2312 | 3.1+ dateInterval | |
2313 | </a> | |
2314 | ||
2315 | </li> | |
2316 | ||
2317 | <li class="md-nav__item"> | |
2318 | <a href="#encodejs" class="md-nav__link"> | |
2319 | encodeJS | |
2320 | </a> | |
2321 | ||
2322 | </li> | |
2323 | ||
2324 | <li class="md-nav__item"> | |
2325 | <a href="#encodejson" class="md-nav__link"> | |
2326 | encodeJSON | |
2327 | </a> | |
2328 | ||
2329 | </li> | |
2330 | ||
2331 | <li class="md-nav__item"> | |
2332 | <a href="#escapecdata" class="md-nav__link"> | |
2333 | escapeCDATA | |
2334 | </a> | |
2335 | ||
2336 | </li> | |
2337 | ||
2338 | <li class="md-nav__item"> | |
2339 | <a href="#event" class="md-nav__link"> | |
2340 | event | |
2341 | </a> | |
2342 | ||
2343 | </li> | |
2344 | ||
2345 | <li class="md-nav__item"> | |
2346 | <a href="#fetch" class="md-nav__link"> | |
2347 | fetch | |
2348 | </a> | |
2349 | ||
2350 | </li> | |
2351 | ||
2352 | <li class="md-nav__item"> | |
2353 | <a href="#filesizebinary" class="md-nav__link"> | |
2354 | filesizeBinary | |
2355 | </a> | |
2356 | ||
2357 | </li> | |
2358 | ||
2359 | <li class="md-nav__item"> | |
2360 | <a href="#filesize" class="md-nav__link"> | |
2361 | filesize | |
2362 | </a> | |
2363 | ||
2364 | </li> | |
2365 | ||
2366 | <li class="md-nav__item"> | |
2367 | <a href="#hascontent" class="md-nav__link"> | |
2368 | hascontent | |
2369 | </a> | |
2370 | ||
2371 | </li> | |
2372 | ||
2373 | <li class="md-nav__item"> | |
2374 | <a href="#htmlcheckboxes" class="md-nav__link"> | |
2375 | htmlCheckboxes | |
2376 | </a> | |
2377 | ||
2378 | </li> | |
2379 | ||
2380 | <li class="md-nav__item"> | |
2381 | <a href="#htmloptions" class="md-nav__link"> | |
2382 | htmlOptions | |
2383 | </a> | |
2384 | ||
2385 | </li> | |
2386 | ||
2387 | <li class="md-nav__item"> | |
2388 | <a href="#implode" class="md-nav__link"> | |
2389 | implode | |
2390 | </a> | |
2391 | ||
2392 | </li> | |
2393 | ||
2394 | <li class="md-nav__item"> | |
2395 | <a href="#52-ipsearch" class="md-nav__link"> | |
2396 | 5.2+ ipSearch | |
2397 | </a> | |
2398 | ||
2399 | </li> | |
2400 | ||
2401 | <li class="md-nav__item"> | |
2402 | <a href="#30-js" class="md-nav__link"> | |
2403 | 3.0+ js | |
2404 | </a> | |
2405 | ||
2406 | </li> | |
2407 | ||
2408 | <li class="md-nav__item"> | |
2409 | <a href="#53-jslang" class="md-nav__link"> | |
2410 | 5.3+ jslang | |
2411 | </a> | |
2412 | ||
2413 | </li> | |
2414 | ||
2415 | <li class="md-nav__item"> | |
2416 | <a href="#lang" class="md-nav__link"> | |
2417 | lang | |
2418 | </a> | |
2419 | ||
2420 | </li> | |
2421 | ||
2422 | <li class="md-nav__item"> | |
2423 | <a href="#language" class="md-nav__link"> | |
2424 | language | |
2425 | </a> | |
2426 | ||
2427 | </li> | |
2428 | ||
2429 | <li class="md-nav__item"> | |
2430 | <a href="#link" class="md-nav__link"> | |
2431 | link | |
2432 | </a> | |
2433 | ||
2434 | </li> | |
2435 | ||
2436 | <li class="md-nav__item"> | |
2437 | <a href="#newlinetobreak" class="md-nav__link"> | |
2438 | newlineToBreak | |
2439 | </a> | |
2440 | ||
7d7c4daf WG |
2441 | </li> |
2442 | ||
2443 | <li class="md-nav__item"> | |
2444 | <a href="#54-objectaction" class="md-nav__link"> | |
2445 | 5.4+ objectAction | |
2446 | </a> | |
2447 | ||
45ca63d0 TD |
2448 | </li> |
2449 | ||
2450 | <li class="md-nav__item"> | |
2451 | <a href="#30-page" class="md-nav__link"> | |
2452 | 3.0+ page | |
2453 | </a> | |
2454 | ||
2455 | </li> | |
2456 | ||
2457 | <li class="md-nav__item"> | |
2458 | <a href="#pages" class="md-nav__link"> | |
2459 | pages | |
2460 | </a> | |
2461 | ||
2462 | </li> | |
2463 | ||
2464 | <li class="md-nav__item"> | |
2465 | <a href="#plaintime" class="md-nav__link"> | |
2466 | plainTime | |
2467 | </a> | |
2468 | ||
2469 | </li> | |
2470 | ||
2471 | <li class="md-nav__item"> | |
2472 | <a href="#53-plural" class="md-nav__link"> | |
2473 | 5.3+ plural | |
2474 | </a> | |
2475 | ||
2476 | </li> | |
2477 | ||
2478 | <li class="md-nav__item"> | |
2479 | <a href="#prepend" class="md-nav__link"> | |
2480 | prepend | |
2481 | </a> | |
2482 | ||
2483 | </li> | |
2484 | ||
2485 | <li class="md-nav__item"> | |
2486 | <a href="#shortunit" class="md-nav__link"> | |
2487 | shortUnit | |
2488 | </a> | |
2489 | ||
2490 | </li> | |
2491 | ||
2492 | <li class="md-nav__item"> | |
2493 | <a href="#smallpages" class="md-nav__link"> | |
2494 | smallpages | |
2495 | </a> | |
2496 | ||
2497 | </li> | |
2498 | ||
2499 | <li class="md-nav__item"> | |
2500 | <a href="#tablewordwrap" class="md-nav__link"> | |
2501 | tableWordwrap | |
2502 | </a> | |
2503 | ||
2504 | </li> | |
2505 | ||
2506 | <li class="md-nav__item"> | |
2507 | <a href="#time" class="md-nav__link"> | |
2508 | time | |
2509 | </a> | |
2510 | ||
2511 | </li> | |
2512 | ||
2513 | <li class="md-nav__item"> | |
2514 | <a href="#truncate" class="md-nav__link"> | |
2515 | truncate | |
2516 | </a> | |
2517 | ||
2518 | </li> | |
2519 | ||
2520 | <li class="md-nav__item"> | |
2521 | <a href="#53-user" class="md-nav__link"> | |
2522 | 5.3+ user | |
2523 | </a> | |
2524 | ||
2525 | </li> | |
2526 | ||
2527 | </ul> | |
2528 | ||
2529 | </nav> | |
2530 | </div> | |
2531 | </div> | |
2532 | </div> | |
2533 | ||
2534 | ||
2535 | <div class="md-content" data-md-component="content"> | |
2536 | <article class="md-content__inner md-typeset"> | |
2537 | ||
2538 | ||
9b8bddda | 2539 | <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/view/template-plugins.md" title="Edit this page" class="md-content__button md-icon"> |
7124f4cb WG |
2540 | <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> |
2541 | </a> | |
2542 | ||
45ca63d0 TD |
2543 | |
2544 | <h1 id="template-plugins">Template Plugins<a class="headerlink" href="#template-plugins" title="Permanent link">#</a></h1> | |
2545 | <h2 id="53-anchor"><span class="label label-info">5.3+</span> <code>anchor</code><a class="headerlink" href="#53-anchor" title="Permanent link">#</a></h2> | |
2546 | <p>The <code>anchor</code> template plugin creates <code>a</code> HTML elements. | |
2547 | The easiest way to use the template plugin is to pass it an instance of <code>ITitledLinkObject</code>:</p> | |
704cbc4a | 2548 | <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 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">$object</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 2549 | </code></pre></div> |
704cbc4a | 2550 | </td></tr></table> |
45ca63d0 | 2551 | <p>generates the same output as</p> |
704cbc4a | 2552 | <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 class="highlight"><pre><span></span><code><span class="x"><a href="</span><span class="cp">{</span><span class="nv">$object</span><span class="o">-></span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">"></span><span class="cp">{</span><span class="nv">$object</span><span class="o">-></span><span class="na">getTitle</span><span class="o">()</span><span class="cp">}</span><span class="x"></a></span> |
45ca63d0 | 2553 | </code></pre></div> |
704cbc4a | 2554 | </td></tr></table> |
45ca63d0 | 2555 | <p>Instead of an <code>object</code> parameter, a <code>link</code> and <code>content</code> parameter can be used:</p> |
704cbc4a | 2556 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">anchor</span> <span class="na">link</span><span class="o">=</span><span class="nv">$linkObject</span> <span class="na">content</span><span class="o">=</span><span class="nv">$content</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 2557 | </code></pre></div> |
704cbc4a | 2558 | </td></tr></table> |
45ca63d0 TD |
2559 | <p>where <code>$linkObject</code> implements <code>ILinkableObject</code> and <code>$content</code> is either an object implementing <code>ITitledObject</code> or having a <code>__toString()</code> method or <code>$content</code> is a string or a number.</p> |
2560 | <p>The last special attribute is <code>append</code> whose contents are appended to the <code>href</code> attribute of the generated anchor element.</p> | |
2561 | <p>All of the other attributes matching <code>~^[a-z]+([A-z]+)+$~</code>, expect for <code>href</code> which is disallowed, are added as attributes to the anchor element.</p> | |
2562 | <p>If an <code>object</code> attribute is present, the object also implements <code>IPopoverObject</code> and if the return value of <code>IPopoverObject::getPopoverLinkClass()</code> is included in the <code>class</code> attribute of the <code>anchor</code> tag, <code>data-object-id</code> is automatically added. | |
2563 | This functionality makes it easy to generate links with popover support. | |
2564 | Instead of</p> | |
704cbc4a | 2565 | <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 class="highlight"><pre><span></span><code><span class="x"><a href="</span><span class="cp">{</span><span class="nv">$entry</span><span class="o">-></span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">" class="blogEntryLink" data-object-id="</span><span class="cp">{</span><span class="o">@</span><span class="nv">$entry</span><span class="o">-></span><span class="na">entryID</span><span class="cp">}</span><span class="x">"></span><span class="cp">{</span><span class="nv">$entry</span><span class="o">-></span><span class="na">subject</span><span class="cp">}</span><span class="x"></a></span> |
45ca63d0 | 2566 | </code></pre></div> |
704cbc4a | 2567 | </td></tr></table> |
45ca63d0 | 2568 | <p>using</p> |
704cbc4a | 2569 | <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 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">$entry</span> <span class="na">class</span><span class="o">=</span><span class="s1">'blogEntryLink'</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 2570 | </code></pre></div> |
704cbc4a | 2571 | </td></tr></table> |
45ca63d0 TD |
2572 | <p>is sufficient if <code>Entry::getPopoverLinkClass()</code> returns <code>blogEntryLink</code>.</p> |
2573 | <h2 id="53-anchorattributes"><span class="label label-info">5.3+</span> <code>anchorAttributes</code><a class="headerlink" href="#53-anchorattributes" title="Permanent link">#</a></h2> | |
2574 | <p><code>anchorAttributes</code> compliments the <code>StringUtil::getAnchorTagAttributes(string, bool): string</code> method. | |
2575 | It allows to easily generate the necessary attributes for an anchor tag based off the destination URL.</p> | |
704cbc4a | 2576 | <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 class="highlight"><pre><span></span><code><span class="x"><a href="https://www.example.com" </span><span class="cp">{</span><span class="nf">anchorAttributes</span> <span class="na">url</span><span class="o">=</span><span class="s1">'https://www.example.com'</span> <span class="na">appendHref</span><span class="o">=</span><span class="kc">false</span> <span class="na">appendClassname</span><span class="o">=</span><span class="kc">true</span> <span class="na">isUgc</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x">></span> |
45ca63d0 | 2577 | </code></pre></div> |
704cbc4a | 2578 | </td></tr></table> |
45ca63d0 TD |
2579 | <table> |
2580 | <thead> | |
2581 | <tr> | |
2582 | <th>Attribute</th> | |
2583 | <th>Description</th> | |
2584 | </tr> | |
2585 | </thead> | |
2586 | <tbody> | |
2587 | <tr> | |
2588 | <td><code>url</code></td> | |
2589 | <td>destination URL</td> | |
2590 | </tr> | |
2591 | <tr> | |
2592 | <td><code>appendHref</code></td> | |
2593 | <td>whether the <code>href</code> attribute should be generated; <code>true</code> by default</td> | |
2594 | </tr> | |
2595 | <tr> | |
2596 | <td><code>isUgc</code></td> | |
2597 | <td>whether the <code>rel="ugc"</code> attribute should be generated; <code>false</code> by default</td> | |
2598 | </tr> | |
2599 | <tr> | |
2600 | <td><code>appendClassname</code></td> | |
2601 | <td>whether the <code>class="externalURL"</code> attribute should be generated; <code>true</code> by default</td> | |
2602 | </tr> | |
2603 | </tbody> | |
2604 | </table> | |
2605 | <h2 id="append"><code>append</code><a class="headerlink" href="#append" title="Permanent link">#</a></h2> | |
2606 | <p>If a string should be appended to the value of a variable, <code>append</code> can be used:</p> | |
704cbc4a WG |
2607 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2608 | <span class="normal">2</span> | |
2609 | <span class="normal">3</span> | |
2610 | <span class="normal">4</span> | |
2611 | <span class="normal">5</span> | |
2612 | <span class="normal">6</span> | |
2613 | <span class="normal">7</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">'newValue'</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2614 | |
2615 | <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'newValue *</span><span class="cp">}</span><span class="x"></span> | |
2616 | ||
2617 | <span class="cp">{</span><span class="nf">append</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">'2'</span><span class="cp">}</span><span class="x"></span> | |
2618 | ||
2619 | <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* now prints 'newValue2 *</span><span class="cp">}</span><span class="x"></span> | |
2620 | </code></pre></div> | |
704cbc4a | 2621 | </td></tr></table> |
45ca63d0 TD |
2622 | <p>If the variables does not exist yet, <code>append</code> creates a new one with the given value. |
2623 | If <code>append</code> is used on an array as the variable, the value is appended to all elements of the array.</p> | |
2624 | <h2 id="assign"><code>assign</code><a class="headerlink" href="#assign" title="Permanent link">#</a></h2> | |
2625 | <p>New template variables can be declared and new values can be assigned to existing template variables using <code>assign</code>:</p> | |
704cbc4a WG |
2626 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2627 | <span class="normal">2</span> | |
2628 | <span class="normal">3</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">'newValue'</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2629 | |
2630 | <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'newValue *</span><span class="cp">}</span><span class="x"></span> | |
2631 | </code></pre></div> | |
704cbc4a | 2632 | </td></tr></table> |
45ca63d0 TD |
2633 | <h2 id="capture"><code>capture</code><a class="headerlink" href="#capture" title="Permanent link">#</a></h2> |
2634 | <p>In some situations, <code>assign</code> is not sufficient to assign values to variables in templates if the value is complex. | |
2635 | Instead, <code>capture</code> can be used:</p> | |
704cbc4a WG |
2636 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2637 | <span class="normal">2</span> | |
2638 | <span class="normal">3</span> | |
2639 | <span class="normal">4</span> | |
2640 | <span class="normal">5</span> | |
2641 | <span class="normal">6</span> | |
2642 | <span class="normal">7</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">capture</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2643 | <span class="x"> </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span><span class="cp">}</span><span class="x"></span> |
2644 | <span class="x"> <p></span><span class="cp">{</span><span class="nv">$bar</span><span class="cp">}</span><span class="x"></p></span> | |
2645 | <span class="x"> </span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span><span class="x"></span> | |
2646 | <span class="x"> <small></span><span class="cp">{</span><span class="nv">$baz</span><span class="cp">}</span><span class="x"></small></span> | |
2647 | <span class="x"> </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span> | |
2648 | <span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span> | |
2649 | </code></pre></div> | |
704cbc4a | 2650 | </td></tr></table> |
45ca63d0 TD |
2651 | <h2 id="concat"><code>concat</code><a class="headerlink" href="#concat" title="Permanent link">#</a></h2> |
2652 | <p><code>concat</code> is a modifier used to concatenate multiple strings:</p> | |
704cbc4a WG |
2653 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2654 | <span class="normal">2</span> | |
2655 | <span class="normal">3</span> | |
2656 | <span class="normal">4</span> | |
2657 | <span class="normal">5</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">foo</span> <span class="na">value</span><span class="o">=</span><span class="s1">'foo'</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2658 | |
2659 | <span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">'bar'</span><span class="o">|</span><span class="na">concat</span><span class="o">:</span><span class="nv">$foo</span><span class="cp">}</span><span class="x"></span> | |
2660 | ||
2661 | <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'foobar *</span><span class="cp">}</span><span class="x"></span> | |
2662 | </code></pre></div> | |
704cbc4a | 2663 | </td></tr></table> |
45ca63d0 TD |
2664 | <h2 id="counter"><code>counter</code><a class="headerlink" href="#counter" title="Permanent link">#</a></h2> |
2665 | <p><code>counter</code> can be used to generate and optionally print a counter:</p> | |
704cbc4a WG |
2666 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2667 | <span class="normal">2</span> | |
2668 | <span class="normal">3</span> | |
2669 | <span class="normal">4</span> | |
2670 | <span class="normal">5</span> | |
2671 | <span class="normal">6</span> | |
2672 | <span class="normal">7</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints '1' *</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2673 | |
2674 | <span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints '2' now *</span><span class="cp">}</span><span class="x"></span> | |
2675 | ||
2676 | <span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints nothing, but counter value is '3' now internally *</span><span class="cp">}</span><span class="x"></span> | |
2677 | ||
2678 | <span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints '4' *</span><span class="cp">}</span><span class="x"></span> | |
2679 | </code></pre></div> | |
704cbc4a | 2680 | </td></tr></table> |
45ca63d0 TD |
2681 | <p>Counter supports the following attributes:</p> |
2682 | <table> | |
2683 | <thead> | |
2684 | <tr> | |
2685 | <th>Attribute</th> | |
2686 | <th>Description</th> | |
2687 | </tr> | |
2688 | </thead> | |
2689 | <tbody> | |
2690 | <tr> | |
2691 | <td><code>assign</code></td> | |
2692 | <td>optional name of the template variable the current counter value is assigned to</td> | |
2693 | </tr> | |
2694 | <tr> | |
2695 | <td><code>direction</code></td> | |
2696 | <td>counting direction, either <code>up</code> or <code>down</code>; <code>up</code> by default</td> | |
2697 | </tr> | |
2698 | <tr> | |
2699 | <td><code>name</code></td> | |
2700 | <td>name of the counter, relevant if multiple counters are used simultaneously</td> | |
2701 | </tr> | |
2702 | <tr> | |
2703 | <td><code>print</code></td> | |
2704 | <td>if <code>true</code>, the current counter value is printed; <code>false</code> by default</td> | |
2705 | </tr> | |
2706 | <tr> | |
2707 | <td><code>skip</code></td> | |
2708 | <td>positive counting increment; <code>1</code> by default</td> | |
2709 | </tr> | |
2710 | <tr> | |
2711 | <td><code>start</code></td> | |
2712 | <td>start counter value; <code>1</code> by default</td> | |
2713 | </tr> | |
2714 | </tbody> | |
2715 | </table> | |
2716 | <h2 id="54-csrftoken"><span class="label label-info">5.4+</span> <code>csrfToken</code><a class="headerlink" href="#54-csrftoken" title="Permanent link">#</a></h2> | |
2717 | <p><code>{csrfToken}</code> prints out the session's CSRF token (“Security Token”).</p> | |
704cbc4a WG |
2718 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2719 | <span class="normal">2</span> | |
2720 | <span class="normal">3</span> | |
2721 | <span class="normal">4</span> | |
2722 | <span class="normal">5</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="x"><form action="</span><span class="cp">{</span><span class="nf">link</span> <span class="na">controller</span><span class="o">=</span><span class="s2">"Foo"</span><span class="cp">}{</span><span class="nf">/link</span><span class="cp">}</span><span class="x">" method="post"></span> | |
45ca63d0 TD |
2723 | <span class="x"> </span><span class="cp">{</span><span class="c">* snip *</span><span class="cp">}</span><span class="x"></span> |
2724 | ||
2725 | <span class="x"> </span><span class="cp">{</span><span class="nf">csrfToken</span><span class="cp">}</span><span class="x"></span> | |
2726 | <span class="x"></form></span> | |
2727 | </code></pre></div> | |
704cbc4a | 2728 | </td></tr></table> |
45ca63d0 TD |
2729 | <p>The <code>{csrfToken}</code> template plugin supports a <code>type</code> parameter. |
2730 | Specifying this parameter might be required in rare situations. | |
2731 | Please <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/template/plugin/CsrfTokenFunctionTemplatePlugin.class.php">check the implementation</a> for details.</p> | |
2732 | <h2 id="currency"><code>currency</code><a class="headerlink" href="#currency" title="Permanent link">#</a></h2> | |
2733 | <p><code>currency</code> is a modifier used to format currency values with two decimals using language dependent thousands separators and decimal point:</p> | |
704cbc4a WG |
2734 | <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></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">currencyValue</span> <span class="na">value</span><span class="o">=</span><span class="m">12.345</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2737 | |
2738 | <span class="cp">{</span><span class="nv">$currencyValue</span><span class="o">|</span><span class="na">currency</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints '12.34' *</span><span class="cp">}</span><span class="x"></span> | |
2739 | </code></pre></div> | |
704cbc4a | 2740 | </td></tr></table> |
45ca63d0 TD |
2741 | <h2 id="cycle"><code>cycle</code><a class="headerlink" href="#cycle" title="Permanent link">#</a></h2> |
2742 | <p><code>cycle</code> can be used to cycle between different values:</p> | |
704cbc4a WG |
2743 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2744 | <span class="normal">2</span> | |
2745 | <span class="normal">3</span> | |
2746 | <span class="normal">4</span> | |
2747 | <span class="normal">5</span> | |
2748 | <span class="normal">6</span> | |
2749 | <span class="normal">7</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span> <span class="na">values</span><span class="o">=</span><span class="s1">'bar,baz'</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'bar' *</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2750 | |
2751 | <span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'baz' *</span><span class="cp">}</span><span class="x"></span> | |
2752 | ||
2753 | <span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span> <span class="na">advance</span><span class="o">=</span><span class="kc">false</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'baz' again *</span><span class="cp">}</span><span class="x"></span> | |
2754 | ||
2755 | <span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'bar' *</span><span class="cp">}</span><span class="x"></span> | |
2756 | </code></pre></div> | |
704cbc4a | 2757 | </td></tr></table> |
45ca63d0 TD |
2758 | <div class="admonition info"> |
2759 | <p class="admonition-title">The values attribute only has to be present for the first call. If <code>cycle</code> is used in a loop, the presence of the same values in consecutive calls has no effect. Only once the values change, the cycle is reset.</p> | |
2760 | </div> | |
2761 | <table> | |
2762 | <thead> | |
2763 | <tr> | |
2764 | <th>Attribute</th> | |
2765 | <th>Description</th> | |
2766 | </tr> | |
2767 | </thead> | |
2768 | <tbody> | |
2769 | <tr> | |
2770 | <td><code>advance</code></td> | |
2771 | <td>if <code>true</code>, the current cycle value is advanced to the next value; <code>true</code> by default</td> | |
2772 | </tr> | |
2773 | <tr> | |
2774 | <td><code>assign</code></td> | |
2775 | <td>optional name of the template variable the current cycle value is assigned to; if used, <code>print</code> is set to <code>false</code></td> | |
2776 | </tr> | |
2777 | <tr> | |
2778 | <td><code>delimiter</code></td> | |
2779 | <td>delimiter between the different cycle values; <code>,</code> by default</td> | |
2780 | </tr> | |
2781 | <tr> | |
2782 | <td><code>name</code></td> | |
2783 | <td>name of the cycle, relevant if multiple cycles are used simultaneously</td> | |
2784 | </tr> | |
2785 | <tr> | |
2786 | <td><code>print</code></td> | |
2787 | <td>if <code>true</code>, the current cycle value is printed, <code>false</code> by default</td> | |
2788 | </tr> | |
2789 | <tr> | |
2790 | <td><code>reset</code></td> | |
2791 | <td>if <code>true</code>, the current cycle value is set to the first value, <code>false</code> by default</td> | |
2792 | </tr> | |
2793 | <tr> | |
2794 | <td><code>values</code></td> | |
2795 | <td>string containing the different cycles values, also see <code>delimiter</code></td> | |
2796 | </tr> | |
2797 | </tbody> | |
2798 | </table> | |
2799 | <h2 id="date"><code>date</code><a class="headerlink" href="#date" title="Permanent link">#</a></h2> | |
2800 | <p><code>date</code> generated a formatted date using <code>wcf\util\DateUtil::format()</code> with <code>DateUtil::DATE_FORMAT</code> internally.</p> | |
704cbc4a | 2801 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$timestamp</span><span class="o">|</span><span class="na">date</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 2802 | </code></pre></div> |
704cbc4a | 2803 | </td></tr></table> |
45ca63d0 TD |
2804 | <h2 id="31-dateinterval"><span class="label label-info">3.1+</span> <code>dateInterval</code><a class="headerlink" href="#31-dateinterval" title="Permanent link">#</a></h2> |
2805 | <p><code>dateInterval</code> calculates the difference between two unix timestamps and generated a textual date interval.</p> | |
704cbc4a | 2806 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">dateInterval</span> <span class="na">start</span><span class="o">=</span><span class="nv">$startTimestamp</span> <span class="na">end</span><span class="o">=</span><span class="nv">$endTimestamp</span> <span class="na">full</span><span class="o">=</span><span class="kc">true</span> <span class="na">format</span><span class="o">=</span><span class="s1">'sentence'</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 2807 | </code></pre></div> |
704cbc4a | 2808 | </td></tr></table> |
45ca63d0 TD |
2809 | <table> |
2810 | <thead> | |
2811 | <tr> | |
2812 | <th>Attribute</th> | |
2813 | <th>Description</th> | |
2814 | </tr> | |
2815 | </thead> | |
2816 | <tbody> | |
2817 | <tr> | |
2818 | <td><code>end</code></td> | |
2819 | <td>end of the time interval; current timestamp by default (though either <code>start</code> or <code>end</code> has to be set)</td> | |
2820 | </tr> | |
2821 | <tr> | |
2822 | <td><code>format</code></td> | |
2823 | <td>output format, either <code>default</code>, <code>sentence</code>, or <code>plain</code>; defaults to <code>default</code>, see <code>wcf\util\DateUtil::FORMAT_*</code> constants</td> | |
2824 | </tr> | |
2825 | <tr> | |
2826 | <td><code>full</code></td> | |
2827 | <td>if <code>true</code>, full difference in minutes is shown; if <code>false</code>, only the longest time interval is shown; <code>false</code> by default</td> | |
2828 | </tr> | |
2829 | <tr> | |
2830 | <td><code>start</code></td> | |
2831 | <td>start of the time interval; current timestamp by default (though either <code>start</code> or <code>end</code> has to be set)</td> | |
2832 | </tr> | |
2833 | </tbody> | |
2834 | </table> | |
2835 | <h2 id="encodejs"><code>encodeJS</code><a class="headerlink" href="#encodejs" title="Permanent link">#</a></h2> | |
2836 | <p><code>encodeJS</code> encodes a string to be used as a single-quoted string in JavaScript by replacing <code>\\</code> with <code>\\\\</code>, <code>'</code> with <code>\'</code>, linebreaks with <code>\n</code>, and <code>/</code> with <code>\/</code>.</p> | |
704cbc4a WG |
2837 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2838 | <span class="normal">2</span> | |
2839 | <span class="normal">3</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="x"><script></span> | |
45ca63d0 TD |
2840 | <span class="x"> var foo = '</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">|</span><span class="na">encodeJS</span><span class="cp">}</span><span class="x">';</span> |
2841 | <span class="x"></script></span> | |
2842 | </code></pre></div> | |
704cbc4a | 2843 | </td></tr></table> |
45ca63d0 TD |
2844 | <h2 id="encodejson"><code>encodeJSON</code><a class="headerlink" href="#encodejson" title="Permanent link">#</a></h2> |
2845 | <p><code>encodeJSON</code> encodes a JSON string to be used as a single-quoted string in JavaScript by replacing <code>\\</code> with <code>\\\\</code>, <code>'</code> with <code>&#39;</code>, linebreaks with <code>\n</code>, and <code>/</code> with <code>\/</code>. | |
2846 | Additionally, <code>htmlspecialchars</code> is applied to the string.</p> | |
704cbc4a | 2847 | <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 class="highlight"><pre><span></span><code><span class="x">'</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">|</span><span class="na">encodeJSON</span><span class="cp">}</span><span class="x">'</span> |
45ca63d0 | 2848 | </code></pre></div> |
704cbc4a | 2849 | </td></tr></table> |
45ca63d0 TD |
2850 | <h2 id="escapecdata"><code>escapeCDATA</code><a class="headerlink" href="#escapecdata" title="Permanent link">#</a></h2> |
2851 | <p><code>escapeCDATA</code> encodes a string to be used in a <code>CDATA</code> element by replacing <code>]]></code> with <code>]]]]><![CDATA[></code>.</p> | |
704cbc4a | 2852 | <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 class="highlight"><pre><span></span><code><span class="x"><![CDATA[</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">|</span><span class="na">encodeCDATA</span><span class="cp">}</span><span class="x">]]></span> |
45ca63d0 | 2853 | </code></pre></div> |
704cbc4a | 2854 | </td></tr></table> |
45ca63d0 TD |
2855 | <h2 id="event"><code>event</code><a class="headerlink" href="#event" title="Permanent link">#</a></h2> |
2856 | <p><code>event</code> provides extension points in templates that <a href="../../package/pip/template-listener/">template listeners</a> can use.</p> | |
704cbc4a | 2857 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">'foo'</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 2858 | </code></pre></div> |
704cbc4a | 2859 | </td></tr></table> |
45ca63d0 TD |
2860 | <h2 id="fetch"><code>fetch</code><a class="headerlink" href="#fetch" title="Permanent link">#</a></h2> |
2861 | <p><code>fetch</code> fetches the contents of a file using <code>file_get_contents</code>.</p> | |
704cbc4a WG |
2862 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2863 | <span class="normal">2</span> | |
2864 | <span class="normal">3</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">fetch</span> <span class="na">file</span><span class="o">=</span><span class="s1">'foo.html'</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints the contents of `foo.html` *</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2865 | |
2866 | <span class="cp">{</span><span class="nf">fetch</span> <span class="na">file</span><span class="o">=</span><span class="s1">'bar.html'</span> <span class="na">assign</span><span class="o">=</span><span class="na">bar</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* assigns the contents of `foo.html` to `$bar`; does not print the contents *</span><span class="cp">}</span><span class="x"></span> | |
2867 | </code></pre></div> | |
704cbc4a | 2868 | </td></tr></table> |
45ca63d0 TD |
2869 | <h2 id="filesizebinary"><code>filesizeBinary</code><a class="headerlink" href="#filesizebinary" title="Permanent link">#</a></h2> |
2870 | <p><code>filesizeBinary</code> formats the filesize using binary filesize (in bytes).</p> | |
704cbc4a | 2871 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$filesize</span><span class="o">|</span><span class="na">filesizeBinary</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 2872 | </code></pre></div> |
704cbc4a | 2873 | </td></tr></table> |
45ca63d0 TD |
2874 | <h2 id="filesize"><code>filesize</code><a class="headerlink" href="#filesize" title="Permanent link">#</a></h2> |
2875 | <p><code>filesize</code> formats the filesize using filesize (in bytes).</p> | |
704cbc4a | 2876 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$filesize</span><span class="o">|</span><span class="na">filesize</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 2877 | </code></pre></div> |
704cbc4a | 2878 | </td></tr></table> |
45ca63d0 TD |
2879 | <h2 id="hascontent"><code>hascontent</code><a class="headerlink" href="#hascontent" title="Permanent link">#</a></h2> |
2880 | <p>In many cases, conditional statements can be used to determine if a certain section of a template is shown:</p> | |
704cbc4a WG |
2881 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2882 | <span class="normal">2</span> | |
2883 | <span class="normal">3</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">'bar'</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2884 | <span class="x"> only shown if $foo is bar</span> |
2885 | <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span> | |
2886 | </code></pre></div> | |
704cbc4a | 2887 | </td></tr></table> |
45ca63d0 TD |
2888 | <p>In some situations, however, such conditional statements are not sufficient. |
2889 | One prominent example is a template event:</p> | |
704cbc4a WG |
2890 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2891 | <span class="normal">2</span> | |
2892 | <span class="normal">3</span> | |
2893 | <span class="normal">4</span> | |
2894 | <span class="normal">5</span> | |
2895 | <span class="normal">6</span> | |
2896 | <span class="normal">7</span> | |
2897 | <span class="normal">8</span> | |
2898 | <span class="normal">9</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">'bar'</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2899 | <span class="x"> <ul></span> |
2900 | <span class="x"> </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">'bar'</span><span class="cp">}</span><span class="x"></span> | |
2901 | <span class="x"> <li>Bar</li></span> | |
2902 | <span class="x"> </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span> | |
2903 | ||
2904 | <span class="x"> </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">'listItems'</span><span class="cp">}</span><span class="x"></span> | |
2905 | <span class="x"> </li></span> | |
2906 | <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span> | |
2907 | </code></pre></div> | |
704cbc4a | 2908 | </td></tr></table> |
45ca63d0 TD |
2909 | <p>In this example, if <code>$foo !== 'bar'</code>, the list will not be shown, regardless of the additional template code provided by template listeners. |
2910 | In such a situation, <code>hascontent</code> has to be used:</p> | |
704cbc4a WG |
2911 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span> |
2912 | <span class="normal"> 2</span> | |
2913 | <span class="normal"> 3</span> | |
2914 | <span class="normal"> 4</span> | |
2915 | <span class="normal"> 5</span> | |
2916 | <span class="normal"> 6</span> | |
2917 | <span class="normal"> 7</span> | |
2918 | <span class="normal"> 8</span> | |
2919 | <span class="normal"> 9</span> | |
2920 | <span class="normal">10</span> | |
2921 | <span class="normal">11</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2922 | <span class="x"> <ul></span> |
2923 | <span class="x"> </span><span class="cp">{</span><span class="nf">content</span><span class="cp">}</span><span class="x"></span> | |
2924 | <span class="x"> </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">'bar'</span><span class="cp">}</span><span class="x"></span> | |
2925 | <span class="x"> <li>Bar</li></span> | |
2926 | <span class="x"> </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span> | |
2927 | ||
2928 | <span class="x"> </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">'listItems'</span><span class="cp">}</span><span class="x"></span> | |
2929 | <span class="x"> </span><span class="cp">{</span><span class="nf">/content</span><span class="cp">}</span><span class="x"></span> | |
2930 | <span class="x"> </ul></span> | |
2931 | <span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span><span class="x"></span> | |
2932 | </code></pre></div> | |
704cbc4a | 2933 | </td></tr></table> |
45ca63d0 TD |
2934 | <p>If the part of the template wrapped in the <code>content</code> tags has any (trimmed) content, the part of the template wrapped by <code>hascontent</code> tags is shown (including the part wrapped by the <code>content</code> tags), otherwise nothing is shown. |
2935 | Thus, this construct avoids an empty list compared to the <code>if</code> solution above.</p> | |
2936 | <p>Like <code>foreach</code>, <code>hascontent</code> also supports an <code>else</code> part:</p> | |
704cbc4a WG |
2937 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2938 | <span class="normal">2</span> | |
2939 | <span class="normal">3</span> | |
2940 | <span class="normal">4</span> | |
2941 | <span class="normal">5</span> | |
2942 | <span class="normal">6</span> | |
2943 | <span class="normal">7</span> | |
2944 | <span class="normal">8</span> | |
2945 | <span class="normal">9</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2946 | <span class="x"> <ul></span> |
2947 | <span class="x"> </span><span class="cp">{</span><span class="nf">content</span><span class="cp">}</span><span class="x"></span> | |
2948 | <span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span> | |
2949 | <span class="x"> </span><span class="cp">{</span><span class="nf">/content</span><span class="cp">}</span><span class="x"></span> | |
2950 | <span class="x"> </ul></span> | |
2951 | <span class="cp">{</span><span class="nf">hascontentelse</span><span class="cp">}</span><span class="x"></span> | |
2952 | <span class="x"> no list</span> | |
2953 | <span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span><span class="x"></span> | |
2954 | </code></pre></div> | |
704cbc4a | 2955 | </td></tr></table> |
45ca63d0 TD |
2956 | <h2 id="htmlcheckboxes"><code>htmlCheckboxes</code><a class="headerlink" href="#htmlcheckboxes" title="Permanent link">#</a></h2> |
2957 | <p><code>htmlCheckboxes</code> generates a list of HTML checkboxes.</p> | |
704cbc4a WG |
2958 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
2959 | <span class="normal">2</span> | |
2960 | <span class="normal">3</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">htmlCheckboxes</span> <span class="na">name</span><span class="o">=</span><span class="na">foo</span> <span class="na">options</span><span class="o">=</span><span class="nv">$fooOptions</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$currentFoo</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
2961 | |
2962 | <span class="cp">{</span><span class="nf">htmlCheckboxes</span> <span class="na">name</span><span class="o">=</span><span class="na">bar</span> <span class="na">output</span><span class="o">=</span><span class="nv">$barLabels</span> <span class="na">values</span><span class="o">=</span><span class="nv">$barValues</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$currentBar</span><span class="cp">}</span><span class="x"></span> | |
2963 | </code></pre></div> | |
704cbc4a | 2964 | </td></tr></table> |
45ca63d0 TD |
2965 | <table> |
2966 | <thead> | |
2967 | <tr> | |
2968 | <th>Attribute</th> | |
2969 | <th>Description</th> | |
2970 | </tr> | |
2971 | </thead> | |
2972 | <tbody> | |
2973 | <tr> | |
2974 | <td><span class="label label-info">5.2+</span> <code>disabled</code></td> | |
2975 | <td>if <code>true</code>, all checkboxes are disabled</td> | |
2976 | </tr> | |
2977 | <tr> | |
2978 | <td><code>disableEncoding</code></td> | |
2979 | <td>if <code>true</code>, the values are not passed through <code>wcf\util\StringUtil::encodeHTML()</code>; <code>false</code> by default</td> | |
2980 | </tr> | |
2981 | <tr> | |
2982 | <td><code>name</code></td> | |
2983 | <td><code>name</code> attribute of the <code>input</code> checkbox element</td> | |
2984 | </tr> | |
2985 | <tr> | |
2986 | <td><code>output</code></td> | |
2987 | <td>array used as keys and values for <code>options</code> if present; not present by default</td> | |
2988 | </tr> | |
2989 | <tr> | |
2990 | <td><code>options</code></td> | |
2991 | <td>array selectable options with the key used as <code>value</code> attribute and the value as the checkbox label</td> | |
2992 | </tr> | |
2993 | <tr> | |
2994 | <td><code>selected</code></td> | |
2995 | <td>current selected value(s)</td> | |
2996 | </tr> | |
2997 | <tr> | |
2998 | <td><code>separator</code></td> | |
2999 | <td>separator between the different checkboxes in the generated output; empty string by default</td> | |
3000 | </tr> | |
3001 | <tr> | |
3002 | <td><code>values</code></td> | |
3003 | <td>array with values used in combination with <code>output</code>, where <code>output</code> is only used as keys for <code>options</code></td> | |
3004 | </tr> | |
3005 | </tbody> | |
3006 | </table> | |
3007 | <h2 id="htmloptions"><code>htmlOptions</code><a class="headerlink" href="#htmloptions" title="Permanent link">#</a></h2> | |
3008 | <p><code>htmlOptions</code> generates an <code>select</code> HTML element.</p> | |
704cbc4a WG |
3009 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3010 | <span class="normal">2</span> | |
3011 | <span class="normal">3</span> | |
3012 | <span class="normal">4</span> | |
3013 | <span class="normal">5</span> | |
3014 | <span class="normal">6</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">htmlOptions</span> <span class="na">name</span><span class="o">=</span><span class="s1">'foo'</span> <span class="na">options</span><span class="o">=</span><span class="nv">$options</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$selected</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3015 | |
3016 | <span class="x"><select name="bar"></span> | |
3017 | <span class="x"> <option value=""</span><span class="cp">{</span><span class="nf">if</span> <span class="o">!</span><span class="nv">$selected</span><span class="cp">}</span><span class="x"> selected</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x">></span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.default</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></option></span> | |
3018 | <span class="x"> </span><span class="cp">{</span><span class="nf">htmlOptions</span> <span class="na">options</span><span class="o">=</span><span class="nv">$options</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$selected</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* no `name` attribute *</span><span class="cp">}</span><span class="x"></span> | |
3019 | <span class="x"></select></span> | |
3020 | </code></pre></div> | |
704cbc4a | 3021 | </td></tr></table> |
45ca63d0 TD |
3022 | <table> |
3023 | <thead> | |
3024 | <tr> | |
3025 | <th>Attribute</th> | |
3026 | <th>Description</th> | |
3027 | </tr> | |
3028 | </thead> | |
3029 | <tbody> | |
3030 | <tr> | |
3031 | <td><code>disableEncoding</code></td> | |
3032 | <td>if <code>true</code>, the values are not passed through <code>wcf\util\StringUtil::encodeHTML()</code>; <code>false</code> by default</td> | |
3033 | </tr> | |
3034 | <tr> | |
3035 | <td><code>object</code></td> | |
3036 | <td>optional instance of <code>wcf\data\DatabaseObjectList</code> that provides the selectable options (overwrites <code>options</code> attribute internally)</td> | |
3037 | </tr> | |
3038 | <tr> | |
3039 | <td><code>name</code></td> | |
3040 | <td><code>name</code> attribute of the <code>select</code> element; if not present, only the <strong>contents</strong> of the <code>select</code> element are printed</td> | |
3041 | </tr> | |
3042 | <tr> | |
3043 | <td><code>output</code></td> | |
3044 | <td>array used as keys and values for <code>options</code> if present; not present by default</td> | |
3045 | </tr> | |
3046 | <tr> | |
3047 | <td><code>values</code></td> | |
3048 | <td>array with values used in combination with <code>output</code>, where <code>output</code> is only used as keys for <code>options</code></td> | |
3049 | </tr> | |
3050 | <tr> | |
3051 | <td><code>options</code></td> | |
3052 | <td>array selectable options with the key used as <code>value</code> attribute and the value as the option label; if a value is an array, an <code>optgroup</code> is generated with the array key as the <code>optgroup</code> label</td> | |
3053 | </tr> | |
3054 | <tr> | |
3055 | <td><code>selected</code></td> | |
3056 | <td>current selected value(s)</td> | |
3057 | </tr> | |
3058 | </tbody> | |
3059 | </table> | |
3060 | <p>All additional attributes are added as attributes of the <code>select</code> HTML element.</p> | |
3061 | <h2 id="implode"><code>implode</code><a class="headerlink" href="#implode" title="Permanent link">#</a></h2> | |
3062 | <p><code>implodes</code> transforms an array into a string and prints it.</p> | |
704cbc4a | 3063 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">implode</span> <span class="na">from</span><span class="o">=</span><span class="nv">$array</span> <span class="na">key</span><span class="o">=</span><span class="na">key</span> <span class="na">item</span><span class="o">=</span><span class="na">item</span> <span class="na">glue</span><span class="o">=</span><span class="s2">";"</span><span class="cp">}{</span><span class="nv">$key</span><span class="cp">}</span><span class="x">: </span><span class="cp">{</span><span class="nv">$value</span><span class="cp">}{</span><span class="nf">/implode</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 3064 | </code></pre></div> |
704cbc4a | 3065 | </td></tr></table> |
45ca63d0 TD |
3066 | <table> |
3067 | <thead> | |
3068 | <tr> | |
3069 | <th>Attribute</th> | |
3070 | <th>Description</th> | |
3071 | </tr> | |
3072 | </thead> | |
3073 | <tbody> | |
3074 | <tr> | |
3075 | <td><code>from</code></td> | |
3076 | <td>array with the imploded values</td> | |
3077 | </tr> | |
3078 | <tr> | |
3079 | <td><code>glue</code></td> | |
3080 | <td>separator between the different array values; <code>', '</code> by default</td> | |
3081 | </tr> | |
3082 | <tr> | |
3083 | <td><code>item</code></td> | |
3084 | <td>template variable name where the current array value is stored during the iteration</td> | |
3085 | </tr> | |
3086 | <tr> | |
3087 | <td><code>key</code></td> | |
3088 | <td>optional template variable name where the current array key is stored during the iteration</td> | |
3089 | </tr> | |
3090 | </tbody> | |
3091 | </table> | |
3092 | <h2 id="52-ipsearch"><span class="label label-info">5.2+</span> <code>ipSearch</code><a class="headerlink" href="#52-ipsearch" title="Permanent link">#</a></h2> | |
3093 | <p><code>ipSearch</code> generates a link to search for an IP address.</p> | |
704cbc4a | 3094 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="s2">"127.0.0.1"</span><span class="o">|</span><span class="na">ipSearch</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 3095 | </code></pre></div> |
704cbc4a | 3096 | </td></tr></table> |
45ca63d0 TD |
3097 | <h2 id="30-js"><span class="label label-info">3.0+</span> <code>js</code><a class="headerlink" href="#30-js" title="Permanent link">#</a></h2> |
3098 | <p><code>js</code> generates script tags based on whether <code>ENABLE_DEBUG_MODE</code> and <code>VISITOR_USE_TINY_BUILD</code> are enabled.</p> | |
704cbc4a WG |
3099 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span> |
3100 | <span class="normal"> 2</span> | |
3101 | <span class="normal"> 3</span> | |
3102 | <span class="normal"> 4</span> | |
3103 | <span class="normal"> 5</span> | |
3104 | <span class="normal"> 6</span> | |
3105 | <span class="normal"> 7</span> | |
3106 | <span class="normal"> 8</span> | |
3107 | <span class="normal"> 9</span> | |
3108 | <span class="normal">10</span> | |
3109 | <span class="normal">11</span> | |
3110 | <span class="normal">12</span> | |
3111 | <span class="normal">13</span> | |
3112 | <span class="normal">14</span> | |
3113 | <span class="normal">15</span> | |
3114 | <span class="normal">16</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">'wbb'</span> <span class="na">file</span><span class="o">=</span><span class="s1">'WBB'</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/js/WBB.js' *</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3115 | |
3116 | <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">'wcf'</span> <span class="na">file</span><span class="o">=</span><span class="s1">'WCF.Like'</span> <span class="na">bundle</span><span class="o">=</span><span class="s1">'WCF.Combined'</span><span class="cp">}</span><span class="x"></span> | |
3117 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/WCF.Like.js' if ENABLE_DEBUG_MODE=1 *</span><span class="cp">}</span><span class="x"></span> | |
3118 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/WCF.Combined.min.js' if ENABLE_DEBUG_MODE=0 *</span><span class="cp">}</span><span class="x"></span> | |
3119 | ||
3120 | <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">'wcf'</span> <span class="na">lib</span><span class="o">=</span><span class="s1">'jquery'</span><span class="cp">}</span><span class="x"></span> | |
3121 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/3rdParty/jquery.js' *</span><span class="cp">}</span><span class="x"></span> | |
3122 | ||
3123 | <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">'wcf'</span> <span class="na">lib</span><span class="o">=</span><span class="s1">'jquery-ui'</span> <span class="na">file</span><span class="o">=</span><span class="s1">'awesomeWidget'</span><span class="cp">}</span><span class="x"></span> | |
3124 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/3rdParty/jquery-ui/awesomeWidget.js' *</span><span class="cp">}</span><span class="x"></span> | |
3125 | ||
3126 | <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">'wcf'</span> <span class="na">file</span><span class="o">=</span><span class="s1">'WCF.Like'</span> <span class="na">bundle</span><span class="o">=</span><span class="s1">'WCF.Combined'</span> <span class="na">hasTiny</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"></span> | |
3127 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/WCF.Like.js' if ENABLE_DEBUG_MODE=1 *</span><span class="cp">}</span><span class="x"></span> | |
3128 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/WCF.Combined.min.js' (ENABLE_DEBUG_MODE=0 *</span><span class="cp">}</span><span class="x"></span> | |
3129 | <span class="x"> </span><span class="cp">{</span><span class="c">* generates 'http://example.com/wcf/js/WCF.Combined.tiny.min.js' if ENABLE_DEBUG_MODE=0 and VISITOR_USE_TINY_BUILD=1 *</span><span class="cp">}</span><span class="x"></span> | |
3130 | </code></pre></div> | |
704cbc4a | 3131 | </td></tr></table> |
45ca63d0 TD |
3132 | <h2 id="53-jslang"><span class="label label-info">5.3+</span> <code>jslang</code><a class="headerlink" href="#53-jslang" title="Permanent link">#</a></h2> |
3133 | <p><code>jslang</code> works like <a href="#lang"><code>lang</code></a> with the difference that the resulting string is automatically passed through <a href="#encodejs"><code>encodeJS</code></a>.</p> | |
704cbc4a WG |
3134 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3135 | <span class="normal">2</span> | |
3136 | <span class="normal">3</span> | |
3137 | <span class="normal">4</span> | |
3138 | <span class="normal">5</span> | |
3139 | <span class="normal">6</span> | |
3140 | <span class="normal">7</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="x">require(['Language', /* … */], function(Language, /* … */) </span><span class="cp">{</span> | |
45ca63d0 TD |
3141 | <span class="na">Language</span><span class="o">.</span><span class="na">addObject</span><span class="o">(</span><span class="cp">{</span> |
3142 | <span class="s1">'app.foo.bar'</span><span class="o">:</span> <span class="s1">'{jslang}app.foo.bar{/jslang}'</span><span class="o">,</span> | |
3143 | <span class="cp">}</span><span class="o">);</span> | |
3144 | ||
3145 | <span class="o">//</span> <span class="err">…</span> | |
3146 | <span class="cp">}</span><span class="x">);</span> | |
3147 | </code></pre></div> | |
704cbc4a | 3148 | </td></tr></table> |
45ca63d0 TD |
3149 | <h2 id="lang"><code>lang</code><a class="headerlink" href="#lang" title="Permanent link">#</a></h2> |
3150 | <p><code>lang</code> replaces a language items with its value.</p> | |
704cbc4a WG |
3151 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3152 | <span class="normal">2</span> | |
3153 | <span class="normal">3</span> | |
3154 | <span class="normal">4</span> | |
3155 | <span class="normal">5</span> | |
3156 | <span class="normal">6</span> | |
3157 | <span class="normal">7</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3158 | |
3159 | <span class="cp">{</span><span class="nf">lang</span> <span class="na">__literal</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span> | |
3160 | ||
3161 | <span class="cp">{</span><span class="nf">lang</span> <span class="na">foo</span><span class="o">=</span><span class="s1">'baz'</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span> | |
3162 | ||
3163 | <span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.baz.</span><span class="cp">{</span><span class="nv">$action</span><span class="cp">}{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span> | |
3164 | </code></pre></div> | |
704cbc4a | 3165 | </td></tr></table> |
45ca63d0 TD |
3166 | <table> |
3167 | <thead> | |
3168 | <tr> | |
3169 | <th>Attribute</th> | |
3170 | <th>Description</th> | |
3171 | </tr> | |
3172 | </thead> | |
3173 | <tbody> | |
3174 | <tr> | |
3175 | <td><code>__encode</code></td> | |
3176 | <td>if <code>true</code>, the output will be passed through <code>StringUtil::encodeHTML()</code></td> | |
3177 | </tr> | |
3178 | <tr> | |
3179 | <td><code>__literal</code></td> | |
3180 | <td>if <code>true</code>, template variables will not resolved but printed as they are in the language item; <code>false</code> by default</td> | |
3181 | </tr> | |
3182 | <tr> | |
3183 | <td><code>__optional</code></td> | |
3184 | <td>if <code>true</code> and the language item does not exist, an empty string is printed; <code>false</code> by default</td> | |
3185 | </tr> | |
3186 | </tbody> | |
3187 | </table> | |
3188 | <p>All additional attributes are available when parsing the language item.</p> | |
3189 | <h2 id="language"><code>language</code><a class="headerlink" href="#language" title="Permanent link">#</a></h2> | |
3190 | <p><code>language</code> replaces a language items with its value. | |
3191 | If the template variable <code>__language</code> exists, this language object will be used instead of <code>WCF::getLanguage()</code>. | |
3192 | This modifier is useful when assigning the value directly to a variable.</p> | |
704cbc4a WG |
3193 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3194 | <span class="normal">2</span> | |
3195 | <span class="normal">3</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$languageItem</span><span class="o">|</span><span class="na">language</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3196 | |
3197 | <span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">foo</span> <span class="na">value</span><span class="o">=</span><span class="nv">$languageItem</span><span class="o">|</span><span class="na">language</span><span class="cp">}</span><span class="x"></span> | |
3198 | </code></pre></div> | |
704cbc4a | 3199 | </td></tr></table> |
45ca63d0 TD |
3200 | <h2 id="link"><code>link</code><a class="headerlink" href="#link" title="Permanent link">#</a></h2> |
3201 | <p><code>link</code> generates internal links using <code>LinkHandler</code>.</p> | |
704cbc4a | 3202 | <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 class="highlight"><pre><span></span><code><span class="x"><a href="</span><span class="cp">{</span><span class="nf">link</span> <span class="na">controller</span><span class="o">=</span><span class="s1">'FooList'</span> <span class="na">application</span><span class="o">=</span><span class="s1">'bar'</span><span class="cp">}</span><span class="x">param1=2&param2=A</span><span class="cp">{</span><span class="nf">/link</span><span class="cp">}</span><span class="x">">Foo</a></span> |
45ca63d0 | 3203 | </code></pre></div> |
704cbc4a | 3204 | </td></tr></table> |
45ca63d0 TD |
3205 | <table> |
3206 | <thead> | |
3207 | <tr> | |
3208 | <th>Attribute</th> | |
3209 | <th>Description</th> | |
3210 | </tr> | |
3211 | </thead> | |
3212 | <tbody> | |
3213 | <tr> | |
3214 | <td><code>application</code></td> | |
3215 | <td>abbreviation of the application the controller belongs to; <code>wcf</code> by default</td> | |
3216 | </tr> | |
3217 | <tr> | |
3218 | <td><code>controller</code></td> | |
3219 | <td>name of the controller; if not present, the landing page is linked in the frontend and the index page in the ACP</td> | |
3220 | </tr> | |
3221 | <tr> | |
3222 | <td><code>encode</code></td> | |
3223 | <td>if <code>true</code>, the generated link is passed through <code>wcf\util\StringUtil::encodeHTML()</code>; <code>true</code> by default</td> | |
3224 | </tr> | |
3225 | <tr> | |
3226 | <td><code>isEmail</code></td> | |
3227 | <td>sets <code>encode=false</code> and forces links to link to the frontend</td> | |
3228 | </tr> | |
3229 | </tbody> | |
3230 | </table> | |
3231 | <p>Additional attributes are passed to <code>LinkHandler::getLink()</code>.</p> | |
3232 | <h2 id="newlinetobreak"><code>newlineToBreak</code><a class="headerlink" href="#newlinetobreak" title="Permanent link">#</a></h2> | |
3233 | <p><code>newlineToBreak</code> transforms newlines into HTML <code><br></code> elements after encoding the content via <code>wcf\util\StringUtil::encodeHTML()</code>.</p> | |
704cbc4a | 3234 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">newlineToBreak</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 3235 | </code></pre></div> |
704cbc4a | 3236 | </td></tr></table> |
7d7c4daf WG |
3237 | <h2 id="54-objectaction"><span class="label label-info">5.4+</span> <code>objectAction</code><a class="headerlink" href="#54-objectaction" title="Permanent link">#</a></h2> |
3238 | <p><code>objectAction</code> generates action buttons to be used in combination with the <a href="../../migration/wsc53/javascript/#wcfactiondelete-and-wcfactiontoggle"><code>WoltLabSuite/Core/Ui/Object/Action</code> API</a>. | |
3239 | For detailed information on its usage, we refer to the extensive documentation in the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/template/plugin/ObjectActionFunctionTemplatePlugin.class.php"><code>ObjectActionFunctionTemplatePlugin</code> class</a> itself.</p> | |
45ca63d0 TD |
3240 | <h2 id="30-page"><span class="label label-info">3.0+</span> <code>page</code><a class="headerlink" href="#30-page" title="Permanent link">#</a></h2> |
3241 | <p><code>page</code> generates an internal link to a CMS page.</p> | |
704cbc4a WG |
3242 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3243 | <span class="normal">2</span> | |
3244 | <span class="normal">3</span> | |
3245 | <span class="normal">4</span> | |
3246 | <span class="normal">5</span> | |
3247 | <span class="normal">6</span> | |
3248 | <span class="normal">7</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">page</span><span class="cp">}</span><span class="x">com.woltlab.wcf.CookiePolicy</span><span class="cp">{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3249 | |
3250 | <span class="cp">{</span><span class="nf">page</span> <span class="na">pageID</span><span class="o">=</span><span class="m">1</span><span class="cp">}{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span> | |
3251 | ||
3252 | <span class="cp">{</span><span class="nf">page</span> <span class="na">language</span><span class="o">=</span><span class="s1">'de'</span><span class="cp">}</span><span class="x">com.woltlab.wcf.CookiePolicy</span><span class="cp">{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span> | |
3253 | ||
3254 | <span class="cp">{</span><span class="nf">page</span> <span class="na">languageID</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x">com.woltlab.wcf.CookiePolicy</span><span class="cp">{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span> | |
3255 | </code></pre></div> | |
704cbc4a | 3256 | </td></tr></table> |
45ca63d0 TD |
3257 | <table> |
3258 | <thead> | |
3259 | <tr> | |
3260 | <th>Attribute</th> | |
3261 | <th>Description</th> | |
3262 | </tr> | |
3263 | </thead> | |
3264 | <tbody> | |
3265 | <tr> | |
3266 | <td><code>pageID</code></td> | |
3267 | <td>unique id of the page (cannot be used together with a page identifier as value)</td> | |
3268 | </tr> | |
3269 | <tr> | |
3270 | <td><code>languageID</code></td> | |
3271 | <td>id of the page language (cannot be used together with <code>language</code>)</td> | |
3272 | </tr> | |
3273 | <tr> | |
3274 | <td><code>language</code></td> | |
3275 | <td>language code of the page language (cannot be used together with <code>languageID</code>)</td> | |
3276 | </tr> | |
3277 | </tbody> | |
3278 | </table> | |
3279 | <h2 id="pages"><code>pages</code><a class="headerlink" href="#pages" title="Permanent link">#</a></h2> | |
3280 | <p><code>pages</code> generates a pagination.</p> | |
704cbc4a WG |
3281 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3282 | <span class="normal">2</span> | |
3283 | <span class="normal">3</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">pages</span> <span class="na">controller</span><span class="o">=</span><span class="s1">'FooList'</span> <span class="na">link</span><span class="o">=</span><span class="s2">"pageNo=%d"</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span> <span class="na">assign</span><span class="o">=</span><span class="na">pagesLinks</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints pagination *</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3284 | |
3285 | <span class="cp">{</span><span class="o">@</span><span class="nv">$pagesLinks</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints same pagination again *</span><span class="cp">}</span><span class="x"></span> | |
3286 | </code></pre></div> | |
704cbc4a | 3287 | </td></tr></table> |
45ca63d0 TD |
3288 | <table> |
3289 | <thead> | |
3290 | <tr> | |
3291 | <th>Attribute</th> | |
3292 | <th>Description</th> | |
3293 | </tr> | |
3294 | </thead> | |
3295 | <tbody> | |
3296 | <tr> | |
3297 | <td><code>assign</code></td> | |
3298 | <td>optional name of the template variable the pagination is assigned to</td> | |
3299 | </tr> | |
3300 | <tr> | |
3301 | <td><code>controller</code></td> | |
3302 | <td>controller name of the generated links</td> | |
3303 | </tr> | |
3304 | <tr> | |
3305 | <td><code>link</code></td> | |
3306 | <td>additional link parameter where <code>%d</code> will be replaced with the relevant page number</td> | |
3307 | </tr> | |
3308 | <tr> | |
3309 | <td><code>pages</code></td> | |
3310 | <td>maximum number of of pages; by default, the template variable <code>$pages</code> is used</td> | |
3311 | </tr> | |
3312 | <tr> | |
3313 | <td><code>print</code></td> | |
3314 | <td>if <code>false</code> and <code>assign=true</code>, the pagination is not printed</td> | |
3315 | </tr> | |
3316 | <tr> | |
3317 | <td><code>application</code>, <code>id</code>, <code>object</code>, <code>title</code></td> | |
3318 | <td>additional parameters passed to <code>LinkHandler::getLink()</code> to generate page links</td> | |
3319 | </tr> | |
3320 | </tbody> | |
3321 | </table> | |
3322 | <h2 id="plaintime"><code>plainTime</code><a class="headerlink" href="#plaintime" title="Permanent link">#</a></h2> | |
3323 | <p><code>plainTime</code> formats a timestamp to include year, month, day, hour, and minutes. | |
3324 | The exact formatting depends on the current language (via the language items <code>wcf.date.dateTimeFormat</code>, <code>wcf.date.dateFormat</code>, and <code>wcf.date.timeFormat</code>).</p> | |
704cbc4a | 3325 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$timestamp</span><span class="o">|</span><span class="na">plainTime</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 3326 | </code></pre></div> |
704cbc4a | 3327 | </td></tr></table> |
45ca63d0 TD |
3328 | <h2 id="53-plural"><span class="label label-info">5.3+</span> <code>plural</code><a class="headerlink" href="#53-plural" title="Permanent link">#</a></h2> |
3329 | <p><code>plural</code> allows to easily select the correct plural form of a phrase based on a given <code>value</code>. | |
3330 | The pluralization logic follows the <a href="https://unicode-org.github.io/cldr-staging/charts/37/supplemental/language_plural_rules.md">Unicode Language Plural Rules</a> for cardinal numbers.</p> | |
3331 | <p>The <code>#</code> placeholder within the resulting phrase is replaced by the <code>value</code>. | |
3332 | It is automatically formatted using <code>StringUtil::formatNumeric</code>.</p> | |
3333 | <p>English:</p> | |
3334 | <p>Note the use of <code>1</code> if the number (<code>#</code>) is not used within the phrase and the use of <code>one</code> otherwise. | |
3335 | They are equivalent for English, but following this rule generalizes better to other languages, helping the translator. | |
704cbc4a WG |
3336 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3337 | <span class="normal">2</span> | |
3338 | <span class="normal">3</span> | |
3339 | <span class="normal">4</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3340 | <span class="x"><h1>Hello </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'World'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'Worlds'</span><span class="cp">}</span><span class="x">!</h1></span> |
3341 | <span class="x"><p>There </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'is one world'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'are # worlds'</span><span class="cp">}</span><span class="x">!</p></span> | |
3342 | <span class="x"><p>There </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="na">one</span><span class="o">=</span><span class="s1">'is # world'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'are # worlds'</span><span class="cp">}</span><span class="x">!</p></span> | |
704cbc4a WG |
3343 | </code></pre></div> |
3344 | </td></tr></table></p> | |
45ca63d0 | 3345 | <p>German: |
704cbc4a WG |
3346 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3347 | <span class="normal">2</span> | |
3348 | <span class="normal">3</span> | |
3349 | <span class="normal">4</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3350 | <span class="x"><h1>Hallo </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'Welt'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'Welten'</span><span class="cp">}</span><span class="x">!</h1></span> |
3351 | <span class="x"><p>Es gibt </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'eine Welt'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'# Welten'</span><span class="cp">}</span><span class="x">!</p></span> | |
3352 | <span class="x"><p>Es gibt </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="na">one</span><span class="o">=</span><span class="s1">'# Welt'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'# Welten'</span><span class="cp">}</span><span class="x">!</p></span> | |
704cbc4a WG |
3353 | </code></pre></div> |
3354 | </td></tr></table></p> | |
45ca63d0 TD |
3355 | <p>Romanian:</p> |
3356 | <p>Note the additional use of <code>few</code> which is not required in English or German. | |
704cbc4a WG |
3357 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3358 | <span class="normal">2</span> | |
3359 | <span class="normal">3</span> | |
3360 | <span class="normal">4</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3361 | <span class="x"><h1>Salut </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'lume'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'lumi'</span><span class="cp">}</span><span class="x">!</h1></span> |
3362 | <span class="x"><p>Există </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'o lume'</span> <span class="na">few</span><span class="o">=</span><span class="s1">'# lumi'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'# de lumi'</span><span class="cp">}</span><span class="x">!</p></span> | |
3363 | <span class="x"><p>Există </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="na">one</span><span class="o">=</span><span class="s1">'# lume'</span> <span class="na">few</span><span class="o">=</span><span class="s1">'# lumi'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'# de lumi'</span><span class="cp">}</span><span class="x">!</p></span> | |
704cbc4a WG |
3364 | </code></pre></div> |
3365 | </td></tr></table></p> | |
45ca63d0 TD |
3366 | <p>Russian:</p> |
3367 | <p>Note the difference between <code>1</code> (exactly <code>1</code>) and <code>one</code> (ending in <code>1</code>, except ending in <code>11</code>). | |
704cbc4a WG |
3368 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3369 | <span class="normal">2</span> | |
3370 | <span class="normal">3</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3371 | <span class="x"><h1>Привет </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorld</span> <span class="m">1</span><span class="o">=</span><span class="s1">'мир'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'миры'</span><span class="cp">}</span><span class="x">!</h1></span> |
3372 | <span class="x"><p>Есть </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">'мир'</span> <span class="na">one</span><span class="o">=</span><span class="s1">'# мир'</span> <span class="na">few</span><span class="o">=</span><span class="s1">'# мира'</span> <span class="na">many</span><span class="o">=</span><span class="s1">'# миров'</span> <span class="na">other</span><span class="o">=</span><span class="s1">'# миров'</span><span class="cp">}</span><span class="x">!</p></span> | |
704cbc4a WG |
3373 | </code></pre></div> |
3374 | </td></tr></table></p> | |
45ca63d0 TD |
3375 | <table> |
3376 | <thead> | |
3377 | <tr> | |
3378 | <th>Attribute</th> | |
3379 | <th>Description</th> | |
3380 | </tr> | |
3381 | </thead> | |
3382 | <tbody> | |
3383 | <tr> | |
3384 | <td>value</td> | |
3385 | <td>The value that is used to select the proper phrase.</td> | |
3386 | </tr> | |
3387 | <tr> | |
3388 | <td>other</td> | |
3389 | <td>The phrase that is used when no other selector matches.</td> | |
3390 | </tr> | |
3391 | <tr> | |
3392 | <td>Any Category Name</td> | |
3393 | <td>The phrase that is used when <code>value</code> belongs to the named category. Available categories depend on the language.</td> | |
3394 | </tr> | |
3395 | <tr> | |
3396 | <td>Any Integer</td> | |
3397 | <td>The phrase that is used when <code>value</code> is that exact integer.</td> | |
3398 | </tr> | |
3399 | </tbody> | |
3400 | </table> | |
3401 | <h2 id="prepend"><code>prepend</code><a class="headerlink" href="#prepend" title="Permanent link">#</a></h2> | |
3402 | <p>If a string should be prepended to the value of a variable, <code>prepend</code> can be used:</p> | |
704cbc4a WG |
3403 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3404 | <span class="normal">2</span> | |
3405 | <span class="normal">3</span> | |
3406 | <span class="normal">4</span> | |
3407 | <span class="normal">5</span> | |
3408 | <span class="normal">6</span> | |
3409 | <span class="normal">7</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">'newValue'</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3410 | |
3411 | <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 'newValue *</span><span class="cp">}</span><span class="x"></span> | |
3412 | ||
3413 | <span class="cp">{</span><span class="nf">prepend</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">'2'</span><span class="cp">}</span><span class="x"></span> | |
3414 | ||
3415 | <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* now prints '2newValue' *</span><span class="cp">}</span><span class="x"></span> | |
3416 | </code></pre></div> | |
704cbc4a | 3417 | </td></tr></table> |
45ca63d0 TD |
3418 | <p>If the variables does not exist yet, <code>prepend</code> creates a new one with the given value. |
3419 | If <code>prepend</code> is used on an array as the variable, the value is prepended to all elements of the array.</p> | |
3420 | <h2 id="shortunit"><code>shortUnit</code><a class="headerlink" href="#shortunit" title="Permanent link">#</a></h2> | |
3421 | <p><code>shortUnit</code> shortens numbers larger than 1000 by using unit suffixes:</p> | |
704cbc4a WG |
3422 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3423 | <span class="normal">2</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="m">10000</span><span class="o">|</span><span class="na">shortUnit</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 10k *</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3424 | <span class="cp">{</span><span class="m">5400000</span><span class="o">|</span><span class="na">shortUnit</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 5.4M *</span><span class="cp">}</span><span class="x"></span> |
3425 | </code></pre></div> | |
704cbc4a | 3426 | </td></tr></table> |
45ca63d0 TD |
3427 | <h2 id="smallpages"><code>smallpages</code><a class="headerlink" href="#smallpages" title="Permanent link">#</a></h2> |
3428 | <p><code>smallpages</code> generates a smaller version of <code>pages</code> by using adding the <code>small</code> CSS class to the generated <code><nav></code> element and only showing 7 instead of 9 links. </p> | |
3429 | <h2 id="tablewordwrap"><code>tableWordwrap</code><a class="headerlink" href="#tablewordwrap" title="Permanent link">#</a></h2> | |
3430 | <p><code>tableWordwrap</code> inserts zero width spaces every 30 characters in words longer than 30 characters.</p> | |
704cbc4a | 3431 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">tableWordwrap</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 3432 | </code></pre></div> |
704cbc4a | 3433 | </td></tr></table> |
45ca63d0 TD |
3434 | <h2 id="time"><code>time</code><a class="headerlink" href="#time" title="Permanent link">#</a></h2> |
3435 | <p><code>time</code> generates an HTML <code>time</code> elements based on a timestamp that shows a relative time or the absolute time if the timestamp more than six days ago.</p> | |
704cbc4a | 3436 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$timestamp</span><span class="o">|</span><span class="na">time</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints a '<time>' element *</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 3437 | </code></pre></div> |
704cbc4a | 3438 | </td></tr></table> |
45ca63d0 TD |
3439 | <h2 id="truncate"><code>truncate</code><a class="headerlink" href="#truncate" title="Permanent link">#</a></h2> |
3440 | <p><code>truncate</code> truncates a long string into a shorter one:</p> | |
704cbc4a WG |
3441 | <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span> |
3442 | <span class="normal">2</span> | |
3443 | <span class="normal">3</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">truncate</span><span class="o">:</span><span class="m">35</span><span class="cp">}</span><span class="x"></span> | |
45ca63d0 TD |
3444 | |
3445 | <span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">truncate</span><span class="o">:</span><span class="m">35</span><span class="o">:</span><span class="s1">'_'</span><span class="o">:</span><span class="kc">true</span><span class="cp">}</span><span class="x"></span> | |
3446 | </code></pre></div> | |
704cbc4a | 3447 | </td></tr></table> |
45ca63d0 TD |
3448 | <table> |
3449 | <thead> | |
3450 | <tr> | |
3451 | <th>Parameter Number</th> | |
3452 | <th>Description</th> | |
3453 | </tr> | |
3454 | </thead> | |
3455 | <tbody> | |
3456 | <tr> | |
3457 | <td>0</td> | |
3458 | <td>truncated string</td> | |
3459 | </tr> | |
3460 | <tr> | |
3461 | <td>1</td> | |
3462 | <td>truncated length; <code>80</code> by default</td> | |
3463 | </tr> | |
3464 | <tr> | |
3465 | <td>2</td> | |
3466 | <td>ellipsis symbol; <code>wcf\util\StringUtil::HELLIP</code> by default</td> | |
3467 | </tr> | |
3468 | <tr> | |
3469 | <td>3</td> | |
3470 | <td>if <code>true</code>, words can be broken up in the middle; <code>false</code> by default</td> | |
3471 | </tr> | |
3472 | </tbody> | |
3473 | </table> | |
3474 | <h2 id="53-user"><span class="label label-info">5.3+</span> <code>user</code><a class="headerlink" href="#53-user" title="Permanent link">#</a></h2> | |
3475 | <p><code>user</code> generates links to user profiles. | |
3476 | The mandatory <code>object</code> parameter requires an instances of <code>UserProfile</code>. | |
3477 | The optional <code>type</code> parameter is responsible for what the generated link contains:</p> | |
3478 | <ul> | |
3479 | <li><code>type='default'</code> (also applies if no <code>type</code> is given) outputs the formatted username relying on the “User Marking” setting of the relevant user group. | |
3480 | Additionally, the user popover card will be shown when hovering over the generated link.</li> | |
3481 | <li><code>type='plain'</code> outputs the username without additional formatting.</li> | |
3482 | <li><code>type='avatar(\d+)'</code> outputs the user’s avatar in the specified size, i.e., <code>avatar48</code> outputs the avatar with a width and height of 48 pixels.</li> | |
3483 | </ul> | |
3484 | <p>The last special attribute is <code>append</code> whose contents are appended to the <code>href</code> attribute of the generated anchor element.</p> | |
3485 | <p>All of the other attributes matching <code>~^[a-z]+([A-z]+)+$~</code>, except for <code>href</code> which may not be added, are added as attributes to the anchor element.</p> | |
3486 | <p>Examples:</p> | |
704cbc4a | 3487 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">user</span> <span class="na">object</span><span class="o">=</span><span class="nv">$user</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 3488 | </code></pre></div> |
704cbc4a | 3489 | </td></tr></table> |
45ca63d0 | 3490 | <p>generates</p> |
704cbc4a | 3491 | <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 class="highlight"><pre><span></span><code><span class="x"><a href="</span><span class="cp">{</span><span class="nv">$user</span><span class="o">-></span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">" data-object-id="</span><span class="cp">{</span><span class="nv">$user</span><span class="o">-></span><span class="na">userID</span><span class="cp">}</span><span class="x">" class="userLink"></span><span class="cp">{</span><span class="o">@</span><span class="nv">$user</span><span class="o">-></span><span class="na">getFormattedUsername</span><span class="o">()</span><span class="cp">}</span><span class="x"></a></span> |
45ca63d0 | 3492 | </code></pre></div> |
704cbc4a | 3493 | </td></tr></table> |
45ca63d0 | 3494 | <p>and</p> |
704cbc4a | 3495 | <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 class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">user</span> <span class="na">object</span><span class="o">=</span><span class="nv">$user</span> <span class="na">type</span><span class="o">=</span><span class="s1">'avatar48'</span> <span class="na">foo</span><span class="o">=</span><span class="s1">'bar'</span><span class="cp">}</span><span class="x"></span> |
45ca63d0 | 3496 | </code></pre></div> |
704cbc4a | 3497 | </td></tr></table> |
45ca63d0 | 3498 | <p>generates</p> |
704cbc4a | 3499 | <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 class="highlight"><pre><span></span><code><span class="x"><a href="</span><span class="cp">{</span><span class="nv">$user</span><span class="o">-></span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">" foo="bar"></span><span class="cp">{</span><span class="o">@</span><span class="nv">$object</span><span class="o">-></span><span class="na">getAvatar</span><span class="o">()-></span><span class="na">getImageTag</span><span class="o">(</span><span class="m">48</span><span class="o">)</span><span class="cp">}</span><span class="x"></a></span> |
45ca63d0 | 3500 | </code></pre></div> |
704cbc4a | 3501 | </td></tr></table> |
45ca63d0 | 3502 | |
4a5c32e1 WG |
3503 | |
3504 | ||
3505 | ||
3506 | <hr> | |
3507 | <div class="md-source-date"> | |
3508 | <small> | |
3509 | ||
7d7c4daf | 3510 | Last update: 2021-04-20 |
4a5c32e1 WG |
3511 | |
3512 | </small> | |
3513 | </div> | |
3514 | ||
3515 | ||
45ca63d0 TD |
3516 | |
3517 | ||
3518 | ||
3519 | ||
3520 | ||
3521 | ||
3522 | </article> | |
3523 | </div> | |
3524 | </div> | |
fb962f09 | 3525 | |
45ca63d0 TD |
3526 | </main> |
3527 | ||
3528 | ||
3529 | <footer class="md-footer"> | |
3530 | ||
6923e968 WG |
3531 | <nav class="md-footer__inner md-grid" aria-label="Footer"> |
3532 | ||
3533 | <a href="../templates/" class="md-footer__link md-footer__link--prev" rel="prev"> | |
3534 | <div class="md-footer__button md-icon"> | |
3535 | <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> | |
3536 | </div> | |
3537 | <div class="md-footer__title"> | |
3538 | <div class="md-ellipsis"> | |
3539 | <span class="md-footer__direction"> | |
3540 | Previous | |
3541 | </span> | |
3542 | Templates | |
3543 | </div> | |
3544 | </div> | |
3545 | </a> | |
3546 | ||
3547 | ||
3548 | <a href="../css/" class="md-footer__link md-footer__link--next" rel="next"> | |
3549 | <div class="md-footer__title"> | |
3550 | <div class="md-ellipsis"> | |
3551 | <span class="md-footer__direction"> | |
3552 | Next | |
3553 | </span> | |
3554 | CSS | |
3555 | </div> | |
3556 | </div> | |
3557 | <div class="md-footer__button md-icon"> | |
3558 | <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> | |
3559 | </div> | |
3560 | </a> | |
3561 | ||
3562 | </nav> | |
3563 | ||
45ca63d0 TD |
3564 | <div class="md-footer-meta md-typeset"> |
3565 | <div class="md-footer-meta__inner md-grid"> | |
3566 | <div class="md-footer-copyright"> | |
3567 | ||
3568 | <div class="md-footer-copyright__highlight"> | |
3569 | Copyright © 2020 WoltLab GmbH | |
3570 | </div> | |
3571 | ||
3572 | Made with | |
3573 | <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> | |
3574 | Material for MkDocs | |
3575 | </a> | |
fb88dc6e | 3576 | |
45ca63d0 TD |
3577 | </div> |
3578 | <div class="md-footer-copyright"> | |
3579 | <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a> | |
3580 | <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a> | |
3581 | </div> | |
3582 | </div> | |
3583 | </div> | |
3584 | </footer> | |
3585 | ||
3586 | </div> | |
3587 | <div class="md-dialog" data-md-component="dialog"> | |
3588 | <div class="md-dialog__inner md-typeset"></div> | |
3589 | </div> | |
fb962f09 | 3590 | <script id="__config" type="application/json">{"base": "../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script> |
45ca63d0 TD |
3591 | |
3592 | ||
a4835aa6 | 3593 | <script src="../../assets/javascripts/bundle.4ea5477f.min.js"></script> |
45ca63d0 TD |
3594 | |
3595 | ||
3596 | </body> | |
3597 | </html> |