https://pool.calebcooper.ie/index.php?action=history&feed=atom&title=Template%3APp%2FdocTemplate:Pp/doc - Revision history2026-04-07T23:05:26ZRevision history for this page on the wikiMediaWiki 1.43.8https://pool.calebcooper.ie/index.php?title=Template:Pp/doc&diff=12262&oldid=prevCaleb Cooper: Created page with "{{Documentation subpage}} {{High-use}} {{Commons Import}} {{lua|Module:Protection banner}} <!--Categories where indicated at the bottom of this page, please; interwikis at Wik..."2020-10-18T18:38:31Z<p>Created page with "{{Documentation subpage}} {{High-use}} {{Commons Import}} {{lua|Module:Protection banner}} <!--Categories where indicated at the bottom of this page, please; interwikis at Wik..."</p>
<p><b>New page</b></p><div>{{Documentation subpage}}<br />
{{High-use}}<br />
{{Commons Import}}<br />
{{lua|Module:Protection banner}}<br />
<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])--><br />
<br />
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.<br />
<br />
== Usage ==<br />
<br />
&#123;{pp<br />
| 1 = ''reason''<br />
| small = ''yes''<br />
| action = ''action''<br />
| date = ''protection date''<br />
| user = ''username''<br />
| section = ''talk page section name''<br />
| category = ''no''<br />
}&#125;<br />
<br />
== Parameters ==<br />
All parameters are optional:<br />
* '''1''' – The reason that the page was protected. If set, this must be one of the values listed in the [[#Reasons|reasons table]].<br />
* '''small''' – If set to "yes", "y", "1", or "true", a padlock icon is generated instead of a full protection banner.<br />
* '''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".<br />
* '''date''' – The protection date. This must be valid input to the second parameter of the [[mw:Help:Extension:ParserFunctions##time|#time parser function]]. This argument only has an effect for the "office" and "reset" reasons.<br />
* '''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.<br />
* '''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''.<br />
* '''category''' – Categories are suppressed if this is set to "no", "n", "0", or "false".<br />
<br />
== Reasons ==<br />
The following table contains the available reasons, plus the actions for which they are available.<br />
<br />
{{#invoke:Protection banner/documentation|reasonTable}}<br />
<br />
== Syntax examples ==<br />
'''Padlock icons'''<br />
<br />
Padlock icon for a page protected due to vandalism:<br />
&#123;{pp|vandalism|small=yes}&#125;<br />
<br />
Padlock icon for a page temporarily protected due to editing disputes:<br />
&#123;{pp|dispute|small=yes}&#125;<br />
<br />
'''Banners'''<br />
<br />
Banner for a page protected due to sockpuppetry, with a link to a talk page discussion:<br />
&#123;{pp|sock|section=Sockpuppetry concerns}&#125;<br />
<br />
Banner for a page temporarily move-protected due to page-move vandalism:<br />
&#123;{pp|vandalism|action=move}&#125;<br />
<br />
== TemplateData ==<br />
{{TemplateData header}}<br />
<templatedata><br />
{<br />
"description": "Produces banners to describe why a page is protected and padlock icons",<br />
"params": {<br />
"1": {<br />
"label": "Reason",<br />
"description": "Reason for protection, may be one of: blp, dispute, dmca, mainpage, office, reset, sock, template, usertalk, vandalism",<br />
"example": "blp",<br />
"type": "string",<br />
"suggested": true<br />
},<br />
"small": {<br />
"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.",<br />
"example": "yes",<br />
"type": "boolean",<br />
"default": "no",<br />
"suggested": true<br />
},<br />
"action": {<br />
"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\".",<br />
"example": "edit",<br />
"type": "string",<br />
"default": "edit"<br />
},<br />
"date": {<br />
"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.",<br />
"type": "date"<br />
},<br />
"user": {<br />
"description": "Username of the user to generate links for. This only has an effect when the \"usertalk\" reason is specified.",<br />
"type": "wiki-user-name"<br />
},<br />
"section": {<br />
"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.",<br />
"type": "string"<br />
},<br />
"category": {<br />
"description": "Categories are suppressed if this is set to \"no\", \"n\", \"0\", or \"false\".",<br />
"type": "boolean"<br />
}<br />
}<br />
}<br />
</templatedata><br />
<br />
== See also ==<br />
{{Protection templates}}<br />
<br />
<includeonly>{{Sandbox other||<br />
<!--Categories below this line, please; interwikis at Wikidata--><br />
[[Category:Protection templates]]<br />
}}</includeonly></div>Caleb Cooper