Skip to content

Commit 6ed0b26

Browse files
author
Matthias Schmidt
authored
Add missing elements to page PIP documentation (#199)
1 parent 43cb6c1 commit 6ed0b26

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

docs/package/pip/page.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,29 @@ page would be presented with a permission denied message.
5959

6060
Set this to `1` to prevent this page from becoming a landing page ever.
6161

62+
### `<requireObjectID>`
63+
64+
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.
65+
If this item is not present, `requireObjectID` defaults to `0`.
66+
67+
### `<availableDuringOfflineMode>`
68+
69+
During offline mode, most pages should generally not be available.
70+
Certain pages, however, might still have to be accessible due to, for example, legal reasons.
71+
To make a page available during offline mode, `<availableDuringOfflineMode>1</availableDuringOfflineMode>` has to be added.
72+
If this item is not present, `availableDuringOfflineMode` defaults to `0`.
73+
74+
### `<allowSpidersToIndex>`
75+
76+
Administrators are able to set in the admin panel for each page, whether or not spiders are allowed to index it.
77+
The default value for this option can be set with the `allowSpidersToIndex` item whose value defaults to `0`.
78+
79+
### `<cssClassName>`
80+
81+
To add custom CSS classes to a page’s `<body>` HTML element, you can specify them via the `cssClassName` item.
82+
83+
!!! info "If you want to add multiple CSS classes, separate them with spaces!"
84+
6285
### `<content>`
6386

6487
!!! info "The `language` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."

snippets/package/pip/page.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
<controller>wcf\page\MembersListPage</controller>
77
<name language="de">Mitglieder</name>
88
<name language="en">Members</name>
9-
<permissions>user.profile.canViewMembersList</permissions>
109
<options>module_members_list</options>
11-
10+
<permissions>user.profile.canViewMembersList</permissions>
11+
<allowSpidersToIndex>1</allowSpidersToIndex>
1212
<content language="en">
1313
<title>Members</title>
1414
</content>

0 commit comments

Comments
 (0)