Editing Module:WikiProjectBanner/Context/doc

This module provides the Context class for [[Module:WikiProjectBanner]]. It stores data about the title we are being called from, provides access  to the config and banner config modules, generates data commonly used by subclasses (e.g. project name), and provides a place to store data generated by subclasses that needs to be reused (e.g. Grade objects). This data is separate from the Banner class so that we can accurately generate documentation and JSON data about a banner without having to have a banner object available.

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

== Properties ==

Context objects have several properties.

Arguments
* args - the arguments that end users pass to banner templates, represented as a Lua table.

Configuration tables:
* cfg - the configuration table for all WikiProject banners.
* bannerCfg - the configuration table for the specific banner being generated.

Title data:
* currentTitle - the Scribunto title object for the page currently being displayed.
* subjectTitle - the Scribunto title object for the subject page of the page currently being displayed. For example, if the page currently being viewed was "Talk:Tulips", the subject page would be "Tulips".

Project data:
* bannerName - the name of the banner being generated, e.g. "WikiProject Tulips".
* project - the project name, e.g. "Tulips".
* projectLink - a link to the project page, without square brackets, e.g. "Wikipedia:WikiProject Tulips".
* projectName - the name of the project, without a namespace prefix, e.g. "WikiProject Tulips". This may not be the same as bannerName.
* projectScope - a link to an article defining the project's scope, *with* square brackets, e.g. "<nowiki>[[Tulips]]</nowiki>".
* projectLinkTalk - a link to the project talk page, without square brackets, e.g. "Wikipedia talk:WikiProject Tulips".
* assessmentLink - the page containing the project's assessment scales, without square brackets, e.g. "Wikipedia:WikiProject Tulips/Assessment".

Display data:
* isSmall - whether we are outputting a small banner. (boolean)
* isDemo - whether we are outputting a demonstration banner. (boolean)