Module:Contentious topics/talk notice/doc: Difference between revisions

Revision as of 03:13, 29 May 2025

Latest revision as of 02:27, 27 July 2025

(6 intermediate revisions by the same user not shown)

Line 1:

{{Module rating|pre-alphabeta}}

{{ArbCom template}}

{{Lua|Module:SetArguments|Module:Check tofor listunknown parameters|Module:Format time|Module:TableTools|Module:Yesno|Module:Message box}}

<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->

<strong>To learn about the template {{t|Contentious topics/talk notice}}, please see [[Template:Contentious topics/talk notice/doc|its documentation]]</strong>. This page documents the technical details of the module. There is probably little of interest here unless you are an arbitrator or clerk (or you are curious how things work under the hood!).

== Usage ==

<code><nowikisyntaxhighlight lang="wikitext">{{</nowiki>#invoke:Contentious topics talk banner|''main''<nowiki>}}</nowikisyntaxhighlight></code> builds the contentious topic banner. Documentation soon to come.

== Technical details==

This module is designed to be [[extensible]] without needing to edit the module code. Much of its data come from the following [[JSON]] pages:

* [[Template:Contentious topics/Additional restrictions.json]] contains per-topic additional restrictions. The <code>topic-wide</code> restrictions apply whenever the corresponding CTOP code is given and applies to the entire page (i.e. there are no {{para|-section}} parameters). The <code>additional-available</code> restrictions can be passed as parameters (e.g. {{para|ECR|yes}}), and can be used either when a restriction is added to the topic's [[Wikipedia:Contentious topics#Standard set|standard set]] or when it applies to all articles within a subtopic of the contentious topic designation. If the contentious topic applies only to a section, the <code>topic-wide</code> behave like <code>additional-available</code> restrictions.

* [[Template:Contentious topics/Restrictions definition.json]] is the text of the bullet point indicating a restriction is active

* [[Template:Contentious topics/Standard set.json]] is a list of all standard set restrictions

* [[Template:Contentious topics/Category database.json]] is the name of the category added when a restriction is active (without the <code>Category:</code> prefix). The following codes have special meaning:

** The <code>all</code> category activates for every page tagged with the contentious topic banner

** The <code>bad-topic</code> category is used whenever a contentious topic code is not found at [[Template:Contentious topics/list]]

** The <code>no-date</code> category is used when there are active, manually-placed restrictions but no {{para|placed-date}} is specified

** The <code>no-topic</code> category is used when no topics are specified

** The <code>protection-error</code> category is used when {{para|protection|yes}}, but the page is not actually protected

** The <code>unknown</code> category is used when [[Module:Check for unknown parameters|unknown parameters]] are provided

<includeonly>{{Sandbox other||

<!-- Categories below this line; interwikis at Wikidata -->

[[Category:Standardised Wikipedia arbitration enforcement templates]]

}}</includeonly><noinclude>

<noinclude>

[[Category:Module documentation pages]]

</noinclude>