Template:Pp/doc
Template:Strong for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
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! |
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
edit{{pp | 1 = reason | small = yes/no | action = action | expiry = expiry | date = protection date | user = username | section = talk page section name | category = no }}
Parameters
editAll 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
editThe following table contains the available reasons, plus the actions for which they are available.
Lua error in package.lua at line 80: module 'Module:Middleclass' not found.
Syntax examples
editPadlock 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=15 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=8 December 2024}}
TemplateDate
editProduces 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
edit