From: Matthias Schmidt Date: Wed, 7 Jul 2021 11:37:16 +0000 (+0200) Subject: Add missing elements to `page` PIP documentation (#199) X-Git-Tag: 5.6.final~53^2~26 X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=6ed0b2684018f54b722b8e7baae55d0951558695;p=GitHub%2FWoltLab%2Fwoltlab.github.io.git Add missing elements to `page` PIP documentation (#199) --- diff --git a/docs/package/pip/page.md b/docs/package/pip/page.md index 74ef6fc7..5658ea62 100644 --- a/docs/package/pip/page.md +++ b/docs/package/pip/page.md @@ -59,6 +59,29 @@ page would be presented with a permission denied message. Set this to `1` to prevent this page from becoming a landing page ever. +### `` + +If the page requires an id of a specific object, like the user profile page requires the id of the user whose profile page is requested, `1` has to be added. +If this item is not present, `requireObjectID` defaults to `0`. + +### `` + +During offline mode, most pages should generally not be available. +Certain pages, however, might still have to be accessible due to, for example, legal reasons. +To make a page available during offline mode, `1` has to be added. +If this item is not present, `availableDuringOfflineMode` defaults to `0`. + +### `` + +Administrators are able to set in the admin panel for each page, whether or not spiders are allowed to index it. +The default value for this option can be set with the `allowSpidersToIndex` item whose value defaults to `0`. + +### `` + +To add custom CSS classes to a page’s `` HTML element, you can specify them via the `cssClassName` item. + +!!! info "If you want to add multiple CSS classes, separate them with spaces!" + ### `` !!! info "The `language` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code." diff --git a/snippets/package/pip/page.xml b/snippets/package/pip/page.xml index dda37998..233eb8c6 100644 --- a/snippets/package/pip/page.xml +++ b/snippets/package/pip/page.xml @@ -6,9 +6,9 @@ wcf\page\MembersListPage Mitglieder Members - user.profile.canViewMembersList module_members_list - + user.profile.canViewMembersList + 1 Members