Template:Protected page text/doc

This template displays the text that users see when they do not have permission to edit a page. This template was created to encourage reuse of code in the MediaWiki messages that display said errors.

For convenience, there are seven subtemplates already filled out with the settings for semi-protection, extended-confirmed protection, template protection, full protection, cascade protection, user JSON page protection, and user script protection: Protected page text/semi, Protected page text/extendedconfirmed, Protected page text/template, Protected page text/full, Protected page text/cascade, Protected page text/user-json and Protected page text/interface. It is recommended that you use these subtemplates, as this will allow you to benefit from future updates to the templates.

Pre-defined settings
 Semi-protection  protected page text/semi

 Extendedconfirmed protection  protected page text/extendedconfirmed

 Template protection  protected page text/template

 Full protection  protected page text/full

Pages transcluded in cascade-protected pages protected page text/cascade

 Protection of user JSON pages protected page text/user-json

 Protection of user scripts  protected page text/interface

Parameters

 * - The shackle image used in the top message box. Defaults to.
 * - The message inside the top message box. This should explain that the page is protected, and who can edit it. This parameter is required.
 * - If this parameter is set with any text, the template shows the "Why is the page protected?" and "What can I do?" headings with a list of suggestions on what actions editors can take upon discovering that they can't edit the page. This parameter can be used with the #ifexist parser function to display the suggestions only on existing pages (i.e. to disable them on create-protected pages).
 * - The general reasons why pages of a given protection level might be protected. This is the first bullet point under the "Why is the page protected?" heading. This parameter is required.
 * - Optional text to use instead of the protection log explanation in the "Why is the page protected?" heading.
 * - If this parameter is set with any text, the template displays a message about logging in and becoming autoconfirmed.
 * - If this parameter is set with any text, and the current page is the Main Page, the template displays advice for new editors and a link to Main Page/Errors.
 * - If this parameter is set with any text, and the current page is in the template namespace, the template will display links to the documentation and the template sandbox if they exist.
 * - The users that can edit pages protected at this level. This should start with a capital letter and include a grammatical article, e.g. . This parameter is required.
 * - The value to send to the type parameter of Template:Submit an edit request. Possible values are,   and  . This parameter is required.
 * - If this parameter is set with any text, the template will hide the message about requesting lowering of protection at WP:RFPP. This is unlikely to be used except for pages subject to cascade-protection and which will have it indefinitely (requests to lower the protection on that particular page must necessarily be declined).

Example
The following example uses the code for full protection.

Code
