Template:Pp/doc
 | This is a documentation subpage for Template:Pp. It contains usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 8,300 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.
Transclusion count updated automatically (see documentation). |
 | If you plan to make breaking changes to this template, move it, or nominate it for deletion, please notify Twinkle's users and maintainers at Wikipedia talk:Twinkle as a courtesy, as this template is used in the standard installation of Twinkle. Thank you! |
 | This template uses Lua: |
This is a general template for producing protection banners and padlock icons. It can be used with any protection reason, any protection action, and any protection level.
Usage
{{pp
| 1 = reason
| small = yes/no
| action = action
| expiry = expiry
| date = protection date
| user = username
| section = talk page section name
| category = no
}}
Parameters
All parameters are optional:
- 1 – The reason that the page was protected. If set, this must be one of the values listed in the reasons table.
- small – If set to "yes", "y", "1", or "true", a padlock icon is generated instead of a full protection banner.
- action – The protection action. Must be one of "edit" (for normal protection), "move" (for move-protection) or "autoreview" (for pending changes). The default value is "edit".
- expiry – The expiry date of the protection. This can be a date (for temporary protection), or one of the strings "indef", "indefinite", "indefinitely", or "infinite" (for indefinite protection). If this is a date, it must be valid input to the second parameter of the #time parser function.
- date – The protection date. This must be valid input to the second parameter of the #time parser function. This argument only has an effect for the "office" and "reset" reasons.
- user – The username of the user to generate links for. As of July 2014, this only has an effect when the "usertalk" reason is specified.
- section – The section name of the protected page's talk page where discussion is taking place. This works for most, but not all, values of reason.
- category – Categories are suppressed if this is set to "no", "n", "0", or "false".
Reasons
The following table contains the available reasons, plus the actions for which they are available.
| Reason | Action | Description |
|---|---|---|
| blp | edit | For pages protected to promote compliance with the biographies of living persons policy |
| dispute | edit | For pages protected due to editing disputes |
| dmca | edit | For pages protected by the Wikimedia Foundation due to Digital Millennium Copyright Act takedown requests |
| ecp | edit | For articles in topic areas authorized by ArbCom or meets the criteria for community use |
| mainpage | edit | For pages protected for being displayed on the Main Page |
| office | edit | For pages protected by the Wikimedia Foundation |
| reset | edit | For pages protected by the Wikimedia Foundation and "reset" to a bare-bones version |
| sock | edit | For pages protected due to sock puppetry |
| template | edit | For high-risk templates and Lua modules |
| usertalk | edit | For pages protected against disruptive edits by a particular user |
| vandalism | edit | For pages protected against vandalism |
| dispute | move | For pages protected against page moves due to disputes over the page title |
| vandalism | move | For pages protected against page-move vandalism |
Syntax examples
Padlock icons
Padlock icon for a page protected due to vandalism:
{{pp|vandalism|small=yes}}
Padlock icon for a page temporarily protected due to editing disputes:
{{pp|dispute|small=yes|expiry=26 November 2024}}
Banners
Banner for a page protected due to sockpuppetry, with a link to a talk page discussion:
{{pp|sock|section=Sockpuppetry concerns}}
Banner for a page temporarily move-protected due to page-move vandalism:
{{pp|vandalism|action=move|expiry=19 December 2024}}
TemplateData
TemplateData for Pp
Produces banners to describe why a page is protected and padlock icons
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Reason | 1 | Reason for protection, may be one of: blp, dispute, dmca, mainpage, office, reset, sock, template, usertalk, vandalism
| String | suggested |
| small | small | Specifies whether the small format is used. If set to "yes", "y", "1", or "true", a padlock icon is generated instead of a full protection banner.
| Boolean | suggested |
| action | action | Protection action. Must be one of "edit" (for normal protection), "move" (for move-protection) or "autoreview" (for pending changes). The default value is "edit".
| String | optional |
| expiry | expiry | Expiry date of the protection. This can be a date (for temporary protection), or one of the strings "indef", "indefinite", "indefinitely", or "infinite" (for indefinite protection). If this is a date, it must be valid input to the second parameter of the #time parser function.
| Date | suggested |
| date | date | Protection date. This must be valid input to the second parameter of the #time parser function. This argument only has an effect for the "office" and "reset" reasons. | Date | optional |
| user | user | Username of the user to generate links for. This only has an effect when the "usertalk" reason is specified. | User | optional |
| section | section | Section name of the protected page's talk page where discussion is taking place. This works for most, but not all, values of reason. | String | optional |
| category | category | Categories are suppressed if this is set to "no", "n", "0", or "false". | Boolean | optional |
See also