Template:Protection padlock/doc

This is a general template for producing protection banners and padlock icons. It can be used for any protection reason, with any protection action and at any protection level.

Usage

{{Protection padlock
 | 1        = <!-- reason for protection -->
 | small    = <!-- yes, for a smaller, right-aligned notice -->
 | action   = <!-- the actions restricted by the protection -->
 | date     = <!-- Date when protection was instituted -->
 | user     = <!-- Username of contact point for edit requests -->
 | section  = <!-- Name of section on that user's Usertalk page for those requests -->
 | category = <!-- Suppress automatic category inclusion when this is set to 'no' -->
}}

Parameters

All parameters are optional:

• |1=/|reason= – 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:Zoophilia Wiki 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 due to Digital Millennium Copyright Act takedown requests
mainpage	edit	For pages protected for being displayed on the Main Page
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 or users
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: ⇒ {{Protection padlock|vandalism|small=yes}}

• Padlock icon for a page temporarily protected due to editing disputes: ⇒ {{Protection padlock|dispute|small=yes}}

Banners

• Banner for a page protected due to sockpuppetry, with a link to a talk page discussion: ⇒ {{Protection padlock|sock|section=Sockpuppetry concerns}}

• Banner for a page temporarily move-protected due to page move vandalism: ⇒ {{Protection padlock|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.

TemplateData

This is the TemplateData for this template, used by TemplateWizard, VisualEditor and other tools.
TemplateData for Protection padlock

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

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Protection reason	reason 1	Explicit justification for protection, may be one of: 'dispute', 'dmca', 'mainpage', 'reset', 'sock', 'template', 'usertalk' or 'vandalism'. Suggested values vandalism template usertalk dispute dmca mainpage reset sock Example vandalism	Line	suggested
Smaller notice	small	When set to a Boolean truthy value (one of 'yes', 'y', '1' 'on' or 'true') a padlock top icon is displayed on the page instead of a full protection banner Example yes	Boolean	optional
Restricted action(s)	action	The user behaviors which are restricted, must be one of: 'edit' (for normal protection), 'move' (for move-protection) or 'autoreview' (for pending changes) Suggested values edit move autoreview Default edit Example move	Line	suggested
Date protected	date	The date protection was instituted, formatted according to ISO 8601; only has an effect for the 'reset' reason. Example YYYY-MM-DD	Date	optional
Protection overseer username	user	Username of the person responding to edit requests; this only has an effect when the 'usertalk' reason is specified. Example JoeSchmoe	User	optional
Talk page section	section	Name of the section of the protected page's Talk page where discussion is taking place; this works for most, but not all, values of reason. Example Protection underway	Line	optional
Auto-categorization	category	Automatic categorization is suppressed if this is set to 'no', 'n', '0', 'off' or 'false' Example no	Boolean	optional