Permanently protected template

Template:Pp

From MediaWiki.org
Jump to navigation Jump to search
Template documentation

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
| 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".

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

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Pp

Produces banners to describe why a page is protected and padlock icons

Template parameters

ParameterDescriptionTypeStatus
Reason1

Reason for protection, may be one of: blp, dispute, dmca, mainpage, office, reset, sock, template, usertalk, vandalism

Example
blp
Stringsuggested
Smallsmall

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.

Default
no
Example
yes
Booleansuggested
Actionaction

Protection action. Must be one of "edit" (for normal protection), "move" (for move-protection) or "autoreview" (for pending changes). The default value is "edit".

Default
edit
Example
edit
Stringoptional
Datedate

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.

Dateoptional
Useruser

Username of the user to generate links for. This only has an effect when the "usertalk" reason is specified.

Useroptional
Sectionsection

Section name of the protected page's talk page where discussion is taking place. This works for most, but not all, values of reason.

Stringoptional
Categorycategory

Categories are suppressed if this is set to "no", "n", "0", or "false".

Booleanoptional