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.5">
17 <title>Package Components - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.77f3fd56.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.7fa14f5b.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=
"">
56 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
57 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
58 <label class=
"md-overlay" for=
"__drawer"></label>
59 <div data-md-component=
"skip">
62 <a href=
"#wcf-21x-package-components" class=
"md-skip">
67 <div data-md-component=
"announce">
69 <aside class=
"md-announce">
70 <div class=
"md-announce__inner md-grid md-typeset">
72 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
81 <header class=
"md-header" data-md-component=
"header">
82 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
83 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation">
85 <img src=
"../../../assets/logo.png" alt=
"logo">
88 <label class=
"md-header__button md-icon" for=
"__drawer">
89 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
91 <div class=
"md-header__title" data-md-component=
"header-title">
92 <div class=
"md-header__ellipsis">
93 <div class=
"md-header__topic">
94 <span class=
"md-ellipsis">
95 WoltLab Suite Documentation
98 <div class=
"md-header__topic" data-md-component=
"header-topic">
99 <span class=
"md-ellipsis">
107 <div class=
"md-header__options">
111 <label class=
"md-header__button md-icon" for=
"__search">
112 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
115 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
116 <label class=
"md-search__overlay" for=
"__search"></label>
117 <div class=
"md-search__inner" role=
"search">
118 <form class=
"md-search__form" name=
"search">
119 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
120 <label class=
"md-search__icon md-icon" for=
"__search">
121 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
122 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
124 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
125 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
128 <div class=
"md-search__output">
129 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
130 <div class=
"md-search-result" data-md-component=
"search-result">
131 <div class=
"md-search-result__meta">
134 <ol class=
"md-search-result__list"></ol>
142 <div class=
"md-header__source">
144 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
145 <div class=
"md-source__icon md-icon">
147 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
149 <div class=
"md-source__repository">
158 <div class=
"md-container" data-md-component=
"container">
163 <main class=
"md-main" data-md-component=
"main">
164 <div class=
"md-main__inner md-grid">
168 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
169 <div class=
"md-sidebar__scrollwrap">
170 <div class=
"md-sidebar__inner">
176 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
177 <label class=
"md-nav__title" for=
"__drawer">
178 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
180 <img src=
"../../../assets/logo.png" alt=
"logo">
183 WoltLab Suite Documentation
186 <div class=
"md-nav__source">
188 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
189 <div class=
"md-source__icon md-icon">
191 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
193 <div class=
"md-source__repository">
199 <ul class=
"md-nav__list" data-md-scrollfix
>
208 <li class=
"md-nav__item">
209 <a href=
"../../../getting-started/" class=
"md-nav__link">
224 <li class=
"md-nav__item md-nav__item--nested">
227 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
229 <label class=
"md-nav__link" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
233 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
234 <label class=
"md-nav__title" for=
"__nav_2">
235 <span class=
"md-nav__icon md-icon"></span>
238 <ul class=
"md-nav__list" data-md-scrollfix
>
244 <li class=
"md-nav__item">
245 <a href=
"../../../php/pages/" class=
"md-nav__link">
256 <li class=
"md-nav__item">
257 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
268 <li class=
"md-nav__item">
269 <a href=
"../../../php/database-access/" class=
"md-nav__link">
280 <li class=
"md-nav__item">
281 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
293 <li class=
"md-nav__item md-nav__item--nested">
296 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
298 <label class=
"md-nav__link" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
302 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
303 <label class=
"md-nav__title" for=
"__nav_2_5">
304 <span class=
"md-nav__icon md-icon"></span>
307 <ul class=
"md-nav__list" data-md-scrollfix
>
313 <li class=
"md-nav__item">
314 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
325 <li class=
"md-nav__item">
326 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
337 <li class=
"md-nav__item">
338 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
349 <li class=
"md-nav__item">
350 <a href=
"../../../php/api/events/" class=
"md-nav__link">
362 <li class=
"md-nav__item md-nav__item--nested">
365 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
367 <label class=
"md-nav__link" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
371 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
372 <label class=
"md-nav__title" for=
"__nav_2_5_5">
373 <span class=
"md-nav__icon md-icon"></span>
376 <ul class=
"md-nav__list" data-md-scrollfix
>
382 <li class=
"md-nav__item">
383 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
394 <li class=
"md-nav__item">
395 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
406 <li class=
"md-nav__item">
407 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
418 <li class=
"md-nav__item">
419 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
430 <li class=
"md-nav__item">
431 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
448 <li class=
"md-nav__item">
449 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
450 Package Installation Plugins
460 <li class=
"md-nav__item">
461 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
472 <li class=
"md-nav__item">
473 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
484 <li class=
"md-nav__item">
485 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
502 <li class=
"md-nav__item">
503 <a href=
"../../../php/code-style/" class=
"md-nav__link">
514 <li class=
"md-nav__item">
515 <a href=
"../../../php/apps/" class=
"md-nav__link">
526 <li class=
"md-nav__item">
527 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
548 <li class=
"md-nav__item md-nav__item--nested">
551 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
553 <label class=
"md-nav__link" for=
"__nav_3">
554 Languages, Templates & CSS
555 <span class=
"md-nav__icon md-icon"></span>
557 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
558 <label class=
"md-nav__title" for=
"__nav_3">
559 <span class=
"md-nav__icon md-icon"></span>
560 Languages, Templates & CSS
562 <ul class=
"md-nav__list" data-md-scrollfix
>
568 <li class=
"md-nav__item">
569 <a href=
"../../../view/languages/" class=
"md-nav__link">
580 <li class=
"md-nav__item">
581 <a href=
"../../../view/templates/" class=
"md-nav__link">
592 <li class=
"md-nav__item">
593 <a href=
"../../../view/css/" class=
"md-nav__link">
614 <li class=
"md-nav__item md-nav__item--nested">
617 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
619 <label class=
"md-nav__link" for=
"__nav_4">
621 <span class=
"md-nav__icon md-icon"></span>
623 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
624 <label class=
"md-nav__title" for=
"__nav_4">
625 <span class=
"md-nav__icon md-icon"></span>
628 <ul class=
"md-nav__list" data-md-scrollfix
>
634 <li class=
"md-nav__item">
635 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
647 <li class=
"md-nav__item md-nav__item--nested">
650 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
652 <label class=
"md-nav__link" for=
"__nav_4_2">
654 <span class=
"md-nav__icon md-icon"></span>
656 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
657 <label class=
"md-nav__title" for=
"__nav_4_2">
658 <span class=
"md-nav__icon md-icon"></span>
661 <ul class=
"md-nav__list" data-md-scrollfix
>
667 <li class=
"md-nav__item">
668 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
679 <li class=
"md-nav__item">
680 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
691 <li class=
"md-nav__item">
692 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
703 <li class=
"md-nav__item">
704 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
715 <li class=
"md-nav__item">
716 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
727 <li class=
"md-nav__item">
728 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
739 <li class=
"md-nav__item">
740 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
751 <li class=
"md-nav__item">
752 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
753 Browser and Screen Sizes
763 <li class=
"md-nav__item">
764 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
781 <li class=
"md-nav__item">
782 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
793 <li class=
"md-nav__item">
794 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
805 <li class=
"md-nav__item">
806 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
827 <li class=
"md-nav__item md-nav__item--nested">
830 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
832 <label class=
"md-nav__link" for=
"__nav_5">
834 <span class=
"md-nav__icon md-icon"></span>
836 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
837 <label class=
"md-nav__title" for=
"__nav_5">
838 <span class=
"md-nav__icon md-icon"></span>
841 <ul class=
"md-nav__list" data-md-scrollfix
>
847 <li class=
"md-nav__item">
848 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
860 <li class=
"md-nav__item md-nav__item--nested">
863 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
865 <label class=
"md-nav__link" for=
"__nav_5_2">
867 <span class=
"md-nav__icon md-icon"></span>
869 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
870 <label class=
"md-nav__title" for=
"__nav_5_2">
871 <span class=
"md-nav__icon md-icon"></span>
874 <ul class=
"md-nav__list" data-md-scrollfix
>
880 <li class=
"md-nav__item">
881 <a href=
"../../../package/pip/" class=
"md-nav__link">
892 <li class=
"md-nav__item">
893 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
904 <li class=
"md-nav__item">
905 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
916 <li class=
"md-nav__item">
917 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
928 <li class=
"md-nav__item">
929 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
940 <li class=
"md-nav__item">
941 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
952 <li class=
"md-nav__item">
953 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
964 <li class=
"md-nav__item">
965 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
976 <li class=
"md-nav__item">
977 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
988 <li class=
"md-nav__item">
989 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1000 <li class=
"md-nav__item">
1001 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1012 <li class=
"md-nav__item">
1013 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1024 <li class=
"md-nav__item">
1025 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1036 <li class=
"md-nav__item">
1037 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1048 <li class=
"md-nav__item">
1049 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1060 <li class=
"md-nav__item">
1061 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1072 <li class=
"md-nav__item">
1073 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1084 <li class=
"md-nav__item">
1085 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1086 objectTypeDefinition
1096 <li class=
"md-nav__item">
1097 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1108 <li class=
"md-nav__item">
1109 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1120 <li class=
"md-nav__item">
1121 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1132 <li class=
"md-nav__item">
1133 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1144 <li class=
"md-nav__item">
1145 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1156 <li class=
"md-nav__item">
1157 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1168 <li class=
"md-nav__item">
1169 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1180 <li class=
"md-nav__item">
1181 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1192 <li class=
"md-nav__item">
1193 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1216 <li class=
"md-nav__item">
1217 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1228 <li class=
"md-nav__item">
1229 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1230 userNotificationEvent
1240 <li class=
"md-nav__item">
1241 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1252 <li class=
"md-nav__item">
1253 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1270 <li class=
"md-nav__item">
1271 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1294 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1297 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" checked
>
1299 <label class=
"md-nav__link" for=
"__nav_6">
1301 <span class=
"md-nav__icon md-icon"></span>
1303 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1304 <label class=
"md-nav__title" for=
"__nav_6">
1305 <span class=
"md-nav__icon md-icon"></span>
1308 <ul class=
"md-nav__list" data-md-scrollfix
>
1315 <li class=
"md-nav__item md-nav__item--nested">
1318 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1320 <label class=
"md-nav__link" for=
"__nav_6_1">
1321 Migrating from WSC
5.3
1322 <span class=
"md-nav__icon md-icon"></span>
1324 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1325 <label class=
"md-nav__title" for=
"__nav_6_1">
1326 <span class=
"md-nav__icon md-icon"></span>
1327 Migrating from WSC
5.3
1329 <ul class=
"md-nav__list" data-md-scrollfix
>
1335 <li class=
"md-nav__item">
1336 <a href=
"../../wsc53/php/" class=
"md-nav__link">
1347 <li class=
"md-nav__item">
1348 <a href=
"../../wsc53/session/" class=
"md-nav__link">
1349 Session Handling and Authentication
1359 <li class=
"md-nav__item">
1360 <a href=
"../../wsc53/javascript/" class=
"md-nav__link">
1371 <li class=
"md-nav__item">
1372 <a href=
"../../wsc53/templates/" class=
"md-nav__link">
1383 <li class=
"md-nav__item">
1384 <a href=
"../../wsc53/libraries/" class=
"md-nav__link">
1385 Third Party Libraries
1402 <li class=
"md-nav__item md-nav__item--nested">
1405 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1407 <label class=
"md-nav__link" for=
"__nav_6_2">
1408 Migrating from WSC
5.2
1409 <span class=
"md-nav__icon md-icon"></span>
1411 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1412 <label class=
"md-nav__title" for=
"__nav_6_2">
1413 <span class=
"md-nav__icon md-icon"></span>
1414 Migrating from WSC
5.2
1416 <ul class=
"md-nav__list" data-md-scrollfix
>
1422 <li class=
"md-nav__item">
1423 <a href=
"../../wsc52/php/" class=
"md-nav__link">
1434 <li class=
"md-nav__item">
1435 <a href=
"../../wsc52/templates/" class=
"md-nav__link">
1436 Templates and Languages
1446 <li class=
"md-nav__item">
1447 <a href=
"../../wsc52/libraries/" class=
"md-nav__link">
1448 Third Party Libraries
1465 <li class=
"md-nav__item md-nav__item--nested">
1468 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1470 <label class=
"md-nav__link" for=
"__nav_6_3">
1471 Migrating from WSC
3.1
1472 <span class=
"md-nav__icon md-icon"></span>
1474 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1475 <label class=
"md-nav__title" for=
"__nav_6_3">
1476 <span class=
"md-nav__icon md-icon"></span>
1477 Migrating from WSC
3.1
1479 <ul class=
"md-nav__list" data-md-scrollfix
>
1485 <li class=
"md-nav__item">
1486 <a href=
"../../wsc31/php/" class=
"md-nav__link">
1504 <li class=
"md-nav__item md-nav__item--nested">
1507 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1509 <label class=
"md-nav__link" for=
"__nav_6_4">
1510 Migrating from WSC
3.0
1511 <span class=
"md-nav__icon md-icon"></span>
1513 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1514 <label class=
"md-nav__title" for=
"__nav_6_4">
1515 <span class=
"md-nav__icon md-icon"></span>
1516 Migrating from WSC
3.0
1518 <ul class=
"md-nav__list" data-md-scrollfix
>
1524 <li class=
"md-nav__item">
1525 <a href=
"../../wsc30/php/" class=
"md-nav__link">
1536 <li class=
"md-nav__item">
1537 <a href=
"../../wsc30/javascript/" class=
"md-nav__link">
1548 <li class=
"md-nav__item">
1549 <a href=
"../../wsc30/templates/" class=
"md-nav__link">
1560 <li class=
"md-nav__item">
1561 <a href=
"../../wsc30/css/" class=
"md-nav__link">
1572 <li class=
"md-nav__item">
1573 <a href=
"../../wsc30/package/" class=
"md-nav__link">
1593 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1596 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" checked
>
1598 <label class=
"md-nav__link" for=
"__nav_6_5">
1599 Migrating from WCF
2.1
1600 <span class=
"md-nav__icon md-icon"></span>
1602 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1603 <label class=
"md-nav__title" for=
"__nav_6_5">
1604 <span class=
"md-nav__icon md-icon"></span>
1605 Migrating from WCF
2.1
1607 <ul class=
"md-nav__list" data-md-scrollfix
>
1613 <li class=
"md-nav__item">
1614 <a href=
"../php/" class=
"md-nav__link">
1625 <li class=
"md-nav__item">
1626 <a href=
"../templates/" class=
"md-nav__link">
1637 <li class=
"md-nav__item">
1638 <a href=
"../css/" class=
"md-nav__link">
1651 <li class=
"md-nav__item md-nav__item--active">
1653 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1658 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1660 <span class=
"md-nav__icon md-icon"></span>
1663 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1668 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1674 <label class=
"md-nav__title" for=
"__toc">
1675 <span class=
"md-nav__icon md-icon"></span>
1678 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1680 <li class=
"md-nav__item">
1681 <a href=
"#packagexml" class=
"md-nav__link">
1685 <nav class=
"md-nav" aria-label=
"package.xml">
1686 <ul class=
"md-nav__list">
1688 <li class=
"md-nav__item">
1689 <a href=
"#short-instructions" class=
"md-nav__link">
1695 <li class=
"md-nav__item">
1696 <a href=
"#example" class=
"md-nav__link">
1702 <li class=
"md-nav__item">
1703 <a href=
"#exceptions" class=
"md-nav__link">
1714 <li class=
"md-nav__item">
1715 <a href=
"#acpmenuxml" class=
"md-nav__link">
1719 <nav class=
"md-nav" aria-label=
"acpMenu.xml">
1720 <ul class=
"md-nav__list">
1722 <li class=
"md-nav__item">
1723 <a href=
"#renamed-categories" class=
"md-nav__link">
1729 <li class=
"md-nav__item">
1730 <a href=
"#submenu-items" class=
"md-nav__link">
1736 <li class=
"md-nav__item">
1737 <a href=
"#example_1" class=
"md-nav__link">
1743 <li class=
"md-nav__item">
1744 <a href=
"#common-icon-names" class=
"md-nav__link">
1755 <li class=
"md-nav__item">
1756 <a href=
"#boxxml" class=
"md-nav__link">
1762 <li class=
"md-nav__item">
1763 <a href=
"#cronjobxml" class=
"md-nav__link">
1769 <li class=
"md-nav__item">
1770 <a href=
"#eventlistenerxml" class=
"md-nav__link">
1776 <li class=
"md-nav__item">
1777 <a href=
"#menuxml" class=
"md-nav__link">
1783 <li class=
"md-nav__item">
1784 <a href=
"#menuitemxml" class=
"md-nav__link">
1790 <li class=
"md-nav__item">
1791 <a href=
"#objecttypexml" class=
"md-nav__link">
1797 <li class=
"md-nav__item">
1798 <a href=
"#optionxml" class=
"md-nav__link">
1804 <li class=
"md-nav__item">
1805 <a href=
"#pagexml" class=
"md-nav__link">
1811 <li class=
"md-nav__item">
1812 <a href=
"#pagemenuxml" class=
"md-nav__link">
1846 <li class=
"md-nav__item md-nav__item--nested">
1849 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1851 <label class=
"md-nav__link" for=
"__nav_7">
1853 <span class=
"md-nav__icon md-icon"></span>
1855 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1856 <label class=
"md-nav__title" for=
"__nav_7">
1857 <span class=
"md-nav__icon md-icon"></span>
1860 <ul class=
"md-nav__list" data-md-scrollfix
>
1867 <li class=
"md-nav__item md-nav__item--nested">
1870 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1872 <label class=
"md-nav__link" for=
"__nav_7_1">
1874 <span class=
"md-nav__icon md-icon"></span>
1876 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1877 <label class=
"md-nav__title" for=
"__nav_7_1">
1878 <span class=
"md-nav__icon md-icon"></span>
1881 <ul class=
"md-nav__list" data-md-scrollfix
>
1887 <li class=
"md-nav__item">
1888 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1899 <li class=
"md-nav__item">
1900 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1911 <li class=
"md-nav__item">
1912 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1923 <li class=
"md-nav__item">
1924 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1951 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1952 <div class=
"md-sidebar__scrollwrap">
1953 <div class=
"md-sidebar__inner">
1955 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1961 <label class=
"md-nav__title" for=
"__toc">
1962 <span class=
"md-nav__icon md-icon"></span>
1965 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1967 <li class=
"md-nav__item">
1968 <a href=
"#packagexml" class=
"md-nav__link">
1972 <nav class=
"md-nav" aria-label=
"package.xml">
1973 <ul class=
"md-nav__list">
1975 <li class=
"md-nav__item">
1976 <a href=
"#short-instructions" class=
"md-nav__link">
1982 <li class=
"md-nav__item">
1983 <a href=
"#example" class=
"md-nav__link">
1989 <li class=
"md-nav__item">
1990 <a href=
"#exceptions" class=
"md-nav__link">
2001 <li class=
"md-nav__item">
2002 <a href=
"#acpmenuxml" class=
"md-nav__link">
2006 <nav class=
"md-nav" aria-label=
"acpMenu.xml">
2007 <ul class=
"md-nav__list">
2009 <li class=
"md-nav__item">
2010 <a href=
"#renamed-categories" class=
"md-nav__link">
2016 <li class=
"md-nav__item">
2017 <a href=
"#submenu-items" class=
"md-nav__link">
2023 <li class=
"md-nav__item">
2024 <a href=
"#example_1" class=
"md-nav__link">
2030 <li class=
"md-nav__item">
2031 <a href=
"#common-icon-names" class=
"md-nav__link">
2042 <li class=
"md-nav__item">
2043 <a href=
"#boxxml" class=
"md-nav__link">
2049 <li class=
"md-nav__item">
2050 <a href=
"#cronjobxml" class=
"md-nav__link">
2056 <li class=
"md-nav__item">
2057 <a href=
"#eventlistenerxml" class=
"md-nav__link">
2063 <li class=
"md-nav__item">
2064 <a href=
"#menuxml" class=
"md-nav__link">
2070 <li class=
"md-nav__item">
2071 <a href=
"#menuitemxml" class=
"md-nav__link">
2077 <li class=
"md-nav__item">
2078 <a href=
"#objecttypexml" class=
"md-nav__link">
2084 <li class=
"md-nav__item">
2085 <a href=
"#optionxml" class=
"md-nav__link">
2091 <li class=
"md-nav__item">
2092 <a href=
"#pagexml" class=
"md-nav__link">
2098 <li class=
"md-nav__item">
2099 <a href=
"#pagemenuxml" class=
"md-nav__link">
2113 <div class=
"md-content" data-md-component=
"content">
2114 <article class=
"md-content__inner md-typeset">
2117 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/migration/wcf21/package.md" title=
"Edit this page" class=
"md-content__button md-icon">
2118 <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>
2122 <h1 id=
"wcf-21x-package-components">WCF
2.1.x - Package Components
<a class=
"headerlink" href=
"#wcf-21x-package-components" title=
"Permanent link">#
</a></h1>
2123 <h2 id=
"packagexml">package.xml
<a class=
"headerlink" href=
"#packagexml" title=
"Permanent link">#
</a></h2>
2124 <h3 id=
"short-instructions">Short Instructions
<a class=
"headerlink" href=
"#short-instructions" title=
"Permanent link">#
</a></h3>
2125 <p>Instructions can now omit the filename, causing them to use the default filename if defined by the package installation plugin (in short:
<code>PIP
</code>). Unless overridden it will default to the PIP's class name with the first letter being lower-cased, e.g.
<code>EventListenerPackageInstallationPlugin
</code> implies the filename
<code>eventListener.xml
</code>. The file is always assumed to be in the archive's root, files located in subdirectories need to be explicitly stated, just as it worked before.
</p>
2126 <p>Every PIP can define a custom filename if the default value cannot be properly derived. For example the
<code>ACPMenu
</code>-pip would default to
<code>aCPMenu.xml
</code>, requiring the class to explicitly override the default filename with
<code>acpMenu.xml
</code> for readability.
</p>
2127 <h3 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h3>
2128 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><instructions
</span> <span class=
"na">type=
</span><span class=
"s">"install
"</span><span class=
"nt">></span>
2129 <span class=
"c"><!-- assumes `eventListener.xml` --
></span>
2130 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"eventListener
"</span> <span class=
"nt">/
></span>
2131 <span class=
"c"><!-- assumes `install.sql` --
></span>
2132 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"sql
"</span> <span class=
"nt">/
></span>
2133 <span class=
"c"><!-- assumes `language/*.xml` --
></span>
2134 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"language
"</span> <span class=
"nt">/
></span>
2136 <span class=
"c"><!-- exceptions --
></span>
2138 <span class=
"c"><!-- assumes `files.tar` --
></span>
2139 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"file
"</span> <span class=
"nt">/
></span>
2140 <span class=
"c"><!-- no default value, requires relative path --
></span>
2141 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"script
"</span><span class=
"nt">></span>acp/install_com.woltlab.wcf_3.0.php
<span class=
"nt"></instruction
></span>
2142 <span class=
"nt"></instructions
></span>
2144 <h3 id=
"exceptions">Exceptions
<a class=
"headerlink" href=
"#exceptions" title=
"Permanent link">#
</a></h3>
2145 <div class=
"admonition info">
2146 <p class=
"admonition-title">These exceptions represent the built-in PIPs only,
3rd party plugins and apps may define their own exceptions.
</p>
2152 <th>Default Value
</th>
2157 <td><code>acpTemplate
</code></td>
2158 <td><code>acptemplates.tar
</code></td>
2161 <td><code>file
</code></td>
2162 <td><code>files.tar
</code></td>
2165 <td><code>language
</code></td>
2166 <td><code>language/*.xml
</code></td>
2169 <td><code>script
</code></td>
2170 <td>(No default value)
</td>
2173 <td><code>sql
</code></td>
2174 <td><code>install.sql
</code></td>
2177 <td><code>template
</code></td>
2178 <td><code>templates.tar
</code></td>
2182 <h2 id=
"acpmenuxml">acpMenu.xml
<a class=
"headerlink" href=
"#acpmenuxml" title=
"Permanent link">#
</a></h2>
2183 <h3 id=
"renamed-categories">Renamed Categories
<a class=
"headerlink" href=
"#renamed-categories" title=
"Permanent link">#
</a></h3>
2184 <p>The following categories have been renamed, menu items need to be adjusted to reflect the new names:
</p>
2194 <td><code>wcf.acp.menu.link.system
</code></td>
2195 <td><code>wcf.acp.menu.link.configuration
</code></td>
2198 <td><code>wcf.acp.menu.link.display
</code></td>
2199 <td><code>wcf.acp.menu.link.customization
</code></td>
2202 <td><code>wcf.acp.menu.link.community
</code></td>
2203 <td><code>wcf.acp.menu.link.application
</code></td>
2207 <h3 id=
"submenu-items">Submenu Items
<a class=
"headerlink" href=
"#submenu-items" title=
"Permanent link">#
</a></h3>
2208 <p>Menu items can now offer additional actions to be accessed from within the menu using an icon-based navigation. This step avoids filling the menu with dozens of
<code>Add …
</code> links, shifting the focus on to actual items. Adding more than one action is not recommended and you should at maximum specify two actions per item.
</p>
2209 <h3 id=
"example_1">Example
<a class=
"headerlink" href=
"#example_1" title=
"Permanent link">#
</a></h3>
2210 <div class=
"highlight"><pre><span></span><code><span class=
"c"><!-- category --
></span>
2211 <span class=
"nt"><acpmenuitem
</span> <span class=
"na">name=
</span><span class=
"s">"wcf.acp.menu.link.group
"</span><span class=
"nt">></span>
2212 <span class=
"nt"><parent
></span>wcf.acp.menu.link.user
<span class=
"nt"></parent
></span>
2213 <span class=
"nt"><showorder
></span>2<span class=
"nt"></showorder
></span>
2214 <span class=
"nt"></acpmenuitem
></span>
2216 <span class=
"c"><!-- menu item --
></span>
2217 <span class=
"nt"><acpmenuitem
</span> <span class=
"na">name=
</span><span class=
"s">"wcf.acp.menu.link.group.list
"</span><span class=
"nt">></span>
2218 <span class=
"nt"><controller
></span>wcf\acp\page\UserGroupListPage
<span class=
"nt"></controller
></span>
2219 <span class=
"nt"><parent
></span>wcf.acp.menu.link.group
<span class=
"nt"></parent
></span>
2220 <span class=
"nt"><permissions
></span>admin.user.canEditGroup,admin.user.canDeleteGroup
<span class=
"nt"></permissions
></span>
2221 <span class=
"nt"></acpmenuitem
></span>
2222 <span class=
"c"><!-- menu item action --
></span>
2223 <span class=
"nt"><acpmenuitem
</span> <span class=
"na">name=
</span><span class=
"s">"wcf.acp.menu.link.group.add
"</span><span class=
"nt">></span>
2224 <span class=
"nt"><controller
></span>wcf\acp\form\UserGroupAddForm
<span class=
"nt"></controller
></span>
2225 <span class=
"c"><!-- actions are defined by menu items of menu items --
></span>
2226 <span class=
"nt"><parent
></span>wcf.acp.menu.link.group.list
<span class=
"nt"></parent
></span>
2227 <span class=
"nt"><permissions
></span>admin.user.canAddGroup
<span class=
"nt"></permissions
></span>
2228 <span class=
"c"><!-- required FontAwesome icon name used for display --
></span>
2229 <span class=
"nt"><icon
></span>fa-plus
<span class=
"nt"></icon
></span>
2230 <span class=
"nt"></acpmenuitem
></span>
2232 <h3 id=
"common-icon-names">Common Icon Names
<a class=
"headerlink" href=
"#common-icon-names" title=
"Permanent link">#
</a></h3>
2233 <p>You should use the same icon names for the (logically) same task, unifying the meaning of items and making the actions predictable.
</p>
2244 <td>Add or create
</td>
2245 <td><code>fa-plus
</code></td>
2246 <td><i class=
"fa fa-plus"></i></td>
2250 <td><code>fa-search
</code></td>
2251 <td><i class=
"fa fa-search"></i></td>
2255 <td><code>fa-upload
</code></td>
2256 <td><i class=
"fa fa-upload"></i></td>
2260 <h2 id=
"boxxml">box.xml
<a class=
"headerlink" href=
"#boxxml" title=
"Permanent link">#
</a></h2>
2261 <p>The
<a href=
"../../../package/pip/box/">box
</a> PIP has been added.
</p>
2262 <h2 id=
"cronjobxml">cronjob.xml
<a class=
"headerlink" href=
"#cronjobxml" title=
"Permanent link">#
</a></h2>
2263 <div class=
"admonition warning">
2264 <p class=
"admonition-title">Legacy cronjobs are assigned a non-deterministic generic name, the only way to assign them a name is removing them and then adding them again.
</p>
2266 <p>Cronjobs can now be assigned a name using the name attribute as in
<code><cronjob
name=
"com.woltlab.wcf.refreshPackageUpdates"></code>, it will be used to identify cronjobs during an update or delete.
</p>
2267 <h2 id=
"eventlistenerxml">eventListener.xml
<a class=
"headerlink" href=
"#eventlistenerxml" title=
"Permanent link">#
</a></h2>
2268 <div class=
"admonition warning">
2269 <p class=
"admonition-title">Legacy event listeners are assigned a non-deterministic generic name, the only way to assign them a name is removing them and then adding them again.
</p>
2271 <p>Event listeners can now be assigned a name using the name attribute as in
<code><eventlistener
name=
"sessionPageAccessLog"></code>, it will be used to identify event listeners during an update or delete.
</p>
2272 <h2 id=
"menuxml">menu.xml
<a class=
"headerlink" href=
"#menuxml" title=
"Permanent link">#
</a></h2>
2273 <p>The
<a href=
"../../../package/pip/menu/">menu
</a> PIP has been added.
</p>
2274 <h2 id=
"menuitemxml">menuItem.xml
<a class=
"headerlink" href=
"#menuitemxml" title=
"Permanent link">#
</a></h2>
2275 <p>The
<a href=
"../../../package/pip/menu-item/">menuItem
</a> PIP has been added.
</p>
2276 <h2 id=
"objecttypexml">objectType.xml
<a class=
"headerlink" href=
"#objecttypexml" title=
"Permanent link">#
</a></h2>
2277 <p>The definition
<code>com.woltlab.wcf.user.dashboardContainer
</code> has been removed, it was previously used to register pages that qualify for dashboard boxes. Since WoltLab Suite
3.0, all pages registered through the
<code>page.xml
</code> are valid containers and therefore there is no need for this definition anymore.
</p>
2278 <p>The definitions
<code>com.woltlab.wcf.page
</code> and
<code>com.woltlab.wcf.user.online.location
</code> have been superseded by the
<code>page.xml
</code>, they're no longer supported.
</p>
2279 <h2 id=
"optionxml">option.xml
<a class=
"headerlink" href=
"#optionxml" title=
"Permanent link">#
</a></h2>
2280 <p>The
<code>module.display
</code> category has been renamed into
<code>module.customization
</code>.
</p>
2281 <h2 id=
"pagexml">page.xml
<a class=
"headerlink" href=
"#pagexml" title=
"Permanent link">#
</a></h2>
2282 <p>The
<a href=
"../../../package/pip/page/">page
</a> PIP has been added.
</p>
2283 <h2 id=
"pagemenuxml">pageMenu.xml
<a class=
"headerlink" href=
"#pagemenuxml" title=
"Permanent link">#
</a></h2>
2284 <p>The
<code>pageMenu.xml
</code> has been superseded by the
<code>page.xml
</code> and is no longer available.
</p>
2298 <footer class=
"md-footer">
2300 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2302 <a href=
"../css/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2303 <div class=
"md-footer__button md-icon">
2304 <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>
2306 <div class=
"md-footer__title">
2307 <div class=
"md-ellipsis">
2308 <span class=
"md-footer__direction">
2317 <a href=
"../../../tutorial/series/overview/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2318 <div class=
"md-footer__title">
2319 <div class=
"md-ellipsis">
2320 <span class=
"md-footer__direction">
2326 <div class=
"md-footer__button md-icon">
2327 <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>
2333 <div class=
"md-footer-meta md-typeset">
2334 <div class=
"md-footer-meta__inner md-grid">
2335 <div class=
"md-footer-copyright">
2337 <div class=
"md-footer-copyright__highlight">
2338 Copyright ©
2020 WoltLab GmbH
2342 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2347 <div class=
"md-footer-copyright">
2348 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2349 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2356 <div class=
"md-dialog" data-md-component=
"dialog">
2357 <div class=
"md-dialog__inner md-typeset"></div>
2359 <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>
2362 <script src=
"../../../assets/javascripts/bundle.5cf3e710.min.js"></script>