Module:Protection banner/config: Difference between revisions

Module:Protection banner/config (edit)

Revision as of 13:32, 24 June 2014

9,032 bytes added , 11 years ago

use a new approach to the banner config, allowing more fine-grained control and less hopping around between parameter definitions

@@ Line 1: / Line 1: @@
 -- This module provides configuration data for [[Module:Protection banner]].
-local cfg, msg = {}, {}
+local cfg = {}
+--------------------------------------------------------------------------------
+-- Banner data
+--------------------------------------------------------------------------------
+--[[
+-- The following banner data fields are available:
+-- text, explanation, tooltip, alt, image, category
+--
+-- When the module is asked to retrieve one of these data fields, it looks in
+-- the cfg.bannerData table. It uses five properties in its search:
+-- 1. the expiry date
+-- 2. the namespace
+-- 3. the protection reason (e.g. "dispute" or "vandalism")
+-- 4. the protection level (e.g. "sysop" or "autoconfirmed")
+-- 5. the action (e.g. "edit" or "move")
+--
+-- For each data field, the module will check to see if the field exists in the
+-- table with the key corresponding to all five parameters. For example, a
+-- user page semi-protected from vandalism for two weeks would have the key
+-- "temp-user-vandalism-autoconfirmed-edit". If no match is found, the module
+-- changes the first part of the key to "all" and checks the table again. It
+-- keeps checking increasingly generic key combinations until it finds the
+-- field, or until it reaches the key "all-all-all-all-all".
+--
+-- This makes it possible to specify fine-grained distinctions in banner text.
+-- For example, data defined for the key "all-user-vandalism-all-edit" can be
+-- used for user pages that are protected either temporarily or permanently,
+-- and either fully protected or semi-protected, but it won't be used for
+-- articles or for pages protected against sockpuppetry.
+--
+-- Note that the fields don't have to be in the same table. A given banner
+-- might use text from "temp-user-vandalism-autoconfirmed-edit" but a
+-- category from "all-all-vandalism-all-edit".
+--
+-- The module uses a binary matrix to determine the order in which to search.
+-- This is best demonstrated by a table. In this table, the "0" values
+-- represent "all", and the "1" values represent the original data (e.g.
+-- "indef" or "file" or "vandalism").
+--
+--        expiry    namespace reason   level     action
+-- order
+-- 1      1         1         1        1         1
+-- 2      0         1         1        1         1
+-- 3      1         0         1        1         1
+-- 4      0         0         1        1         1
+-- 5      1         1         0        1         1
+-- 6      0         1         0        1         1
+-- 7      1         0         0        1         1
+-- 8      0         0         0        1         1
+-- 9      1         1         1        0         1
+-- 10     0         1         1        0         1
+-- 11     1         0         1        0         1
+-- 12     0         0         1        0         1
+-- 13     1         1         0        0         1
+-- 14     0         1         0        0         1
+-- 15     1         0         0        0         1
+-- 16     0         0         0        0         1
+-- 17     1         1         1        1         0
+-- 18     0         1         1        1         0
+-- 19     1         0         1        1         0
+-- 20     0         0         1        1         0
+-- 21     1         1         0        1         0
+-- 22     0         1         0        1         0
+-- 23     1         0         0        1         0
+-- 24     0         0         0        1         0
+-- 25     1         1         1        0         0
+-- 26     0         1         1        0         0
+-- 27     1         0         1        0         0
+-- 28     0         0         1        0         0
+-- 29     1         1         0        0         0
+-- 30     0         1         0        0         0
+-- 31     1         0         0        0         0
+-- 32     0         0         0        0         0
+--
+-- In this scheme the action has the highest priority, as it is the last
+-- to change, and the expiry has the least priority, as it changes the most.
+-- The priorities of the expiry, the protection level and the action are
+-- fixed, but the priorities of the reason and the namespace can be swapped
+-- through the use of the cfg.bannerDataNamespaceHasPriority table.
+--
+--
+--                          PARAMETERS
+--
+-- The values in the banner data can take parameters. These are specified
+-- using ${TEXTLIKETHIS} (a dollar sign preceding a parameter name
+-- enclosed in curly braces). Available parameters:
+--
+-- ${PAGETYPE} - the type of the page, e.g. "article" or "template".
+-- Defined in the cfg.pagetypes table.
+--
+--
+--]]
+cfg.bannerDataNamespaceHasPriority = {
+	-- If the reason specified to the template is listed in this table,
+	-- namespace data will take priority over reason data in the bannerData
+	-- table.
+	vandalism = true,
+}
+cfg.bannerDataNamespaceKeys = {
+	-- The string to use as a namespace key for bannerData for each
+	-- namespace number.
+	[  2] = 'user',
+	[  3] = 'user',
+	[  4] = 'project',
+	[  6] = 'file',
+	[ 10] = 'template',
+	[ 12] = 'project',
+	[ 14] = 'category',
+	[100] = 'po