Module:Contentious topics talk banner/doc

This is a documentation subpage for Module:Contentious topics talk banner.
It may contain usage information, categories and other content that is not part of the original module page.

This template is within the jurisdiction of the Arbitration Committee, as one of its associated enforcement processes. Therefore, you must not make significant changes to the wording or functionality of this template without the Committee's consent. Thank you!

This module depends on the following other modules:

To learn about the template {{Contentious topics/talk notice}}, please see its documentation. 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

{{#invoke:Contentious topics talk banner|main}}

Technical details

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

Template:Contentious topics/Additional restrictions.json contains per-topic additional restrictions. The topic-wide restrictions apply whenever the corresponding CTOP code is given. The additional-available restrictions can be passed as parameters (e.g. |ECR=yes), and can be used either when a restriction is added to the topic's standard set or when it applies to all articles within a subtopic of the contentious topic designation.
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 Category: prefix). The following codes have special meaning:
- The all category activates for every page tagged with the contentious topic banner
- The bad-topic category is used whenever a contentious topic code is not found at Template:Contentious topics/list
- The no-date category is used when there are active, manually-placed restrictions but no |placed-date= is specified
- The no-topic category is used when no topics are specified
- The protection-error category is used when |protection=yes, but the page is not actually protected