Editing Module:WikiProjectBanner/Context/doc (section)

== Usage ==

Load the Context class:

<syntaxhighlight lang="lua">
local Context = require('Module:WikiProjectBanner/Context')
</syntaxhighlight>

Once the class is loaded, initialise a context object:

<syntaxhighlight lang="lua">
local contextObj = Context.new(bannerName, args, cfg, bannerCfg)
</syntaxhighlight>

* <var>bannerName</var> is the name of the banner template we were called from, minus the "Template:" prefix. Often this is the full project name, e.g. "WikiProject Tulips". This parameter is required.
* <var>args</var> is a table representing the arguments passed to the banner template by end users. This is optional.
* <var>cfg</var> is a config module to use instead of the default module. This is optional, and usually only used for testing.
* <var>bannerCfg</var> is a banner config module to use instead of the one at Module:WikiProjectBanner/banners/''bannerName''. This is optional, and usually only used for testing.