Module:Contentious topics/talk notice

Module documentation[view] [edit] [history] [purge]

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 come 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 and applies to the entire page (i.e. there are no |-section= parameters). 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. If the contentious topic applies only to a section, the topic-wide behave like additional-available 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 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
  • The unknown category is used when unknown parameters are provided

The above documentation is transcluded from Module:Contentious topics/talk notice/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit) pages.
Subpages of this module.

local p = {}

-- Maps normalized topic names to sub-template names (special cases)
local topicMap = {
    aa2 = 'Contentious topics/Armenia-Azerbaijan talk notice',
    ['a-a'] = 'Contentious topics/Armenia-Azerbaijan talk notice',
    ['a-i'] = 'Contentious topics/Arab-Israeli talk notice',
    gmo = 'Contentious topics/gmo talk notice',
    tt = 'Contentious topics/The Troubles talk notice',
}

local function collectTopics(args)
    local seen = {}
    local topics = {}

    local function addTopic(value)
        if value then
            value = mw.text.trim(value)
            if value ~= '' and not seen[value] then
                seen[value] = true
                table.insert(topics, value)
            end
        end
    end

    addTopic(args.topic)
    addTopic(args.t)
    addTopic(args[1])
    for i = 2, 10 do
        addTopic(args[i])
    end

    return topics
end

function p.main(frame)
    local args = frame:getParent().args
    local topics = collectTopics(args)
    local specialTopics = {}
    local otherTopics = {}

    for _, topic in ipairs(topics) do
        if topicMap[topic] then
            table.insert(specialTopics, topic)
        else
            table.insert(otherTopics, topic)
        end
    end

    local output = {}

    -- Render special topics individually
    for _, topic in ipairs(specialTopics) do
        table.insert(output, frame:expandTemplate{
            title = 'Template wrapper',
            args = {['_template'] = topicMap[topic]}
        })
    end

    -- Render all other topics combined using the base template
    if #otherTopics > 0 then
        local baseArgs = {
            _template = 'Contentious topics/page restriction talk notice base',
            topic = table.concat(otherTopics, ','),
            protection = args.protection,
            ['0RR'] = args['0RR'],
            ['1RR'] = args['1RR'],
            ['consensus-required'] = args['consensus-required'],
            BRD = args.BRD,
            other = args.other,
            ['placed-date'] = args['placed-date'],
            nocat = args.nocat,
            small = args.small,
        }
        table.insert(output, frame:expandTemplate{
            title = 'Template wrapper',
            args = baseArgs
        })
    end

    return table.concat(output, '\n')
end

return p