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
>
309 <li class=
"md-nav__item">
310 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
321 <li class=
"md-nav__item">
322 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
333 <li class=
"md-nav__item">
334 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
345 <li class=
"md-nav__item">
346 <a href=
"../../../php/api/events/" class=
"md-nav__link">
358 <li class=
"md-nav__item md-nav__item--nested">
361 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
363 <label class=
"md-nav__link" for=
"__nav_2_5_5">
365 <span class=
"md-nav__icon md-icon"></span>
367 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
368 <label class=
"md-nav__title" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
372 <ul class=
"md-nav__list" data-md-scrollfix
>
378 <li class=
"md-nav__item">
379 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
390 <li class=
"md-nav__item">
391 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
402 <li class=
"md-nav__item">
403 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
414 <li class=
"md-nav__item">
415 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
426 <li class=
"md-nav__item">
427 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
444 <li class=
"md-nav__item">
445 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
446 Package Installation Plugins
456 <li class=
"md-nav__item">
457 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
468 <li class=
"md-nav__item">
469 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
480 <li class=
"md-nav__item">
481 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
498 <li class=
"md-nav__item">
499 <a href=
"../../../php/code-style/" class=
"md-nav__link">
510 <li class=
"md-nav__item">
511 <a href=
"../../../php/apps/" class=
"md-nav__link">
522 <li class=
"md-nav__item">
523 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
544 <li class=
"md-nav__item md-nav__item--nested">
547 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
549 <label class=
"md-nav__link" for=
"__nav_3">
550 Languages, Templates & CSS
551 <span class=
"md-nav__icon md-icon"></span>
553 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
554 <label class=
"md-nav__title" for=
"__nav_3">
555 <span class=
"md-nav__icon md-icon"></span>
556 Languages, Templates & CSS
558 <ul class=
"md-nav__list" data-md-scrollfix
>
564 <li class=
"md-nav__item">
565 <a href=
"../../../view/languages/" class=
"md-nav__link">
576 <li class=
"md-nav__item">
577 <a href=
"../../../view/templates/" class=
"md-nav__link">
588 <li class=
"md-nav__item">
589 <a href=
"../../../view/css/" class=
"md-nav__link">
610 <li class=
"md-nav__item md-nav__item--nested">
613 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
615 <label class=
"md-nav__link" for=
"__nav_4">
617 <span class=
"md-nav__icon md-icon"></span>
619 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
620 <label class=
"md-nav__title" for=
"__nav_4">
621 <span class=
"md-nav__icon md-icon"></span>
624 <ul class=
"md-nav__list" data-md-scrollfix
>
630 <li class=
"md-nav__item">
631 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
643 <li class=
"md-nav__item md-nav__item--nested">
646 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
648 <label class=
"md-nav__link" for=
"__nav_4_2">
650 <span class=
"md-nav__icon md-icon"></span>
652 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
653 <label class=
"md-nav__title" for=
"__nav_4_2">
654 <span class=
"md-nav__icon md-icon"></span>
657 <ul class=
"md-nav__list" data-md-scrollfix
>
663 <li class=
"md-nav__item">
664 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
675 <li class=
"md-nav__item">
676 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
687 <li class=
"md-nav__item">
688 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
699 <li class=
"md-nav__item">
700 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
711 <li class=
"md-nav__item">
712 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
723 <li class=
"md-nav__item">
724 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
735 <li class=
"md-nav__item">
736 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
747 <li class=
"md-nav__item">
748 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
749 Browser and Screen Sizes
759 <li class=
"md-nav__item">
760 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
777 <li class=
"md-nav__item">
778 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
789 <li class=
"md-nav__item">
790 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
801 <li class=
"md-nav__item">
802 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
823 <li class=
"md-nav__item md-nav__item--nested">
826 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
828 <label class=
"md-nav__link" for=
"__nav_5">
830 <span class=
"md-nav__icon md-icon"></span>
832 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
833 <label class=
"md-nav__title" for=
"__nav_5">
834 <span class=
"md-nav__icon md-icon"></span>
837 <ul class=
"md-nav__list" data-md-scrollfix
>
843 <li class=
"md-nav__item">
844 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
856 <li class=
"md-nav__item md-nav__item--nested">
859 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
861 <label class=
"md-nav__link" for=
"__nav_5_2">
863 <span class=
"md-nav__icon md-icon"></span>
865 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
866 <label class=
"md-nav__title" for=
"__nav_5_2">
867 <span class=
"md-nav__icon md-icon"></span>
870 <ul class=
"md-nav__list" data-md-scrollfix
>
876 <li class=
"md-nav__item">
877 <a href=
"../../../package/pip/" class=
"md-nav__link">
888 <li class=
"md-nav__item">
889 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
900 <li class=
"md-nav__item">
901 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
912 <li class=
"md-nav__item">
913 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
924 <li class=
"md-nav__item">
925 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
936 <li class=
"md-nav__item">
937 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
948 <li class=
"md-nav__item">
949 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
960 <li class=
"md-nav__item">
961 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
972 <li class=
"md-nav__item">
973 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
984 <li class=
"md-nav__item">
985 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
996 <li class=
"md-nav__item">
997 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1008 <li class=
"md-nav__item">
1009 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1020 <li class=
"md-nav__item">
1021 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1032 <li class=
"md-nav__item">
1033 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1044 <li class=
"md-nav__item">
1045 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1056 <li class=
"md-nav__item">
1057 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1068 <li class=
"md-nav__item">
1069 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1080 <li class=
"md-nav__item">
1081 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1082 objectTypeDefinition
1092 <li class=
"md-nav__item">
1093 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1104 <li class=
"md-nav__item">
1105 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1116 <li class=
"md-nav__item">
1117 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1128 <li class=
"md-nav__item">
1129 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1140 <li class=
"md-nav__item">
1141 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1152 <li class=
"md-nav__item">
1153 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1164 <li class=
"md-nav__item">
1165 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1176 <li class=
"md-nav__item">
1177 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1188 <li class=
"md-nav__item">
1189 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1200 <li class=
"md-nav__item">
1201 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1212 <li class=
"md-nav__item">
1213 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1224 <li class=
"md-nav__item">
1225 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1226 userNotificationEvent
1236 <li class=
"md-nav__item">
1237 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1248 <li class=
"md-nav__item">
1249 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1266 <li class=
"md-nav__item">
1267 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1290 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1293 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" checked
>
1295 <label class=
"md-nav__link" for=
"__nav_6">
1297 <span class=
"md-nav__icon md-icon"></span>
1299 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1300 <label class=
"md-nav__title" for=
"__nav_6">
1301 <span class=
"md-nav__icon md-icon"></span>
1304 <ul class=
"md-nav__list" data-md-scrollfix
>
1311 <li class=
"md-nav__item md-nav__item--nested">
1314 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1316 <label class=
"md-nav__link" for=
"__nav_6_1">
1317 Migrating from WSC
5.3
1318 <span class=
"md-nav__icon md-icon"></span>
1320 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1321 <label class=
"md-nav__title" for=
"__nav_6_1">
1322 <span class=
"md-nav__icon md-icon"></span>
1323 Migrating from WSC
5.3
1325 <ul class=
"md-nav__list" data-md-scrollfix
>
1331 <li class=
"md-nav__item">
1332 <a href=
"../../wsc53/php/" class=
"md-nav__link">
1343 <li class=
"md-nav__item">
1344 <a href=
"../../wsc53/session/" class=
"md-nav__link">
1345 Session Handling and Authentication
1355 <li class=
"md-nav__item">
1356 <a href=
"../../wsc53/javascript/" class=
"md-nav__link">
1367 <li class=
"md-nav__item">
1368 <a href=
"../../wsc53/templates/" class=
"md-nav__link">
1379 <li class=
"md-nav__item">
1380 <a href=
"../../wsc53/libraries/" class=
"md-nav__link">
1381 Third Party Libraries
1398 <li class=
"md-nav__item md-nav__item--nested">
1401 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1403 <label class=
"md-nav__link" for=
"__nav_6_2">
1404 Migrating from WSC
5.2
1405 <span class=
"md-nav__icon md-icon"></span>
1407 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1408 <label class=
"md-nav__title" for=
"__nav_6_2">
1409 <span class=
"md-nav__icon md-icon"></span>
1410 Migrating from WSC
5.2
1412 <ul class=
"md-nav__list" data-md-scrollfix
>
1418 <li class=
"md-nav__item">
1419 <a href=
"../../wsc52/php/" class=
"md-nav__link">
1430 <li class=
"md-nav__item">
1431 <a href=
"../../wsc52/templates/" class=
"md-nav__link">
1432 Templates and Languages
1442 <li class=
"md-nav__item">
1443 <a href=
"../../wsc52/libraries/" class=
"md-nav__link">
1444 Third Party Libraries
1461 <li class=
"md-nav__item md-nav__item--nested">
1464 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1466 <label class=
"md-nav__link" for=
"__nav_6_3">
1467 Migrating from WSC
3.1
1468 <span class=
"md-nav__icon md-icon"></span>
1470 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1471 <label class=
"md-nav__title" for=
"__nav_6_3">
1472 <span class=
"md-nav__icon md-icon"></span>
1473 Migrating from WSC
3.1
1475 <ul class=
"md-nav__list" data-md-scrollfix
>
1481 <li class=
"md-nav__item">
1482 <a href=
"../../wsc31/php/" class=
"md-nav__link">
1500 <li class=
"md-nav__item md-nav__item--nested">
1503 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1505 <label class=
"md-nav__link" for=
"__nav_6_4">
1506 Migrating from WSC
3.0
1507 <span class=
"md-nav__icon md-icon"></span>
1509 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1510 <label class=
"md-nav__title" for=
"__nav_6_4">
1511 <span class=
"md-nav__icon md-icon"></span>
1512 Migrating from WSC
3.0
1514 <ul class=
"md-nav__list" data-md-scrollfix
>
1520 <li class=
"md-nav__item">
1521 <a href=
"../../wsc30/php/" class=
"md-nav__link">
1532 <li class=
"md-nav__item">
1533 <a href=
"../../wsc30/javascript/" class=
"md-nav__link">
1544 <li class=
"md-nav__item">
1545 <a href=
"../../wsc30/templates/" class=
"md-nav__link">
1556 <li class=
"md-nav__item">
1557 <a href=
"../../wsc30/css/" class=
"md-nav__link">
1568 <li class=
"md-nav__item">
1569 <a href=
"../../wsc30/package/" class=
"md-nav__link">
1589 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1592 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" checked
>
1594 <label class=
"md-nav__link" for=
"__nav_6_5">
1595 Migrating from WCF
2.1
1596 <span class=
"md-nav__icon md-icon"></span>
1598 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1599 <label class=
"md-nav__title" for=
"__nav_6_5">
1600 <span class=
"md-nav__icon md-icon"></span>
1601 Migrating from WCF
2.1
1603 <ul class=
"md-nav__list" data-md-scrollfix
>
1609 <li class=
"md-nav__item">
1610 <a href=
"../php/" class=
"md-nav__link">
1623 <li class=
"md-nav__item md-nav__item--active">
1625 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1630 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1632 <span class=
"md-nav__icon md-icon"></span>
1635 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1640 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1646 <label class=
"md-nav__title" for=
"__toc">
1647 <span class=
"md-nav__icon md-icon"></span>
1650 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1652 <li class=
"md-nav__item">
1653 <a href=
"#page-layout" class=
"md-nav__link">
1659 <li class=
"md-nav__item">
1660 <a href=
"#sidebars" class=
"md-nav__link">
1666 <li class=
"md-nav__item">
1667 <a href=
"#forms" class=
"md-nav__link">
1673 <li class=
"md-nav__item">
1674 <a href=
"#icons" class=
"md-nav__link">
1678 <nav class=
"md-nav" aria-label=
"Icons">
1679 <ul class=
"md-nav__list">
1681 <li class=
"md-nav__item">
1682 <a href=
"#changed-icon-names" class=
"md-nav__link">
1693 <li class=
"md-nav__item">
1694 <a href=
"#changed-classes" class=
"md-nav__link">
1700 <li class=
"md-nav__item">
1701 <a href=
"#removed-elements-and-classes" class=
"md-nav__link">
1702 Removed Elements and Classes
1707 <li class=
"md-nav__item">
1708 <a href=
"#simple-example" class=
"md-nav__link">
1714 <li class=
"md-nav__item">
1715 <a href=
"#full-example" class=
"md-nav__link">
1719 <nav class=
"md-nav" aria-label=
"Full Example">
1720 <ul class=
"md-nav__list">
1722 <li class=
"md-nav__item">
1723 <a href=
"#content-header" class=
"md-nav__link">
1727 <nav class=
"md-nav" aria-label=
"Content Header">
1728 <ul class=
"md-nav__list">
1730 <li class=
"md-nav__item">
1731 <a href=
"#recommended-approach" class=
"md-nav__link">
1732 Recommended Approach
1737 <li class=
"md-nav__item">
1738 <a href=
"#alternative" class=
"md-nav__link">
1766 <li class=
"md-nav__item">
1767 <a href=
"../css/" class=
"md-nav__link">
1778 <li class=
"md-nav__item">
1779 <a href=
"../package/" class=
"md-nav__link">
1806 <li class=
"md-nav__item md-nav__item--nested">
1809 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1811 <label class=
"md-nav__link" for=
"__nav_7">
1813 <span class=
"md-nav__icon md-icon"></span>
1815 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1816 <label class=
"md-nav__title" for=
"__nav_7">
1817 <span class=
"md-nav__icon md-icon"></span>
1820 <ul class=
"md-nav__list" data-md-scrollfix
>
1827 <li class=
"md-nav__item md-nav__item--nested">
1830 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1832 <label class=
"md-nav__link" for=
"__nav_7_1">
1834 <span class=
"md-nav__icon md-icon"></span>
1836 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1837 <label class=
"md-nav__title" for=
"__nav_7_1">
1838 <span class=
"md-nav__icon md-icon"></span>
1841 <ul class=
"md-nav__list" data-md-scrollfix
>
1847 <li class=
"md-nav__item">
1848 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1859 <li class=
"md-nav__item">
1860 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1871 <li class=
"md-nav__item">
1872 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1883 <li class=
"md-nav__item">
1884 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1911 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1912 <div class=
"md-sidebar__scrollwrap">
1913 <div class=
"md-sidebar__inner">
1915 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1921 <label class=
"md-nav__title" for=
"__toc">
1922 <span class=
"md-nav__icon md-icon"></span>
1925 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1927 <li class=
"md-nav__item">
1928 <a href=
"#page-layout" class=
"md-nav__link">
1934 <li class=
"md-nav__item">
1935 <a href=
"#sidebars" class=
"md-nav__link">
1941 <li class=
"md-nav__item">
1942 <a href=
"#forms" class=
"md-nav__link">
1948 <li class=
"md-nav__item">
1949 <a href=
"#icons" class=
"md-nav__link">
1953 <nav class=
"md-nav" aria-label=
"Icons">
1954 <ul class=
"md-nav__list">
1956 <li class=
"md-nav__item">
1957 <a href=
"#changed-icon-names" class=
"md-nav__link">
1968 <li class=
"md-nav__item">
1969 <a href=
"#changed-classes" class=
"md-nav__link">
1975 <li class=
"md-nav__item">
1976 <a href=
"#removed-elements-and-classes" class=
"md-nav__link">
1977 Removed Elements and Classes
1982 <li class=
"md-nav__item">
1983 <a href=
"#simple-example" class=
"md-nav__link">
1989 <li class=
"md-nav__item">
1990 <a href=
"#full-example" class=
"md-nav__link">
1994 <nav class=
"md-nav" aria-label=
"Full Example">
1995 <ul class=
"md-nav__list">
1997 <li class=
"md-nav__item">
1998 <a href=
"#content-header" class=
"md-nav__link">
2002 <nav class=
"md-nav" aria-label=
"Content Header">
2003 <ul class=
"md-nav__list">
2005 <li class=
"md-nav__item">
2006 <a href=
"#recommended-approach" class=
"md-nav__link">
2007 Recommended Approach
2012 <li class=
"md-nav__item">
2013 <a href=
"#alternative" class=
"md-nav__link">
2037 <div class=
"md-content" data-md-component=
"content">
2038 <article class=
"md-content__inner md-typeset">
2041 <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">
2042 <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>
2046 <h1 id=
"wcf-21x-templates">WCF
2.1.x - Templates
<a class=
"headerlink" href=
"#wcf-21x-templates" title=
"Permanent link">#
</a></h1>
2047 <h2 id=
"page-layout">Page Layout
<a class=
"headerlink" href=
"#page-layout" title=
"Permanent link">#
</a></h2>
2048 <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>
2050 <li>Templates must not include a trailing
<code></body
></html
></code> after including the
<code>footer
</code> template.
</li>
2051 <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>
2052 <li>The
<code>sidebarOrientation
</code> variable for the
<code>header
</code> template has been removed and no longer works.
</li>
2053 <li><code>header.boxHeadline
</code> has been unified and now reads
<code>header.contentHeader
</code></li>
2055 <p>Please see the full example at the end of this page for more information.
</p>
2056 <h2 id=
"sidebars">Sidebars
<a class=
"headerlink" href=
"#sidebars" title=
"Permanent link">#
</a></h2>
2057 <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>
2058 <p>Previous markup used in WoltLab Community Framework
2.1 and earlier:
</p>
2059 <div class=
"highlight"><pre><span></span><code><span class=
"p"><</span><span class=
"nt">fieldset
</span><span class=
"p">></span>
2060 <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>
2062 <span class=
"p"><</span><span class=
"nt">div
</span><span class=
"p">></span>
2063 <span class=
"c"><!-- Content --
></span>
2064 <span class=
"p"></
</span><span class=
"nt">div
</span><span class=
"p">></span>
2065 <span class=
"p"></
</span><span class=
"nt">fieldset
</span><span class=
"p">></span>
2067 <p>The new markup since WoltLab Suite
3.0:
</p>
2068 <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>
2069 <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>
2071 <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>
2072 <span class=
"c"><!-- Content --
></span>
2073 <span class=
"p"></
</span><span class=
"nt">div
</span><span class=
"p">></span>
2074 <span class=
"p"></
</span><span class=
"nt">section
</span><span class=
"p">></span>
2076 <h2 id=
"forms">Forms
<a class=
"headerlink" href=
"#forms" title=
"Permanent link">#
</a></h2>
2077 <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>
2078 <p>If you're using the preview feature for WYSIWYG-powered input fields, you need to alter the preview button include instruction:
</p>
2079 <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>
2081 <p><em>The message object id should be non-zero when editing.
</em></p>
2082 <h2 id=
"icons">Icons
<a class=
"headerlink" href=
"#icons" title=
"Permanent link">#
</a></h2>
2083 <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>
2085 <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>
2088 <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>
2090 <h3 id=
"changed-icon-names">Changed Icon Names
<a class=
"headerlink" href=
"#changed-icon-names" title=
"Permanent link">#
</a></h3>
2091 <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>
2092 <h2 id=
"changed-classes">Changed Classes
<a class=
"headerlink" href=
"#changed-classes" title=
"Permanent link">#
</a></h2>
2094 <li><code>.dataList
</code> has been replaced and should now read
<code><ol
class=
"inlineList commaSeparated"></code> (same applies to
<code><ul
></code>)
</li>
2095 <li><code>.framedIconList
</code> has been changed into
<code>.userAvatarList
</code></li>
2097 <h2 id=
"removed-elements-and-classes">Removed Elements and Classes
<a class=
"headerlink" href=
"#removed-elements-and-classes" title=
"Permanent link">#
</a></h2>
2099 <li><code><nav
class=
"jsClipboardEditor"></code> and
<code><div
class=
"jsClipboardContainer"></code> have been replaced with a floating button.
</li>
2100 <li>The anchors
<code>a.toTopLink
</code> have been replaced with a floating button.
</li>
2101 <li>Avatars should no longer receive the class
<code>framed
</code></li>
2102 <li>The
<code>dl.condensed
</code> class, as seen in the editor tab menu, is no longer required.
</li>
2103 <li>Anything related to
<code>sidebarCollapsed
</code> has been removed as sidebars are no longer collapsible.
</li>
2105 <h2 id=
"simple-example">Simple Example
<a class=
"headerlink" href=
"#simple-example" title=
"Permanent link">#
</a></h2>
2106 <p>The code below includes only the absolute minimum required to display a page, the content title is already included in the output.
</p>
2107 <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>
2109 <span class=
"x"><div class=
"section
"></span>
2110 <span class=
"x"> Hello World!
</span>
2111 <span class=
"x"></div
></span>
2113 <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>
2115 <h2 id=
"full-example">Full Example
<a class=
"headerlink" href=
"#full-example" title=
"Permanent link">#
</a></h2>
2116 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"c">*
</span>
2117 <span class=
"c"> The page title is automatically set using the page definition, avoid setting it if you can!
</span>
2118 <span class=
"c"> If you really need to modify the title, you can still reference the original title with:
</span>
2119 <span class=
"c"> {$__wcf-
>getActivePage()-
>getTitle()}
</span>
2120 <span class=
"c">*
</span><span class=
"cp">}
</span><span class=
"x"></span>
2121 <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>
2123 <span class=
"cp">{
</span><span class=
"c">*
</span>
2124 <span class=
"c"> NOTICE: The content header goes here, see the section after this to learn more.
</span>
2125 <span class=
"c">*
</span><span class=
"cp">}
</span><span class=
"x"></span>
2127 <span class=
"cp">{
</span><span class=
"c">* you must not use `headContent` for JavaScript *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2128 <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>
2129 <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>
2130 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2132 <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>
2133 <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>
2134 <span class=
"x"> …
</span>
2136 <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>
2137 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2139 <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>
2140 <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>
2141 <span class=
"x"> …
</span>
2143 <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>
2144 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2146 <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>
2147 <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>
2148 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2150 <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>
2152 <span class=
"cp">{
</span><span class=
"nf">hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2153 <span class=
"x"> <div class=
"paginationTop
"></span>
2154 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">content
</span><span class=
"cp">}
</span><span class=
"x"></span>
2155 <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>
2156 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">/content
</span><span class=
"cp">}
</span><span class=
"x"></span>
2157 <span class=
"x"> </div
></span>
2158 <span class=
"cp">{
</span><span class=
"nf">/hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2160 <span class=
"cp">{
</span><span class=
"c">* the actual content *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2161 <span class=
"x"><div class=
"section
"></span>
2162 <span class=
"x"> …
</span>
2163 <span class=
"x"></div
></span>
2165 <span class=
"x"><footer class=
"contentFooter
"></span>
2166 <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>
2167 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2168 <span class=
"x"> <div class=
"paginationBottom
"></span>
2169 <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>
2170 <span class=
"x"> </div
></span>
2171 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">/hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2173 <span class=
"x"> <nav class=
"contentFooterNavigation
"></span>
2174 <span class=
"x"> <ul
></span>
2175 <span class=
"x"> <li
><a href=
"…
" class=
"button
"><span class=
"icon icon16 fa-plus
"></span
> <span
>Custom Button
</span
></a
></li
></span>
2176 <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>
2177 <span class=
"x"> </ul
></span>
2178 <span class=
"x"> </nav
></span>
2179 <span class=
"x"></footer
></span>
2181 <span class=
"x"><script data-relocate=
"true
"></span>
2182 <span class=
"x"> /* any JavaScript code you need */
</span>
2183 <span class=
"x"></script
></span>
2185 <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>
2186 <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>
2188 <h3 id=
"content-header">Content Header
<a class=
"headerlink" href=
"#content-header" title=
"Permanent link">#
</a></h3>
2189 <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>
2190 <h4 id=
"recommended-approach">Recommended Approach
<a class=
"headerlink" href=
"#recommended-approach" title=
"Permanent link">#
</a></h4>
2191 <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>
2192 <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>
2194 <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>
2196 <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>
2198 <h4 id=
"alternative">Alternative
<a class=
"headerlink" href=
"#alternative" title=
"Permanent link">#
</a></h4>
2199 <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>
2200 <span class=
"x"> <header class=
"contentHeader
"></span>
2201 <span class=
"x"> <div class=
"contentHeaderTitle
"></span>
2202 <span class=
"x"> <h1 class=
"contentTitle
">Custom Content Title
</h1
></span>
2203 <span class=
"x"> <p class=
"contentHeaderDescription
">Custom Content Description
</p
></span>
2204 <span class=
"x"> </div
></span>
2206 <span class=
"x"> <nav class=
"contentHeaderNavigation
"></span>
2207 <span class=
"x"> <ul
></span>
2208 <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>
2209 <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>
2210 <span class=
"x"> </ul
></span>
2211 <span class=
"x"> </nav
></span>
2212 <span class=
"x"> </header
></span>
2213 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2220 <div class=
"md-source-date">
2223 Last update:
2021-
01-
08
2242 <footer class=
"md-footer">
2244 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2246 <a href=
"../php/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2247 <div class=
"md-footer__button md-icon">
2248 <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>
2250 <div class=
"md-footer__title">
2251 <div class=
"md-ellipsis">
2252 <span class=
"md-footer__direction">
2261 <a href=
"../css/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2262 <div class=
"md-footer__title">
2263 <div class=
"md-ellipsis">
2264 <span class=
"md-footer__direction">
2270 <div class=
"md-footer__button md-icon">
2271 <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>
2277 <div class=
"md-footer-meta md-typeset">
2278 <div class=
"md-footer-meta__inner md-grid">
2279 <div class=
"md-footer-copyright">
2281 <div class=
"md-footer-copyright__highlight">
2282 Copyright ©
2020 WoltLab GmbH
2286 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2291 <div class=
"md-footer-copyright">
2292 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2293 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2300 <div class=
"md-dialog" data-md-component=
"dialog">
2301 <div class=
"md-dialog__inner md-typeset"></div>
2303 <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>
2306 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>