Module:Protection banner/doc: Difference between revisions

Revision as of 20:51, 2 August 2018

Latest revision as of 16:59, 4 September 2023

(24 intermediate revisions by 20 users not shown)

Line 1:

{{High-use|33000+}}

{{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 18 ⟶ 19:

| user = ''username''

| section = ''talk page section name''

| category = ''noyes''

}}

Line 29 ⟶ 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 45 ⟶ 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.

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

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

== Reasons ==

Line 67 ⟶ 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 92 ⟶ 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>