3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"shortcut icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.0.3">
17 <title>Templates - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.1655a90d.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.7fa14f5b.min.css">
28 <meta name=
"theme-color" content=
"#009485">
37 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
51 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
56 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
57 <label class=
"md-overlay" for=
"__drawer"></label>
58 <div data-md-component=
"skip">
61 <a href=
"#wcf-21x-templates" class=
"md-skip">
66 <div data-md-component=
"announce">
68 <aside class=
"md-announce">
69 <div class=
"md-announce__inner md-grid md-typeset">
71 <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">
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">
106 <div class=
"md-header__options">
110 <label class=
"md-header__button md-icon" for=
"__search">
111 <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>
114 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
115 <label class=
"md-search__overlay" for=
"__search"></label>
116 <div class=
"md-search__inner" role=
"search">
117 <form class=
"md-search__form" name=
"search">
118 <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
>
119 <label class=
"md-search__icon md-icon" for=
"__search">
120 <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>
121 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
123 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
124 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
127 <div class=
"md-search__output">
128 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
129 <div class=
"md-search-result" data-md-component=
"search-result">
130 <div class=
"md-search-result__meta">
133 <ol class=
"md-search-result__list"></ol>
144 <div class=
"md-container" data-md-component=
"container">
149 <main class=
"md-main" data-md-component=
"main">
150 <div class=
"md-main__inner md-grid">
154 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
155 <div class=
"md-sidebar__scrollwrap">
156 <div class=
"md-sidebar__inner">
162 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
163 <label class=
"md-nav__title" for=
"__drawer">
164 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
166 <img src=
"../../../assets/logo.png" alt=
"logo">
169 WoltLab Suite Documentation
172 <ul class=
"md-nav__list" data-md-scrollfix
>
181 <li class=
"md-nav__item">
182 <a href=
"../../../getting-started/" class=
"md-nav__link">
197 <li class=
"md-nav__item md-nav__item--nested">
200 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
202 <label class=
"md-nav__link" for=
"__nav_2">
204 <span class=
"md-nav__icon md-icon"></span>
206 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
207 <label class=
"md-nav__title" for=
"__nav_2">
208 <span class=
"md-nav__icon md-icon"></span>
211 <ul class=
"md-nav__list" data-md-scrollfix
>
217 <li class=
"md-nav__item">
218 <a href=
"../../../php/pages/" class=
"md-nav__link">
229 <li class=
"md-nav__item">
230 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
241 <li class=
"md-nav__item">
242 <a href=
"../../../php/database-access/" class=
"md-nav__link">
253 <li class=
"md-nav__item">
254 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
266 <li class=
"md-nav__item md-nav__item--nested">
269 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
271 <label class=
"md-nav__link" for=
"__nav_2_5">
273 <span class=
"md-nav__icon md-icon"></span>
275 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
276 <label class=
"md-nav__title" for=
"__nav_2_5">
277 <span class=
"md-nav__icon md-icon"></span>
280 <ul class=
"md-nav__list" data-md-scrollfix
>
286 <li class=
"md-nav__item">
287 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
298 <li class=
"md-nav__item">
299 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
322 <li class=
"md-nav__item">
323 <a href=
"../../../php/api/events/" class=
"md-nav__link">
335 <li class=
"md-nav__item md-nav__item--nested">
338 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
340 <label class=
"md-nav__link" for=
"__nav_2_5_5">
342 <span class=
"md-nav__icon md-icon"></span>
344 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
345 <label class=
"md-nav__title" for=
"__nav_2_5_5">
346 <span class=
"md-nav__icon md-icon"></span>
349 <ul class=
"md-nav__list" data-md-scrollfix
>
355 <li class=
"md-nav__item">
356 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
367 <li class=
"md-nav__item">
368 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
379 <li class=
"md-nav__item">
380 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
391 <li class=
"md-nav__item">
392 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
403 <li class=
"md-nav__item">
404 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
421 <li class=
"md-nav__item">
422 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
423 Package Installation Plugins
433 <li class=
"md-nav__item">
434 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
445 <li class=
"md-nav__item">
446 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
457 <li class=
"md-nav__item">
458 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
475 <li class=
"md-nav__item">
476 <a href=
"../../../php/code-style/" class=
"md-nav__link">
487 <li class=
"md-nav__item">
488 <a href=
"../../../php/apps/" class=
"md-nav__link">
499 <li class=
"md-nav__item">
500 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
521 <li class=
"md-nav__item md-nav__item--nested">
524 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
526 <label class=
"md-nav__link" for=
"__nav_3">
527 Languages, Templates & CSS
528 <span class=
"md-nav__icon md-icon"></span>
530 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
531 <label class=
"md-nav__title" for=
"__nav_3">
532 <span class=
"md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
535 <ul class=
"md-nav__list" data-md-scrollfix
>
541 <li class=
"md-nav__item">
542 <a href=
"../../../view/languages/" class=
"md-nav__link">
553 <li class=
"md-nav__item">
554 <a href=
"../../../view/templates/" class=
"md-nav__link">
565 <li class=
"md-nav__item">
566 <a href=
"../../../view/css/" class=
"md-nav__link">
587 <li class=
"md-nav__item md-nav__item--nested">
590 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
592 <label class=
"md-nav__link" for=
"__nav_4">
594 <span class=
"md-nav__icon md-icon"></span>
596 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
597 <label class=
"md-nav__title" for=
"__nav_4">
598 <span class=
"md-nav__icon md-icon"></span>
601 <ul class=
"md-nav__list" data-md-scrollfix
>
607 <li class=
"md-nav__item">
608 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
620 <li class=
"md-nav__item md-nav__item--nested">
623 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
625 <label class=
"md-nav__link" for=
"__nav_4_2">
627 <span class=
"md-nav__icon md-icon"></span>
629 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
630 <label class=
"md-nav__title" for=
"__nav_4_2">
631 <span class=
"md-nav__icon md-icon"></span>
634 <ul class=
"md-nav__list" data-md-scrollfix
>
640 <li class=
"md-nav__item">
641 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
652 <li class=
"md-nav__item">
653 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
676 <li class=
"md-nav__item">
677 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
688 <li class=
"md-nav__item">
689 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
700 <li class=
"md-nav__item">
701 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
712 <li class=
"md-nav__item">
713 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
724 <li class=
"md-nav__item">
725 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
726 Browser and Screen Sizes
736 <li class=
"md-nav__item">
737 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
754 <li class=
"md-nav__item">
755 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
766 <li class=
"md-nav__item">
767 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
778 <li class=
"md-nav__item">
779 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
800 <li class=
"md-nav__item md-nav__item--nested">
803 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
805 <label class=
"md-nav__link" for=
"__nav_5">
807 <span class=
"md-nav__icon md-icon"></span>
809 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
810 <label class=
"md-nav__title" for=
"__nav_5">
811 <span class=
"md-nav__icon md-icon"></span>
814 <ul class=
"md-nav__list" data-md-scrollfix
>
820 <li class=
"md-nav__item">
821 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
833 <li class=
"md-nav__item md-nav__item--nested">
836 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
838 <label class=
"md-nav__link" for=
"__nav_5_2">
840 <span class=
"md-nav__icon md-icon"></span>
842 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
843 <label class=
"md-nav__title" for=
"__nav_5_2">
844 <span class=
"md-nav__icon md-icon"></span>
847 <ul class=
"md-nav__list" data-md-scrollfix
>
853 <li class=
"md-nav__item">
854 <a href=
"../../../package/pip/" class=
"md-nav__link">
865 <li class=
"md-nav__item">
866 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
877 <li class=
"md-nav__item">
878 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
889 <li class=
"md-nav__item">
890 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
901 <li class=
"md-nav__item">
902 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
913 <li class=
"md-nav__item">
914 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
925 <li class=
"md-nav__item">
926 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
937 <li class=
"md-nav__item">
938 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
949 <li class=
"md-nav__item">
950 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
961 <li class=
"md-nav__item">
962 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
973 <li class=
"md-nav__item">
974 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
985 <li class=
"md-nav__item">
986 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
997 <li class=
"md-nav__item">
998 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1009 <li class=
"md-nav__item">
1010 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1021 <li class=
"md-nav__item">
1022 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1033 <li class=
"md-nav__item">
1034 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1045 <li class=
"md-nav__item">
1046 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1057 <li class=
"md-nav__item">
1058 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1059 objectTypeDefinition
1069 <li class=
"md-nav__item">
1070 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1081 <li class=
"md-nav__item">
1082 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1093 <li class=
"md-nav__item">
1094 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1105 <li class=
"md-nav__item">
1106 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1117 <li class=
"md-nav__item">
1118 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1129 <li class=
"md-nav__item">
1130 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1141 <li class=
"md-nav__item">
1142 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1153 <li class=
"md-nav__item">
1154 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1165 <li class=
"md-nav__item">
1166 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1177 <li class=
"md-nav__item">
1178 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1189 <li class=
"md-nav__item">
1190 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1201 <li class=
"md-nav__item">
1202 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1203 userNotificationEvent
1213 <li class=
"md-nav__item">
1214 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1225 <li class=
"md-nav__item">
1226 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1243 <li class=
"md-nav__item">
1244 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1267 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1270 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" checked
>
1272 <label class=
"md-nav__link" for=
"__nav_6">
1274 <span class=
"md-nav__icon md-icon"></span>
1276 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1277 <label class=
"md-nav__title" for=
"__nav_6">
1278 <span class=
"md-nav__icon md-icon"></span>
1281 <ul class=
"md-nav__list" data-md-scrollfix
>
1288 <li class=
"md-nav__item md-nav__item--nested">
1291 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1293 <label class=
"md-nav__link" for=
"__nav_6_1">
1294 Migrating from WSC
5.3
1295 <span class=
"md-nav__icon md-icon"></span>
1297 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1298 <label class=
"md-nav__title" for=
"__nav_6_1">
1299 <span class=
"md-nav__icon md-icon"></span>
1300 Migrating from WSC
5.3
1302 <ul class=
"md-nav__list" data-md-scrollfix
>
1308 <li class=
"md-nav__item">
1309 <a href=
"../../wsc53/php/" class=
"md-nav__link">
1320 <li class=
"md-nav__item">
1321 <a href=
"../../wsc53/session/" class=
"md-nav__link">
1322 Session Handling and Authentication
1332 <li class=
"md-nav__item">
1333 <a href=
"../../wsc53/javascript/" class=
"md-nav__link">
1344 <li class=
"md-nav__item">
1345 <a href=
"../../wsc53/templates/" class=
"md-nav__link">
1356 <li class=
"md-nav__item">
1357 <a href=
"../../wsc53/libraries/" class=
"md-nav__link">
1358 Third Party Libraries
1375 <li class=
"md-nav__item md-nav__item--nested">
1378 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1380 <label class=
"md-nav__link" for=
"__nav_6_2">
1381 Migrating from WSC
5.2
1382 <span class=
"md-nav__icon md-icon"></span>
1384 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1385 <label class=
"md-nav__title" for=
"__nav_6_2">
1386 <span class=
"md-nav__icon md-icon"></span>
1387 Migrating from WSC
5.2
1389 <ul class=
"md-nav__list" data-md-scrollfix
>
1395 <li class=
"md-nav__item">
1396 <a href=
"../../wsc52/php/" class=
"md-nav__link">
1407 <li class=
"md-nav__item">
1408 <a href=
"../../wsc52/templates/" class=
"md-nav__link">
1409 Templates and Languages
1419 <li class=
"md-nav__item">
1420 <a href=
"../../wsc52/libraries/" class=
"md-nav__link">
1421 Third Party Libraries
1438 <li class=
"md-nav__item md-nav__item--nested">
1441 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1443 <label class=
"md-nav__link" for=
"__nav_6_3">
1444 Migrating from WSC
3.1
1445 <span class=
"md-nav__icon md-icon"></span>
1447 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1448 <label class=
"md-nav__title" for=
"__nav_6_3">
1449 <span class=
"md-nav__icon md-icon"></span>
1450 Migrating from WSC
3.1
1452 <ul class=
"md-nav__list" data-md-scrollfix
>
1458 <li class=
"md-nav__item">
1459 <a href=
"../../wsc31/php/" class=
"md-nav__link">
1477 <li class=
"md-nav__item md-nav__item--nested">
1480 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1482 <label class=
"md-nav__link" for=
"__nav_6_4">
1483 Migrating from WSC
3.0
1484 <span class=
"md-nav__icon md-icon"></span>
1486 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1487 <label class=
"md-nav__title" for=
"__nav_6_4">
1488 <span class=
"md-nav__icon md-icon"></span>
1489 Migrating from WSC
3.0
1491 <ul class=
"md-nav__list" data-md-scrollfix
>
1497 <li class=
"md-nav__item">
1498 <a href=
"../../wsc30/php/" class=
"md-nav__link">
1509 <li class=
"md-nav__item">
1510 <a href=
"../../wsc30/javascript/" class=
"md-nav__link">
1521 <li class=
"md-nav__item">
1522 <a href=
"../../wsc30/templates/" class=
"md-nav__link">
1533 <li class=
"md-nav__item">
1534 <a href=
"../../wsc30/css/" class=
"md-nav__link">
1545 <li class=
"md-nav__item">
1546 <a href=
"../../wsc30/package/" class=
"md-nav__link">
1566 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1569 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" checked
>
1571 <label class=
"md-nav__link" for=
"__nav_6_5">
1572 Migrating from WCF
2.1
1573 <span class=
"md-nav__icon md-icon"></span>
1575 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1576 <label class=
"md-nav__title" for=
"__nav_6_5">
1577 <span class=
"md-nav__icon md-icon"></span>
1578 Migrating from WCF
2.1
1580 <ul class=
"md-nav__list" data-md-scrollfix
>
1586 <li class=
"md-nav__item">
1587 <a href=
"../php/" class=
"md-nav__link">
1600 <li class=
"md-nav__item md-nav__item--active">
1602 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1607 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1609 <span class=
"md-nav__icon md-icon"></span>
1612 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1617 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1623 <label class=
"md-nav__title" for=
"__toc">
1624 <span class=
"md-nav__icon md-icon"></span>
1627 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1629 <li class=
"md-nav__item">
1630 <a href=
"#page-layout" class=
"md-nav__link">
1636 <li class=
"md-nav__item">
1637 <a href=
"#sidebars" class=
"md-nav__link">
1643 <li class=
"md-nav__item">
1644 <a href=
"#forms" class=
"md-nav__link">
1650 <li class=
"md-nav__item">
1651 <a href=
"#icons" class=
"md-nav__link">
1655 <nav class=
"md-nav" aria-label=
"Icons">
1656 <ul class=
"md-nav__list">
1658 <li class=
"md-nav__item">
1659 <a href=
"#changed-icon-names" class=
"md-nav__link">
1670 <li class=
"md-nav__item">
1671 <a href=
"#changed-classes" class=
"md-nav__link">
1677 <li class=
"md-nav__item">
1678 <a href=
"#removed-elements-and-classes" class=
"md-nav__link">
1679 Removed Elements and Classes
1684 <li class=
"md-nav__item">
1685 <a href=
"#simple-example" class=
"md-nav__link">
1691 <li class=
"md-nav__item">
1692 <a href=
"#full-example" class=
"md-nav__link">
1696 <nav class=
"md-nav" aria-label=
"Full Example">
1697 <ul class=
"md-nav__list">
1699 <li class=
"md-nav__item">
1700 <a href=
"#content-header" class=
"md-nav__link">
1704 <nav class=
"md-nav" aria-label=
"Content Header">
1705 <ul class=
"md-nav__list">
1707 <li class=
"md-nav__item">
1708 <a href=
"#recommended-approach" class=
"md-nav__link">
1709 Recommended Approach
1714 <li class=
"md-nav__item">
1715 <a href=
"#alternative" class=
"md-nav__link">
1743 <li class=
"md-nav__item">
1744 <a href=
"../css/" class=
"md-nav__link">
1755 <li class=
"md-nav__item">
1756 <a href=
"../package/" class=
"md-nav__link">
1783 <li class=
"md-nav__item md-nav__item--nested">
1786 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1788 <label class=
"md-nav__link" for=
"__nav_7">
1790 <span class=
"md-nav__icon md-icon"></span>
1792 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1793 <label class=
"md-nav__title" for=
"__nav_7">
1794 <span class=
"md-nav__icon md-icon"></span>
1797 <ul class=
"md-nav__list" data-md-scrollfix
>
1804 <li class=
"md-nav__item md-nav__item--nested">
1807 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1809 <label class=
"md-nav__link" for=
"__nav_7_1">
1811 <span class=
"md-nav__icon md-icon"></span>
1813 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1814 <label class=
"md-nav__title" for=
"__nav_7_1">
1815 <span class=
"md-nav__icon md-icon"></span>
1818 <ul class=
"md-nav__list" data-md-scrollfix
>
1824 <li class=
"md-nav__item">
1825 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1836 <li class=
"md-nav__item">
1837 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1848 <li class=
"md-nav__item">
1849 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1860 <li class=
"md-nav__item">
1861 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1888 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1889 <div class=
"md-sidebar__scrollwrap">
1890 <div class=
"md-sidebar__inner">
1892 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1898 <label class=
"md-nav__title" for=
"__toc">
1899 <span class=
"md-nav__icon md-icon"></span>
1902 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1904 <li class=
"md-nav__item">
1905 <a href=
"#page-layout" class=
"md-nav__link">
1911 <li class=
"md-nav__item">
1912 <a href=
"#sidebars" class=
"md-nav__link">
1918 <li class=
"md-nav__item">
1919 <a href=
"#forms" class=
"md-nav__link">
1925 <li class=
"md-nav__item">
1926 <a href=
"#icons" class=
"md-nav__link">
1930 <nav class=
"md-nav" aria-label=
"Icons">
1931 <ul class=
"md-nav__list">
1933 <li class=
"md-nav__item">
1934 <a href=
"#changed-icon-names" class=
"md-nav__link">
1945 <li class=
"md-nav__item">
1946 <a href=
"#changed-classes" class=
"md-nav__link">
1952 <li class=
"md-nav__item">
1953 <a href=
"#removed-elements-and-classes" class=
"md-nav__link">
1954 Removed Elements and Classes
1959 <li class=
"md-nav__item">
1960 <a href=
"#simple-example" class=
"md-nav__link">
1966 <li class=
"md-nav__item">
1967 <a href=
"#full-example" class=
"md-nav__link">
1971 <nav class=
"md-nav" aria-label=
"Full Example">
1972 <ul class=
"md-nav__list">
1974 <li class=
"md-nav__item">
1975 <a href=
"#content-header" class=
"md-nav__link">
1979 <nav class=
"md-nav" aria-label=
"Content Header">
1980 <ul class=
"md-nav__list">
1982 <li class=
"md-nav__item">
1983 <a href=
"#recommended-approach" class=
"md-nav__link">
1984 Recommended Approach
1989 <li class=
"md-nav__item">
1990 <a href=
"#alternative" class=
"md-nav__link">
2014 <div class=
"md-content" data-md-component=
"content">
2015 <article class=
"md-content__inner md-typeset">
2019 <h1 id=
"wcf-21x-templates">WCF
2.1.x - Templates
<a class=
"headerlink" href=
"#wcf-21x-templates" title=
"Permanent link">#
</a></h1>
2020 <h2 id=
"page-layout">Page Layout
<a class=
"headerlink" href=
"#page-layout" title=
"Permanent link">#
</a></h2>
2021 <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>
2023 <li>Templates must not include a trailing
<code></body
></html
></code> after including the
<code>footer
</code> template.
</li>
2024 <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>
2025 <li>The
<code>sidebarOrientation
</code> variable for the
<code>header
</code> template has been removed and no longer works.
</li>
2026 <li><code>header.boxHeadline
</code> has been unified and now reads
<code>header.contentHeader
</code></li>
2028 <p>Please see the full example at the end of this page for more information.
</p>
2029 <h2 id=
"sidebars">Sidebars
<a class=
"headerlink" href=
"#sidebars" title=
"Permanent link">#
</a></h2>
2030 <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>
2031 <p>Previous markup used in WoltLab Community Framework
2.1 and earlier:
</p>
2032 <div class=
"highlight"><pre><span></span><code><span class=
"p"><</span><span class=
"nt">fieldset
</span><span class=
"p">></span>
2033 <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>
2035 <span class=
"p"><</span><span class=
"nt">div
</span><span class=
"p">></span>
2036 <span class=
"c"><!-- Content --
></span>
2037 <span class=
"p"></
</span><span class=
"nt">div
</span><span class=
"p">></span>
2038 <span class=
"p"></
</span><span class=
"nt">fieldset
</span><span class=
"p">></span>
2041 <p>The new markup since WoltLab Suite
3.0:
</p>
2042 <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>
2043 <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>
2045 <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>
2046 <span class=
"c"><!-- Content --
></span>
2047 <span class=
"p"></
</span><span class=
"nt">div
</span><span class=
"p">></span>
2048 <span class=
"p"></
</span><span class=
"nt">section
</span><span class=
"p">></span>
2051 <h2 id=
"forms">Forms
<a class=
"headerlink" href=
"#forms" title=
"Permanent link">#
</a></h2>
2052 <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>
2053 <p>If you're using the preview feature for WYSIWYG-powered input fields, you need to alter the preview button include instruction:
</p>
2054 <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>
2057 <p><em>The message object id should be non-zero when editing.
</em></p>
2058 <h2 id=
"icons">Icons
<a class=
"headerlink" href=
"#icons" title=
"Permanent link">#
</a></h2>
2059 <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>
2061 <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>
2065 <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>
2068 <h3 id=
"changed-icon-names">Changed Icon Names
<a class=
"headerlink" href=
"#changed-icon-names" title=
"Permanent link">#
</a></h3>
2069 <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>
2070 <h2 id=
"changed-classes">Changed Classes
<a class=
"headerlink" href=
"#changed-classes" title=
"Permanent link">#
</a></h2>
2072 <li><code>.dataList
</code> has been replaced and should now read
<code><ol
class=
"inlineList commaSeparated"></code> (same applies to
<code><ul
></code>)
</li>
2073 <li><code>.framedIconList
</code> has been changed into
<code>.userAvatarList
</code></li>
2075 <h2 id=
"removed-elements-and-classes">Removed Elements and Classes
<a class=
"headerlink" href=
"#removed-elements-and-classes" title=
"Permanent link">#
</a></h2>
2077 <li><code><nav
class=
"jsClipboardEditor"></code> and
<code><div
class=
"jsClipboardContainer"></code> have been replaced with a floating button.
</li>
2078 <li>The anchors
<code>a.toTopLink
</code> have been replaced with a floating button.
</li>
2079 <li>Avatars should no longer receive the class
<code>framed
</code></li>
2080 <li>The
<code>dl.condensed
</code> class, as seen in the editor tab menu, is no longer required.
</li>
2081 <li>Anything related to
<code>sidebarCollapsed
</code> has been removed as sidebars are no longer collapsible.
</li>
2083 <h2 id=
"simple-example">Simple Example
<a class=
"headerlink" href=
"#simple-example" title=
"Permanent link">#
</a></h2>
2084 <p>The code below includes only the absolute minimum required to display a page, the content title is already included in the output.
</p>
2085 <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>
2087 <span class=
"x"><div class=
"section
"></span>
2088 <span class=
"x"> Hello World!
</span>
2089 <span class=
"x"></div
></span>
2091 <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>
2094 <h2 id=
"full-example">Full Example
<a class=
"headerlink" href=
"#full-example" title=
"Permanent link">#
</a></h2>
2095 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"c">*
</span>
2096 <span class=
"c"> The page title is automatically set using the page definition, avoid setting it if you can!
</span>
2097 <span class=
"c"> If you really need to modify the title, you can still reference the original title with:
</span>
2098 <span class=
"c"> {$__wcf-
>getActivePage()-
>getTitle()}
</span>
2099 <span class=
"c">*
</span><span class=
"cp">}
</span><span class=
"x"></span>
2100 <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>
2102 <span class=
"cp">{
</span><span class=
"c">*
</span>
2103 <span class=
"c"> NOTICE: The content header goes here, see the section after this to learn more.
</span>
2104 <span class=
"c">*
</span><span class=
"cp">}
</span><span class=
"x"></span>
2106 <span class=
"cp">{
</span><span class=
"c">* you must not use `headContent` for JavaScript *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2107 <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>
2108 <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>
2109 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2111 <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>
2112 <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>
2113 <span class=
"x"> …
</span>
2115 <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>
2116 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2118 <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>
2119 <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>
2120 <span class=
"x"> …
</span>
2122 <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>
2123 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2125 <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>
2126 <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>
2127 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2129 <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>
2131 <span class=
"cp">{
</span><span class=
"nf">hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2132 <span class=
"x"> <div class=
"paginationTop
"></span>
2133 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">content
</span><span class=
"cp">}
</span><span class=
"x"></span>
2134 <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>
2135 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">/content
</span><span class=
"cp">}
</span><span class=
"x"></span>
2136 <span class=
"x"> </div
></span>
2137 <span class=
"cp">{
</span><span class=
"nf">/hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2139 <span class=
"cp">{
</span><span class=
"c">* the actual content *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2140 <span class=
"x"><div class=
"section
"></span>
2141 <span class=
"x"> …
</span>
2142 <span class=
"x"></div
></span>
2144 <span class=
"x"><footer class=
"contentFooter
"></span>
2145 <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>
2146 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2147 <span class=
"x"> <div class=
"paginationBottom
"></span>
2148 <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>
2149 <span class=
"x"> </div
></span>
2150 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">/hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2152 <span class=
"x"> <nav class=
"contentFooterNavigation
"></span>
2153 <span class=
"x"> <ul
></span>
2154 <span class=
"x"> <li
><a href=
"…
" class=
"button
"><span class=
"icon icon16 fa-plus
"></span
> <span
>Custom Button
</span
></a
></li
></span>
2155 <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>
2156 <span class=
"x"> </ul
></span>
2157 <span class=
"x"> </nav
></span>
2158 <span class=
"x"></footer
></span>
2160 <span class=
"x"><script data-relocate=
"true
"></span>
2161 <span class=
"x"> /* any JavaScript code you need */
</span>
2162 <span class=
"x"></script
></span>
2164 <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>
2165 <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>
2168 <h3 id=
"content-header">Content Header
<a class=
"headerlink" href=
"#content-header" title=
"Permanent link">#
</a></h3>
2169 <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>
2170 <h4 id=
"recommended-approach">Recommended Approach
<a class=
"headerlink" href=
"#recommended-approach" title=
"Permanent link">#
</a></h4>
2171 <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>
2172 <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>
2174 <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>
2176 <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>
2179 <h4 id=
"alternative">Alternative
<a class=
"headerlink" href=
"#alternative" title=
"Permanent link">#
</a></h4>
2180 <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>
2181 <span class=
"x"> <header class=
"contentHeader
"></span>
2182 <span class=
"x"> <div class=
"contentHeaderTitle
"></span>
2183 <span class=
"x"> <h1 class=
"contentTitle
">Custom Content Title
</h1
></span>
2184 <span class=
"x"> <p class=
"contentHeaderDescription
">Custom Content Description
</p
></span>
2185 <span class=
"x"> </div
></span>
2187 <span class=
"x"> <nav class=
"contentHeaderNavigation
"></span>
2188 <span class=
"x"> <ul
></span>
2189 <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>
2190 <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>
2191 <span class=
"x"> </ul
></span>
2192 <span class=
"x"> </nav
></span>
2193 <span class=
"x"> </header
></span>
2194 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2209 <footer class=
"md-footer">
2211 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2213 <a href=
"../php/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2214 <div class=
"md-footer__button md-icon">
2215 <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>
2217 <div class=
"md-footer__title">
2218 <div class=
"md-ellipsis">
2219 <span class=
"md-footer__direction">
2228 <a href=
"../css/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2229 <div class=
"md-footer__title">
2230 <div class=
"md-ellipsis">
2231 <span class=
"md-footer__direction">
2237 <div class=
"md-footer__button md-icon">
2238 <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>
2244 <div class=
"md-footer-meta md-typeset">
2245 <div class=
"md-footer-meta__inner md-grid">
2246 <div class=
"md-footer-copyright">
2248 <div class=
"md-footer-copyright__highlight">
2249 Copyright ©
2020 WoltLab GmbH
2253 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2257 <div class=
"md-footer-copyright">
2258 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2259 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2266 <div class=
"md-dialog" data-md-component=
"dialog">
2267 <div class=
"md-dialog__inner md-typeset"></div>
2269 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../../assets/javascripts/workers/search.fb4a9340.min.js",
"version": {
"provider":
"mike"}}
</script>
2272 <script src=
"../../../assets/javascripts/bundle.ca5457b8.min.js"></script>