This module is rated asready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved bysandbox testing rather than repeated trial-and-error editing.
This module issubject to page protection. It is ahighly visible module in use by a very large number of pages, or issubstituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it isprotected from editing.
This Lua module is used onapproximately 139,000 pages. To avoid major disruption and server load, any changes should be tested in the module's/sandbox or/testcases subpages, or in your ownmodule sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on thetalk page before implementing them.
This module depends on the following other modules:
The political party's name. If a party is not found, place a request at thetalk page.
error
Optional, this parameter will return the provided|error= value if the module does not contain the requested party or color.
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 letters A to Z of theLatin alphabet (including numbers and accented characters).
Within each data submodule are two local groups:local alternate andlocal full.
Alternate party names
The alternate group is for alternate names of a party. The following is an example of alternate names for theLabour Party (UK):
localalternate={....["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 thefull 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
localfull={....["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 ahex triplet orbasic color name or, if the party does not have an associated color, "default".
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, ifabbrev is stored butshortname is not, regardless of which value is asked for it will return theabbrev value.
Requesting an addition or a change
Requests should be made at thetalk page in a new section. Copy the following line and fill inonly 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.
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).
localp={}localdefault_color='#F8F9FA'localcategories={party_not_in_list='[[Category:Pages using Political party with unknown party]]',shortname_not_in_list='[[Category:Pages using Political party with missing shortname]]',color_not_in_list='[[Category:Pages using Political party with missing color]]',}localfunctioncreate_error(error_message)returnstring.format('<strong>%s</strong>',error_message)endlocalfunctiongetFirstLetter(party)localindex=mw.ustring.sub(party,1,1)-- Set index for non-A-Z startsifstring.match(index,'%A')thenreturn'1'endreturnstring.upper(index)endlocalfunctionstripToNil(text)-- If text is a string, return its trimmed content, or nil if empty.-- Otherwise return text (which may, for example, be nil).iftype(text)=='string'thentext=text:match('(%S.-)%s*$')localdelink=require('Module:Delink')._delinktext=delink({text,wikilinks="target"})endreturntextend-- Example of having all the data - color and names - in one table. Requires one page to be edited instead of two when adding a new party.functionp._fetch(args)ifnotargs[1]thenreturncreate_error("parameter 1 should be a party name.")endifnotargs[2]thenreturncreate_error("parameter 2 should be the output type.")endlocalparty=stripToNil(args[1])localout_type=stripToNil(args[2])ifout_type=='colour'thenout_type='color'endlocalindex=getFirstLetter(party)-- Load data from submodulelocaldata=mw.loadData('Module:Political party/'..index)localdata_all=data.fulllocalparty_alt=data.alternate[party]localparty_infoifparty_altthenifdata_all[party_alt]thenparty_info=data_all[party_alt]elseindex=getFirstLetter(party_alt)data=mw.loadData('Module:Political party/'..index)party_info=data.full[party_alt]endelseparty_info=data_all[party]end-- Check if database value exists-- * Not even in database - return given error or input-- * No color - return error-- * No shortname/abbrev - return first non-blank of abbrev->shortname->inputifnotparty_infothenifout_type=='color'thenreturnargs.errorordefault_colorelsereturnargs.errororpartyendendlocalreturn_value=party_info[out_type]ifreturn_value==""thenifout_type=='color'thenreturnargs.errororcreate_error("Value not in template. Please request that it be added.")elseifout_type=='abbrev'thenifparty_info.shortname~=""thenreturnparty_info.shortnameelsereturnpartyendelseifout_type=='shortname'thenifparty_info.abbrev~=""thenreturnparty_info.abbrevelsereturnpartyendelsereturnpartyendendifout_type=='color'thenifstring.find(return_value,'#')thenreturn_value=string.gsub(return_value,'#','#')elseifstring.lower(return_value)=='default'thenreturndefault_colorendendreturnreturn_valueendfunctionp.fetch(frame)-- Initialise and populate variableslocalgetArgs=require("Module:Arguments").getArgslocalargs=getArgs(frame)returnp._fetch(args)endreturnp
