http://fispact.ukaea.uk/wiki/index.php?title=Module:Protection_banner/doc&feed=atom&action=historyModule:Protection banner/doc - Revision history2024-03-28T14:31:43ZRevision history for this page on the wikiMediaWiki 1.26.2http://fispact.ukaea.uk/wiki/index.php?title=Module:Protection_banner/doc&diff=471&oldid=prevMichael Fleming: 1 revision imported2016-12-19T13:08:27Z<p>1 revision imported</p>
<table class='diff diff-contentalign-left'>
<tr style='vertical-align: top;' lang='en'>
<td colspan='1' style="background-color: white; color:black; text-align: center;">← Older revision</td>
<td colspan='1' style="background-color: white; color:black; text-align: center;">Revision as of 13:08, 19 December 2016</td>
</tr><tr><td colspan='2' style='text-align: center;' lang='en'><div class="mw-diff-empty">(No difference)</div>
</td></tr></table>Michael Fleminghttp://fispact.ukaea.uk/wiki/index.php?title=Module:Protection_banner/doc&diff=470&oldid=prevDavidLeighEllis: Reverted edits by 182.232.145.72 (talk) (HG) (3.1.22)2016-11-19T00:37:52Z<p>Reverted edits by <a href="/wiki/Special:Contributions/182.232.145.72" title="Special:Contributions/182.232.145.72">182.232.145.72</a> (<a href="/wiki/index.php?title=User_talk:182.232.145.72&action=edit&redlink=1" class="new" title="User talk:182.232.145.72 (page does not exist)">talk</a>) (<a href="/wiki/index.php?title=WP:HG&action=edit&redlink=1" class="new" title="WP:HG (page does not exist)">HG</a>) (3.1.22)</p>
<p><b>New page</b></p><div>{{High-use|21000+}}<br />
{{Module rating|protected}}<br />
This module creates protection banners and padlock icons that are placed at the top of [[Help:Protection|protected pages]].<br />
<br />
== Usage ==<br />
<br />
Most users will not need to use this module directly. For adding protection templates to pages you can use the {{tl|pp}} template, or you may find it more convenient to use one of the more specific protection templates in the table below.<br />
<br />
{{protection templates}}<br />
<br />
=== From wikitext ===<br />
<br />
&#123;{#invoke:Protection banner|main<br />
| 1 = ''reason''<br />
| small = ''yes/no''<br />
| action = ''action''<br />
| date = ''protection date''<br />
| user = ''username''<br />
| section = ''talk page section name''<br />
| category = ''no''<br />
}&#125;<br />
<br />
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''. 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''.<br />
<br />
'''''Note:''' You should no longer specify the expiry, as it is automatically retrieved in all cases.''<br />
<br />
=== From Lua ===<br />
<br />
First, load the module.<br />
<br />
<source lang="lua"><br />
local mProtectionBanner = require('Module:Protection banner')<br />
</source><br />
<br />
Then you can make protection banners by using the _main function.<br />
<br />
<source lang="lua"><br />
mProtectionBanner._main(args, cfg, titleObj)<br />
</source><br />
<br />
<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.<br />
<br />
== Parameters ==<br />
<br />
All parameters are optional.<br />
<br />
* '''1''' - the reason that the page was protected. If set, this must be one of the values listed in the [[#Reasons|reasons table]].<br />
* '''small''' - if set to "yes", "y", "1", or "true", a padlock icon is generated instead of a full protection banner.<br />
* '''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".<br />
* '''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.<br />
* '''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.<br />
* '''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''.<br />
* '''category''' - categories are suppressed if this is set to "no", "n", "0", or "false".<br />
<br />
== Reasons ==<br />
<br />
The following table contains the available reasons, plus the actions for which they are available.<br />
<br />
{{#invoke:Protection banner/documentation|reasonTable}}<br />
<br />
== Errors ==<br />
<br />
Below is a list of some of the common errors that this module can produce, and how to fix them.<br />
<br />
=== Invalid protection date ===<br />
<br />
{{error|Error: invalid protection date ("abc")}}<br />
<br />
This error is produced if you supply an {{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).<br />
<br />
=== Invalid action ===<br />
<br />
{{error|Error: invalid action ("abc")}}<br />
<br />
This error is produced if you specify an invalid protection action. There are only three valid actions: <code>edit</code> (the default, for normal protection), <code>move</code> (for move-protection), and <code>autoreview</code> (for [[WP:PC|pending changes]]). This should only be possible if you are using a template that supports manually specifying the protection action, such as {{tl|pp}}, or if you are using #invoke directly. If this is not the case, please leave a message on [[Module talk:Protection banner]].<br />
<br />
=== Reasons cannot contain the pipe character ===<br />
<br />
{{error|Error: reasons cannot contain the pipe character ("&#124;")}}<br />
<br />
This error is produced if you specify a reason using the {{para|1}} parameter that includes a pipe character ("&#124;"). Please check that you are not entering the {{tl|!}} 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|reasons section]].<br />
<br />
=== Other errors ===<br />
<br />
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]].<br />
<br />
== Technical details ==<br />
<br />
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.<br />
<br />
General test cases for the module can be found at [[w:en:Module:Protection banner/testcases|Module:Protection banner/testcases]], and test cases specific to enwiki's config can be found at [[w:en:Module:Protection banner/config/testcases|Module:Protection banner/config/testcases]].<br />
<br />
Bug reports and feature requests should be made on [[w:en:Module talk:Protection banner|the module's talk page]].<br />
<br />
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||<br />
<!-- Categories go here and interwikis go in Wikidata. --><br />
<br />
}}</includeonly></div>DavidLeighEllis