Template:Pp/doc

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
&#123;{pp | 1       = reason | small   = yes | action  = action | date    = protection date | user    = username | section = talk page section name | category = no }&#125;

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.

Syntax examples
Padlock icons

Padlock icon for a page protected due to vandalism: &#123;{pp|vandalism|small=yes}&#125;

Padlock icon for a page temporarily protected due to editing disputes: &#123;{pp|dispute|small=yes}&#125;

Banners

Banner for a page protected due to sockpuppetry, with a link to a talk page discussion: &#123;{pp|sock|section=Sockpuppetry concerns}&#125;

Banner for a page temporarily move-protected due to page-move vandalism: &#123;{pp|vandalism|action=move}&#125;

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