Template:Protection padlock/doc - Revision history

SockyPaws: Fix broken example

2026-01-01T01:58:31Z

Fix broken example

← Older revision		Revision as of 01:58, 1 January 2026
Line 1:		Line 1:
	{{Documentation subpage}}<!-- Please place category links where indicated at the bottom of this page. Thank you! -->		{{Documentation subpage}}<!-- Please place category links where indicated at the bottom of this page. Thank you! -->
	{{High-use}}		{{High-use}}
	{{Template shortcut\|Pp}}		{{Template shortcut\|Pp\|Pp-protected\|Pp-semi-protected}}
	This is a general template for producing '''p'''rotection banners and '''p'''adlock icons. It can be used for any protection reason, with any protection action and at any protection level.		This is a general template for producing '''p'''rotection banners and '''p'''adlock icons. It can be used for any protection reason, with any protection action and at any protection level.
	{{Lua\|Module:Protection banner}}		{{Lua\|Module:Protection banner}}
Line 7:		Line 7:

	== Usage ==		== Usage ==
	<pre style="background-color: #f8f9fa; border: medium ridge #ccc; margin-left: 2.5rem; overflow: auto; padding: 0.5em 1em; width: fit-content;"><nowiki>{{~~Pp-semi-protected~~		<pre style="background-color: #f8f9fa; border: medium ridge #ccc; margin-left: 2.5rem; overflow: auto; padding: 0.5em 1em; width: fit-content;"><nowiki>{{Protection padlock
	\| 1 = <!-- reason for protection -->		\| 1 = <!-- reason for protection -->
	\| small = <!-- yes, for a smaller, right-aligned notice -->		\| small = <!-- yes, for a smaller, right-aligned notice -->
Line 34:		Line 34:
	=== Syntax examples ===		=== Syntax examples ===
	==== Padlock icons ====		==== Padlock icons ====
	* Padlock icon for a page protected due to vandalism:~~<br />~~&emsp;{{Template link general\|code=on\|Pp\|vandalism\|3=small=yes}}		* Padlock icon for a page protected due to vandalism:&emsp;⇒&emsp;{{Template link general\|code=on\|Protection padlock\|vandalism\|3=small=yes}}
	* Padlock icon for a page temporarily protected due to editing disputes:~~<br />~~&emsp;{{Template link general\|code=on\|Pp\|dispute\|3=small=yes})
			* Padlock icon for a page temporarily protected due to editing disputes:&emsp;⇒&emsp;{{Template link general\|code=on\|Protection padlock\|dispute\|3=small=yes}}

	==== Banners ====		==== Banners ====
	* Banner for a page protected due to sockpuppetry, with a link to a talk page discussion:~~<br />~~&emsp;{{Template link general\|code=on\|Pp\|sock\|3=section=Sockpuppetry concerns}}		* Banner for a page protected due to sockpuppetry, with a link to a talk page discussion:&emsp;⇒&emsp;{{Template link general\|code=on\|Protection padlock\|sock\|3=section=Sockpuppetry concerns}}
	* Banner for a page temporarily move-protected due to page move vandalism:~~<br />~~&emsp;{{Template link general\|code=on\|Pp\|vandalism\|3=action=move}}
			* Banner for a page temporarily move-protected due to page move vandalism:&emsp;⇒&emsp;{{Template link general\|code=on\|Protection padlock\|vandalism\|3=action=move}}

	== Visibility ==		== Visibility ==

SockyPaws: SockyPaws moved page Template:Pp-semi-protected/doc to Template:Protection padlock/doc: More generic and explanatory title

2026-01-01T01:44:07Z

SockyPaws moved page Template:Pp-semi-protected/doc to Template:Protection padlock/doc: More generic and explanatory title

← Older revision	Revision as of 01:44, 1 January 2026
(No difference)

SockyPaws: Improve TemplateData

2026-01-01T01:41:23Z

Improve TemplateData

Show changes

SockyPaws: Create template documentation

2026-01-01T01:16:04Z

Create template documentation

New page

{{Documentation subpage}}
{{High-use}}
{{Template shortcut|Pp}}
This is a general template for producing '''p'''rotection banners and '''p'''adlock icons. It can be used for any protection reason, with any protection action and at any protection level.
{{Lua|Module:Protection banner}}
{{TOC right}}

== Usage ==
<pre style="background-color: #f8f9fa; border: medium ridge #ccc; margin-left: 2.5rem; overflow: auto; padding: 0.5em 1em; width: fit-content;"><nowiki>{{Pp-semi-protected
| 1 = 
| small = 
| action = 
| date = 
| user = 
| section = 
| category = 
}}</nowiki></pre>

=== Parameters ===
All parameters are optional:
* {{Para|1}}/{{Para|reason}} – The reason that the page was protected. If set, this must be one of the values listed in the [[#Reasons|reasons table]].
* {{Para|small}} – If set to {{Pval|yes}}, {{Pval|y}}, {{Pval|1}}, or {{Pval|true}}, a padlock icon is generated instead of a full protection banner.
* {{Para|action}} – The protection action, must be one of {{Pval|edit}} (for normal protection), {{Pval|move}} (for move-protection) or {{Pval|autoreview}} (for pending changes); the default value is {{Pval|edit}}.
* {{Para|date}} – The protection date. This must be valid input to the second parameter of the [[mediawikiwiki:Help:Extension:ParserFunctions##time|#time parser function]]. This argument only has an effect for the {{Pval|office}} and {{Pval|reset}} reasons.
* {{Para|user}} – The username of the user to generate links for. As of July 2014, this only has an effect when the {{Pval|usertalk}} reason is specified.
* {{Para|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 {{Para|reason}}.
* {{Para|category}} – Categories are suppressed if this is set to {{Pval|no}}, {{Pval|n}}, {{Pval|0}} or {{Pval|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).

{{#invoke:Protection banner/documentation|reasonTable}}

=== Syntax examples ===
==== Padlock icons ====
* Padlock icon for a page protected due to vandalism:<br />&emsp;{{Template link general|code=on|Pp|vandalism|3=small=yes}}
* Padlock icon for a page temporarily protected due to editing disputes:<br />&emsp;{{Template link general|code=on|Pp|dispute|3=small=yes})

==== Banners ====
* Banner for a page protected due to sockpuppetry, with a link to a talk page discussion:<br />&emsp;{{Template link general|code=on|Pp|sock|3=section=Sockpuppetry concerns}}
* Banner for a page temporarily move-protected due to page move vandalism:<br />&emsp;{{Template link general|code=on|Pp|vandalism|3=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 ==
{{TemplateData header}}
<templatedata>{
"description": "Produces banners to describe why a page is protected and padlock icons",
"paramOrder": [
"1",
"small",
"action",
"date",
"user",
"section",
"category"
],
"params": {
"1": {
"label": "Reason",
"description": "Reason for protection, may be one of: blp, dispute, dmca, mainpage, office, reset, sock, template, usertalk, vandalism",
"type": "string",
"suggestedvalues": [
"vandalism",
"template",
"usertalk",
"blp",
"dispute",
"dmca",
"ecp",
"mainpage",
"reset",
"sock",
"office"
],
"suggested": true
},
"small": {
"description": "Specifies whether only a padlock is generated. If set to \"yes\", \"y\", \"1\", or \"true\", a padlock icon is generated instead of a full protection banner.",
"example": "1",
"type": "boolean",
"default": "0",
"suggested": true,
"label": "Small?"
},
"action": {
"description": "Action which is restricted. Must be one of \"edit\" (for normal protection), \"move\" (for move-protection) or \"autoreview\" (for pending changes).",
"example": "move",
"type": "string",
"default": "edit",
"label": "Restricted action",
"suggestedvalues": [
"edit",
"move",
"autoreview"
],
"suggested": true
},
"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",
"label": "Date protected",
"example": "yyyy-mm-dd"
},
"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",
"label": "Username"
},
"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",
"label": "Section name of talk"
},
"category": {
"description": "Categories are suppressed if this is set to \"no\", \"n\", \"0\", or \"false\".",
"type": "boolean",
"label": "Categorize?",
"example": "0",
"default": "1"
}
}
}</templatedata>

== See also ==
{{Protection templates}}

<includeonly>{{Sandbox other||

[[Category:Protection templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>