Editing Module:Protection banner/doc (section)

== Usage ==

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.

{{protection templates}}

=== From wikitext ===

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

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

'''''Note:''' You should no longer specify the expiry, as it is automatically retrieved in all cases.''

=== From Lua ===

First, load the module.

<syntaxhighlight lang="lua">
local mProtectionBanner = require('Module:Protection banner')
</syntaxhighlight>

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

<syntaxhighlight lang="lua">
mProtectionBanner._main(args, cfg, titleObj)
</syntaxhighlight>

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