Template:Pp/doc: Difference between revisions
m (fmt) |
m (1 revision imported) |
(No difference)
| |
Latest revision as of 02:59, 8 February 2024
 | This is a documentation subpage for Template:Pp. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 15,000 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. |
 | 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 the standard installation of Twinkle adds and removes this template. 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
| action = action
| 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".
- 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. Reasons are used to customize the banner text, to place articles in more specific hidden categories such as Category:Wikipedia pages semi-protected against vandalism, and sometimes to change the icon of the banner (e.g. office actions).
| 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}}
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}}
Visibility
This template will hide itself (not display a padlock icon) if it is used on a page that is not currently protected. User:MusikBot II may also automatically remove the template wikicode from pages that are not currently protected.
TemplateData
TemplateData for Pp
<templatedata> { "description": "Produces banners to describe why a page is protected and padlock icons", "params": { "1": { "label": "Reason", "description": "Reason for protection, may be one of: blp, dispute, dmca, mainpage, office, reset, sock, template, usertalk, vandalism", "example": "blp", "type": "string", "suggested": true }, "small": { "description": "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.", "example": "yes", "type": "boolean", "default": "no", "suggested": true }, "action": { "description": "Protection action. Must be one of \"edit\" (for normal protection), \"move\" (for move-protection) or \"autoreview\" (for pending changes). The default value is \"edit\".", "example": "edit", "type": "string", "default": "edit" }, "date": { "description": "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.", "type": "date" }, "user": { "description": "Username of the user to generate links for. This only has an effect when the \"usertalk\" reason is specified.", "type": "wiki-user-name" }, "section": { "description": "Section name of the protected page's talk page where discussion is taking place. This works for most, but not all, values of reason.", "type": "string" }, "category": { "description": "Categories are suppressed if this is set to \"no\", \"n\", \"0\", or \"false\".", "type": "boolean" } } } </templatedata>
See also