3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
11 <link rel=
"canonical" href=
"https://docs.woltlab.com/6.0/package/pip/box/">
14 <link rel=
"prev" href=
"../bbcode/">
17 <link rel=
"next" href=
"../clipboard-action/">
19 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
20 <meta name=
"generator" content=
"mkdocs-1.5.1, mkdocs-material-9.1.21">
24 <title>box - WoltLab Suite Documentation
</title>
28 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.eebd395e.min.css">
31 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ecc896b0.min.css">
41 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
43 <script>__md_scope=new URL(
"../../..",location),__md_hash=e=
>[...e].reduce((e,_)=
>(e<
<5)-e+_.charCodeAt(
0),
0),__md_get=(e,_=localStorage,t=__md_scope)=
>JSON.parse(_.getItem(t.pathname+
"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=
>{try{t.setItem(a.pathname+
"."+e,JSON.stringify(_))}catch(e){}}
</script>
58 <body dir=
"ltr" data-md-color-scheme=
"default" data-md-color-primary=
"teal" data-md-color-accent=
"indigo">
62 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
63 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
64 <label class=
"md-overlay" for=
"__drawer"></label>
65 <div data-md-component=
"skip">
68 <a href=
"#box-package-installation-plugin" class=
"md-skip">
73 <div data-md-component=
"announce">
75 <aside class=
"md-banner">
76 <div class=
"md-banner__inner md-grid md-typeset">
79 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
87 <div data-md-color-scheme=
"default" data-md-component=
"outdated" hidden
>
96 <header class=
"md-header md-header--shadow" data-md-component=
"header">
97 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
98 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
100 <img src=
"../../../assets/logo.png" alt=
"logo">
103 <label class=
"md-header__button md-icon" for=
"__drawer">
104 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
106 <div class=
"md-header__title" data-md-component=
"header-title">
107 <div class=
"md-header__ellipsis">
108 <div class=
"md-header__topic">
109 <span class=
"md-ellipsis">
110 WoltLab Suite Documentation
113 <div class=
"md-header__topic" data-md-component=
"header-topic">
114 <span class=
"md-ellipsis">
127 <label class=
"md-header__button md-icon" for=
"__search">
128 <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>
130 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
131 <label class=
"md-search__overlay" for=
"__search"></label>
132 <div class=
"md-search__inner" role=
"search">
133 <form class=
"md-search__form" name=
"search">
134 <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" required
>
135 <label class=
"md-search__icon md-icon" for=
"__search">
136 <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>
137 <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>
139 <nav class=
"md-search__options" aria-label=
"Search">
141 <button type=
"reset" class=
"md-search__icon md-icon" title=
"Clear" aria-label=
"Clear" tabindex=
"-1">
142 <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>
147 <div class=
"md-search__output">
148 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
149 <div class=
"md-search-result" data-md-component=
"search-result">
150 <div class=
"md-search-result__meta">
153 <ol class=
"md-search-result__list" role=
"presentation"></ol>
161 <div class=
"md-header__source">
162 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
163 <div class=
"md-source__icon md-icon">
165 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
167 <div class=
"md-source__repository">
177 <div class=
"md-container" data-md-component=
"container">
184 <main class=
"md-main" data-md-component=
"main">
185 <div class=
"md-main__inner md-grid">
189 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
190 <div class=
"md-sidebar__scrollwrap">
191 <div class=
"md-sidebar__inner">
195 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
196 <label class=
"md-nav__title" for=
"__drawer">
197 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
199 <img src=
"../../../assets/logo.png" alt=
"logo">
202 WoltLab Suite Documentation
205 <div class=
"md-nav__source">
206 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
207 <div class=
"md-source__icon md-icon">
209 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
211 <div class=
"md-source__repository">
217 <ul class=
"md-nav__list" data-md-scrollfix
>
226 <li class=
"md-nav__item">
227 <a href=
"../../../getting-started/" class=
"md-nav__link">
242 <li class=
"md-nav__item md-nav__item--nested">
247 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2" >
251 <label class=
"md-nav__link" for=
"__nav_2" id=
"__nav_2_label" tabindex=
"0">
253 <span class=
"md-nav__icon md-icon"></span>
256 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_2_label" aria-expanded=
"false">
257 <label class=
"md-nav__title" for=
"__nav_2">
258 <span class=
"md-nav__icon md-icon"></span>
261 <ul class=
"md-nav__list" data-md-scrollfix
>
268 <li class=
"md-nav__item">
269 <a href=
"../../../php/pages/" class=
"md-nav__link">
282 <li class=
"md-nav__item">
283 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
296 <li class=
"md-nav__item">
297 <a href=
"../../../php/database-access/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
325 <li class=
"md-nav__item md-nav__item--nested">
330 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5" >
334 <label class=
"md-nav__link" for=
"__nav_2_5" id=
"__nav_2_5_label" tabindex=
"0">
336 <span class=
"md-nav__icon md-icon"></span>
339 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_2_5_label" aria-expanded=
"false">
340 <label class=
"md-nav__title" for=
"__nav_2_5">
341 <span class=
"md-nav__icon md-icon"></span>
344 <ul class=
"md-nav__list" data-md-scrollfix
>
352 <li class=
"md-nav__item md-nav__item--nested">
357 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5_1" >
361 <label class=
"md-nav__link" for=
"__nav_2_5_1" id=
"__nav_2_5_1_label" tabindex=
"0">
363 <span class=
"md-nav__icon md-icon"></span>
366 <nav class=
"md-nav" data-md-level=
"3" aria-labelledby=
"__nav_2_5_1_label" aria-expanded=
"false">
367 <label class=
"md-nav__title" for=
"__nav_2_5_1">
368 <span class=
"md-nav__icon md-icon"></span>
371 <ul class=
"md-nav__list" data-md-scrollfix
>
378 <li class=
"md-nav__item">
379 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
392 <li class=
"md-nav__item">
393 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
406 <li class=
"md-nav__item">
407 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
427 <li class=
"md-nav__item">
428 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
455 <li class=
"md-nav__item">
456 <a href=
"../../../php/api/events/" class=
"md-nav__link">
470 <li class=
"md-nav__item md-nav__item--nested">
475 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5_5" >
479 <label class=
"md-nav__link" for=
"__nav_2_5_5" id=
"__nav_2_5_5_label" tabindex=
"0">
481 <span class=
"md-nav__icon md-icon"></span>
484 <nav class=
"md-nav" data-md-level=
"3" aria-labelledby=
"__nav_2_5_5_label" aria-expanded=
"false">
485 <label class=
"md-nav__title" for=
"__nav_2_5_5">
486 <span class=
"md-nav__icon md-icon"></span>
489 <ul class=
"md-nav__list" data-md-scrollfix
>
496 <li class=
"md-nav__item">
497 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
510 <li class=
"md-nav__item">
511 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
524 <li class=
"md-nav__item">
525 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
538 <li class=
"md-nav__item">
539 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
552 <li class=
"md-nav__item">
553 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
575 Package Installation Plugins
587 <li class=
"md-nav__item">
588 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
601 <li class=
"md-nav__item">
602 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
615 <li class=
"md-nav__item">
616 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
636 <li class=
"md-nav__item">
637 <a href=
"../../../php/code-style/" class=
"md-nav__link">
650 <li class=
"md-nav__item">
651 <a href=
"../../../php/apps/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
687 <li class=
"md-nav__item md-nav__item--nested">
692 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_3" >
696 <label class=
"md-nav__link" for=
"__nav_3" id=
"__nav_3_label" tabindex=
"0">
697 Languages, Templates & CSS
698 <span class=
"md-nav__icon md-icon"></span>
701 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_3_label" aria-expanded=
"false">
702 <label class=
"md-nav__title" for=
"__nav_3">
703 <span class=
"md-nav__icon md-icon"></span>
704 Languages, Templates & CSS
706 <ul class=
"md-nav__list" data-md-scrollfix
>
713 <li class=
"md-nav__item">
714 <a href=
"../../../view/languages/" class=
"md-nav__link">
727 <li class=
"md-nav__item">
728 <a href=
"../../../view/templates/" class=
"md-nav__link">
741 <li class=
"md-nav__item">
742 <a href=
"../../../view/template-modifiers/" class=
"md-nav__link">
755 <li class=
"md-nav__item">
756 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
769 <li class=
"md-nav__item">
770 <a href=
"../../../view/css/" class=
"md-nav__link">
792 <li class=
"md-nav__item md-nav__item--nested">
797 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4" >
801 <label class=
"md-nav__link" for=
"__nav_4" id=
"__nav_4_label" tabindex=
"0">
802 TypeScript and JavaScript API
803 <span class=
"md-nav__icon md-icon"></span>
806 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_4_label" aria-expanded=
"false">
807 <label class=
"md-nav__title" for=
"__nav_4">
808 <span class=
"md-nav__icon md-icon"></span>
809 TypeScript and JavaScript API
811 <ul class=
"md-nav__list" data-md-scrollfix
>
818 <li class=
"md-nav__item">
819 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
832 <li class=
"md-nav__item">
833 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
847 <li class=
"md-nav__item md-nav__item--nested">
852 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4_3" >
856 <label class=
"md-nav__link" for=
"__nav_4_3" id=
"__nav_4_3_label" tabindex=
"0">
858 <span class=
"md-nav__icon md-icon"></span>
861 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_4_3_label" aria-expanded=
"false">
862 <label class=
"md-nav__title" for=
"__nav_4_3">
863 <span class=
"md-nav__icon md-icon"></span>
866 <ul class=
"md-nav__list" data-md-scrollfix
>
873 <li class=
"md-nav__item">
874 <a href=
"../../../javascript/components_ckeditor5/" class=
"md-nav__link">
887 <li class=
"md-nav__item">
888 <a href=
"../../../javascript/components_confirmation/" class=
"md-nav__link">
901 <li class=
"md-nav__item">
902 <a href=
"../../../javascript/components_dialog/" class=
"md-nav__link">
915 <li class=
"md-nav__item">
916 <a href=
"../../../javascript/components_google_maps/" class=
"md-nav__link">
929 <li class=
"md-nav__item">
930 <a href=
"../../../javascript/components_pagination/" class=
"md-nav__link">
951 <li class=
"md-nav__item md-nav__item--nested">
956 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4_4" >
960 <label class=
"md-nav__link" for=
"__nav_4_4" id=
"__nav_4_4_label" tabindex=
"0">
962 <span class=
"md-nav__icon md-icon"></span>
965 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_4_4_label" aria-expanded=
"false">
966 <label class=
"md-nav__title" for=
"__nav_4_4">
967 <span class=
"md-nav__icon md-icon"></span>
970 <ul class=
"md-nav__list" data-md-scrollfix
>
977 <li class=
"md-nav__item">
978 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
991 <li class=
"md-nav__item">
992 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
1005 <li class=
"md-nav__item">
1006 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
1019 <li class=
"md-nav__item">
1020 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
1033 <li class=
"md-nav__item">
1034 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
1047 <li class=
"md-nav__item">
1048 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
1061 <li class=
"md-nav__item">
1062 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
1063 Browser and Screen Sizes
1075 <li class=
"md-nav__item">
1076 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
1110 <li class=
"md-nav__item">
1111 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
1135 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1140 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5" checked
>
1144 <label class=
"md-nav__link" for=
"__nav_5" id=
"__nav_5_label" tabindex=
"0">
1146 <span class=
"md-nav__icon md-icon"></span>
1149 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_5_label" aria-expanded=
"true">
1150 <label class=
"md-nav__title" for=
"__nav_5">
1151 <span class=
"md-nav__icon md-icon"></span>
1154 <ul class=
"md-nav__list" data-md-scrollfix
>
1161 <li class=
"md-nav__item">
1162 <a href=
"../../package-xml/" class=
"md-nav__link">
1178 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1183 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5_2" checked
>
1187 <label class=
"md-nav__link" for=
"__nav_5_2" id=
"__nav_5_2_label" tabindex=
"0">
1189 <span class=
"md-nav__icon md-icon"></span>
1192 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_5_2_label" aria-expanded=
"true">
1193 <label class=
"md-nav__title" for=
"__nav_5_2">
1194 <span class=
"md-nav__icon md-icon"></span>
1197 <ul class=
"md-nav__list" data-md-scrollfix
>
1204 <li class=
"md-nav__item">
1205 <a href=
"../" class=
"md-nav__link">
1218 <li class=
"md-nav__item">
1219 <a href=
"../acl-option/" class=
"md-nav__link">
1232 <li class=
"md-nav__item">
1233 <a href=
"../acp-menu/" class=
"md-nav__link">
1246 <li class=
"md-nav__item">
1247 <a href=
"../acp-search-provider/" class=
"md-nav__link">
1260 <li class=
"md-nav__item">
1261 <a href=
"../acp-template/" class=
"md-nav__link">
1274 <li class=
"md-nav__item">
1275 <a href=
"../acp-template-delete/" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"../bbcode/" class=
"md-nav__link">
1304 <li class=
"md-nav__item md-nav__item--active">
1306 <input class=
"md-nav__toggle md-toggle" type=
"checkbox" id=
"__toc">
1312 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1314 <span class=
"md-nav__icon md-icon"></span>
1317 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1323 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1330 <label class=
"md-nav__title" for=
"__toc">
1331 <span class=
"md-nav__icon md-icon"></span>
1334 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1336 <li class=
"md-nav__item">
1337 <a href=
"#components" class=
"md-nav__link">
1341 <nav class=
"md-nav" aria-label=
"Components">
1342 <ul class=
"md-nav__list">
1344 <li class=
"md-nav__item">
1345 <a href=
"#name" class=
"md-nav__link">
1351 <li class=
"md-nav__item">
1352 <a href=
"#boxtype" class=
"md-nav__link">
1356 <nav class=
"md-nav" aria-label=
"<boxType>">
1357 <ul class=
"md-nav__list">
1359 <li class=
"md-nav__item">
1360 <a href=
"#system" class=
"md-nav__link">
1366 <li class=
"md-nav__item">
1367 <a href=
"#html-text-or-tpl" class=
"md-nav__link">
1378 <li class=
"md-nav__item">
1379 <a href=
"#objecttype" class=
"md-nav__link">
1385 <li class=
"md-nav__item">
1386 <a href=
"#position" class=
"md-nav__link">
1390 <nav class=
"md-nav" aria-label=
"<position>">
1391 <ul class=
"md-nav__list">
1393 <li class=
"md-nav__item">
1394 <a href=
"#placeholder-positions" class=
"md-nav__link">
1395 Placeholder Positions
1405 <li class=
"md-nav__item">
1406 <a href=
"#showheader" class=
"md-nav__link">
1412 <li class=
"md-nav__item">
1413 <a href=
"#visibleeverywhere" class=
"md-nav__link">
1414 <visibleEverywhere
>
1419 <li class=
"md-nav__item">
1420 <a href=
"#visibilityexceptions" class=
"md-nav__link">
1421 <visibilityExceptions
>
1426 <li class=
"md-nav__item">
1427 <a href=
"#cssclassname" class=
"md-nav__link">
1428 <cssClassName
>
1433 <li class=
"md-nav__item">
1434 <a href=
"#content" class=
"md-nav__link">
1438 <nav class=
"md-nav" aria-label=
"<content>">
1439 <ul class=
"md-nav__list">
1441 <li class=
"md-nav__item">
1442 <a href=
"#title" class=
"md-nav__link">
1448 <li class=
"md-nav__item">
1449 <a href=
"#content_1" class=
"md-nav__link">
1465 <li class=
"md-nav__item">
1466 <a href=
"#example" class=
"md-nav__link">
1486 <li class=
"md-nav__item">
1487 <a href=
"../clipboard-action/" class=
"md-nav__link">
1500 <li class=
"md-nav__item">
1501 <a href=
"../core-object/" class=
"md-nav__link">
1514 <li class=
"md-nav__item">
1515 <a href=
"../cronjob/" class=
"md-nav__link">
1528 <li class=
"md-nav__item">
1529 <a href=
"../database/" class=
"md-nav__link">
1542 <li class=
"md-nav__item">
1543 <a href=
"../event-listener/" class=
"md-nav__link">
1556 <li class=
"md-nav__item">
1557 <a href=
"../file/" class=
"md-nav__link">
1570 <li class=
"md-nav__item">
1571 <a href=
"../file-delete/" class=
"md-nav__link">
1584 <li class=
"md-nav__item">
1585 <a href=
"../language/" class=
"md-nav__link">
1598 <li class=
"md-nav__item">
1599 <a href=
"../media-provider/" class=
"md-nav__link">
1612 <li class=
"md-nav__item">
1613 <a href=
"../menu/" class=
"md-nav__link">
1626 <li class=
"md-nav__item">
1627 <a href=
"../menu-item/" class=
"md-nav__link">
1640 <li class=
"md-nav__item">
1641 <a href=
"../object-type/" class=
"md-nav__link">
1654 <li class=
"md-nav__item">
1655 <a href=
"../object-type-definition/" class=
"md-nav__link">
1656 objectTypeDefinition
1668 <li class=
"md-nav__item">
1669 <a href=
"../option/" class=
"md-nav__link">
1682 <li class=
"md-nav__item">
1683 <a href=
"../page/" class=
"md-nav__link">
1696 <li class=
"md-nav__item">
1697 <a href=
"../pip/" class=
"md-nav__link">
1710 <li class=
"md-nav__item">
1711 <a href=
"../script/" class=
"md-nav__link">
1724 <li class=
"md-nav__item">
1725 <a href=
"../smiley/" class=
"md-nav__link">
1738 <li class=
"md-nav__item">
1739 <a href=
"../sql/" class=
"md-nav__link">
1752 <li class=
"md-nav__item">
1753 <a href=
"../style/" class=
"md-nav__link">
1766 <li class=
"md-nav__item">
1767 <a href=
"../template/" class=
"md-nav__link">
1780 <li class=
"md-nav__item">
1781 <a href=
"../template-delete/" class=
"md-nav__link">
1794 <li class=
"md-nav__item">
1795 <a href=
"../template-listener/" class=
"md-nav__link">
1808 <li class=
"md-nav__item">
1809 <a href=
"../user-group-option/" class=
"md-nav__link">
1822 <li class=
"md-nav__item">
1823 <a href=
"../user-menu/" class=
"md-nav__link">
1836 <li class=
"md-nav__item">
1837 <a href=
"../user-notification-event/" class=
"md-nav__link">
1838 userNotificationEvent
1850 <li class=
"md-nav__item">
1851 <a href=
"../user-option/" class=
"md-nav__link">
1864 <li class=
"md-nav__item">
1865 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1885 <li class=
"md-nav__item">
1886 <a href=
"../../database-php-api/" class=
"md-nav__link">
1908 <li class=
"md-nav__item md-nav__item--nested">
1913 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6" >
1917 <label class=
"md-nav__link" for=
"__nav_6" id=
"__nav_6_label" tabindex=
"0">
1919 <span class=
"md-nav__icon md-icon"></span>
1922 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_6_label" aria-expanded=
"false">
1923 <label class=
"md-nav__title" for=
"__nav_6">
1924 <span class=
"md-nav__icon md-icon"></span>
1927 <ul class=
"md-nav__list" data-md-scrollfix
>
1935 <li class=
"md-nav__item md-nav__item--nested">
1940 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_1" >
1944 <label class=
"md-nav__link" for=
"__nav_6_1" id=
"__nav_6_1_label" tabindex=
"0">
1945 From WoltLab Suite
5.5
1946 <span class=
"md-nav__icon md-icon"></span>
1949 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_1_label" aria-expanded=
"false">
1950 <label class=
"md-nav__title" for=
"__nav_6_1">
1951 <span class=
"md-nav__icon md-icon"></span>
1952 From WoltLab Suite
5.5
1954 <ul class=
"md-nav__list" data-md-scrollfix
>
1961 <li class=
"md-nav__item">
1962 <a href=
"../../../migration/wsc55/php/" class=
"md-nav__link">
1975 <li class=
"md-nav__item">
1976 <a href=
"../../../migration/wsc55/javascript/" class=
"md-nav__link">
1977 TypeScript and JavaScript
1989 <li class=
"md-nav__item">
1990 <a href=
"../../../migration/wsc55/templates/" class=
"md-nav__link">
2003 <li class=
"md-nav__item">
2004 <a href=
"../../../migration/wsc55/icons/" class=
"md-nav__link">
2017 <li class=
"md-nav__item">
2018 <a href=
"../../../migration/wsc55/dialogs/" class=
"md-nav__link">
2031 <li class=
"md-nav__item">
2032 <a href=
"../../../migration/wsc55/libraries/" class=
"md-nav__link">
2033 Third Party Libraries
2045 <li class=
"md-nav__item">
2046 <a href=
"../../../migration/wsc55/deprecations_removals/" class=
"md-nav__link">
2047 Deprecations and Removals
2067 <li class=
"md-nav__item md-nav__item--nested">
2072 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_2" >
2076 <label class=
"md-nav__link" for=
"__nav_6_2" id=
"__nav_6_2_label" tabindex=
"0">
2077 From WoltLab Suite
5.4
2078 <span class=
"md-nav__icon md-icon"></span>
2081 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_2_label" aria-expanded=
"false">
2082 <label class=
"md-nav__title" for=
"__nav_6_2">
2083 <span class=
"md-nav__icon md-icon"></span>
2084 From WoltLab Suite
5.4
2086 <ul class=
"md-nav__list" data-md-scrollfix
>
2093 <li class=
"md-nav__item">
2094 <a href=
"../../../migration/wsc54/php/" class=
"md-nav__link">
2107 <li class=
"md-nav__item">
2108 <a href=
"../../../migration/wsc54/javascript/" class=
"md-nav__link">
2109 TypeScript and JavaScript
2121 <li class=
"md-nav__item">
2122 <a href=
"../../../migration/wsc54/templates/" class=
"md-nav__link">
2135 <li class=
"md-nav__item">
2136 <a href=
"../../../migration/wsc54/libraries/" class=
"md-nav__link">
2137 Third Party Libraries
2149 <li class=
"md-nav__item">
2150 <a href=
"../../../migration/wsc54/deprecations_removals/" class=
"md-nav__link">
2151 Deprecations and Removals
2171 <li class=
"md-nav__item md-nav__item--nested">
2176 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_3" >
2180 <label class=
"md-nav__link" for=
"__nav_6_3" id=
"__nav_6_3_label" tabindex=
"0">
2181 From WoltLab Suite
5.3
2182 <span class=
"md-nav__icon md-icon"></span>
2185 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_3_label" aria-expanded=
"false">
2186 <label class=
"md-nav__title" for=
"__nav_6_3">
2187 <span class=
"md-nav__icon md-icon"></span>
2188 From WoltLab Suite
5.3
2190 <ul class=
"md-nav__list" data-md-scrollfix
>
2197 <li class=
"md-nav__item">
2198 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
2211 <li class=
"md-nav__item">
2212 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
2213 Session Handling and Authentication
2225 <li class=
"md-nav__item">
2226 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
2227 TypeScript and JavaScript
2239 <li class=
"md-nav__item">
2240 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
2253 <li class=
"md-nav__item">
2254 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
2255 Third Party Libraries
2275 <li class=
"md-nav__item md-nav__item--nested">
2280 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_4" >
2284 <label class=
"md-nav__link" for=
"__nav_6_4" id=
"__nav_6_4_label" tabindex=
"0">
2285 From WoltLab Suite
5.2
2286 <span class=
"md-nav__icon md-icon"></span>
2289 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_4_label" aria-expanded=
"false">
2290 <label class=
"md-nav__title" for=
"__nav_6_4">
2291 <span class=
"md-nav__icon md-icon"></span>
2292 From WoltLab Suite
5.2
2294 <ul class=
"md-nav__list" data-md-scrollfix
>
2301 <li class=
"md-nav__item">
2302 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
2315 <li class=
"md-nav__item">
2316 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
2317 Templates and Languages
2329 <li class=
"md-nav__item">
2330 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
2331 Third Party Libraries
2351 <li class=
"md-nav__item md-nav__item--nested">
2356 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_5" >
2360 <label class=
"md-nav__link" for=
"__nav_6_5" id=
"__nav_6_5_label" tabindex=
"0">
2361 From WoltLab Suite
3.1
2362 <span class=
"md-nav__icon md-icon"></span>
2365 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_5_label" aria-expanded=
"false">
2366 <label class=
"md-nav__title" for=
"__nav_6_5">
2367 <span class=
"md-nav__icon md-icon"></span>
2368 From WoltLab Suite
3.1
2370 <ul class=
"md-nav__list" data-md-scrollfix
>
2377 <li class=
"md-nav__item">
2378 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
2399 <li class=
"md-nav__item md-nav__item--nested">
2404 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_6" >
2408 <label class=
"md-nav__link" for=
"__nav_6_6" id=
"__nav_6_6_label" tabindex=
"0">
2409 From WoltLab Suite
3.0
2410 <span class=
"md-nav__icon md-icon"></span>
2413 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_6_label" aria-expanded=
"false">
2414 <label class=
"md-nav__title" for=
"__nav_6_6">
2415 <span class=
"md-nav__icon md-icon"></span>
2416 From WoltLab Suite
3.0
2418 <ul class=
"md-nav__list" data-md-scrollfix
>
2425 <li class=
"md-nav__item">
2426 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
2439 <li class=
"md-nav__item">
2440 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
2453 <li class=
"md-nav__item">
2454 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
2467 <li class=
"md-nav__item">
2468 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
2481 <li class=
"md-nav__item">
2482 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
2503 <li class=
"md-nav__item md-nav__item--nested">
2508 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_7" >
2512 <label class=
"md-nav__link" for=
"__nav_6_7" id=
"__nav_6_7_label" tabindex=
"0">
2514 <span class=
"md-nav__icon md-icon"></span>
2517 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_7_label" aria-expanded=
"false">
2518 <label class=
"md-nav__title" for=
"__nav_6_7">
2519 <span class=
"md-nav__icon md-icon"></span>
2522 <ul class=
"md-nav__list" data-md-scrollfix
>
2529 <li class=
"md-nav__item">
2530 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
2543 <li class=
"md-nav__item">
2544 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
2557 <li class=
"md-nav__item">
2558 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
2571 <li class=
"md-nav__item">
2572 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
2601 <li class=
"md-nav__item md-nav__item--nested">
2606 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7" >
2610 <label class=
"md-nav__link" for=
"__nav_7" id=
"__nav_7_label" tabindex=
"0">
2612 <span class=
"md-nav__icon md-icon"></span>
2615 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_7_label" aria-expanded=
"false">
2616 <label class=
"md-nav__title" for=
"__nav_7">
2617 <span class=
"md-nav__icon md-icon"></span>
2620 <ul class=
"md-nav__list" data-md-scrollfix
>
2628 <li class=
"md-nav__item md-nav__item--nested">
2633 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7_1" >
2637 <label class=
"md-nav__link" for=
"__nav_7_1" id=
"__nav_7_1_label" tabindex=
"0">
2639 <span class=
"md-nav__icon md-icon"></span>
2642 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_7_1_label" aria-expanded=
"false">
2643 <label class=
"md-nav__title" for=
"__nav_7_1">
2644 <span class=
"md-nav__icon md-icon"></span>
2647 <ul class=
"md-nav__list" data-md-scrollfix
>
2654 <li class=
"md-nav__item">
2655 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
2668 <li class=
"md-nav__item">
2669 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
2682 <li class=
"md-nav__item">
2683 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2696 <li class=
"md-nav__item">
2697 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2710 <li class=
"md-nav__item">
2711 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
2724 <li class=
"md-nav__item">
2725 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
2738 <li class=
"md-nav__item">
2739 <a href=
"../../../tutorial/series/part_6/" class=
"md-nav__link">
2768 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2769 <div class=
"md-sidebar__scrollwrap">
2770 <div class=
"md-sidebar__inner">
2773 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2780 <label class=
"md-nav__title" for=
"__toc">
2781 <span class=
"md-nav__icon md-icon"></span>
2784 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2786 <li class=
"md-nav__item">
2787 <a href=
"#components" class=
"md-nav__link">
2791 <nav class=
"md-nav" aria-label=
"Components">
2792 <ul class=
"md-nav__list">
2794 <li class=
"md-nav__item">
2795 <a href=
"#name" class=
"md-nav__link">
2801 <li class=
"md-nav__item">
2802 <a href=
"#boxtype" class=
"md-nav__link">
2806 <nav class=
"md-nav" aria-label=
"<boxType>">
2807 <ul class=
"md-nav__list">
2809 <li class=
"md-nav__item">
2810 <a href=
"#system" class=
"md-nav__link">
2816 <li class=
"md-nav__item">
2817 <a href=
"#html-text-or-tpl" class=
"md-nav__link">
2828 <li class=
"md-nav__item">
2829 <a href=
"#objecttype" class=
"md-nav__link">
2835 <li class=
"md-nav__item">
2836 <a href=
"#position" class=
"md-nav__link">
2840 <nav class=
"md-nav" aria-label=
"<position>">
2841 <ul class=
"md-nav__list">
2843 <li class=
"md-nav__item">
2844 <a href=
"#placeholder-positions" class=
"md-nav__link">
2845 Placeholder Positions
2855 <li class=
"md-nav__item">
2856 <a href=
"#showheader" class=
"md-nav__link">
2862 <li class=
"md-nav__item">
2863 <a href=
"#visibleeverywhere" class=
"md-nav__link">
2864 <visibleEverywhere
>
2869 <li class=
"md-nav__item">
2870 <a href=
"#visibilityexceptions" class=
"md-nav__link">
2871 <visibilityExceptions
>
2876 <li class=
"md-nav__item">
2877 <a href=
"#cssclassname" class=
"md-nav__link">
2878 <cssClassName
>
2883 <li class=
"md-nav__item">
2884 <a href=
"#content" class=
"md-nav__link">
2888 <nav class=
"md-nav" aria-label=
"<content>">
2889 <ul class=
"md-nav__list">
2891 <li class=
"md-nav__item">
2892 <a href=
"#title" class=
"md-nav__link">
2898 <li class=
"md-nav__item">
2899 <a href=
"#content_1" class=
"md-nav__link">
2915 <li class=
"md-nav__item">
2916 <a href=
"#example" class=
"md-nav__link">
2931 <div class=
"md-content" data-md-component=
"content">
2932 <article class=
"md-content__inner md-typeset">
2940 <h1 id=
"box-package-installation-plugin">Box Package Installation Plugin
<a class=
"headerlink" href=
"#box-package-installation-plugin" title=
"Permanent link">#
</a></h1>
2941 <p>Deploy and manage boxes that can be placed anywhere on the site, they come in two flavors: system and content-based.
</p>
2942 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
2943 <p>Each item is described as a
<code><box
></code> element with the mandatory attribute
<code>name
</code> that should follow the naming pattern
<code><packageIdentifier
>.
<BoxName
></code>, e.g.
<code>com.woltlab.wcf.RecentActivity
</code>.
</p>
2944 <h3 id=
"name"><code><name
></code><a class=
"headerlink" href=
"#name" title=
"Permanent link">#
</a></h3>
2945 <div class=
"admonition info">
2946 <p class=
"admonition-title">The
<code>language
</code> attribute is required and should specify the
<a href=
"https://en.wikipedia.org/wiki/ISO_639-1">ISO-
639-
1</a> language code.
</p>
2948 <p>The internal name displayed in the admin panel only, can be fully customized by the administrator and is immutable. Only one value is accepted and will be picked based on the site's default language, but you can provide localized values by including multiple
<code><name
></code> elements.
</p>
2949 <h3 id=
"boxtype"><code><boxType
></code><a class=
"headerlink" href=
"#boxtype" title=
"Permanent link">#
</a></h3>
2950 <h4 id=
"system"><code>system
</code><a class=
"headerlink" href=
"#system" title=
"Permanent link">#
</a></h4>
2951 <p>The special
<code>system
</code> type is reserved for boxes that pull their properties and content from a registered PHP class. Requires the
<code><objectType
></code> element.
</p>
2952 <h4 id=
"html-text-or-tpl"><code>html
</code>,
<code>text
</code> or
<code>tpl
</code><a class=
"headerlink" href=
"#html-text-or-tpl" title=
"Permanent link">#
</a></h4>
2953 <p>Provide arbitrary content, requires the
<code><content
></code> element.
</p>
2954 <h3 id=
"objecttype"><code><objectType
></code><a class=
"headerlink" href=
"#objecttype" title=
"Permanent link">#
</a></h3>
2955 <p>Required for boxes with
<code>boxType = system
</code>, must be registered through
<a href=
"../object-type/">the objectType PIP
</a> for the definition
<code>com.woltlab.wcf.boxController
</code>.
</p>
2956 <h3 id=
"position"><code><position
></code><a class=
"headerlink" href=
"#position" title=
"Permanent link">#
</a></h3>
2957 <p>The default display position of this box, can be any of the following:
</p>
2960 <li>contentBottom
</li>
2963 <li>footerBoxes
</li>
2964 <li>headerBoxes
</li>
2966 <li>sidebarLeft
</li>
2967 <li>sidebarRight
</li>
2970 <h4 id=
"placeholder-positions">Placeholder Positions
<a class=
"headerlink" href=
"#placeholder-positions" title=
"Permanent link">#
</a></h4>
2971 <p><img alt=
"Visual illustration of placeholder positions" src=
"../../../assets/boxPlaceholders.png" /></p>
2972 <h3 id=
"showheader"><code><showHeader
></code><a class=
"headerlink" href=
"#showheader" title=
"Permanent link">#
</a></h3>
2973 <p>Setting this to
<code>0</code> will suppress display of the box title, useful for boxes containing advertisements or similar. Defaults to
<code>1</code>.
</p>
2974 <h3 id=
"visibleeverywhere"><code><visibleEverywhere
></code><a class=
"headerlink" href=
"#visibleeverywhere" title=
"Permanent link">#
</a></h3>
2975 <p>Controls the display on all pages (
<code>1</code>) or none (
<code>0</code>), can be used in conjunction with
<code><visibilityExceptions
></code>.
</p>
2976 <h3 id=
"visibilityexceptions"><code><visibilityExceptions
></code><a class=
"headerlink" href=
"#visibilityexceptions" title=
"Permanent link">#
</a></h3>
2977 <p>Inverts the
<code><visibleEverywhere
></code> setting for the listed pages only.
</p>
2978 <h3 id=
"cssclassname"><code><cssClassName
></code><a class=
"headerlink" href=
"#cssclassname" title=
"Permanent link">#
</a></h3>
2979 <p>Provide a custom CSS class name that is added to the menu container, allowing further customization of the menu's appearance.
</p>
2980 <h3 id=
"content"><code><content
></code><a class=
"headerlink" href=
"#content" title=
"Permanent link">#
</a></h3>
2981 <div class=
"admonition info">
2982 <p class=
"admonition-title">The
<code>language
</code> attribute is required and should specify the
<a href=
"https://en.wikipedia.org/wiki/ISO_639-1">ISO-
639-
1</a> language code.
</p>
2984 <h4 id=
"title"><code><title
></code><a class=
"headerlink" href=
"#title" title=
"Permanent link">#
</a></h4>
2985 <p>The title element is required and controls the box title shown to the end users.
</p>
2986 <h4 id=
"content_1"><code><content
></code><a class=
"headerlink" href=
"#content_1" title=
"Permanent link">#
</a></h4>
2987 <p>The content that should be used to populate the box, only used and required if the
<code>boxType
</code> equals
<code>text
</code>,
<code>html
</code> and
<code>tpl
</code>.
</p>
2988 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
2989 <div class=
"highlight"><table class=
"highlighttable"><tr><th colspan=
"2" class=
"filename"><span class=
"filename">box.xml
<a class=
"codeBoxTitleGitHubLink" href=
"https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/package/pip/box.xml" title=
"View on GitHub"><span class=
"twemoji"><svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal"> 1</span>
2990 <span class=
"normal"> 2</span>
2991 <span class=
"normal"> 3</span>
2992 <span class=
"normal"> 4</span>
2993 <span class=
"normal"> 5</span>
2994 <span class=
"normal"> 6</span>
2995 <span class=
"normal"> 7</span>
2996 <span class=
"normal"> 8</span>
2997 <span class=
"normal"> 9</span>
2998 <span class=
"normal">10</span>
2999 <span class=
"normal">11</span>
3000 <span class=
"normal">12</span>
3001 <span class=
"normal">13</span>
3002 <span class=
"normal">14</span>
3003 <span class=
"normal">15</span>
3004 <span class=
"normal">16</span>
3005 <span class=
"normal">17</span>
3006 <span class=
"normal">18</span>
3007 <span class=
"normal">19</span>
3008 <span class=
"normal">20</span>
3009 <span class=
"normal">21</span>
3010 <span class=
"normal">22</span>
3011 <span class=
"normal">23</span>
3012 <span class=
"normal">24</span>
3013 <span class=
"normal">25</span>
3014 <span class=
"normal">26</span>
3015 <span class=
"normal">27</span>
3016 <span class=
"normal">28</span>
3017 <span class=
"normal">29</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
3018 <span class=
"nt"><data
</span><span class=
"w"> </span><span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span><span class=
"w"> </span><span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span><span class=
"w"> </span><span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/
2019/box.xsd
"</span><span class=
"nt">></span>
3019 <span class=
"w"> </span><span class=
"nt"><import
></span>
3020 <span class=
"w"> </span><span class=
"nt"><box
</span><span class=
"w"> </span><span class=
"na">identifier=
</span><span class=
"s">"com.woltlab.wcf.RecentActivity
"</span><span class=
"nt">></span>
3021 <span class=
"w"> </span><span class=
"nt"><name
</span><span class=
"w"> </span><span class=
"na">language=
</span><span class=
"s">"de
"</span><span class=
"nt">></span>Letzte
<span class=
"w"> </span>Aktivitäten
<span class=
"nt"></name
></span>
3022 <span class=
"w"> </span><span class=
"nt"><name
</span><span class=
"w"> </span><span class=
"na">language=
</span><span class=
"s">"en
"</span><span class=
"nt">></span>Recent
<span class=
"w"> </span>Activities
<span class=
"nt"></name
></span>
3023 <span class=
"w"> </span><span class=
"nt"><boxType
></span>system
<span class=
"nt"></boxType
></span>
3024 <span class=
"w"> </span><span class=
"nt"><objectType
></span>com.woltlab.wcf.recentActivityList
<span class=
"nt"></objectType
></span>
3025 <span class=
"w"> </span><span class=
"nt"><position
></span>contentBottom
<span class=
"nt"></position
></span>
3026 <span class=
"w"> </span><span class=
"nt"><showHeader
></span>0<span class=
"nt"></showHeader
></span>
3027 <span class=
"w"> </span><span class=
"nt"><visibleEverywhere
></span>0<span class=
"nt"></visibleEverywhere
></span>
3028 <span class=
"w"> </span><span class=
"nt"><visibilityExceptions
></span>
3029 <span class=
"w"> </span><span class=
"nt"><page
></span>com.woltlab.wcf.Dashboard
<span class=
"nt"></page
></span>
3030 <span class=
"w"> </span><span class=
"nt"></visibilityExceptions
></span>
3031 <span class=
"w"> </span><span class=
"nt"><limit
></span>10<span class=
"nt"></limit
></span>
3033 <span class=
"w"> </span><span class=
"nt"><content
</span><span class=
"w"> </span><span class=
"na">language=
</span><span class=
"s">"de
"</span><span class=
"nt">></span>
3034 <span class=
"w"> </span><span class=
"nt"><title
></span>Letzte
<span class=
"w"> </span>Aktivitäten
<span class=
"nt"></title
></span>
3035 <span class=
"w"> </span><span class=
"nt"></content
></span>
3036 <span class=
"w"> </span><span class=
"nt"><content
</span><span class=
"w"> </span><span class=
"na">language=
</span><span class=
"s">"en
"</span><span class=
"nt">></span>
3037 <span class=
"w"> </span><span class=
"nt"><title
></span>Recent
<span class=
"w"> </span>Activities
<span class=
"nt"></title
></span>
3038 <span class=
"w"> </span><span class=
"nt"></content
></span>
3039 <span class=
"w"> </span><span class=
"nt"></box
></span>
3040 <span class=
"w"> </span><span class=
"nt"></import
></span>
3042 <span class=
"w"> </span><span class=
"nt"><delete
></span>
3043 <span class=
"w"> </span><span class=
"nt"><box
</span><span class=
"w"> </span><span class=
"na">identifier=
</span><span class=
"s">"com.woltlab.wcf.RecentActivity
"</span><span class=
"w"> </span><span class=
"nt">/
></span>
3044 <span class=
"w"> </span><span class=
"nt"></delete
></span>
3045 <span class=
"nt"></data
></span>
3046 </code></pre></div></td></tr></table></div>
3049 <div class=
"md-source-file">
3071 <footer class=
"md-footer">
3073 <div class=
"md-footer-meta md-typeset">
3074 <div class=
"md-footer-meta__inner md-grid">
3075 <div class=
"md-copyright">
3077 <div class=
"md-copyright__highlight">
3078 Copyright ©
2020 WoltLab GmbH
3083 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
3089 <div class=
"md-copyright">
3090 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
3091 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
3099 <div class=
"md-dialog" data-md-component=
"dialog">
3100 <div class=
"md-dialog__inner md-typeset"></div>
3103 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [
"navigation.tracking"],
"search":
"../../../assets/javascripts/workers/search.74e28a9f.min.js",
"translations": {
"clipboard.copied":
"Copied to clipboard",
"clipboard.copy":
"Copy to clipboard",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.placeholder":
"Type to start searching",
"search.result.term.missing":
"Missing",
"select.version":
"Select version"},
"version": {
"provider":
"mike"}}
</script>
3106 <script src=
"../../../assets/javascripts/bundle.220ee61c.min.js"></script>