Template:Pp/doc

From Vietnam Veterans for Factual History
Jump to: navigation, search

Lua error: Internal error: The interpreter exited with status 127. Lua error: Internal error: The interpreter exited with status 127.

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
| expiry   = expiry
| 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".
  • expiry – The expiry date of the protection. This can be a date (for temporary protection), or one of the strings "indef", "indefinite", "indefinitely", or "infinite" (for indefinite protection). If this is a date, it must be valid input to the second parameter of the #time parser function.
  • 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.

Lua error: Internal error: The interpreter exited with status 127.

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|expiry=13 December 2021}}

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|expiry=6 January 2022}}

TemplateData

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

See the monthly error report for this template.

TemplateData for Pp

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

Template parameters

This template has custom formatting.

Parameter Description Type Status
Reason 1

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

Default
empty
Example
blp
Auto value
empty
String suggested
Small small

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
Auto value
empty
Boolean suggested
Action action

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
Auto value
empty
String optional
Expiry expiry

Expiry date of the protection. This can be a date (for temporary protection), or one of the strings "indef", "indefinite", "indefinitely", or "infinite" (for indefinite protection). If this is a date, it must be valid input to the second parameter of the #time parser function.

Default
empty
Example
20 December 2027
Auto value
empty
Date suggested
Date date

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.

Default
empty
Example
empty
Auto value
empty
Date optional
User user

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

Default
empty
Example
empty
Auto value
empty
User optional
Section section

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

Default
empty
Example
empty
Auto value
empty
String optional
Category category

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

Default
empty
Example
empty
Auto value
empty
Boolean optional

See also

Lua error: Internal error: The interpreter exited with status 127.