Modul:Protection banner/dok
Dette er dokumentasjonssiden for Modul:Protection banner
This module creates protection banners and padlock icons that are placed at the top of protected pages.
Usage
Most users will not need to use this module directly. For adding protection templates to articles you can use the {{pp}} template, or you may find it more convenient to use one of the more specific protection templates in the table below.
From wikitext
{{#invoke:Protection banner|main | small = yes/no | reason = reason | action = action | expiry = expiry | date = protection date | user = username | section = talk page section name | category = no }}
Parameters
All parameters are optional.
- small - if set to "yes", "y", "1", or "true", a padlock icon is generated instead of a full protection banner.
- reason - the reason that the page was protected. This must be one of the values listed in the reasons table.
- 1 - an alias for the reason parameter. If both are set, reason takes priority.
- 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 has an effect for reasons that use the PROTECTIONDATE parameter in their configuration. As of July 2014, those were 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.
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 by the Wikimedia Foundation due to Digital Millennium Copyright Act takedown requests |
ecp | edit | For articles in topic areas authorized by ArbCom or meets the criteria for community use |
mainpage | edit | For pages protected for being displayed on the Main Page |
office | edit | For pages protected by the Wikimedia Foundation |
reset | edit | For pages protected by the Wikimedia Foundation and "reset" to a bare-bones version |
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 |
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 |
Technical details
This module uses configuration data from Module:Protection banner/config. Most of the module's behaviour can be configured there, making it easily portable across different wikis and different languages.
General test cases for the module can be found at Module:Protection banner/testcases, and test cases specific to enwiki's config can be found at Module:Protection banner/config/testcases.
Bug reports and feature requests should be made on the module's talk page.