Module:Protection banner/doc: Difference between revisions

Revision as of 23:10, 22 July 2016

Latest revision as of 16:59, 4 September 2023

(30 intermediate revisions by 24 users not shown)

Line 1:

{{High-use|21000+}}

{{Module rating|protected}}

{{Lua|Module:Protection banner/config|Module:File link|Module:Effective protection level|Module:Effective protection expiry|Module:Yesno|Module:Arguments|Module:Message box|Module:Submit an edit request}}

This module creates protection banners and padlock icons that are placed at the top of [[Help:Protection|protected pages]].

Line 15 ⟶ 16:

| small = ''yes/no''

| action = ''action''

| expiry = ''expiry'' (only for action = 'autoreview')

| date = ''protection date''

| user = ''username''

| section = ''talk page section name''

| category = ''noyes''

}}

The #invoke syntax can be used for creating protection templates more specific than {{tl|pp}}. For example, it is possible to create a protection template which always shows a padlock icon by using the code <code><nowiki>{{#invoke:Protection banner|main|small=yes}}</nowiki></code>. 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''.

'''''Note:''' You needshould tono longer specify the expiry only for pending changes, i.e. action = 'autoreview', as it is automatically retrieved in otherall cases.''

=== From Lua ===

Line 30:

First, load the module.

<sourcesyntaxhighlight lang="lua">

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

</syntaxhighlight>

</source>

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

<sourcesyntaxhighlight lang="lua">

mProtectionBanner._main(args, cfg, titleObj)

</syntaxhighlight>

</source>

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

Line 46:

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|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 [[mw:Help:Extension:ParserFunctions##time|#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.

* '''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 [[mw:Help:Extension:ParserFunctions##time|#time parser function]].

* '''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.

* '''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 has an effect for reasons that use the PROTECTIONDATE parameter in their configuration. As of July 2014, those were the "office" and "reset" reasons.

* '''usersection''' -– the usernamesection name of the userprotected topage's generatetalk linkspage for.where Asdiscussion ofis Julytaking 2014,place. thisThis onlyworks hasfor anmost, effectbut whennot theall, "usertalk"values reasonof is specified''reason''.

* '''category''' -– categories are suppressed if this is set to "no", "n", "0", or "false".

* '''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''.

* '''catonly''' – if set to "yes", "y", "1", or "true", will only return the protection categories, and not return the banner or padlock. This has no visible output.

* '''category''' - categories are suppressed if this is set to "no", "n", "0", or "false".

== Reasons ==

Line 64:

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

=== Invalid expiry ===

{{error|Error: invalid expiry ("abc")}}

This error is produced if you supply an {{para|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. "{{#time:j F Y|+ 1 week}}". To see a full range of valid inputs, see the [[mw:Help:Extension:ParserFunctions##time|#time documentation]] (only the first parameter, the ''format string'', may be specified).

You do not need to specify the expiry except for pending changes, as it is automatically retrieved.

=== Invalid protection date ===

Line 77 ⟶ 69:

{{error|Error: invalid protection date ("abc")}}

This error is produced if you supply ana {{para|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. "{{#time:j F Y|+ 1 week}}". To see a full range of valid inputs, see the [[mw:Help:Extension:ParserFunctions##time|#time documentation]] (only the first parameter, the ''format string'', may be specified).

=== Invalid action ===

Line 102 ⟶ 94:

Bug reports and feature requests should be made on [[w:en:Module talk:Protection banner|the module's talk page]].

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||

<!-- Categories go here and interwikis go in Wikidata. -->

}}</includeonly>