Commit | Line | Data |
---|---|---|
45ca63d0 TD |
1 | |
2 | <!doctype html> | |
3 | <html lang="en" class="no-js"> | |
4 | <head> | |
5 | ||
6 | <meta charset="utf-8"> | |
7 | <meta name="viewport" content="width=device-width,initial-scale=1"> | |
8 | ||
9 | ||
10 | ||
11 | ||
fb962f09 WG |
12 | <link rel="icon" href="../../../assets/default.favicon.ico"> |
13 | <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0"> | |
45ca63d0 TD |
14 | |
15 | ||
16 | ||
17 | <title>Sitemaps - WoltLab Suite Documentation</title> | |
18 | ||
19 | ||
20 | ||
fb962f09 | 21 | <link rel="stylesheet" href="../../../assets/stylesheets/main.33e2939f.min.css"> |
45ca63d0 TD |
22 | |
23 | ||
fb962f09 | 24 | <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css"> |
45ca63d0 TD |
25 | |
26 | ||
27 | ||
28 | <meta name="theme-color" content="#009485"> | |
29 | ||
30 | ||
31 | ||
32 | ||
33 | ||
fd8430cb WG |
34 | |
35 | ||
45ca63d0 TD |
36 | |
37 | ||
38 | <link rel="stylesheet" href="../../../stylesheets/extra.css"> | |
39 | ||
40 | ||
41 | ||
42 | ||
43 | ||
44 | </head> | |
45 | ||
46 | ||
47 | ||
48 | ||
49 | ||
50 | ||
51 | ||
52 | <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent=""> | |
45ca63d0 TD |
53 | |
54 | ||
fb962f09 WG |
55 | <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script> |
56 | ||
45ca63d0 TD |
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"> | |
61 | ||
62 | ||
63 | <a href="#sitemaps" class="md-skip"> | |
64 | Skip to content | |
65 | </a> | |
66 | ||
67 | </div> | |
68 | <div data-md-component="announce"> | |
69 | ||
70 | <aside class="md-announce"> | |
71 | <div class="md-announce__inner md-grid md-typeset"> | |
72 | ||
73 | <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a> | |
74 | ||
75 | </div> | |
76 | </aside> | |
77 | ||
78 | </div> | |
79 | ||
fb962f09 | 80 | <header class="md-header" data-md-component="header"> |
45ca63d0 | 81 | <nav class="md-header__inner md-grid" aria-label="Header"> |
fb962f09 | 82 | <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo"> |
45ca63d0 TD |
83 | |
84 | <img src="../../../assets/logo.png" alt="logo"> | |
85 | ||
86 | </a> | |
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> | |
89 | </label> | |
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 | |
95 | </span> | |
96 | </div> | |
97 | <div class="md-header__topic" data-md-component="header-topic"> | |
98 | <span class="md-ellipsis"> | |
99 | ||
100 | Sitemaps | |
101 | ||
102 | </span> | |
103 | </div> | |
104 | </div> | |
45ca63d0 TD |
105 | </div> |
106 | ||
fb962f09 WG |
107 | |
108 | ||
a3639e76 WG |
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> | |
111 | </label> | |
112 | ||
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> | |
121 | </label> | |
122 | <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> | |
fb962f09 | 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> |
a3639e76 WG |
124 | </button> |
125 | </form> | |
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"> | |
130 | Initializing search | |
131 | </div> | |
132 | <ol class="md-search-result__list"></ol> | |
133 | </div> | |
134 | </div> | |
135 | </div> | |
136 | </div> | |
137 | </div> | |
138 | ||
45ca63d0 | 139 | |
7124f4cb WG |
140 | <div class="md-header__source"> |
141 | ||
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"> | |
144 | ||
fb962f09 | 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> |
7124f4cb WG |
146 | </div> |
147 | <div class="md-source__repository"> | |
148 | GitHub | |
149 | </div> | |
150 | </a> | |
151 | </div> | |
152 | ||
45ca63d0 TD |
153 | </nav> |
154 | </header> | |
155 | ||
156 | <div class="md-container" data-md-component="container"> | |
157 | ||
158 | ||
159 | ||
160 | ||
161 | <main class="md-main" data-md-component="main"> | |
162 | <div class="md-main__inner md-grid"> | |
163 | ||
164 | ||
165 | ||
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"> | |
169 | ||
170 | ||
171 | ||
45ca63d0 TD |
172 | <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> |
173 | <label class="md-nav__title" for="__drawer"> | |
fb962f09 | 174 | <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo"> |
45ca63d0 TD |
175 | |
176 | <img src="../../../assets/logo.png" alt="logo"> | |
177 | ||
178 | </a> | |
179 | WoltLab Suite Documentation | |
180 | </label> | |
181 | ||
7124f4cb WG |
182 | <div class="md-nav__source"> |
183 | ||
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"> | |
186 | ||
fb962f09 | 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> |
7124f4cb WG |
188 | </div> |
189 | <div class="md-source__repository"> | |
190 | GitHub | |
191 | </div> | |
192 | </a> | |
193 | </div> | |
194 | ||
45ca63d0 TD |
195 | <ul class="md-nav__list" data-md-scrollfix> |
196 | ||
197 | ||
198 | ||
199 | ||
200 | ||
201 | ||
202 | ||
203 | ||
204 | <li class="md-nav__item"> | |
205 | <a href="../../../getting-started/" class="md-nav__link"> | |
206 | Getting Started | |
207 | </a> | |
208 | </li> | |
209 | ||
210 | ||
211 | ||
212 | ||
213 | ||
214 | ||
215 | ||
216 | ||
217 | ||
218 | ||
219 | ||
220 | ||
221 | ||
222 | <li class="md-nav__item md-nav__item--active md-nav__item--nested"> | |
223 | ||
224 | ||
225 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked> | |
226 | ||
227 | <label class="md-nav__link" for="__nav_2"> | |
228 | PHP API | |
229 | <span class="md-nav__icon md-icon"></span> | |
230 | </label> | |
231 | <nav class="md-nav" aria-label="PHP API" data-md-level="1"> | |
232 | <label class="md-nav__title" for="__nav_2"> | |
233 | <span class="md-nav__icon md-icon"></span> | |
234 | PHP API | |
235 | </label> | |
236 | <ul class="md-nav__list" data-md-scrollfix> | |
237 | ||
238 | ||
239 | ||
240 | ||
241 | ||
242 | <li class="md-nav__item"> | |
243 | <a href="../../pages/" class="md-nav__link"> | |
244 | Pages | |
245 | </a> | |
246 | </li> | |
247 | ||
248 | ||
249 | ||
250 | ||
251 | ||
252 | ||
253 | ||
254 | <li class="md-nav__item"> | |
255 | <a href="../../database-objects/" class="md-nav__link"> | |
256 | Database Objects | |
257 | </a> | |
258 | </li> | |
259 | ||
260 | ||
261 | ||
262 | ||
263 | ||
264 | ||
265 | ||
266 | <li class="md-nav__item"> | |
267 | <a href="../../database-access/" class="md-nav__link"> | |
268 | Database Access | |
269 | </a> | |
270 | </li> | |
271 | ||
272 | ||
273 | ||
274 | ||
275 | ||
276 | ||
277 | ||
278 | <li class="md-nav__item"> | |
279 | <a href="../../exceptions/" class="md-nav__link"> | |
280 | Exceptions | |
281 | </a> | |
282 | </li> | |
283 | ||
284 | ||
285 | ||
286 | ||
287 | ||
288 | ||
289 | ||
290 | ||
291 | ||
292 | ||
293 | <li class="md-nav__item md-nav__item--active md-nav__item--nested"> | |
294 | ||
295 | ||
296 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" checked> | |
297 | ||
298 | <label class="md-nav__link" for="__nav_2_5"> | |
299 | API | |
300 | <span class="md-nav__icon md-icon"></span> | |
301 | </label> | |
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> | |
305 | API | |
306 | </label> | |
307 | <ul class="md-nav__list" data-md-scrollfix> | |
308 | ||
309 | ||
310 | ||
311 | ||
312 | ||
6923e968 WG |
313 | |
314 | <li class="md-nav__item md-nav__item--nested"> | |
315 | ||
316 | ||
317 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" > | |
318 | ||
319 | <label class="md-nav__link" for="__nav_2_5_1"> | |
320 | Caches | |
321 | <span class="md-nav__icon md-icon"></span> | |
322 | </label> | |
323 | <nav class="md-nav" aria-label="Caches" data-md-level="3"> | |
324 | <label class="md-nav__title" for="__nav_2_5_1"> | |
325 | <span class="md-nav__icon md-icon"></span> | |
326 | Caches | |
327 | </label> | |
328 | <ul class="md-nav__list" data-md-scrollfix> | |
329 | ||
330 | ||
331 | ||
332 | ||
333 | ||
45ca63d0 TD |
334 | <li class="md-nav__item"> |
335 | <a href="../caches/" class="md-nav__link"> | |
6923e968 WG |
336 | Overview |
337 | </a> | |
338 | </li> | |
339 | ||
340 | ||
341 | ||
342 | ||
343 | ||
344 | ||
345 | ||
346 | <li class="md-nav__item"> | |
347 | <a href="../caches_persistent-caches/" class="md-nav__link"> | |
348 | Persistent Caches | |
349 | </a> | |
350 | </li> | |
351 | ||
352 | ||
353 | ||
354 | ||
355 | ||
356 | ||
357 | ||
358 | <li class="md-nav__item"> | |
359 | <a href="../caches_runtime-caches/" class="md-nav__link"> | |
360 | Runtime Caches | |
45ca63d0 TD |
361 | </a> |
362 | </li> | |
363 | ||
364 | ||
365 | ||
6923e968 WG |
366 | </ul> |
367 | </nav> | |
368 | </li> | |
369 | ||
370 | ||
371 | ||
45ca63d0 TD |
372 | |
373 | ||
374 | ||
375 | ||
376 | <li class="md-nav__item"> | |
377 | <a href="../comments/" class="md-nav__link"> | |
378 | Comments | |
379 | </a> | |
380 | </li> | |
381 | ||
382 | ||
383 | ||
384 | ||
385 | ||
386 | ||
387 | ||
388 | <li class="md-nav__item"> | |
389 | <a href="../cronjobs/" class="md-nav__link"> | |
390 | Cronjobs | |
391 | </a> | |
392 | </li> | |
393 | ||
394 | ||
395 | ||
396 | ||
397 | ||
398 | ||
399 | ||
400 | <li class="md-nav__item"> | |
401 | <a href="../events/" class="md-nav__link"> | |
402 | Events | |
403 | </a> | |
404 | </li> | |
405 | ||
406 | ||
407 | ||
408 | ||
409 | ||
410 | ||
411 | ||
412 | ||
413 | <li class="md-nav__item md-nav__item--nested"> | |
414 | ||
415 | ||
416 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" > | |
417 | ||
418 | <label class="md-nav__link" for="__nav_2_5_5"> | |
419 | Form Builder | |
420 | <span class="md-nav__icon md-icon"></span> | |
421 | </label> | |
422 | <nav class="md-nav" aria-label="Form Builder" data-md-level="3"> | |
423 | <label class="md-nav__title" for="__nav_2_5_5"> | |
424 | <span class="md-nav__icon md-icon"></span> | |
425 | Form Builder | |
426 | </label> | |
427 | <ul class="md-nav__list" data-md-scrollfix> | |
428 | ||
429 | ||
430 | ||
431 | ||
432 | ||
433 | <li class="md-nav__item"> | |
434 | <a href="../form_builder/overview/" class="md-nav__link"> | |
435 | Overview | |
436 | </a> | |
437 | </li> | |
438 | ||
439 | ||
440 | ||
441 | ||
442 | ||
443 | ||
444 | ||
445 | <li class="md-nav__item"> | |
446 | <a href="../form_builder/structure/" class="md-nav__link"> | |
447 | Structure | |
448 | </a> | |
449 | </li> | |
450 | ||
451 | ||
452 | ||
453 | ||
454 | ||
455 | ||
456 | ||
457 | <li class="md-nav__item"> | |
458 | <a href="../form_builder/form_fields/" class="md-nav__link"> | |
459 | Fields | |
460 | </a> | |
461 | </li> | |
462 | ||
463 | ||
464 | ||
465 | ||
466 | ||
467 | ||
468 | ||
469 | <li class="md-nav__item"> | |
470 | <a href="../form_builder/validation_data/" class="md-nav__link"> | |
471 | Validation and Data | |
472 | </a> | |
473 | </li> | |
474 | ||
475 | ||
476 | ||
477 | ||
478 | ||
479 | ||
480 | ||
481 | <li class="md-nav__item"> | |
482 | <a href="../form_builder/dependencies/" class="md-nav__link"> | |
483 | Dependencies | |
484 | </a> | |
485 | </li> | |
486 | ||
487 | ||
488 | ||
489 | </ul> | |
490 | </nav> | |
491 | </li> | |
492 | ||
493 | ||
494 | ||
495 | ||
496 | ||
497 | ||
498 | ||
499 | <li class="md-nav__item"> | |
500 | <a href="../package_installation_plugins/" class="md-nav__link"> | |
501 | Package Installation Plugins | |
502 | </a> | |
503 | </li> | |
504 | ||
505 | ||
506 | ||
507 | ||
508 | ||
509 | ||
510 | ||
511 | <li class="md-nav__item"> | |
512 | <a href="../user_activity_points/" class="md-nav__link"> | |
513 | User Activity Points | |
514 | </a> | |
515 | </li> | |
516 | ||
517 | ||
518 | ||
519 | ||
520 | ||
521 | ||
522 | ||
523 | <li class="md-nav__item"> | |
524 | <a href="../user_notifications/" class="md-nav__link"> | |
525 | User Notifications | |
526 | </a> | |
527 | </li> | |
528 | ||
529 | ||
530 | ||
531 | ||
532 | ||
533 | ||
534 | ||
535 | ||
536 | ||
537 | <li class="md-nav__item md-nav__item--active"> | |
538 | ||
539 | <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> | |
540 | ||
541 | ||
542 | ||
543 | ||
544 | <a href="./" class="md-nav__link md-nav__link--active"> | |
545 | Sitemaps | |
546 | </a> | |
547 | ||
548 | </li> | |
549 | ||
550 | ||
551 | ||
552 | </ul> | |
553 | </nav> | |
554 | </li> | |
555 | ||
556 | ||
557 | ||
558 | ||
559 | ||
560 | ||
561 | ||
562 | <li class="md-nav__item"> | |
563 | <a href="../../code-style/" class="md-nav__link"> | |
564 | Code Style | |
565 | </a> | |
566 | </li> | |
567 | ||
568 | ||
569 | ||
570 | ||
571 | ||
572 | ||
573 | ||
574 | <li class="md-nav__item"> | |
575 | <a href="../../apps/" class="md-nav__link"> | |
576 | Apps | |
577 | </a> | |
578 | </li> | |
579 | ||
580 | ||
581 | ||
582 | ||
583 | ||
584 | ||
585 | ||
586 | <li class="md-nav__item"> | |
587 | <a href="../../gdpr/" class="md-nav__link"> | |
588 | GDPR | |
589 | </a> | |
590 | </li> | |
591 | ||
592 | ||
593 | ||
594 | </ul> | |
595 | </nav> | |
596 | </li> | |
597 | ||
598 | ||
599 | ||
600 | ||
601 | ||
602 | ||
603 | ||
604 | ||
605 | ||
606 | ||
607 | ||
608 | <li class="md-nav__item md-nav__item--nested"> | |
609 | ||
610 | ||
611 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" > | |
612 | ||
613 | <label class="md-nav__link" for="__nav_3"> | |
614 | Languages, Templates & CSS | |
615 | <span class="md-nav__icon md-icon"></span> | |
616 | </label> | |
617 | <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1"> | |
618 | <label class="md-nav__title" for="__nav_3"> | |
619 | <span class="md-nav__icon md-icon"></span> | |
620 | Languages, Templates & CSS | |
621 | </label> | |
622 | <ul class="md-nav__list" data-md-scrollfix> | |
623 | ||
624 | ||
625 | ||
626 | ||
627 | ||
628 | <li class="md-nav__item"> | |
629 | <a href="../../../view/languages/" class="md-nav__link"> | |
630 | Languages | |
631 | </a> | |
632 | </li> | |
633 | ||
634 | ||
635 | ||
636 | ||
637 | ||
638 | ||
639 | ||
640 | <li class="md-nav__item"> | |
641 | <a href="../../../view/templates/" class="md-nav__link"> | |
642 | Templates | |
643 | </a> | |
644 | </li> | |
645 | ||
646 | ||
647 | ||
648 | ||
649 | ||
650 | ||
651 | ||
6923e968 WG |
652 | <li class="md-nav__item"> |
653 | <a href="../../../view/template-plugins/" class="md-nav__link"> | |
654 | Template Plugins | |
655 | </a> | |
656 | </li> | |
657 | ||
658 | ||
659 | ||
660 | ||
661 | ||
662 | ||
663 | ||
45ca63d0 TD |
664 | <li class="md-nav__item"> |
665 | <a href="../../../view/css/" class="md-nav__link"> | |
666 | CSS | |
667 | </a> | |
668 | </li> | |
669 | ||
670 | ||
671 | ||
672 | </ul> | |
673 | </nav> | |
674 | </li> | |
675 | ||
676 | ||
677 | ||
678 | ||
679 | ||
680 | ||
681 | ||
682 | ||
683 | ||
684 | ||
685 | ||
686 | <li class="md-nav__item md-nav__item--nested"> | |
687 | ||
688 | ||
689 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > | |
690 | ||
691 | <label class="md-nav__link" for="__nav_4"> | |
77efcd46 | 692 | TypeScript and JavaScript API |
45ca63d0 TD |
693 | <span class="md-nav__icon md-icon"></span> |
694 | </label> | |
77efcd46 | 695 | <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1"> |
45ca63d0 TD |
696 | <label class="md-nav__title" for="__nav_4"> |
697 | <span class="md-nav__icon md-icon"></span> | |
77efcd46 | 698 | TypeScript and JavaScript API |
45ca63d0 TD |
699 | </label> |
700 | <ul class="md-nav__list" data-md-scrollfix> | |
701 | ||
702 | ||
703 | ||
704 | ||
705 | ||
706 | <li class="md-nav__item"> | |
707 | <a href="../../../javascript/general-usage/" class="md-nav__link"> | |
708 | General Usage | |
709 | </a> | |
710 | </li> | |
711 | ||
712 | ||
713 | ||
714 | ||
715 | ||
716 | ||
717 | ||
77efcd46 WG |
718 | <li class="md-nav__item"> |
719 | <a href="../../../javascript/typescript/" class="md-nav__link"> | |
720 | TypeScript | |
721 | </a> | |
722 | </li> | |
723 | ||
724 | ||
725 | ||
726 | ||
727 | ||
728 | ||
729 | ||
45ca63d0 TD |
730 | |
731 | <li class="md-nav__item md-nav__item--nested"> | |
732 | ||
733 | ||
77efcd46 | 734 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" > |
45ca63d0 | 735 | |
77efcd46 | 736 | <label class="md-nav__link" for="__nav_4_3"> |
45ca63d0 TD |
737 | New API |
738 | <span class="md-nav__icon md-icon"></span> | |
739 | </label> | |
740 | <nav class="md-nav" aria-label="New API" data-md-level="2"> | |
77efcd46 | 741 | <label class="md-nav__title" for="__nav_4_3"> |
45ca63d0 TD |
742 | <span class="md-nav__icon md-icon"></span> |
743 | New API | |
744 | </label> | |
745 | <ul class="md-nav__list" data-md-scrollfix> | |
746 | ||
747 | ||
748 | ||
749 | ||
750 | ||
751 | <li class="md-nav__item"> | |
752 | <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link"> | |
753 | Writing a module | |
754 | </a> | |
755 | </li> | |
756 | ||
757 | ||
758 | ||
759 | ||
760 | ||
761 | ||
762 | ||
763 | <li class="md-nav__item"> | |
764 | <a href="../../../javascript/new-api_data-structures/" class="md-nav__link"> | |
765 | Data Structures | |
766 | </a> | |
767 | </li> | |
768 | ||
769 | ||
770 | ||
771 | ||
772 | ||
773 | ||
774 | ||
775 | <li class="md-nav__item"> | |
776 | <a href="../../../javascript/new-api_core/" class="md-nav__link"> | |
777 | Core Functions | |
778 | </a> | |
779 | </li> | |
780 | ||
781 | ||
782 | ||
783 | ||
784 | ||
785 | ||
786 | ||
787 | <li class="md-nav__item"> | |
788 | <a href="../../../javascript/new-api_dom/" class="md-nav__link"> | |
789 | DOM | |
790 | </a> | |
791 | </li> | |
792 | ||
793 | ||
794 | ||
795 | ||
796 | ||
797 | ||
798 | ||
799 | <li class="md-nav__item"> | |
800 | <a href="../../../javascript/new-api_events/" class="md-nav__link"> | |
801 | Event Handling | |
802 | </a> | |
803 | </li> | |
804 | ||
805 | ||
806 | ||
807 | ||
808 | ||
809 | ||
810 | ||
811 | <li class="md-nav__item"> | |
812 | <a href="../../../javascript/new-api_ajax/" class="md-nav__link"> | |
813 | Ajax | |
814 | </a> | |
815 | </li> | |
816 | ||
817 | ||
818 | ||
819 | ||
820 | ||
821 | ||
822 | ||
823 | <li class="md-nav__item"> | |
824 | <a href="../../../javascript/new-api_dialogs/" class="md-nav__link"> | |
825 | Dialogs | |
826 | </a> | |
827 | </li> | |
828 | ||
829 | ||
830 | ||
831 | ||
832 | ||
833 | ||
834 | ||
835 | <li class="md-nav__item"> | |
836 | <a href="../../../javascript/new-api_browser/" class="md-nav__link"> | |
837 | Browser and Screen Sizes | |
838 | </a> | |
839 | </li> | |
840 | ||
841 | ||
842 | ||
843 | ||
844 | ||
845 | ||
846 | ||
847 | <li class="md-nav__item"> | |
848 | <a href="../../../javascript/new-api_ui/" class="md-nav__link"> | |
849 | User Interface | |
850 | </a> | |
851 | </li> | |
852 | ||
853 | ||
854 | ||
855 | </ul> | |
856 | </nav> | |
857 | </li> | |
858 | ||
859 | ||
860 | ||
861 | ||
862 | ||
863 | ||
864 | ||
865 | <li class="md-nav__item"> | |
866 | <a href="../../../javascript/legacy-api/" class="md-nav__link"> | |
867 | Legacy API | |
868 | </a> | |
869 | </li> | |
870 | ||
871 | ||
872 | ||
873 | ||
874 | ||
875 | ||
876 | ||
877 | <li class="md-nav__item"> | |
878 | <a href="../../../javascript/helper-functions/" class="md-nav__link"> | |
879 | Helper Functions | |
880 | </a> | |
881 | </li> | |
882 | ||
883 | ||
884 | ||
885 | ||
886 | ||
887 | ||
888 | ||
889 | <li class="md-nav__item"> | |
890 | <a href="../../../javascript/code-snippets/" class="md-nav__link"> | |
891 | Code Snippets | |
892 | </a> | |
893 | </li> | |
894 | ||
895 | ||
896 | ||
897 | </ul> | |
898 | </nav> | |
899 | </li> | |
900 | ||
901 | ||
902 | ||
903 | ||
904 | ||
905 | ||
906 | ||
907 | ||
908 | ||
909 | ||
910 | ||
911 | <li class="md-nav__item md-nav__item--nested"> | |
912 | ||
913 | ||
914 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > | |
915 | ||
916 | <label class="md-nav__link" for="__nav_5"> | |
917 | Package Components | |
918 | <span class="md-nav__icon md-icon"></span> | |
919 | </label> | |
920 | <nav class="md-nav" aria-label="Package Components" data-md-level="1"> | |
921 | <label class="md-nav__title" for="__nav_5"> | |
922 | <span class="md-nav__icon md-icon"></span> | |
923 | Package Components | |
924 | </label> | |
925 | <ul class="md-nav__list" data-md-scrollfix> | |
926 | ||
927 | ||
928 | ||
929 | ||
930 | ||
931 | <li class="md-nav__item"> | |
932 | <a href="../../../package/package-xml/" class="md-nav__link"> | |
933 | package.xml | |
934 | </a> | |
935 | </li> | |
936 | ||
937 | ||
938 | ||
939 | ||
940 | ||
941 | ||
942 | ||
943 | ||
944 | <li class="md-nav__item md-nav__item--nested"> | |
945 | ||
946 | ||
947 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" > | |
948 | ||
949 | <label class="md-nav__link" for="__nav_5_2"> | |
950 | PIPs | |
951 | <span class="md-nav__icon md-icon"></span> | |
952 | </label> | |
953 | <nav class="md-nav" aria-label="PIPs" data-md-level="2"> | |
954 | <label class="md-nav__title" for="__nav_5_2"> | |
955 | <span class="md-nav__icon md-icon"></span> | |
956 | PIPs | |
957 | </label> | |
958 | <ul class="md-nav__list" data-md-scrollfix> | |
959 | ||
960 | ||
961 | ||
962 | ||
963 | ||
964 | <li class="md-nav__item"> | |
965 | <a href="../../../package/pip/" class="md-nav__link"> | |
966 | Overview | |
967 | </a> | |
968 | </li> | |
969 | ||
970 | ||
971 | ||
972 | ||
973 | ||
974 | ||
975 | ||
976 | <li class="md-nav__item"> | |
977 | <a href="../../../package/pip/acl-option/" class="md-nav__link"> | |
978 | aclOption | |
979 | </a> | |
980 | </li> | |
981 | ||
982 | ||
983 | ||
984 | ||
985 | ||
986 | ||
987 | ||
988 | <li class="md-nav__item"> | |
989 | <a href="../../../package/pip/acp-menu/" class="md-nav__link"> | |
990 | acpMenu | |
991 | </a> | |
992 | </li> | |
993 | ||
994 | ||
995 | ||
996 | ||
997 | ||
998 | ||
999 | ||
1000 | <li class="md-nav__item"> | |
1001 | <a href="../../../package/pip/acp-search-provider/" class="md-nav__link"> | |
1002 | acpSearchProvider | |
1003 | </a> | |
1004 | </li> | |
1005 | ||
1006 | ||
1007 | ||
1008 | ||
1009 | ||
1010 | ||
1011 | ||
1012 | <li class="md-nav__item"> | |
1013 | <a href="../../../package/pip/acp-template/" class="md-nav__link"> | |
1014 | acpTemplate | |
1015 | </a> | |
1016 | </li> | |
1017 | ||
1018 | ||
1019 | ||
1020 | ||
1021 | ||
1022 | ||
1023 | ||
1024 | <li class="md-nav__item"> | |
1025 | <a href="../../../package/pip/bbcode/" class="md-nav__link"> | |
1026 | bbcode | |
1027 | </a> | |
1028 | </li> | |
1029 | ||
1030 | ||
1031 | ||
1032 | ||
1033 | ||
1034 | ||
1035 | ||
1036 | <li class="md-nav__item"> | |
1037 | <a href="../../../package/pip/box/" class="md-nav__link"> | |
1038 | box | |
1039 | </a> | |
1040 | </li> | |
1041 | ||
1042 | ||
1043 | ||
1044 | ||
1045 | ||
1046 | ||
1047 | ||
1048 | <li class="md-nav__item"> | |
1049 | <a href="../../../package/pip/clipboard-action/" class="md-nav__link"> | |
1050 | clipboardAction | |
1051 | </a> | |
1052 | </li> | |
1053 | ||
1054 | ||
1055 | ||
1056 | ||
1057 | ||
1058 | ||
1059 | ||
1060 | <li class="md-nav__item"> | |
1061 | <a href="../../../package/pip/core-object/" class="md-nav__link"> | |
1062 | coreObject | |
1063 | </a> | |
1064 | </li> | |
1065 | ||
1066 | ||
1067 | ||
1068 | ||
1069 | ||
1070 | ||
1071 | ||
1072 | <li class="md-nav__item"> | |
1073 | <a href="../../../package/pip/cronjob/" class="md-nav__link"> | |
1074 | cronjob | |
1075 | </a> | |
1076 | </li> | |
1077 | ||
1078 | ||
1079 | ||
1080 | ||
1081 | ||
1082 | ||
1083 | ||
6923e968 WG |
1084 | <li class="md-nav__item"> |
1085 | <a href="../../../package/pip/database/" class="md-nav__link"> | |
1086 | database | |
1087 | </a> | |
1088 | </li> | |
1089 | ||
1090 | ||
1091 | ||
1092 | ||
1093 | ||
1094 | ||
1095 | ||
45ca63d0 TD |
1096 | <li class="md-nav__item"> |
1097 | <a href="../../../package/pip/event-listener/" class="md-nav__link"> | |
1098 | eventListener | |
1099 | </a> | |
1100 | </li> | |
1101 | ||
1102 | ||
1103 | ||
1104 | ||
1105 | ||
1106 | ||
1107 | ||
1108 | <li class="md-nav__item"> | |
1109 | <a href="../../../package/pip/file/" class="md-nav__link"> | |
1110 | file | |
1111 | </a> | |
1112 | </li> | |
1113 | ||
1114 | ||
1115 | ||
1116 | ||
1117 | ||
1118 | ||
1119 | ||
1120 | <li class="md-nav__item"> | |
1121 | <a href="../../../package/pip/language/" class="md-nav__link"> | |
1122 | language | |
1123 | </a> | |
1124 | </li> | |
1125 | ||
1126 | ||
1127 | ||
1128 | ||
1129 | ||
1130 | ||
1131 | ||
1132 | <li class="md-nav__item"> | |
1133 | <a href="../../../package/pip/media-provider/" class="md-nav__link"> | |
1134 | mediaProvider | |
1135 | </a> | |
1136 | </li> | |
1137 | ||
1138 | ||
1139 | ||
1140 | ||
1141 | ||
1142 | ||
1143 | ||
1144 | <li class="md-nav__item"> | |
1145 | <a href="../../../package/pip/menu/" class="md-nav__link"> | |
1146 | menu | |
1147 | </a> | |
1148 | </li> | |
1149 | ||
1150 | ||
1151 | ||
1152 | ||
1153 | ||
1154 | ||
1155 | ||
1156 | <li class="md-nav__item"> | |
1157 | <a href="../../../package/pip/menu-item/" class="md-nav__link"> | |
1158 | menuItem | |
1159 | </a> | |
1160 | </li> | |
1161 | ||
1162 | ||
1163 | ||
1164 | ||
1165 | ||
1166 | ||
1167 | ||
1168 | <li class="md-nav__item"> | |
1169 | <a href="../../../package/pip/object-type/" class="md-nav__link"> | |
1170 | objectType | |
1171 | </a> | |
1172 | </li> | |
1173 | ||
1174 | ||
1175 | ||
1176 | ||
1177 | ||
1178 | ||
1179 | ||
1180 | <li class="md-nav__item"> | |
1181 | <a href="../../../package/pip/object-type-definition/" class="md-nav__link"> | |
1182 | objectTypeDefinition | |
1183 | </a> | |
1184 | </li> | |
1185 | ||
1186 | ||
1187 | ||
1188 | ||
1189 | ||
1190 | ||
1191 | ||
1192 | <li class="md-nav__item"> | |
1193 | <a href="../../../package/pip/option/" class="md-nav__link"> | |
1194 | option | |
1195 | </a> | |
1196 | </li> | |
1197 | ||
1198 | ||
1199 | ||
1200 | ||
1201 | ||
1202 | ||
1203 | ||
1204 | <li class="md-nav__item"> | |
1205 | <a href="../../../package/pip/page/" class="md-nav__link"> | |
1206 | page | |
1207 | </a> | |
1208 | </li> | |
1209 | ||
1210 | ||
1211 | ||
1212 | ||
1213 | ||
1214 | ||
1215 | ||
1216 | <li class="md-nav__item"> | |
1217 | <a href="../../../package/pip/pip/" class="md-nav__link"> | |
1218 | pip | |
1219 | </a> | |
1220 | </li> | |
1221 | ||
1222 | ||
1223 | ||
1224 | ||
1225 | ||
1226 | ||
1227 | ||
1228 | <li class="md-nav__item"> | |
1229 | <a href="../../../package/pip/script/" class="md-nav__link"> | |
1230 | script | |
1231 | </a> | |
1232 | </li> | |
1233 | ||
1234 | ||
1235 | ||
1236 | ||
1237 | ||
1238 | ||
1239 | ||
1240 | <li class="md-nav__item"> | |
1241 | <a href="../../../package/pip/smiley/" class="md-nav__link"> | |
1242 | smiley | |
1243 | </a> | |
1244 | </li> | |
1245 | ||
1246 | ||
1247 | ||
1248 | ||
1249 | ||
1250 | ||
1251 | ||
1252 | <li class="md-nav__item"> | |
1253 | <a href="../../../package/pip/sql/" class="md-nav__link"> | |
1254 | sql | |
1255 | </a> | |
1256 | </li> | |
1257 | ||
1258 | ||
1259 | ||
1260 | ||
1261 | ||
1262 | ||
1263 | ||
1264 | <li class="md-nav__item"> | |
1265 | <a href="../../../package/pip/style/" class="md-nav__link"> | |
1266 | style | |
1267 | </a> | |
1268 | </li> | |
1269 | ||
1270 | ||
1271 | ||
1272 | ||
1273 | ||
1274 | ||
1275 | ||
1276 | <li class="md-nav__item"> | |
1277 | <a href="../../../package/pip/template/" class="md-nav__link"> | |
1278 | template | |
1279 | </a> | |
1280 | </li> | |
1281 | ||
1282 | ||
1283 | ||
1284 | ||
1285 | ||
1286 | ||
1287 | ||
1288 | <li class="md-nav__item"> | |
1289 | <a href="../../../package/pip/template-listener/" class="md-nav__link"> | |
1290 | templateListener | |
1291 | </a> | |
1292 | </li> | |
1293 | ||
1294 | ||
1295 | ||
1296 | ||
1297 | ||
1298 | ||
1299 | ||
1300 | <li class="md-nav__item"> | |
1301 | <a href="../../../package/pip/user-group-option/" class="md-nav__link"> | |
1302 | userGroupOption | |
1303 | </a> | |
1304 | </li> | |
1305 | ||
1306 | ||
1307 | ||
1308 | ||
1309 | ||
1310 | ||
1311 | ||
1312 | <li class="md-nav__item"> | |
1313 | <a href="../../../package/pip/user-menu/" class="md-nav__link"> | |
1314 | userMenu | |
1315 | </a> | |
1316 | </li> | |
1317 | ||
1318 | ||
1319 | ||
1320 | ||
1321 | ||
1322 | ||
1323 | ||
1324 | <li class="md-nav__item"> | |
1325 | <a href="../../../package/pip/user-notification-event/" class="md-nav__link"> | |
1326 | userNotificationEvent | |
1327 | </a> | |
1328 | </li> | |
1329 | ||
1330 | ||
1331 | ||
1332 | ||
1333 | ||
1334 | ||
1335 | ||
1336 | <li class="md-nav__item"> | |
1337 | <a href="../../../package/pip/user-option/" class="md-nav__link"> | |
1338 | userOption | |
1339 | </a> | |
1340 | </li> | |
1341 | ||
1342 | ||
1343 | ||
1344 | ||
1345 | ||
1346 | ||
1347 | ||
1348 | <li class="md-nav__item"> | |
1349 | <a href="../../../package/pip/user-profile-menu/" class="md-nav__link"> | |
1350 | userProfileMenu | |
1351 | </a> | |
1352 | </li> | |
1353 | ||
1354 | ||
1355 | ||
1356 | </ul> | |
1357 | </nav> | |
1358 | </li> | |
1359 | ||
1360 | ||
1361 | ||
1362 | ||
1363 | ||
1364 | ||
1365 | ||
1366 | <li class="md-nav__item"> | |
1367 | <a href="../../../package/database-php-api/" class="md-nav__link"> | |
1368 | Database PHP API | |
1369 | </a> | |
1370 | </li> | |
1371 | ||
1372 | ||
1373 | ||
1374 | </ul> | |
1375 | </nav> | |
1376 | </li> | |
1377 | ||
1378 | ||
1379 | ||
1380 | ||
1381 | ||
1382 | ||
1383 | ||
1384 | ||
1385 | ||
1386 | ||
1387 | ||
1388 | <li class="md-nav__item md-nav__item--nested"> | |
1389 | ||
1390 | ||
1391 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > | |
1392 | ||
1393 | <label class="md-nav__link" for="__nav_6"> | |
1394 | Migration | |
1395 | <span class="md-nav__icon md-icon"></span> | |
1396 | </label> | |
1397 | <nav class="md-nav" aria-label="Migration" data-md-level="1"> | |
1398 | <label class="md-nav__title" for="__nav_6"> | |
1399 | <span class="md-nav__icon md-icon"></span> | |
1400 | Migration | |
1401 | </label> | |
1402 | <ul class="md-nav__list" data-md-scrollfix> | |
1403 | ||
1404 | ||
1405 | ||
1406 | ||
1407 | ||
1408 | ||
1409 | <li class="md-nav__item md-nav__item--nested"> | |
1410 | ||
1411 | ||
1412 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" > | |
1413 | ||
1414 | <label class="md-nav__link" for="__nav_6_1"> | |
1415 | Migrating from WSC 5.3 | |
1416 | <span class="md-nav__icon md-icon"></span> | |
1417 | </label> | |
1418 | <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2"> | |
1419 | <label class="md-nav__title" for="__nav_6_1"> | |
1420 | <span class="md-nav__icon md-icon"></span> | |
1421 | Migrating from WSC 5.3 | |
1422 | </label> | |
1423 | <ul class="md-nav__list" data-md-scrollfix> | |
1424 | ||
1425 | ||
1426 | ||
1427 | ||
1428 | ||
1429 | <li class="md-nav__item"> | |
1430 | <a href="../../../migration/wsc53/php/" class="md-nav__link"> | |
1431 | PHP API | |
1432 | </a> | |
1433 | </li> | |
1434 | ||
1435 | ||
1436 | ||
1437 | ||
1438 | ||
1439 | ||
1440 | ||
1441 | <li class="md-nav__item"> | |
1442 | <a href="../../../migration/wsc53/session/" class="md-nav__link"> | |
1443 | Session Handling and Authentication | |
1444 | </a> | |
1445 | </li> | |
1446 | ||
1447 | ||
1448 | ||
1449 | ||
1450 | ||
1451 | ||
1452 | ||
1453 | <li class="md-nav__item"> | |
1454 | <a href="../../../migration/wsc53/javascript/" class="md-nav__link"> | |
77efcd46 | 1455 | TypeScript and JavaScript |
45ca63d0 TD |
1456 | </a> |
1457 | </li> | |
1458 | ||
1459 | ||
1460 | ||
1461 | ||
1462 | ||
1463 | ||
1464 | ||
1465 | <li class="md-nav__item"> | |
1466 | <a href="../../../migration/wsc53/templates/" class="md-nav__link"> | |
1467 | Templates | |
1468 | </a> | |
1469 | </li> | |
1470 | ||
1471 | ||
1472 | ||
1473 | ||
1474 | ||
1475 | ||
1476 | ||
1477 | <li class="md-nav__item"> | |
1478 | <a href="../../../migration/wsc53/libraries/" class="md-nav__link"> | |
1479 | Third Party Libraries | |
1480 | </a> | |
1481 | </li> | |
1482 | ||
1483 | ||
1484 | ||
1485 | </ul> | |
1486 | </nav> | |
1487 | </li> | |
1488 | ||
1489 | ||
1490 | ||
1491 | ||
1492 | ||
1493 | ||
1494 | ||
1495 | ||
1496 | <li class="md-nav__item md-nav__item--nested"> | |
1497 | ||
1498 | ||
1499 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" > | |
1500 | ||
1501 | <label class="md-nav__link" for="__nav_6_2"> | |
1502 | Migrating from WSC 5.2 | |
1503 | <span class="md-nav__icon md-icon"></span> | |
1504 | </label> | |
1505 | <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2"> | |
1506 | <label class="md-nav__title" for="__nav_6_2"> | |
1507 | <span class="md-nav__icon md-icon"></span> | |
1508 | Migrating from WSC 5.2 | |
1509 | </label> | |
1510 | <ul class="md-nav__list" data-md-scrollfix> | |
1511 | ||
1512 | ||
1513 | ||
1514 | ||
1515 | ||
1516 | <li class="md-nav__item"> | |
1517 | <a href="../../../migration/wsc52/php/" class="md-nav__link"> | |
1518 | PHP API | |
1519 | </a> | |
1520 | </li> | |
1521 | ||
1522 | ||
1523 | ||
1524 | ||
1525 | ||
1526 | ||
1527 | ||
1528 | <li class="md-nav__item"> | |
1529 | <a href="../../../migration/wsc52/templates/" class="md-nav__link"> | |
1530 | Templates and Languages | |
1531 | </a> | |
1532 | </li> | |
1533 | ||
1534 | ||
1535 | ||
1536 | ||
1537 | ||
1538 | ||
1539 | ||
1540 | <li class="md-nav__item"> | |
1541 | <a href="../../../migration/wsc52/libraries/" class="md-nav__link"> | |
1542 | Third Party Libraries | |
1543 | </a> | |
1544 | </li> | |
1545 | ||
1546 | ||
1547 | ||
1548 | </ul> | |
1549 | </nav> | |
1550 | </li> | |
1551 | ||
1552 | ||
1553 | ||
1554 | ||
1555 | ||
1556 | ||
1557 | ||
1558 | ||
1559 | <li class="md-nav__item md-nav__item--nested"> | |
1560 | ||
1561 | ||
1562 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" > | |
1563 | ||
1564 | <label class="md-nav__link" for="__nav_6_3"> | |
1565 | Migrating from WSC 3.1 | |
1566 | <span class="md-nav__icon md-icon"></span> | |
1567 | </label> | |
1568 | <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2"> | |
1569 | <label class="md-nav__title" for="__nav_6_3"> | |
1570 | <span class="md-nav__icon md-icon"></span> | |
1571 | Migrating from WSC 3.1 | |
1572 | </label> | |
1573 | <ul class="md-nav__list" data-md-scrollfix> | |
1574 | ||
1575 | ||
1576 | ||
1577 | ||
1578 | ||
1579 | <li class="md-nav__item"> | |
1580 | <a href="../../../migration/wsc31/php/" class="md-nav__link"> | |
1581 | PHP API | |
1582 | </a> | |
1583 | </li> | |
1584 | ||
1585 | ||
1586 | ||
1587 | </ul> | |
1588 | </nav> | |
1589 | </li> | |
1590 | ||
1591 | ||
1592 | ||
1593 | ||
1594 | ||
1595 | ||
1596 | ||
1597 | ||
1598 | <li class="md-nav__item md-nav__item--nested"> | |
1599 | ||
1600 | ||
1601 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" > | |
1602 | ||
1603 | <label class="md-nav__link" for="__nav_6_4"> | |
1604 | Migrating from WSC 3.0 | |
1605 | <span class="md-nav__icon md-icon"></span> | |
1606 | </label> | |
1607 | <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2"> | |
1608 | <label class="md-nav__title" for="__nav_6_4"> | |
1609 | <span class="md-nav__icon md-icon"></span> | |
1610 | Migrating from WSC 3.0 | |
1611 | </label> | |
1612 | <ul class="md-nav__list" data-md-scrollfix> | |
1613 | ||
1614 | ||
1615 | ||
1616 | ||
1617 | ||
1618 | <li class="md-nav__item"> | |
1619 | <a href="../../../migration/wsc30/php/" class="md-nav__link"> | |
1620 | PHP API | |
1621 | </a> | |
1622 | </li> | |
1623 | ||
1624 | ||
1625 | ||
1626 | ||
1627 | ||
1628 | ||
1629 | ||
1630 | <li class="md-nav__item"> | |
1631 | <a href="../../../migration/wsc30/javascript/" class="md-nav__link"> | |
1632 | JavaScript API | |
1633 | </a> | |
1634 | </li> | |
1635 | ||
1636 | ||
1637 | ||
1638 | ||
1639 | ||
1640 | ||
1641 | ||
1642 | <li class="md-nav__item"> | |
1643 | <a href="../../../migration/wsc30/templates/" class="md-nav__link"> | |
1644 | Templates | |
1645 | </a> | |
1646 | </li> | |
1647 | ||
1648 | ||
1649 | ||
1650 | ||
1651 | ||
1652 | ||
1653 | ||
1654 | <li class="md-nav__item"> | |
1655 | <a href="../../../migration/wsc30/css/" class="md-nav__link"> | |
1656 | CSS | |
1657 | </a> | |
1658 | </li> | |
1659 | ||
1660 | ||
1661 | ||
1662 | ||
1663 | ||
1664 | ||
1665 | ||
1666 | <li class="md-nav__item"> | |
1667 | <a href="../../../migration/wsc30/package/" class="md-nav__link"> | |
1668 | Package Components | |
1669 | </a> | |
1670 | </li> | |
1671 | ||
1672 | ||
1673 | ||
1674 | </ul> | |
1675 | </nav> | |
1676 | </li> | |
1677 | ||
1678 | ||
1679 | ||
1680 | ||
1681 | ||
1682 | ||
1683 | ||
1684 | ||
1685 | <li class="md-nav__item md-nav__item--nested"> | |
1686 | ||
1687 | ||
1688 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" > | |
1689 | ||
1690 | <label class="md-nav__link" for="__nav_6_5"> | |
1691 | Migrating from WCF 2.1 | |
1692 | <span class="md-nav__icon md-icon"></span> | |
1693 | </label> | |
1694 | <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2"> | |
1695 | <label class="md-nav__title" for="__nav_6_5"> | |
1696 | <span class="md-nav__icon md-icon"></span> | |
1697 | Migrating from WCF 2.1 | |
1698 | </label> | |
1699 | <ul class="md-nav__list" data-md-scrollfix> | |
1700 | ||
1701 | ||
1702 | ||
1703 | ||
1704 | ||
1705 | <li class="md-nav__item"> | |
1706 | <a href="../../../migration/wcf21/php/" class="md-nav__link"> | |
1707 | PHP API | |
1708 | </a> | |
1709 | </li> | |
1710 | ||
1711 | ||
1712 | ||
1713 | ||
1714 | ||
1715 | ||
1716 | ||
1717 | <li class="md-nav__item"> | |
1718 | <a href="../../../migration/wcf21/templates/" class="md-nav__link"> | |
1719 | Templates | |
1720 | </a> | |
1721 | </li> | |
1722 | ||
1723 | ||
1724 | ||
1725 | ||
1726 | ||
1727 | ||
1728 | ||
1729 | <li class="md-nav__item"> | |
1730 | <a href="../../../migration/wcf21/css/" class="md-nav__link"> | |
1731 | CSS | |
1732 | </a> | |
1733 | </li> | |
1734 | ||
1735 | ||
1736 | ||
1737 | ||
1738 | ||
1739 | ||
1740 | ||
1741 | <li class="md-nav__item"> | |
1742 | <a href="../../../migration/wcf21/package/" class="md-nav__link"> | |
1743 | Package Components | |
1744 | </a> | |
1745 | </li> | |
1746 | ||
1747 | ||
1748 | ||
1749 | </ul> | |
1750 | </nav> | |
1751 | </li> | |
1752 | ||
1753 | ||
1754 | ||
1755 | </ul> | |
1756 | </nav> | |
1757 | </li> | |
1758 | ||
1759 | ||
1760 | ||
1761 | ||
1762 | ||
1763 | ||
1764 | ||
1765 | ||
1766 | ||
1767 | ||
1768 | ||
1769 | <li class="md-nav__item md-nav__item--nested"> | |
1770 | ||
1771 | ||
1772 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > | |
1773 | ||
1774 | <label class="md-nav__link" for="__nav_7"> | |
1775 | Tutorials | |
1776 | <span class="md-nav__icon md-icon"></span> | |
1777 | </label> | |
1778 | <nav class="md-nav" aria-label="Tutorials" data-md-level="1"> | |
1779 | <label class="md-nav__title" for="__nav_7"> | |
1780 | <span class="md-nav__icon md-icon"></span> | |
1781 | Tutorials | |
1782 | </label> | |
1783 | <ul class="md-nav__list" data-md-scrollfix> | |
1784 | ||
1785 | ||
1786 | ||
1787 | ||
1788 | ||
1789 | ||
1790 | <li class="md-nav__item md-nav__item--nested"> | |
1791 | ||
1792 | ||
1793 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" > | |
1794 | ||
1795 | <label class="md-nav__link" for="__nav_7_1"> | |
1796 | Tutorial Series | |
1797 | <span class="md-nav__icon md-icon"></span> | |
1798 | </label> | |
1799 | <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2"> | |
1800 | <label class="md-nav__title" for="__nav_7_1"> | |
1801 | <span class="md-nav__icon md-icon"></span> | |
1802 | Tutorial Series | |
1803 | </label> | |
1804 | <ul class="md-nav__list" data-md-scrollfix> | |
1805 | ||
1806 | ||
1807 | ||
1808 | ||
1809 | ||
1810 | <li class="md-nav__item"> | |
1811 | <a href="../../../tutorial/series/overview/" class="md-nav__link"> | |
1812 | Overview | |
1813 | </a> | |
1814 | </li> | |
1815 | ||
1816 | ||
1817 | ||
1818 | ||
1819 | ||
1820 | ||
1821 | ||
1822 | <li class="md-nav__item"> | |
1823 | <a href="../../../tutorial/series/part_1/" class="md-nav__link"> | |
1824 | Part 1 | |
1825 | </a> | |
1826 | </li> | |
1827 | ||
1828 | ||
1829 | ||
1830 | ||
1831 | ||
1832 | ||
1833 | ||
1834 | <li class="md-nav__item"> | |
1835 | <a href="../../../tutorial/series/part_2/" class="md-nav__link"> | |
1836 | Part 2 | |
1837 | </a> | |
1838 | </li> | |
1839 | ||
1840 | ||
1841 | ||
1842 | ||
1843 | ||
1844 | ||
1845 | ||
1846 | <li class="md-nav__item"> | |
1847 | <a href="../../../tutorial/series/part_3/" class="md-nav__link"> | |
1848 | Part 3 | |
1849 | </a> | |
1850 | </li> | |
1851 | ||
1852 | ||
1853 | ||
1854 | </ul> | |
1855 | </nav> | |
1856 | </li> | |
1857 | ||
1858 | ||
1859 | ||
1860 | </ul> | |
1861 | </nav> | |
1862 | </li> | |
1863 | ||
1864 | ||
1865 | ||
1866 | </ul> | |
1867 | </nav> | |
1868 | </div> | |
1869 | </div> | |
1870 | </div> | |
1871 | ||
1872 | ||
1873 | ||
1874 | <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > | |
1875 | <div class="md-sidebar__scrollwrap"> | |
1876 | <div class="md-sidebar__inner"> | |
1877 | ||
1878 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
1879 | ||
1880 | ||
1881 | ||
1882 | ||
1883 | ||
1884 | </nav> | |
1885 | </div> | |
1886 | </div> | |
1887 | </div> | |
1888 | ||
1889 | ||
1890 | <div class="md-content" data-md-component="content"> | |
1891 | <article class="md-content__inner md-typeset"> | |
1892 | ||
1893 | ||
9b8bddda | 1894 | <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/api/sitemaps.md" title="Edit this page" class="md-content__button md-icon"> |
7124f4cb WG |
1895 | <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> |
1896 | </a> | |
1897 | ||
45ca63d0 TD |
1898 | |
1899 | <h1 id="sitemaps">Sitemaps<a class="headerlink" href="#sitemaps" title="Permanent link">#</a></h1> | |
1900 | <div class="admonition warning"> | |
1901 | <p class="admonition-title">This feature is available with WoltLab Suite 3.1 or newer only.</p> | |
1902 | </div> | |
1903 | <p>Since version 3.1, WoltLab Suite Core is capable of automatically creating a sitemap. | |
1904 | This sitemap contains all static pages registered via the page package installation plugin and which may be indexed by search engines (checking the <code>allowSpidersToIndex</code> parameter and page permissions) and do not expect an object ID. | |
1905 | Other pages have to be added to the sitemap as a separate object.</p> | |
1906 | <p>The only prerequisite for sitemap objects is that the objects are instances of <code>wcf\data\DatabaseObject</code> and that there is a <code>wcf\data\DatabaseObjectList</code> implementation.</p> | |
1907 | <p>First, we implement the PHP class, which provides us all database objects and optionally checks the permissions for a single object. | |
1908 | The class must implement the interface <code>wcf\system\sitemap\object\ISitemapObjectObjectType</code>. | |
1909 | However, in order to have some methods already implemented and ensure backwards compatibility, you should use the abstract class <code>wcf\system\sitemap\object\AbstractSitemapObjectObjectType</code>. | |
1910 | The abstract class takes care of generating the <code>DatabaseObjectList</code> class name and list directly and implements optional methods with the default values. | |
1911 | The only method that you have to implement yourself is the <code>getObjectClass()</code> method which returns the fully qualified name of the <code>DatabaseObject</code> class. | |
1912 | The <code>DatabaseObject</code> class must implement the interface <code>wcf\data\ILinkableObject</code>.</p> | |
1913 | <p>Other optional methods are:</p> | |
1914 | <ul> | |
1915 | <li>The <code>getLastModifiedColumn()</code> method returns the name of the column in the database where the last modification date is stored. | |
1916 | If there is none, this method must return <code>null</code>.</li> | |
1917 | <li>The <code>canView()</code> method checks whether the passed <code>DatabaseObject</code> is visible to the current user with the current user always being a guest.</li> | |
1918 | <li>The <code>getObjectListClass()</code> method returns a non-standard <code>DatabaseObjectList</code> class name.</li> | |
1919 | <li>The <code>getObjectList()</code> method returns the <code>DatabaseObjectList</code> instance. | |
1920 | You can, for example, specify additional query conditions in the method.</li> | |
1921 | </ul> | |
1922 | <p>As an example, the implementation for users looks like this:</p> | |
1923 | <div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="nx">php</span> | |
1924 | <span class="k">namespace</span> <span class="nx">wcf\system\sitemap\object</span><span class="p">;</span> | |
1925 | <span class="k">use</span> <span class="nx">wcf\data\user\User</span><span class="p">;</span> | |
1926 | <span class="k">use</span> <span class="nx">wcf\data\DatabaseObject</span><span class="p">;</span> | |
1927 | <span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span> | |
1928 | ||
1929 | <span class="sd">/**</span> | |
1930 | <span class="sd"> * User sitemap implementation.</span> | |
1931 | <span class="sd"> *</span> | |
1932 | <span class="sd"> * @author Joshua Ruesweg</span> | |
1933 | <span class="sd"> * @copyright 2001-2017 WoltLab GmbH</span> | |
1934 | <span class="sd"> * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php></span> | |
1935 | <span class="sd"> * @package WoltLabSuite\Core\Sitemap\Object</span> | |
1936 | <span class="sd"> * @since 3.1</span> | |
1937 | <span class="sd"> */</span> | |
1938 | <span class="k">class</span> <span class="nc">UserSitemapObject</span> <span class="k">extends</span> <span class="nx">AbstractSitemapObjectObjectType</span> <span class="p">{</span> | |
1939 | <span class="sd">/**</span> | |
1940 | <span class="sd"> * @inheritDoc</span> | |
1941 | <span class="sd"> */</span> | |
1942 | <span class="k">public</span> <span class="k">function</span> <span class="nf">getObjectClass</span><span class="p">()</span> <span class="p">{</span> | |
1943 | <span class="k">return</span> <span class="nx">User</span><span class="o">::</span><span class="na">class</span><span class="p">;</span> | |
1944 | <span class="p">}</span> | |
1945 | ||
1946 | <span class="sd">/**</span> | |
1947 | <span class="sd"> * @inheritDoc</span> | |
1948 | <span class="sd"> */</span> | |
1949 | <span class="k">public</span> <span class="k">function</span> <span class="nf">getLastModifiedColumn</span><span class="p">()</span> <span class="p">{</span> | |
1950 | <span class="k">return</span> <span class="s1">'lastActivityTime'</span><span class="p">;</span> | |
1951 | <span class="p">}</span> | |
1952 | ||
1953 | <span class="sd">/**</span> | |
1954 | <span class="sd"> * @inheritDoc</span> | |
1955 | <span class="sd"> */</span> | |
1956 | <span class="k">public</span> <span class="k">function</span> <span class="nf">canView</span><span class="p">(</span><span class="nx">DatabaseObject</span> <span class="nv">$object</span><span class="p">)</span> <span class="p">{</span> | |
1957 | <span class="k">return</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getSession</span><span class="p">()</span><span class="o">-></span><span class="na">getPermission</span><span class="p">(</span><span class="s1">'user.profile.canViewUserProfile'</span><span class="p">);</span> | |
1958 | <span class="p">}</span> | |
1959 | <span class="p">}</span> | |
1960 | </code></pre></div> | |
45ca63d0 TD |
1961 | <p>Next, the sitemap object must be registered as an object type:</p> |
1962 | <div class="highlight"><pre><span></span><code><span class="nt"><type></span> | |
1963 | <span class="nt"><name></span>com.example.plugin.sitemap.object.user<span class="nt"></name></span> | |
1964 | <span class="nt"><definitionname></span>com.woltlab.wcf.sitemap.object<span class="nt"></definitionname></span> | |
1965 | <span class="nt"><classname></span>wcf\system\sitemap\object\UserSitemapObject<span class="nt"></classname></span> | |
1966 | <span class="nt"><priority></span>0.5<span class="nt"></priority></span> | |
1967 | <span class="nt"><changeFreq></span>monthly<span class="nt"></changeFreq></span> | |
1968 | <span class="nt"><rebuildTime></span>259200<span class="nt"></rebuildTime></span> | |
1969 | <span class="nt"></type></span> | |
1970 | </code></pre></div> | |
45ca63d0 TD |
1971 | <p>In addition to the fully qualified class name, the object type definition <code>com.woltlab.wcf.sitemap.object</code> and the object type name, the parameters <code>priority</code>, <code>changeFreq</code> and <code>rebuildTime</code> must also be specified. |
1972 | <code>priority</code> (<a href="https://www.sitemaps.org/protocol.html#prioritydef">https://www.sitemaps.org/protocol.html#prioritydef</a>) and <code>changeFreq</code> (<a href="https://www.sitemaps.org/protocol.html#changefreqdef">https://www.sitemaps.org/protocol.html#changefreqdef</a>) are specifications in the sitemaps protocol and can be changed by the user in the ACP. | |
1973 | The <code>priority</code> should be <code>0.5</code> by default, unless there is an important reason to change it. | |
1974 | The parameter <code>rebuildTime</code> specifies the number of seconds after which the sitemap should be regenerated.</p> | |
1975 | <p>Finally, you have to create the language variable for the sitemap object. | |
1976 | The language variable follows the pattern <code>wcf.acp.sitemap.objectType.{objectTypeName}</code> and is in the category <code>wcf.acp.sitemap</code>.</p> | |
1977 | ||
4a5c32e1 WG |
1978 | |
1979 | ||
1980 | ||
1981 | <hr> | |
1982 | <div class="md-source-date"> | |
1983 | <small> | |
1984 | ||
1985 | Last update: 2021-01-08 | |
1986 | ||
1987 | </small> | |
1988 | </div> | |
1989 | ||
1990 | ||
45ca63d0 TD |
1991 | |
1992 | ||
1993 | ||
1994 | ||
1995 | ||
1996 | ||
1997 | </article> | |
1998 | </div> | |
1999 | </div> | |
fb962f09 | 2000 | |
45ca63d0 TD |
2001 | </main> |
2002 | ||
2003 | ||
2004 | <footer class="md-footer"> | |
2005 | ||
2006 | <nav class="md-footer__inner md-grid" aria-label="Footer"> | |
2007 | ||
2008 | <a href="../user_notifications/" class="md-footer__link md-footer__link--prev" rel="prev"> | |
2009 | <div class="md-footer__button md-icon"> | |
2010 | <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> | |
2011 | </div> | |
2012 | <div class="md-footer__title"> | |
2013 | <div class="md-ellipsis"> | |
2014 | <span class="md-footer__direction"> | |
2015 | Previous | |
2016 | </span> | |
2017 | User Notifications | |
2018 | </div> | |
2019 | </div> | |
2020 | </a> | |
2021 | ||
2022 | ||
2023 | <a href="../../code-style/" class="md-footer__link md-footer__link--next" rel="next"> | |
2024 | <div class="md-footer__title"> | |
2025 | <div class="md-ellipsis"> | |
2026 | <span class="md-footer__direction"> | |
2027 | Next | |
2028 | </span> | |
2029 | Code Style | |
2030 | </div> | |
2031 | </div> | |
2032 | <div class="md-footer__button md-icon"> | |
2033 | <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> | |
2034 | </div> | |
2035 | </a> | |
2036 | ||
2037 | </nav> | |
2038 | ||
2039 | <div class="md-footer-meta md-typeset"> | |
2040 | <div class="md-footer-meta__inner md-grid"> | |
2041 | <div class="md-footer-copyright"> | |
2042 | ||
2043 | <div class="md-footer-copyright__highlight"> | |
2044 | Copyright © 2020 WoltLab GmbH | |
2045 | </div> | |
2046 | ||
2047 | Made with | |
2048 | <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> | |
2049 | Material for MkDocs | |
2050 | </a> | |
fb88dc6e | 2051 | |
45ca63d0 TD |
2052 | </div> |
2053 | <div class="md-footer-copyright"> | |
2054 | <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a> | |
2055 | <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a> | |
2056 | </div> | |
2057 | </div> | |
2058 | </div> | |
2059 | </footer> | |
2060 | ||
2061 | </div> | |
2062 | <div class="md-dialog" data-md-component="dialog"> | |
2063 | <div class="md-dialog__inner md-typeset"></div> | |
2064 | </div> | |
fb962f09 | 2065 | <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> |
45ca63d0 TD |
2066 | |
2067 | ||
fb962f09 | 2068 | <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script> |
45ca63d0 TD |
2069 | |
2070 | ||
2071 | </body> | |
2072 | </html> |