Module:Political party/doc: Difference between revisions

Jump to navigation Jump to search
(move: seems clearer there)
 
m (1 revision imported)
 
(2 intermediate revisions by 2 users not shown)
Line 13: Line 13:
The political parties contained in this module are split into alphabetised lists based on the first character of the name (for example, "Labour Party (UK)" would be under [[Module:Political party/L|/L]]). The [[Module:Political party/1|/1]] subpage is for any party that does not start with the western letters A-Z (including numbers and accented characters).
The political parties contained in this module are split into alphabetised lists based on the first character of the name (for example, "Labour Party (UK)" would be under [[Module:Political party/L|/L]]). The [[Module:Political party/1|/1]] subpage is for any party that does not start with the western letters A-Z (including numbers and accented characters).


Within each data submodule are two local groups: <code lang=lua>local alternate</code> and <code lang=lua>local full</code>. The alternate group is for alternate names of a party. The following is an example of alternate names for the [[Labour Party (UK)]]:
Within each data submodule are two local groups: <code lang=lua>local alternate</code> and <code lang=lua>local full</code>.  
===Alternate party names===
The alternate group is for alternate names of a party. The following is an example of alternate names for the [[Labour Party (UK)]]:
<syntaxhighlight lang=lua>
<syntaxhighlight lang=lua>
local alternate = {
local alternate = {
Line 36: Line 38:
* The color of the party (<code>color</code>), which can either be a [[hex triplet]] or a [[Web_colors#Basic colors|basic color name]].
* The color of the party (<code>color</code>), which can either be a [[hex triplet]] or a [[Web_colors#Basic colors|basic color name]].
* A shorter name for the party (<code>shortname</code>).
* A shorter name for the party (<code>shortname</code>).
The values added to these parameters need not be unique from other parties in this module, unlike the primary name of a party.


If a name value is not stored for a party, the module will attempt to return the other "short" name variant before returning the input. Thus, if <code>abbrev</code> is stored but <code>shortname</code> is not, regardless of which value is asked for it will return the <code>abbrev</code> value.
If a name value is not stored for a party, the module will attempt to return the other "short" name variant before returning the input. Thus, if <code>abbrev</code> is stored but <code>shortname</code> is not, regardless of which value is asked for it will return the <code>abbrev</code> value.

Latest revision as of 19:02, 17 February 2024

Usage

Template:Mlx

Parameters

{{#section:Template:Political party/doc|Parameters}}

Updating the module

The political parties contained in this module are split into alphabetised lists based on the first character of the name (for example, "Labour Party (UK)" would be under /L). The /1 subpage is for any party that does not start with the western letters A-Z (including numbers and accented characters).

Within each data submodule are two local groups: local alternate and local full.

Alternate party names

The alternate group is for alternate names of a party. The following is an example of alternate names for the Labour Party (UK):

local alternate = {
    ....
	["Labour and Co-operative"] = "Labour Party (UK)",
	["Labour Co-operative"] = "Labour Party (UK)",
    ...
}

The first entry in square brackets is the alternate name, and the second entry only in quotes is the name found in the full group, seen below. Note that the alternate name of a party should be stored in its corresponding letter-based subpage; "Alabama Democratic Party" is listed in /A even though it is an alternate name for "Democratic Party (US)" (which is stored in /D).

Table values

local full = {
    ....
	["Labour Party (UK)"] = {abbrev = "Lab", color = "#E4003B", shortname = "Labour",},
    ...
}

There are three values stored for each party:

  • The abbreviation (abbrev).
  • The color of the party (color), which can either be a hex triplet or a basic color name.
  • A shorter name for the party (shortname).

The values added to these parameters need not be unique from other parties in this module, unlike the primary name of a party.

If a name value is not stored for a party, the module will attempt to return the other "short" name variant before returning the input. Thus, if abbrev is stored but shortname is not, regardless of which value is asked for it will return the abbrev value.

Requesting an addition or a change

Requests should be made at the talk page in a new section. Copy the following line and fill in only the fields relevant to the party. A party name is required as is at least one other piece of information. See above for information regarding each value.

  • ["party"] = {abbrev = "", color = "", shortname = "",},

Error messages

Module error messages and resolutions
Error message Resolution
Lua error: bad argument #1 to 'sub' (string expected, got table). An entry intended for the "local full" section has been placed into the "local alternate" section. Move it to the "local full" section
Lua error in package.lua at line 80: module 'Module:Political party/' not found. Party added to alternate list with empty value.
Value not in template. Please request that it be added. (article search) The party in question has an entry with no color in the "local full" section. (This can be caused by duplicate entries in "local full" that, if present, should be merged.)
(no error message, but party color is white/blank) Add a color for the party to its entry in the "local full" section in the relevant Module:Political party/ lettered data page (see links below).
parameter 1 should be a party name (article search) A template is trying to feed a missing parameter to the module. Work around this by testing for the parameter in the template.
parameter 2 should be the output type (article search)

Data pages