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>Package Components - 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-package-components" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
84 <img src=
"../../../assets/logo.png" alt=
"logo">
87 <label class=
"md-header__button md-icon" for=
"__drawer">
88 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 <div class=
"md-header__title" data-md-component=
"header-title">
91 <div class=
"md-header__ellipsis">
92 <div class=
"md-header__topic">
93 <span class=
"md-ellipsis">
94 WoltLab Suite Documentation
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
109 <label class=
"md-header__button md-icon" for=
"__search">
110 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
113 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
114 <label class=
"md-search__overlay" for=
"__search"></label>
115 <div class=
"md-search__inner" role=
"search">
116 <form class=
"md-search__form" name=
"search">
117 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
118 <label class=
"md-search__icon md-icon" for=
"__search">
119 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
120 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
123 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
126 <div class=
"md-search__output">
127 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
128 <div class=
"md-search-result" data-md-component=
"search-result">
129 <div class=
"md-search-result__meta">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
142 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
143 <div class=
"md-source__icon md-icon">
145 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
166 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
167 <div class=
"md-sidebar__scrollwrap">
168 <div class=
"md-sidebar__inner">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
184 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
185 <div class=
"md-source__icon md-icon">
187 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
229 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
230 <label class=
"md-nav__title" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
298 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
299 <label class=
"md-nav__title" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
319 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
320 <label class=
"md-nav__title" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
418 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
419 <label class=
"md-nav__title" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
595 <li class=
"md-nav__item md-nav__item--nested">
598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
600 <label class=
"md-nav__link" for=
"__nav_3">
601 Languages, Templates & CSS
602 <span class=
"md-nav__icon md-icon"></span>
604 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
605 <label class=
"md-nav__title" for=
"__nav_3">
606 <span class=
"md-nav__icon md-icon"></span>
607 Languages, Templates & CSS
609 <ul class=
"md-nav__list" data-md-scrollfix
>
615 <li class=
"md-nav__item">
616 <a href=
"../../../view/languages/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../../view/templates/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"../../../view/css/" class=
"md-nav__link">
673 <li class=
"md-nav__item md-nav__item--nested">
676 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
678 <label class=
"md-nav__link" for=
"__nav_4">
679 TypeScript and JavaScript API
680 <span class=
"md-nav__icon md-icon"></span>
682 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
683 <label class=
"md-nav__title" for=
"__nav_4">
684 <span class=
"md-nav__icon md-icon"></span>
685 TypeScript and JavaScript API
687 <ul class=
"md-nav__list" data-md-scrollfix
>
693 <li class=
"md-nav__item">
694 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
705 <li class=
"md-nav__item">
706 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
718 <li class=
"md-nav__item md-nav__item--nested">
721 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
723 <label class=
"md-nav__link" for=
"__nav_4_3">
725 <span class=
"md-nav__icon md-icon"></span>
727 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
728 <label class=
"md-nav__title" for=
"__nav_4_3">
729 <span class=
"md-nav__icon md-icon"></span>
732 <ul class=
"md-nav__list" data-md-scrollfix
>
738 <li class=
"md-nav__item">
739 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
750 <li class=
"md-nav__item">
751 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
762 <li class=
"md-nav__item">
763 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
774 <li class=
"md-nav__item">
775 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
786 <li class=
"md-nav__item">
787 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
798 <li class=
"md-nav__item">
799 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
810 <li class=
"md-nav__item">
811 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
822 <li class=
"md-nav__item">
823 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
824 Browser and Screen Sizes
834 <li class=
"md-nav__item">
835 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
852 <li class=
"md-nav__item">
853 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
864 <li class=
"md-nav__item">
865 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
876 <li class=
"md-nav__item">
877 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
898 <li class=
"md-nav__item md-nav__item--nested">
901 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
903 <label class=
"md-nav__link" for=
"__nav_5">
905 <span class=
"md-nav__icon md-icon"></span>
907 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
908 <label class=
"md-nav__title" for=
"__nav_5">
909 <span class=
"md-nav__icon md-icon"></span>
912 <ul class=
"md-nav__list" data-md-scrollfix
>
918 <li class=
"md-nav__item">
919 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
931 <li class=
"md-nav__item md-nav__item--nested">
934 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
936 <label class=
"md-nav__link" for=
"__nav_5_2">
938 <span class=
"md-nav__icon md-icon"></span>
940 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
941 <label class=
"md-nav__title" for=
"__nav_5_2">
942 <span class=
"md-nav__icon md-icon"></span>
945 <ul class=
"md-nav__list" data-md-scrollfix
>
951 <li class=
"md-nav__item">
952 <a href=
"../../../package/pip/" class=
"md-nav__link">
963 <li class=
"md-nav__item">
964 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
975 <li class=
"md-nav__item">
976 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
987 <li class=
"md-nav__item">
988 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
999 <li class=
"md-nav__item">
1000 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1011 <li class=
"md-nav__item">
1012 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1023 <li class=
"md-nav__item">
1024 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1035 <li class=
"md-nav__item">
1036 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1047 <li class=
"md-nav__item">
1048 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1059 <li class=
"md-nav__item">
1060 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1071 <li class=
"md-nav__item">
1072 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1083 <li class=
"md-nav__item">
1084 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1095 <li class=
"md-nav__item">
1096 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1107 <li class=
"md-nav__item">
1108 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1119 <li class=
"md-nav__item">
1120 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1131 <li class=
"md-nav__item">
1132 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1143 <li class=
"md-nav__item">
1144 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1155 <li class=
"md-nav__item">
1156 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1167 <li class=
"md-nav__item">
1168 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1169 objectTypeDefinition
1179 <li class=
"md-nav__item">
1180 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1191 <li class=
"md-nav__item">
1192 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1203 <li class=
"md-nav__item">
1204 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1215 <li class=
"md-nav__item">
1216 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1227 <li class=
"md-nav__item">
1228 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1239 <li class=
"md-nav__item">
1240 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1251 <li class=
"md-nav__item">
1252 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1263 <li class=
"md-nav__item">
1264 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1275 <li class=
"md-nav__item">
1276 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1287 <li class=
"md-nav__item">
1288 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1299 <li class=
"md-nav__item">
1300 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1311 <li class=
"md-nav__item">
1312 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1313 userNotificationEvent
1323 <li class=
"md-nav__item">
1324 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1335 <li class=
"md-nav__item">
1336 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1353 <li class=
"md-nav__item">
1354 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1377 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1380 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" checked
>
1382 <label class=
"md-nav__link" for=
"__nav_6">
1384 <span class=
"md-nav__icon md-icon"></span>
1386 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1387 <label class=
"md-nav__title" for=
"__nav_6">
1388 <span class=
"md-nav__icon md-icon"></span>
1391 <ul class=
"md-nav__list" data-md-scrollfix
>
1398 <li class=
"md-nav__item md-nav__item--nested">
1401 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1403 <label class=
"md-nav__link" for=
"__nav_6_1">
1404 Migrating from WSC
5.3
1405 <span class=
"md-nav__icon md-icon"></span>
1407 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1408 <label class=
"md-nav__title" for=
"__nav_6_1">
1409 <span class=
"md-nav__icon md-icon"></span>
1410 Migrating from WSC
5.3
1412 <ul class=
"md-nav__list" data-md-scrollfix
>
1418 <li class=
"md-nav__item">
1419 <a href=
"../../wsc53/php/" class=
"md-nav__link">
1430 <li class=
"md-nav__item">
1431 <a href=
"../../wsc53/session/" class=
"md-nav__link">
1432 Session Handling and Authentication
1442 <li class=
"md-nav__item">
1443 <a href=
"../../wsc53/javascript/" class=
"md-nav__link">
1444 TypeScript and JavaScript
1454 <li class=
"md-nav__item">
1455 <a href=
"../../wsc53/templates/" class=
"md-nav__link">
1466 <li class=
"md-nav__item">
1467 <a href=
"../../wsc53/libraries/" class=
"md-nav__link">
1468 Third Party Libraries
1485 <li class=
"md-nav__item md-nav__item--nested">
1488 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1490 <label class=
"md-nav__link" for=
"__nav_6_2">
1491 Migrating from WSC
5.2
1492 <span class=
"md-nav__icon md-icon"></span>
1494 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1495 <label class=
"md-nav__title" for=
"__nav_6_2">
1496 <span class=
"md-nav__icon md-icon"></span>
1497 Migrating from WSC
5.2
1499 <ul class=
"md-nav__list" data-md-scrollfix
>
1505 <li class=
"md-nav__item">
1506 <a href=
"../../wsc52/php/" class=
"md-nav__link">
1517 <li class=
"md-nav__item">
1518 <a href=
"../../wsc52/templates/" class=
"md-nav__link">
1519 Templates and Languages
1529 <li class=
"md-nav__item">
1530 <a href=
"../../wsc52/libraries/" class=
"md-nav__link">
1531 Third Party Libraries
1548 <li class=
"md-nav__item md-nav__item--nested">
1551 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1553 <label class=
"md-nav__link" for=
"__nav_6_3">
1554 Migrating from WSC
3.1
1555 <span class=
"md-nav__icon md-icon"></span>
1557 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1558 <label class=
"md-nav__title" for=
"__nav_6_3">
1559 <span class=
"md-nav__icon md-icon"></span>
1560 Migrating from WSC
3.1
1562 <ul class=
"md-nav__list" data-md-scrollfix
>
1568 <li class=
"md-nav__item">
1569 <a href=
"../../wsc31/php/" class=
"md-nav__link">
1587 <li class=
"md-nav__item md-nav__item--nested">
1590 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1592 <label class=
"md-nav__link" for=
"__nav_6_4">
1593 Migrating from WSC
3.0
1594 <span class=
"md-nav__icon md-icon"></span>
1596 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1597 <label class=
"md-nav__title" for=
"__nav_6_4">
1598 <span class=
"md-nav__icon md-icon"></span>
1599 Migrating from WSC
3.0
1601 <ul class=
"md-nav__list" data-md-scrollfix
>
1607 <li class=
"md-nav__item">
1608 <a href=
"../../wsc30/php/" class=
"md-nav__link">
1619 <li class=
"md-nav__item">
1620 <a href=
"../../wsc30/javascript/" class=
"md-nav__link">
1631 <li class=
"md-nav__item">
1632 <a href=
"../../wsc30/templates/" class=
"md-nav__link">
1643 <li class=
"md-nav__item">
1644 <a href=
"../../wsc30/css/" class=
"md-nav__link">
1655 <li class=
"md-nav__item">
1656 <a href=
"../../wsc30/package/" class=
"md-nav__link">
1676 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1679 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" checked
>
1681 <label class=
"md-nav__link" for=
"__nav_6_5">
1682 Migrating from WCF
2.1
1683 <span class=
"md-nav__icon md-icon"></span>
1685 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1686 <label class=
"md-nav__title" for=
"__nav_6_5">
1687 <span class=
"md-nav__icon md-icon"></span>
1688 Migrating from WCF
2.1
1690 <ul class=
"md-nav__list" data-md-scrollfix
>
1696 <li class=
"md-nav__item">
1697 <a href=
"../php/" class=
"md-nav__link">
1708 <li class=
"md-nav__item">
1709 <a href=
"../templates/" class=
"md-nav__link">
1720 <li class=
"md-nav__item">
1721 <a href=
"../css/" class=
"md-nav__link">
1734 <li class=
"md-nav__item md-nav__item--active">
1736 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1741 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1743 <span class=
"md-nav__icon md-icon"></span>
1746 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1751 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1757 <label class=
"md-nav__title" for=
"__toc">
1758 <span class=
"md-nav__icon md-icon"></span>
1761 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1763 <li class=
"md-nav__item">
1764 <a href=
"#packagexml" class=
"md-nav__link">
1768 <nav class=
"md-nav" aria-label=
"package.xml">
1769 <ul class=
"md-nav__list">
1771 <li class=
"md-nav__item">
1772 <a href=
"#short-instructions" class=
"md-nav__link">
1778 <li class=
"md-nav__item">
1779 <a href=
"#example" class=
"md-nav__link">
1785 <li class=
"md-nav__item">
1786 <a href=
"#exceptions" class=
"md-nav__link">
1797 <li class=
"md-nav__item">
1798 <a href=
"#acpmenuxml" class=
"md-nav__link">
1802 <nav class=
"md-nav" aria-label=
"acpMenu.xml">
1803 <ul class=
"md-nav__list">
1805 <li class=
"md-nav__item">
1806 <a href=
"#renamed-categories" class=
"md-nav__link">
1812 <li class=
"md-nav__item">
1813 <a href=
"#submenu-items" class=
"md-nav__link">
1819 <li class=
"md-nav__item">
1820 <a href=
"#example_1" class=
"md-nav__link">
1826 <li class=
"md-nav__item">
1827 <a href=
"#common-icon-names" class=
"md-nav__link">
1838 <li class=
"md-nav__item">
1839 <a href=
"#boxxml" class=
"md-nav__link">
1845 <li class=
"md-nav__item">
1846 <a href=
"#cronjobxml" class=
"md-nav__link">
1852 <li class=
"md-nav__item">
1853 <a href=
"#eventlistenerxml" class=
"md-nav__link">
1859 <li class=
"md-nav__item">
1860 <a href=
"#menuxml" class=
"md-nav__link">
1866 <li class=
"md-nav__item">
1867 <a href=
"#menuitemxml" class=
"md-nav__link">
1873 <li class=
"md-nav__item">
1874 <a href=
"#objecttypexml" class=
"md-nav__link">
1880 <li class=
"md-nav__item">
1881 <a href=
"#optionxml" class=
"md-nav__link">
1887 <li class=
"md-nav__item">
1888 <a href=
"#pagexml" class=
"md-nav__link">
1894 <li class=
"md-nav__item">
1895 <a href=
"#pagemenuxml" class=
"md-nav__link">
1929 <li class=
"md-nav__item md-nav__item--nested">
1932 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1934 <label class=
"md-nav__link" for=
"__nav_7">
1936 <span class=
"md-nav__icon md-icon"></span>
1938 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1939 <label class=
"md-nav__title" for=
"__nav_7">
1940 <span class=
"md-nav__icon md-icon"></span>
1943 <ul class=
"md-nav__list" data-md-scrollfix
>
1950 <li class=
"md-nav__item md-nav__item--nested">
1953 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1955 <label class=
"md-nav__link" for=
"__nav_7_1">
1957 <span class=
"md-nav__icon md-icon"></span>
1959 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1960 <label class=
"md-nav__title" for=
"__nav_7_1">
1961 <span class=
"md-nav__icon md-icon"></span>
1964 <ul class=
"md-nav__list" data-md-scrollfix
>
1970 <li class=
"md-nav__item">
1971 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1982 <li class=
"md-nav__item">
1983 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1994 <li class=
"md-nav__item">
1995 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2006 <li class=
"md-nav__item">
2007 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2034 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2035 <div class=
"md-sidebar__scrollwrap">
2036 <div class=
"md-sidebar__inner">
2038 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2044 <label class=
"md-nav__title" for=
"__toc">
2045 <span class=
"md-nav__icon md-icon"></span>
2048 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2050 <li class=
"md-nav__item">
2051 <a href=
"#packagexml" class=
"md-nav__link">
2055 <nav class=
"md-nav" aria-label=
"package.xml">
2056 <ul class=
"md-nav__list">
2058 <li class=
"md-nav__item">
2059 <a href=
"#short-instructions" class=
"md-nav__link">
2065 <li class=
"md-nav__item">
2066 <a href=
"#example" class=
"md-nav__link">
2072 <li class=
"md-nav__item">
2073 <a href=
"#exceptions" class=
"md-nav__link">
2084 <li class=
"md-nav__item">
2085 <a href=
"#acpmenuxml" class=
"md-nav__link">
2089 <nav class=
"md-nav" aria-label=
"acpMenu.xml">
2090 <ul class=
"md-nav__list">
2092 <li class=
"md-nav__item">
2093 <a href=
"#renamed-categories" class=
"md-nav__link">
2099 <li class=
"md-nav__item">
2100 <a href=
"#submenu-items" class=
"md-nav__link">
2106 <li class=
"md-nav__item">
2107 <a href=
"#example_1" class=
"md-nav__link">
2113 <li class=
"md-nav__item">
2114 <a href=
"#common-icon-names" class=
"md-nav__link">
2125 <li class=
"md-nav__item">
2126 <a href=
"#boxxml" class=
"md-nav__link">
2132 <li class=
"md-nav__item">
2133 <a href=
"#cronjobxml" class=
"md-nav__link">
2139 <li class=
"md-nav__item">
2140 <a href=
"#eventlistenerxml" class=
"md-nav__link">
2146 <li class=
"md-nav__item">
2147 <a href=
"#menuxml" class=
"md-nav__link">
2153 <li class=
"md-nav__item">
2154 <a href=
"#menuitemxml" class=
"md-nav__link">
2160 <li class=
"md-nav__item">
2161 <a href=
"#objecttypexml" class=
"md-nav__link">
2167 <li class=
"md-nav__item">
2168 <a href=
"#optionxml" class=
"md-nav__link">
2174 <li class=
"md-nav__item">
2175 <a href=
"#pagexml" class=
"md-nav__link">
2181 <li class=
"md-nav__item">
2182 <a href=
"#pagemenuxml" class=
"md-nav__link">
2196 <div class=
"md-content" data-md-component=
"content">
2197 <article class=
"md-content__inner md-typeset">
2200 <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">
2201 <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>
2205 <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>
2206 <h2 id=
"packagexml">package.xml
<a class=
"headerlink" href=
"#packagexml" title=
"Permanent link">#
</a></h2>
2207 <h3 id=
"short-instructions">Short Instructions
<a class=
"headerlink" href=
"#short-instructions" title=
"Permanent link">#
</a></h3>
2208 <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>
2209 <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>
2210 <h3 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h3>
2211 <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>
2212 <span class=
"c"><!-- assumes `eventListener.xml` --
></span>
2213 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"eventListener
"</span> <span class=
"nt">/
></span>
2214 <span class=
"c"><!-- assumes `install.sql` --
></span>
2215 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"sql
"</span> <span class=
"nt">/
></span>
2216 <span class=
"c"><!-- assumes `language/*.xml` --
></span>
2217 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"language
"</span> <span class=
"nt">/
></span>
2219 <span class=
"c"><!-- exceptions --
></span>
2221 <span class=
"c"><!-- assumes `files.tar` --
></span>
2222 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"file
"</span> <span class=
"nt">/
></span>
2223 <span class=
"c"><!-- no default value, requires relative path --
></span>
2224 <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>
2225 <span class=
"nt"></instructions
></span>
2227 <h3 id=
"exceptions">Exceptions
<a class=
"headerlink" href=
"#exceptions" title=
"Permanent link">#
</a></h3>
2228 <div class=
"admonition info">
2229 <p class=
"admonition-title">These exceptions represent the built-in PIPs only,
3rd party plugins and apps may define their own exceptions.
</p>
2235 <th>Default Value
</th>
2240 <td><code>acpTemplate
</code></td>
2241 <td><code>acptemplates.tar
</code></td>
2244 <td><code>file
</code></td>
2245 <td><code>files.tar
</code></td>
2248 <td><code>language
</code></td>
2249 <td><code>language/*.xml
</code></td>
2252 <td><code>script
</code></td>
2253 <td>(No default value)
</td>
2256 <td><code>sql
</code></td>
2257 <td><code>install.sql
</code></td>
2260 <td><code>template
</code></td>
2261 <td><code>templates.tar
</code></td>
2265 <h2 id=
"acpmenuxml">acpMenu.xml
<a class=
"headerlink" href=
"#acpmenuxml" title=
"Permanent link">#
</a></h2>
2266 <h3 id=
"renamed-categories">Renamed Categories
<a class=
"headerlink" href=
"#renamed-categories" title=
"Permanent link">#
</a></h3>
2267 <p>The following categories have been renamed, menu items need to be adjusted to reflect the new names:
</p>
2277 <td><code>wcf.acp.menu.link.system
</code></td>
2278 <td><code>wcf.acp.menu.link.configuration
</code></td>
2281 <td><code>wcf.acp.menu.link.display
</code></td>
2282 <td><code>wcf.acp.menu.link.customization
</code></td>
2285 <td><code>wcf.acp.menu.link.community
</code></td>
2286 <td><code>wcf.acp.menu.link.application
</code></td>
2290 <h3 id=
"submenu-items">Submenu Items
<a class=
"headerlink" href=
"#submenu-items" title=
"Permanent link">#
</a></h3>
2291 <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>
2292 <h3 id=
"example_1">Example
<a class=
"headerlink" href=
"#example_1" title=
"Permanent link">#
</a></h3>
2293 <div class=
"highlight"><pre><span></span><code><span class=
"c"><!-- category --
></span>
2294 <span class=
"nt"><acpmenuitem
</span> <span class=
"na">name=
</span><span class=
"s">"wcf.acp.menu.link.group
"</span><span class=
"nt">></span>
2295 <span class=
"nt"><parent
></span>wcf.acp.menu.link.user
<span class=
"nt"></parent
></span>
2296 <span class=
"nt"><showorder
></span>2<span class=
"nt"></showorder
></span>
2297 <span class=
"nt"></acpmenuitem
></span>
2299 <span class=
"c"><!-- menu item --
></span>
2300 <span class=
"nt"><acpmenuitem
</span> <span class=
"na">name=
</span><span class=
"s">"wcf.acp.menu.link.group.list
"</span><span class=
"nt">></span>
2301 <span class=
"nt"><controller
></span>wcf\acp\page\UserGroupListPage
<span class=
"nt"></controller
></span>
2302 <span class=
"nt"><parent
></span>wcf.acp.menu.link.group
<span class=
"nt"></parent
></span>
2303 <span class=
"nt"><permissions
></span>admin.user.canEditGroup,admin.user.canDeleteGroup
<span class=
"nt"></permissions
></span>
2304 <span class=
"nt"></acpmenuitem
></span>
2305 <span class=
"c"><!-- menu item action --
></span>
2306 <span class=
"nt"><acpmenuitem
</span> <span class=
"na">name=
</span><span class=
"s">"wcf.acp.menu.link.group.add
"</span><span class=
"nt">></span>
2307 <span class=
"nt"><controller
></span>wcf\acp\form\UserGroupAddForm
<span class=
"nt"></controller
></span>
2308 <span class=
"c"><!-- actions are defined by menu items of menu items --
></span>
2309 <span class=
"nt"><parent
></span>wcf.acp.menu.link.group.list
<span class=
"nt"></parent
></span>
2310 <span class=
"nt"><permissions
></span>admin.user.canAddGroup
<span class=
"nt"></permissions
></span>
2311 <span class=
"c"><!-- required FontAwesome icon name used for display --
></span>
2312 <span class=
"nt"><icon
></span>fa-plus
<span class=
"nt"></icon
></span>
2313 <span class=
"nt"></acpmenuitem
></span>
2315 <h3 id=
"common-icon-names">Common Icon Names
<a class=
"headerlink" href=
"#common-icon-names" title=
"Permanent link">#
</a></h3>
2316 <p>You should use the same icon names for the (logically) same task, unifying the meaning of items and making the actions predictable.
</p>
2327 <td>Add or create
</td>
2328 <td><code>fa-plus
</code></td>
2329 <td><i class=
"fa fa-plus"></i></td>
2333 <td><code>fa-search
</code></td>
2334 <td><i class=
"fa fa-search"></i></td>
2338 <td><code>fa-upload
</code></td>
2339 <td><i class=
"fa fa-upload"></i></td>
2343 <h2 id=
"boxxml">box.xml
<a class=
"headerlink" href=
"#boxxml" title=
"Permanent link">#
</a></h2>
2344 <p>The
<a href=
"../../../package/pip/box/">box
</a> PIP has been added.
</p>
2345 <h2 id=
"cronjobxml">cronjob.xml
<a class=
"headerlink" href=
"#cronjobxml" title=
"Permanent link">#
</a></h2>
2346 <div class=
"admonition warning">
2347 <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>
2349 <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>
2350 <h2 id=
"eventlistenerxml">eventListener.xml
<a class=
"headerlink" href=
"#eventlistenerxml" title=
"Permanent link">#
</a></h2>
2351 <div class=
"admonition warning">
2352 <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>
2354 <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>
2355 <h2 id=
"menuxml">menu.xml
<a class=
"headerlink" href=
"#menuxml" title=
"Permanent link">#
</a></h2>
2356 <p>The
<a href=
"../../../package/pip/menu/">menu
</a> PIP has been added.
</p>
2357 <h2 id=
"menuitemxml">menuItem.xml
<a class=
"headerlink" href=
"#menuitemxml" title=
"Permanent link">#
</a></h2>
2358 <p>The
<a href=
"../../../package/pip/menu-item/">menuItem
</a> PIP has been added.
</p>
2359 <h2 id=
"objecttypexml">objectType.xml
<a class=
"headerlink" href=
"#objecttypexml" title=
"Permanent link">#
</a></h2>
2360 <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>
2361 <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>
2362 <h2 id=
"optionxml">option.xml
<a class=
"headerlink" href=
"#optionxml" title=
"Permanent link">#
</a></h2>
2363 <p>The
<code>module.display
</code> category has been renamed into
<code>module.customization
</code>.
</p>
2364 <h2 id=
"pagexml">page.xml
<a class=
"headerlink" href=
"#pagexml" title=
"Permanent link">#
</a></h2>
2365 <p>The
<a href=
"../../../package/pip/page/">page
</a> PIP has been added.
</p>
2366 <h2 id=
"pagemenuxml">pageMenu.xml
<a class=
"headerlink" href=
"#pagemenuxml" title=
"Permanent link">#
</a></h2>
2367 <p>The
<code>pageMenu.xml
</code> has been superseded by the
<code>page.xml
</code> and is no longer available.
</p>
2373 <div class=
"md-source-date">
2376 Last update:
2021-
01-
08
2395 <footer class=
"md-footer">
2397 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2399 <a href=
"../css/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2400 <div class=
"md-footer__button md-icon">
2401 <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>
2403 <div class=
"md-footer__title">
2404 <div class=
"md-ellipsis">
2405 <span class=
"md-footer__direction">
2414 <a href=
"../../../tutorial/series/overview/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2415 <div class=
"md-footer__title">
2416 <div class=
"md-ellipsis">
2417 <span class=
"md-footer__direction">
2423 <div class=
"md-footer__button md-icon">
2424 <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>
2430 <div class=
"md-footer-meta md-typeset">
2431 <div class=
"md-footer-meta__inner md-grid">
2432 <div class=
"md-footer-copyright">
2434 <div class=
"md-footer-copyright__highlight">
2435 Copyright ©
2020 WoltLab GmbH
2439 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2444 <div class=
"md-footer-copyright">
2445 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2446 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2453 <div class=
"md-dialog" data-md-component=
"dialog">
2454 <div class=
"md-dialog__inner md-typeset"></div>
2456 <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>
2459 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>