Add missing elements to `page` PIP documentation (#199)
authorMatthias Schmidt <gravatronics@live.com>
Wed, 7 Jul 2021 11:37:16 +0000 (13:37 +0200)
committerGitHub <noreply@github.com>
Wed, 7 Jul 2021 11:37:16 +0000 (13:37 +0200)
docs/package/pip/page.md
snippets/package/pip/page.xml

index 74ef6fc71369f19b4e46b346abb37b4c06acb2a5..5658ea625d73d097622e623af29c97a334aba4f6 100644 (file)
@@ -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.
 
+### `<requireObjectID>`
+
+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, `<requireObjectID>1</requireObjectID>` has to be added.
+If this item is not present, `requireObjectID` defaults to `0`.
+
+### `<availableDuringOfflineMode>`
+
+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, `<availableDuringOfflineMode>1</availableDuringOfflineMode>` has to be added.
+If this item is not present, `availableDuringOfflineMode` defaults to `0`.
+
+### `<allowSpidersToIndex>`
+
+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`.
+
+### `<cssClassName>`
+
+To add custom CSS classes to a page’s `<body>` HTML element, you can specify them via the `cssClassName` item.
+
+!!! info "If you want to add multiple CSS classes, separate them with spaces!"
+
 ### `<content>`
 
 !!! info "The `language` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."
index dda379985c9dc976ece27479c0d5349063655de1..233eb8c6626a49c0f5e8917969401e3bb98b68fc 100644 (file)
@@ -6,9 +6,9 @@
                        <controller>wcf\page\MembersListPage</controller>
                        <name language="de">Mitglieder</name>
                        <name language="en">Members</name>
-                       <permissions>user.profile.canViewMembersList</permissions>
                        <options>module_members_list</options>
-
+                       <permissions>user.profile.canViewMembersList</permissions>
+                       <allowSpidersToIndex>1</allowSpidersToIndex>
                        <content language="en">
                                <title>Members</title>
                        </content>