Module:Protection banner/doc

This is the documentation page for Module:Protection banner

This {{<tvar|1>#switch:Module|File</>=Image|page}} is a candidate for deletion. The given reason is: Unnecessary imported over-complexity, MediaWiki.org only uses protection icons for templates, never uses big banners, and there are only two protection levels, so most of the features of this module are not needed and those that are can be implemented in Wikitext more easily

This notice should remain for a minimum of 1 week after it was placed on the page.

If discussion is still ongoing, it should remain until a consensus is reached, after which the page will either be deleted or this notice removed.

If you disagree with its deletion, please discuss your reasons on this page or on its associated talk page, as applicable.

Remember to check [[<tvar|1>Special:Whatlinkshere/Module:Protection banner/doc</>|if anything links here]] and [<tvar

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

This module creates protection banners and padlock icons that are placed at the top of protected pages.

UsageEdit

Most users will not need to use this module directly. For adding protection templates to pages 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 wikitextEdit

{{#invoke:Protection banner|main
| 1        = reason
| small    = yes/no
| action   = action
| expiry   = expiry
| date     = protection date
| user     = username
| section  = talk page section name
| category = no
}}

The #invoke syntax can be used for creating protection templates more specific than {{pp}}. For example, it is possible to create a protection template which always shows a padlock icon by using the code {{#invoke:Protection banner|main|small=yes}}. Pages which call this template will still be able to use other arguments, like action and expiry. However, this only works one level deep; a page calling a template which calls another template containing the above code will not automatically be able to use parameters like action and expiry.

From LuaEdit

First, load the module.

local mProtectionBanner = require('Module:Protection banner')

Then you can make protection banners by using the _main function.

mProtectionBanner._main(args, cfg, titleObj)

args is an table of arguments to pass to the module. For possible keys and values for this table, see the parameters section. The cfg and titleObj variables are intended only for testing; cfg specifies a customised config table to use instead of Module:Protection banner/config, and titleObj specifies a mw.title object to use instead of the current title. args, cfg and titleObj are all optional.

ParametersEdit

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 "upload" (for upload protection). 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".

ReasonsEdit

The following table contains the available reasons, plus the actions for which they are available.

reasons table

ErrorsEdit

Below is a list of some of the common errors that this module can produce, and how to fix them.

Invalid expiryEdit

Error: invalid expiry ("abc")

This error is produced if you supply an |expiry= parameter value that is not recognised as a valid date by the #time parser function. If in doubt, you can just use a date in the format "dd Month YYYY", e.g. "21 November 2024". To see a full range of valid inputs, see the #time documentation (only the first parameter, the format string, may be specified).

Invalid protection dateEdit

Error: invalid protection date ("abc")

This error is produced if you supply an |date= parameter value that is not recognised as a valid date by the #time parser function. If in doubt, you can just use a date in the format "dd Month YYYY", e.g. "21 November 2024". To see a full range of valid inputs, see the #time documentation (only the first parameter, the format string, may be specified).

Invalid actionEdit

Error: invalid action ("abc")

This error is produced if you specify an invalid protection action. There are only three valid actions: edit (the default, for normal protection), move (for move-protection), and upload (for upload-protection). This should only be possible if you are using a template that supports manually specifying the protection action, such as {{pp}}, or if you are using #invoke directly. If this is not the case, please leave a message on Module talk:Protection banner.

Reasons cannot contain the pipe characterEdit

Error: reasons cannot contain the pipe character ("|")

This error is produced if you specify a reason using the |1= parameter that includes a pipe character ("|"). Please check that you are not entering the {{!}} template into this parameter by mistake. The pipe character is disallowed as the module uses it internally. A list of valid reasons can be seen in the reasons section.

Other errorsEdit

If you see an error other than the ones above, it is likely to either be a bug in the module or mistake in the configuration. Please post a message about it at Module talk:Protection banner.

Technical detailsEdit

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.