Template:Protected page text/template/sandbox

Template documentation[view] [edit] [history] [purge]

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.

Syntax

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}}

Manual settings

<syntaxhighlight lang="wikitext">

</syntaxhighlight>

Parameters

• |image= – The shackle image used in the top message box. Defaults to Full-protection-shackle.svg.
• |protection-message= – The message inside the top message box. This should explain that the page is protected, and who can edit it. This parameter is required.
• |suggestions= – 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).
• |protection-reason= – 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.
• |log-text= – Optional text to use instead of the protection log explanation in the "Why is the page protected?" heading.
• |login-message= – If this parameter is set with any text, the template displays a message about logging in and becoming autoconfirmed.
• |main-page-links= – 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 Wikipedia:Main Page/Errors.
• |template-links= – 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.
• |who-can-edit= – The users that can edit pages protected at this level. This should start with a capital letter and include a grammatical article, e.g. An [[Wikipedia:Administrator|administrator]]. This parameter is required.
• |request-type= – The value to send to the |type= parameter of Template:Submit an edit request. Possible values are semi, template and full. This parameter is required.
• |hide-requestlower= – 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

<syntaxhighlight lang="wikitext" style="white-space: pre-wrap;">

</syntaxhighlight>

Result

The above documentation is transcluded from Template:Protected page text/template/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this template.