3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>Templates - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ef6f36e2.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <script>function __prefix(e){return new URL(
"../../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
57 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
58 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
59 <label class=
"md-overlay" for=
"__drawer"></label>
60 <div data-md-component=
"skip">
63 <a href=
"#wcf-21x-templates" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
84 <img src=
"../../../assets/logo.png" alt=
"logo">
87 <label class=
"md-header__button md-icon" for=
"__drawer">
88 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 <div class=
"md-header__title" data-md-component=
"header-title">
91 <div class=
"md-header__ellipsis">
92 <div class=
"md-header__topic">
93 <span class=
"md-ellipsis">
94 WoltLab Suite Documentation
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
109 <label class=
"md-header__button md-icon" for=
"__search">
110 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
113 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
114 <label class=
"md-search__overlay" for=
"__search"></label>
115 <div class=
"md-search__inner" role=
"search">
116 <form class=
"md-search__form" name=
"search">
117 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
118 <label class=
"md-search__icon md-icon" for=
"__search">
119 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
120 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
123 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
126 <div class=
"md-search__output">
127 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
128 <div class=
"md-search-result" data-md-component=
"search-result">
129 <div class=
"md-search-result__meta">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
142 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
143 <div class=
"md-source__icon md-icon">
145 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
166 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
167 <div class=
"md-sidebar__scrollwrap">
168 <div class=
"md-sidebar__inner">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
184 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
185 <div class=
"md-source__icon md-icon">
187 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
229 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
230 <label class=
"md-nav__title" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
298 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
299 <label class=
"md-nav__title" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
319 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
320 <label class=
"md-nav__title" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
418 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
419 <label class=
"md-nav__title" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
595 <li class=
"md-nav__item md-nav__item--nested">
598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
600 <label class=
"md-nav__link" for=
"__nav_3">
601 Languages, Templates & CSS
602 <span class=
"md-nav__icon md-icon"></span>
604 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
605 <label class=
"md-nav__title" for=
"__nav_3">
606 <span class=
"md-nav__icon md-icon"></span>
607 Languages, Templates & CSS
609 <ul class=
"md-nav__list" data-md-scrollfix
>
615 <li class=
"md-nav__item">
616 <a href=
"../../../view/languages/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../../view/templates/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"../../../view/css/" class=
"md-nav__link">
673 <li class=
"md-nav__item md-nav__item--nested">
676 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
678 <label class=
"md-nav__link" for=
"__nav_4">
679 TypeScript and JavaScript API
680 <span class=
"md-nav__icon md-icon"></span>
682 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
683 <label class=
"md-nav__title" for=
"__nav_4">
684 <span class=
"md-nav__icon md-icon"></span>
685 TypeScript and JavaScript API
687 <ul class=
"md-nav__list" data-md-scrollfix
>
693 <li class=
"md-nav__item">
694 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
705 <li class=
"md-nav__item">
706 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
718 <li class=
"md-nav__item md-nav__item--nested">
721 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
723 <label class=
"md-nav__link" for=
"__nav_4_3">
725 <span class=
"md-nav__icon md-icon"></span>
727 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
728 <label class=
"md-nav__title" for=
"__nav_4_3">
729 <span class=
"md-nav__icon md-icon"></span>
732 <ul class=
"md-nav__list" data-md-scrollfix
>
738 <li class=
"md-nav__item">
739 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
750 <li class=
"md-nav__item">
751 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
762 <li class=
"md-nav__item">
763 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
774 <li class=
"md-nav__item">
775 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
786 <li class=
"md-nav__item">
787 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
798 <li class=
"md-nav__item">
799 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
810 <li class=
"md-nav__item">
811 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
822 <li class=
"md-nav__item">
823 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
824 Browser and Screen Sizes
834 <li class=
"md-nav__item">
835 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
852 <li class=
"md-nav__item">
853 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
864 <li class=
"md-nav__item">
865 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
876 <li class=
"md-nav__item">
877 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
898 <li class=
"md-nav__item md-nav__item--nested">
901 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
903 <label class=
"md-nav__link" for=
"__nav_5">
905 <span class=
"md-nav__icon md-icon"></span>
907 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
908 <label class=
"md-nav__title" for=
"__nav_5">
909 <span class=
"md-nav__icon md-icon"></span>
912 <ul class=
"md-nav__list" data-md-scrollfix
>
918 <li class=
"md-nav__item">
919 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
931 <li class=
"md-nav__item md-nav__item--nested">
934 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
936 <label class=
"md-nav__link" for=
"__nav_5_2">
938 <span class=
"md-nav__icon md-icon"></span>
940 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
941 <label class=
"md-nav__title" for=
"__nav_5_2">
942 <span class=
"md-nav__icon md-icon"></span>
945 <ul class=
"md-nav__list" data-md-scrollfix
>
951 <li class=
"md-nav__item">
952 <a href=
"../../../package/pip/" class=
"md-nav__link">
963 <li class=
"md-nav__item">
964 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
975 <li class=
"md-nav__item">
976 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
987 <li class=
"md-nav__item">
988 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
999 <li class=
"md-nav__item">
1000 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1011 <li class=
"md-nav__item">
1012 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1023 <li class=
"md-nav__item">
1024 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1035 <li class=
"md-nav__item">
1036 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1047 <li class=
"md-nav__item">
1048 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1059 <li class=
"md-nav__item">
1060 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1071 <li class=
"md-nav__item">
1072 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1083 <li class=
"md-nav__item">
1084 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1095 <li class=
"md-nav__item">
1096 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1107 <li class=
"md-nav__item">
1108 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1119 <li class=
"md-nav__item">
1120 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1131 <li class=
"md-nav__item">
1132 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1143 <li class=
"md-nav__item">
1144 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1155 <li class=
"md-nav__item">
1156 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1167 <li class=
"md-nav__item">
1168 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1169 objectTypeDefinition
1179 <li class=
"md-nav__item">
1180 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1191 <li class=
"md-nav__item">
1192 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1203 <li class=
"md-nav__item">
1204 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1215 <li class=
"md-nav__item">
1216 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1227 <li class=
"md-nav__item">
1228 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1239 <li class=
"md-nav__item">
1240 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1251 <li class=
"md-nav__item">
1252 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1263 <li class=
"md-nav__item">
1264 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1275 <li class=
"md-nav__item">
1276 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1287 <li class=
"md-nav__item">
1288 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1299 <li class=
"md-nav__item">
1300 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1311 <li class=
"md-nav__item">
1312 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1313 userNotificationEvent
1323 <li class=
"md-nav__item">
1324 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1335 <li class=
"md-nav__item">
1336 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1353 <li class=
"md-nav__item">
1354 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1377 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1380 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" checked
>
1382 <label class=
"md-nav__link" for=
"__nav_6">
1384 <span class=
"md-nav__icon md-icon"></span>
1386 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1387 <label class=
"md-nav__title" for=
"__nav_6">
1388 <span class=
"md-nav__icon md-icon"></span>
1391 <ul class=
"md-nav__list" data-md-scrollfix
>
1398 <li class=
"md-nav__item md-nav__item--nested">
1401 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1403 <label class=
"md-nav__link" for=
"__nav_6_1">
1404 Migrating from WSC
5.3
1405 <span class=
"md-nav__icon md-icon"></span>
1407 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1408 <label class=
"md-nav__title" for=
"__nav_6_1">
1409 <span class=
"md-nav__icon md-icon"></span>
1410 Migrating from WSC
5.3
1412 <ul class=
"md-nav__list" data-md-scrollfix
>
1418 <li class=
"md-nav__item">
1419 <a href=
"../../wsc53/php/" class=
"md-nav__link">
1430 <li class=
"md-nav__item">
1431 <a href=
"../../wsc53/session/" class=
"md-nav__link">
1432 Session Handling and Authentication
1442 <li class=
"md-nav__item">
1443 <a href=
"../../wsc53/javascript/" class=
"md-nav__link">
1444 TypeScript and JavaScript
1454 <li class=
"md-nav__item">
1455 <a href=
"../../wsc53/templates/" class=
"md-nav__link">
1466 <li class=
"md-nav__item">
1467 <a href=
"../../wsc53/libraries/" class=
"md-nav__link">
1468 Third Party Libraries
1485 <li class=
"md-nav__item md-nav__item--nested">
1488 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1490 <label class=
"md-nav__link" for=
"__nav_6_2">
1491 Migrating from WSC
5.2
1492 <span class=
"md-nav__icon md-icon"></span>
1494 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1495 <label class=
"md-nav__title" for=
"__nav_6_2">
1496 <span class=
"md-nav__icon md-icon"></span>
1497 Migrating from WSC
5.2
1499 <ul class=
"md-nav__list" data-md-scrollfix
>
1505 <li class=
"md-nav__item">
1506 <a href=
"../../wsc52/php/" class=
"md-nav__link">
1517 <li class=
"md-nav__item">
1518 <a href=
"../../wsc52/templates/" class=
"md-nav__link">
1519 Templates and Languages
1529 <li class=
"md-nav__item">
1530 <a href=
"../../wsc52/libraries/" class=
"md-nav__link">
1531 Third Party Libraries
1548 <li class=
"md-nav__item md-nav__item--nested">
1551 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1553 <label class=
"md-nav__link" for=
"__nav_6_3">
1554 Migrating from WSC
3.1
1555 <span class=
"md-nav__icon md-icon"></span>
1557 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1558 <label class=
"md-nav__title" for=
"__nav_6_3">
1559 <span class=
"md-nav__icon md-icon"></span>
1560 Migrating from WSC
3.1
1562 <ul class=
"md-nav__list" data-md-scrollfix
>
1568 <li class=
"md-nav__item">
1569 <a href=
"../../wsc31/php/" class=
"md-nav__link">
1587 <li class=
"md-nav__item md-nav__item--nested">
1590 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1592 <label class=
"md-nav__link" for=
"__nav_6_4">
1593 Migrating from WSC
3.0
1594 <span class=
"md-nav__icon md-icon"></span>
1596 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1597 <label class=
"md-nav__title" for=
"__nav_6_4">
1598 <span class=
"md-nav__icon md-icon"></span>
1599 Migrating from WSC
3.0
1601 <ul class=
"md-nav__list" data-md-scrollfix
>
1607 <li class=
"md-nav__item">
1608 <a href=
"../../wsc30/php/" class=
"md-nav__link">
1619 <li class=
"md-nav__item">
1620 <a href=
"../../wsc30/javascript/" class=
"md-nav__link">
1631 <li class=
"md-nav__item">
1632 <a href=
"../../wsc30/templates/" class=
"md-nav__link">
1643 <li class=
"md-nav__item">
1644 <a href=
"../../wsc30/css/" class=
"md-nav__link">
1655 <li class=
"md-nav__item">
1656 <a href=
"../../wsc30/package/" class=
"md-nav__link">
1676 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1679 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" checked
>
1681 <label class=
"md-nav__link" for=
"__nav_6_5">
1682 Migrating from WCF
2.1
1683 <span class=
"md-nav__icon md-icon"></span>
1685 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1686 <label class=
"md-nav__title" for=
"__nav_6_5">
1687 <span class=
"md-nav__icon md-icon"></span>
1688 Migrating from WCF
2.1
1690 <ul class=
"md-nav__list" data-md-scrollfix
>
1696 <li class=
"md-nav__item">
1697 <a href=
"../php/" class=
"md-nav__link">
1710 <li class=
"md-nav__item md-nav__item--active">
1712 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1717 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1719 <span class=
"md-nav__icon md-icon"></span>
1722 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1727 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1733 <label class=
"md-nav__title" for=
"__toc">
1734 <span class=
"md-nav__icon md-icon"></span>
1737 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1739 <li class=
"md-nav__item">
1740 <a href=
"#page-layout" class=
"md-nav__link">
1746 <li class=
"md-nav__item">
1747 <a href=
"#sidebars" class=
"md-nav__link">
1753 <li class=
"md-nav__item">
1754 <a href=
"#forms" class=
"md-nav__link">
1760 <li class=
"md-nav__item">
1761 <a href=
"#icons" class=
"md-nav__link">
1765 <nav class=
"md-nav" aria-label=
"Icons">
1766 <ul class=
"md-nav__list">
1768 <li class=
"md-nav__item">
1769 <a href=
"#changed-icon-names" class=
"md-nav__link">
1780 <li class=
"md-nav__item">
1781 <a href=
"#changed-classes" class=
"md-nav__link">
1787 <li class=
"md-nav__item">
1788 <a href=
"#removed-elements-and-classes" class=
"md-nav__link">
1789 Removed Elements and Classes
1794 <li class=
"md-nav__item">
1795 <a href=
"#simple-example" class=
"md-nav__link">
1801 <li class=
"md-nav__item">
1802 <a href=
"#full-example" class=
"md-nav__link">
1806 <nav class=
"md-nav" aria-label=
"Full Example">
1807 <ul class=
"md-nav__list">
1809 <li class=
"md-nav__item">
1810 <a href=
"#content-header" class=
"md-nav__link">
1814 <nav class=
"md-nav" aria-label=
"Content Header">
1815 <ul class=
"md-nav__list">
1817 <li class=
"md-nav__item">
1818 <a href=
"#recommended-approach" class=
"md-nav__link">
1819 Recommended Approach
1824 <li class=
"md-nav__item">
1825 <a href=
"#alternative" class=
"md-nav__link">
1853 <li class=
"md-nav__item">
1854 <a href=
"../css/" class=
"md-nav__link">
1865 <li class=
"md-nav__item">
1866 <a href=
"../package/" class=
"md-nav__link">
1893 <li class=
"md-nav__item md-nav__item--nested">
1896 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1898 <label class=
"md-nav__link" for=
"__nav_7">
1900 <span class=
"md-nav__icon md-icon"></span>
1902 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1903 <label class=
"md-nav__title" for=
"__nav_7">
1904 <span class=
"md-nav__icon md-icon"></span>
1907 <ul class=
"md-nav__list" data-md-scrollfix
>
1914 <li class=
"md-nav__item md-nav__item--nested">
1917 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1919 <label class=
"md-nav__link" for=
"__nav_7_1">
1921 <span class=
"md-nav__icon md-icon"></span>
1923 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1924 <label class=
"md-nav__title" for=
"__nav_7_1">
1925 <span class=
"md-nav__icon md-icon"></span>
1928 <ul class=
"md-nav__list" data-md-scrollfix
>
1934 <li class=
"md-nav__item">
1935 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1946 <li class=
"md-nav__item">
1947 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1958 <li class=
"md-nav__item">
1959 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1970 <li class=
"md-nav__item">
1971 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1998 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1999 <div class=
"md-sidebar__scrollwrap">
2000 <div class=
"md-sidebar__inner">
2002 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2008 <label class=
"md-nav__title" for=
"__toc">
2009 <span class=
"md-nav__icon md-icon"></span>
2012 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2014 <li class=
"md-nav__item">
2015 <a href=
"#page-layout" class=
"md-nav__link">
2021 <li class=
"md-nav__item">
2022 <a href=
"#sidebars" class=
"md-nav__link">
2028 <li class=
"md-nav__item">
2029 <a href=
"#forms" class=
"md-nav__link">
2035 <li class=
"md-nav__item">
2036 <a href=
"#icons" class=
"md-nav__link">
2040 <nav class=
"md-nav" aria-label=
"Icons">
2041 <ul class=
"md-nav__list">
2043 <li class=
"md-nav__item">
2044 <a href=
"#changed-icon-names" class=
"md-nav__link">
2055 <li class=
"md-nav__item">
2056 <a href=
"#changed-classes" class=
"md-nav__link">
2062 <li class=
"md-nav__item">
2063 <a href=
"#removed-elements-and-classes" class=
"md-nav__link">
2064 Removed Elements and Classes
2069 <li class=
"md-nav__item">
2070 <a href=
"#simple-example" class=
"md-nav__link">
2076 <li class=
"md-nav__item">
2077 <a href=
"#full-example" class=
"md-nav__link">
2081 <nav class=
"md-nav" aria-label=
"Full Example">
2082 <ul class=
"md-nav__list">
2084 <li class=
"md-nav__item">
2085 <a href=
"#content-header" class=
"md-nav__link">
2089 <nav class=
"md-nav" aria-label=
"Content Header">
2090 <ul class=
"md-nav__list">
2092 <li class=
"md-nav__item">
2093 <a href=
"#recommended-approach" class=
"md-nav__link">
2094 Recommended Approach
2099 <li class=
"md-nav__item">
2100 <a href=
"#alternative" class=
"md-nav__link">
2124 <div class=
"md-content" data-md-component=
"content">
2125 <article class=
"md-content__inner md-typeset">
2128 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/migration/wcf21/templates.md" title=
"Edit this page" class=
"md-content__button md-icon">
2129 <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>
2133 <h1 id=
"wcf-21x-templates">WCF
2.1.x - Templates
<a class=
"headerlink" href=
"#wcf-21x-templates" title=
"Permanent link">#
</a></h1>
2134 <h2 id=
"page-layout">Page Layout
<a class=
"headerlink" href=
"#page-layout" title=
"Permanent link">#
</a></h2>
2135 <p>The template structure has been overhauled and it is no longer required nor recommended to include internal templates, such as
<code>documentHeader
</code>,
<code>headInclude
</code> or
<code>userNotice
</code>. Instead use a simple
<code>{include file='header'}
</code> that now takes care of of the entire application frame.
</p>
2137 <li>Templates must not include a trailing
<code></body
></html
></code> after including the
<code>footer
</code> template.
</li>
2138 <li>The
<code>documentHeader
</code>,
<code>headInclude
</code> and
<code>userNotice
</code> template should no longer be included manually, the same goes with the
<code><body
></code> element, please use
<code>{include file='header'}
</code> instead.
</li>
2139 <li>The
<code>sidebarOrientation
</code> variable for the
<code>header
</code> template has been removed and no longer works.
</li>
2140 <li><code>header.boxHeadline
</code> has been unified and now reads
<code>header.contentHeader
</code></li>
2142 <p>Please see the full example at the end of this page for more information.
</p>
2143 <h2 id=
"sidebars">Sidebars
<a class=
"headerlink" href=
"#sidebars" title=
"Permanent link">#
</a></h2>
2144 <p>Sidebars are now dynamically populated by the box system, this requires a small change to unify the markup. Additionally the usage of
<code><fieldset
></code> has been deprecated due to browser inconsistencies and bugs and should be replaced with
<code>section.box
</code>.
</p>
2145 <p>Previous markup used in WoltLab Community Framework
2.1 and earlier:
</p>
2146 <div class=
"highlight"><pre><span></span><code><span class=
"p"><</span><span class=
"nt">fieldset
</span><span class=
"p">></span>
2147 <span class=
"p"><</span><span class=
"nt">legend
</span><span class=
"p">></span><span class=
"c"><!-- Title --
></span><span class=
"p"></
</span><span class=
"nt">legend
</span><span class=
"p">></span>
2149 <span class=
"p"><</span><span class=
"nt">div
</span><span class=
"p">></span>
2150 <span class=
"c"><!-- Content --
></span>
2151 <span class=
"p"></
</span><span class=
"nt">div
</span><span class=
"p">></span>
2152 <span class=
"p"></
</span><span class=
"nt">fieldset
</span><span class=
"p">></span>
2154 <p>The new markup since WoltLab Suite
3.0:
</p>
2155 <div class=
"highlight"><pre><span></span><code><span class=
"p"><</span><span class=
"nt">section
</span> <span class=
"na">class
</span><span class=
"o">=
</span><span class=
"s">"box
"</span><span class=
"p">></span>
2156 <span class=
"p"><</span><span class=
"nt">h2
</span> <span class=
"na">class
</span><span class=
"o">=
</span><span class=
"s">"boxTitle
"</span><span class=
"p">></span><span class=
"c"><!-- Title --
></span><span class=
"p"></
</span><span class=
"nt">h2
</span><span class=
"p">></span>
2158 <span class=
"p"><</span><span class=
"nt">div
</span> <span class=
"na">class
</span><span class=
"o">=
</span><span class=
"s">"boxContent
"</span><span class=
"p">></span>
2159 <span class=
"c"><!-- Content --
></span>
2160 <span class=
"p"></
</span><span class=
"nt">div
</span><span class=
"p">></span>
2161 <span class=
"p"></
</span><span class=
"nt">section
</span><span class=
"p">></span>
2163 <h2 id=
"forms">Forms
<a class=
"headerlink" href=
"#forms" title=
"Permanent link">#
</a></h2>
2164 <p>The input tag for session ids
<code>SID_INPUT_TAG
</code> has been deprecated and no longer yields any content, it can be safely removed. In previous versions forms have been wrapped in
<code><div
class=
"container containerPadding marginTop">…
</div
></code> which no longer has any effect and should be removed.
</p>
2165 <p>If you're using the preview feature for WYSIWYG-powered input fields, you need to alter the preview button include instruction:
</p>
2166 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">include
</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'messageFormPreviewButton
'</span> <span class=
"na">previewMessageObjectType
</span><span class=
"o">=
</span><span class=
"s1">'com.example.foo.bar
'</span> <span class=
"na">previewMessageObjectID
</span><span class=
"o">=
</span><span class=
"m">0</span><span class=
"cp">}
</span><span class=
"x"></span>
2168 <p><em>The message object id should be non-zero when editing.
</em></p>
2169 <h2 id=
"icons">Icons
<a class=
"headerlink" href=
"#icons" title=
"Permanent link">#
</a></h2>
2170 <p>The old
<code>.icon-
<iconName
></code> classes have been removed, you are required to use the official
<code>.fa-
<iconName
></code> class names from FontAwesome. This does not affect the generic classes
<code>.icon
</code> (indicates an icon) and
<code>.icon
<size
></code> (e.g.
<code>.icon16
</code> that sets the dimensions), these are still required and have not been deprecated.
</p>
2172 <div class=
"highlight"><pre><span></span><code><span class=
"p"><</span><span class=
"nt">span
</span> <span class=
"na">class
</span><span class=
"o">=
</span><span class=
"s">"icon icon16 icon-list
"</span><span class=
"p">></span>
2175 <div class=
"highlight"><pre><span></span><code><span class=
"p"><</span><span class=
"nt">span
</span> <span class=
"na">class
</span><span class=
"o">=
</span><span class=
"s">"icon icon16 fa-list
"</span><span class=
"p">></span>
2177 <h3 id=
"changed-icon-names">Changed Icon Names
<a class=
"headerlink" href=
"#changed-icon-names" title=
"Permanent link">#
</a></h3>
2178 <p>Quite a few icon names have been renamed, the official wiki lists the
<a href=
"https://github.com/FortAwesome/Font-Awesome/wiki/Upgrading-from-3.2.1-to-4">new icon names
</a> in FontAwesome
4.
</p>
2179 <h2 id=
"changed-classes">Changed Classes
<a class=
"headerlink" href=
"#changed-classes" title=
"Permanent link">#
</a></h2>
2181 <li><code>.dataList
</code> has been replaced and should now read
<code><ol
class=
"inlineList commaSeparated"></code> (same applies to
<code><ul
></code>)
</li>
2182 <li><code>.framedIconList
</code> has been changed into
<code>.userAvatarList
</code></li>
2184 <h2 id=
"removed-elements-and-classes">Removed Elements and Classes
<a class=
"headerlink" href=
"#removed-elements-and-classes" title=
"Permanent link">#
</a></h2>
2186 <li><code><nav
class=
"jsClipboardEditor"></code> and
<code><div
class=
"jsClipboardContainer"></code> have been replaced with a floating button.
</li>
2187 <li>The anchors
<code>a.toTopLink
</code> have been replaced with a floating button.
</li>
2188 <li>Avatars should no longer receive the class
<code>framed
</code></li>
2189 <li>The
<code>dl.condensed
</code> class, as seen in the editor tab menu, is no longer required.
</li>
2190 <li>Anything related to
<code>sidebarCollapsed
</code> has been removed as sidebars are no longer collapsible.
</li>
2192 <h2 id=
"simple-example">Simple Example
<a class=
"headerlink" href=
"#simple-example" title=
"Permanent link">#
</a></h2>
2193 <p>The code below includes only the absolute minimum required to display a page, the content title is already included in the output.
</p>
2194 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">include
</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'header
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2196 <span class=
"x"><div class=
"section
"></span>
2197 <span class=
"x"> Hello World!
</span>
2198 <span class=
"x"></div
></span>
2200 <span class=
"cp">{
</span><span class=
"nf">include
</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'footer
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2202 <h2 id=
"full-example">Full Example
<a class=
"headerlink" href=
"#full-example" title=
"Permanent link">#
</a></h2>
2203 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"c">*
</span>
2204 <span class=
"c"> The page title is automatically set using the page definition, avoid setting it if you can!
</span>
2205 <span class=
"c"> If you really need to modify the title, you can still reference the original title with:
</span>
2206 <span class=
"c"> {$__wcf-
>getActivePage()-
>getTitle()}
</span>
2207 <span class=
"c">*
</span><span class=
"cp">}
</span><span class=
"x"></span>
2208 <span class=
"cp">{
</span><span class=
"nf">capture
</span> <span class=
"na">assign
</span><span class=
"o">=
</span><span class=
"s1">'pageTitle
'</span><span class=
"cp">}
</span><span class=
"x">Custom Page Title
</span><span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2210 <span class=
"cp">{
</span><span class=
"c">*
</span>
2211 <span class=
"c"> NOTICE: The content header goes here, see the section after this to learn more.
</span>
2212 <span class=
"c">*
</span><span class=
"cp">}
</span><span class=
"x"></span>
2214 <span class=
"cp">{
</span><span class=
"c">* you must not use `headContent` for JavaScript *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2215 <span class=
"cp">{
</span><span class=
"nf">capture
</span> <span class=
"na">assign
</span><span class=
"o">=
</span><span class=
"s1">'headContent
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2216 <span class=
"x"> <link rel=
"alternate
" type=
"application/rss+xml
" title=
"</span><span class=
"cp">{
</span><span class=
"nf">lang
</span><span class=
"cp">}
</span><span class=
"x">wcf.global.button.rss
</span><span class=
"cp">{
</span><span class=
"nf">/lang
</span><span class=
"cp">}
</span><span class=
"x">" href=
"…
"></span>
2217 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2219 <span class=
"cp">{
</span><span class=
"c">* optional, content will be added to the top of the left sidebar *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2220 <span class=
"cp">{
</span><span class=
"nf">capture
</span> <span class=
"na">assign
</span><span class=
"o">=
</span><span class=
"s1">'sidebarLeft
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2221 <span class=
"x"> …
</span>
2223 <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">'boxes
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2224 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2226 <span class=
"cp">{
</span><span class=
"c">* optional, content will be added to the top of the right sidebar *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2227 <span class=
"cp">{
</span><span class=
"nf">capture
</span> <span class=
"na">assign
</span><span class=
"o">=
</span><span class=
"s1">'sidebarRight
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2228 <span class=
"x"> …
</span>
2230 <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">'boxes
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2231 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2233 <span class=
"cp">{
</span><span class=
"nf">capture
</span> <span class=
"na">assign
</span><span class=
"o">=
</span><span class=
"s1">'headerNavigation
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2234 <span class=
"x"> <li
><a href=
"#
" title=
"Custom Button
" class=
"jsTooltip
"><span class=
"icon icon16 fa-check
"></span
> <span class=
"invisible
">Custom Button
</span
></a
></li
></span>
2235 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2237 <span class=
"cp">{
</span><span class=
"nf">include
</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'header
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2239 <span class=
"cp">{
</span><span class=
"nf">hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2240 <span class=
"x"> <div class=
"paginationTop
"></span>
2241 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">content
</span><span class=
"cp">}
</span><span class=
"x"></span>
2242 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">pages
</span> <span class=
"err">…
</span><span class=
"cp">}
</span><span class=
"x"></span>
2243 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">/content
</span><span class=
"cp">}
</span><span class=
"x"></span>
2244 <span class=
"x"> </div
></span>
2245 <span class=
"cp">{
</span><span class=
"nf">/hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2247 <span class=
"cp">{
</span><span class=
"c">* the actual content *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2248 <span class=
"x"><div class=
"section
"></span>
2249 <span class=
"x"> …
</span>
2250 <span class=
"x"></div
></span>
2252 <span class=
"x"><footer class=
"contentFooter
"></span>
2253 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* skip this if you
're not using any pagination *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2254 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2255 <span class=
"x"> <div class=
"paginationBottom
"></span>
2256 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">content
</span><span class=
"cp">}{
</span><span class=
"o">@
</span><span class=
"nv">$pagesLinks
</span><span class=
"cp">}{
</span><span class=
"nf">/content
</span><span class=
"cp">}
</span><span class=
"x"></span>
2257 <span class=
"x"> </div
></span>
2258 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">/hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2260 <span class=
"x"> <nav class=
"contentFooterNavigation
"></span>
2261 <span class=
"x"> <ul
></span>
2262 <span class=
"x"> <li
><a href=
"…
" class=
"button
"><span class=
"icon icon16 fa-plus
"></span
> <span
>Custom Button
</span
></a
></li
></span>
2263 <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">'contentFooterNavigation
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2264 <span class=
"x"> </ul
></span>
2265 <span class=
"x"> </nav
></span>
2266 <span class=
"x"></footer
></span>
2268 <span class=
"x"><script data-relocate=
"true
"></span>
2269 <span class=
"x"> /* any JavaScript code you need */
</span>
2270 <span class=
"x"></script
></span>
2272 <span class=
"cp">{
</span><span class=
"c">* do not include `
</body
></html
>` here, the footer template is the last bit of code! *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2273 <span class=
"cp">{
</span><span class=
"nf">include
</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'footer
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2275 <h3 id=
"content-header">Content Header
<a class=
"headerlink" href=
"#content-header" title=
"Permanent link">#
</a></h3>
2276 <p>There are two different methods to set the content header, one sets only the actual values, but leaves the outer HTML untouched, that is generated by the
<code>header
</code> template. This is the recommended approach and you should avoid using the alternative method whenever possible.
</p>
2277 <h4 id=
"recommended-approach">Recommended Approach
<a class=
"headerlink" href=
"#recommended-approach" title=
"Permanent link">#
</a></h4>
2278 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"c">* This is automatically set using the page data and should not be set manually! *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2279 <span class=
"cp">{
</span><span class=
"nf">capture
</span> <span class=
"na">assign
</span><span class=
"o">=
</span><span class=
"s1">'contentTitle
'</span><span class=
"cp">}
</span><span class=
"x">Custom Content Title
</span><span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2281 <span class=
"cp">{
</span><span class=
"nf">capture
</span> <span class=
"na">assign
</span><span class=
"o">=
</span><span class=
"s1">'contentDescription
'</span><span class=
"cp">}
</span><span class=
"x">Optional description that is displayed right after the title.
</span><span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2283 <span class=
"cp">{
</span><span class=
"nf">capture
</span> <span class=
"na">assign
</span><span class=
"o">=
</span><span class=
"s1">'contentHeaderNavigation
'</span><span class=
"cp">}
</span><span class=
"x">List of navigation buttons displayed right next to the title.
</span><span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2285 <h4 id=
"alternative">Alternative
<a class=
"headerlink" href=
"#alternative" title=
"Permanent link">#
</a></h4>
2286 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">capture
</span> <span class=
"na">assign
</span><span class=
"o">=
</span><span class=
"s1">'contentHeader
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2287 <span class=
"x"> <header class=
"contentHeader
"></span>
2288 <span class=
"x"> <div class=
"contentHeaderTitle
"></span>
2289 <span class=
"x"> <h1 class=
"contentTitle
">Custom Content Title
</h1
></span>
2290 <span class=
"x"> <p class=
"contentHeaderDescription
">Custom Content Description
</p
></span>
2291 <span class=
"x"> </div
></span>
2293 <span class=
"x"> <nav class=
"contentHeaderNavigation
"></span>
2294 <span class=
"x"> <ul
></span>
2295 <span class=
"x"> <li
><a href=
"</span><span class=
"cp">{
</span><span class=
"nf">link
</span> <span class=
"na">controller
</span><span class=
"o">=
</span><span class=
"s1">'CustomController
'</span><span class=
"cp">}{
</span><span class=
"nf">/link
</span><span class=
"cp">}
</span><span class=
"x">" class=
"button
"><span class=
"icon icon16 fa-plus
"></span
> <span
>Custom Button
</span
></a
></li
></span>
2296 <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">'contentHeaderNavigation
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2297 <span class=
"x"> </ul
></span>
2298 <span class=
"x"> </nav
></span>
2299 <span class=
"x"> </header
></span>
2300 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2307 <div class=
"md-source-date">
2310 Last update:
2021-
01-
08
2329 <footer class=
"md-footer">
2331 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2333 <a href=
"../php/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2334 <div class=
"md-footer__button md-icon">
2335 <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>
2337 <div class=
"md-footer__title">
2338 <div class=
"md-ellipsis">
2339 <span class=
"md-footer__direction">
2348 <a href=
"../css/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2349 <div class=
"md-footer__title">
2350 <div class=
"md-ellipsis">
2351 <span class=
"md-footer__direction">
2357 <div class=
"md-footer__button md-icon">
2358 <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>
2364 <div class=
"md-footer-meta md-typeset">
2365 <div class=
"md-footer-meta__inner md-grid">
2366 <div class=
"md-footer-copyright">
2368 <div class=
"md-footer-copyright__highlight">
2369 Copyright ©
2020 WoltLab GmbH
2373 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2378 <div class=
"md-footer-copyright">
2379 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2380 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2387 <div class=
"md-dialog" data-md-component=
"dialog">
2388 <div class=
"md-dialog__inner md-typeset"></div>
2390 <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>
2393 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>