Module:Political party/doc: Difference between revisions

From Wiki Balkavani
VisualWikitext
Created page with "{{Documentation subpage}} {{tsh|Colorbox|Colourbox|Colour box|Color square|Legend3}} {{For-text|the templates that display text in a colored box|{{tl|Divbox}} or Template:Mbox templates see also}} {{Uses TemplateStyles|Template:Legend/styles.css}} {{High-use}} <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE --> ==Usage== {{Format TemplateData|JSON= { "params": { "1": { "label": "Color", "description": "Background color of the box.", "example": "Gre..."
 
mNo edit summary
 
Line 1: Line 1:
{{Documentation subpage}}
{{Module rating|general}}
{{tsh|Colorbox|Colourbox|Colour box|Color square|Legend3}}
{{For-text|the templates that display text in a colored box|{{tl|Divbox}} or [[Template:Mbox templates see also]]}}
{{Uses TemplateStyles|Template:Legend/styles.css}}
{{High-use}}
{{High-use}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
{{Lua|Module:Arguments|Module:Delink}}


==Usage==
== Usage ==
{{Format TemplateData|JSON=
{{Mlx|{{BASEPAGENAME}}|fetch|<party>|<value>}}
{
"params": {
"1": {
"label": "Color",
"description": "Background color of the box.",
"example": "Green",
"type": "string",
"required": true,
"suggested": true
},
"2": {
"label": "Text",
"description": "Adds text inside the box; box is otherwise an empty square.",
"example": "Hello, world!",
"type": "string",
"suggested": true
},
"3": {
"label": "Text color",
"description": "Sets the color of the text inside the box.",
"example": "Yellow",
            "type": "string",
"suggested": true,
            "default": "Either black or white; whichever has greater contrast."
},
"border": {
            "label": "Border color",
"description": "Sets the color of the border around the box.",
"example": "#FF0",
            "type": "string",
            "default": "black"
}
},
"description": "<noexport><code>&#123;&#123;color box&#124;''color''&#124;''text''&#124;''text color''&#125;&#125;</code><br></noexport>Adds a rectangular color box. <ul><li>Colors are most commonly specified as either a color keyword or as the [[Web colors#Hex triplet|hexadecimal triplet]] representing an RGB combination.  See the article [[web colors]] for details.</li><li>If specified, the text is centered within the box.</li></ul>",
"format": "inline"
} }}


== Parameters ==
{{Transcluded section|source=Template:Political party/doc}}
{{Trim|{{#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 [[Module:Political party/L|/L]]). The [[Module:Political party/1|/1]] subpage is for any party that does not start with the letters A to Z of the [[Latin alphabet]] (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>.
===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>
local alternate = {
    ....
["Labour and Co-operative"] = "Labour Party (UK)",
["Labour Co-operative"] = "Labour Party (UK)",
    ...
}
</syntaxhighlight>
The first entry in square brackets is the alternate name, and the second entry only in quotes is the name found in the <code>full</code> 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 [[Module:Political party/A|/A]] even though it is an alternate name for "Democratic Party (US)" (which is stored in [[Module:Political party/D|/D]]).
=== Table values ===
<syntaxhighlight lang=lua>
local full = {
    ....
["Labour Party (UK)"] = {abbrev = "Lab", color = "#E4003B", shortname = "Labour",},
    ...
}
</syntaxhighlight>
There are three values stored for each party:
* The abbreviation (<code>abbrev</code>).
* The color of the party (<code>color</code>), which can either be a [[hex triplet]] or [[Web_colors#Basic colors|basic color name]] or, if the party does not have an associated color, "default".
* 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.
==Requesting an addition or a change ==
Requests should be made at the [[Module talk:Political party|talk page]] in a new section. Copy the following line and fill in {{em|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.
* <code>["party"] = {abbrev = "", color = "", shortname = "",},</code>
==Error messages==
{| class="wikitable"
{| class="wikitable"
|+ '''Examples'''
|+Module error messages and resolutions
!Error message
!Resolution
|-
|-
! Visual effect !! Markup
|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
|-
|-
| {{color box|Green}} || <code><nowiki>{{color box|Green}}</nowiki></code>
| Lua error in package.lua at line 80: module 'Module:Political party/' not found.
| Party added to alternate list with empty value.
|-
|-
| {{color box|Yellow|Default color for this text}} || <code><nowiki>{{color box|Yellow|Default color for this text}}</nowiki></code>
|Value not in template. Please request that it be added. ([https://en.wikipedia.org/w/index.php?search=%22Value+not+in+template.+Please+request+that+it+be+added.%22&title=Special:Search&profile=advanced&fulltext=1&ns0=1 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.)
|-
|-
| {{color box|Blue|Default color for this text}} || <code><nowiki>{{color box|Blue|Default color for this text}}</nowiki></code>
|(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).
|-
|-
| {{color box|SteelBlue|'''Using X11 color names'''|Gold}} || <code><nowiki>{{color box|SteelBlue|'''</nowiki>Using [[X11 color names]]<nowiki>'''|Gold}}</nowiki></code>
|parameter 1 should be a party name ([https://en.wikipedia.org/w/index.php?search=%22parameter+1+should+be+a+party+name%22&title=Special:Search&profile=advanced&fulltext=1&ns0=1&searchToken=6facepv07u1udc6gtrdi3x0fy article search])
| A template is trying to feed a missing parameter to the module. Work around this by [https://en.wikipedia.org/w/index.php?title=Template:Election_box_inline_candidate_with_party_link_no_change&action=history testing for the parameter] in the template.
|-
|-
| {{color box|#012345|''Using RGB hex triplets''|#FEDCBA}} || <code><nowiki>{{color box|#012345|''</nowiki>Using [[Web colors#Hex triplet|RGB hex triplet]]<nowiki>''|#FEDCBA}}</nowiki></code>
|parameter 2 should be the output type ([https://en.wikipedia.org/w/index.php?search=%22parameter+2+should+be+the+output+type%22&title=Special:Search&profile=advanced&fulltext=1&ns0=1 article search])
|
|-
|-
| {{color box|Yellow|Red|#f00|border=#f00}} || <code><nowiki>{{color box|Yellow|Red|#f00|border=#f00}}</nowiki></code>
|-
| {{color box|white|bordercolor like wikitable|border=#A2A9B1}} || <code><nowiki>{{color box|white|bordercolor like wikitable|border=#A2A9B1}} </nowiki></code>
|}
|}


== Variants ==
== Data pages ==
{{Color box templates}}
{{div col}}
 
*[[Module:Political party/1|Political party/1]]
== Supporting template ==
*[[Module:Political party/A|Political party/A]]
* {{tl|Greater color contrast ratio}}
*[[Module:Political party/B|Political party/B]]
 
*[[Module:Political party/C|Political party/C]]
== See also ==
*[[Module:Political party/D|Political party/D]]
* {{tl|Infobox color}}, an infobox for the detailed description of a color.
*[[Module:Political party/E|Political party/E]]
* {{tl|Legend}}
*[[Module:Political party/F|Political party/F]]
 
*[[Module:Political party/G|Political party/G]]
<includeonly>{{Sandbox other|
*[[Module:Political party/H|Political party/H]]
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
*[[Module:Political party/I|Political party/I]]
[[Category:Color templates]]
*[[Module:Political party/J|Political party/J]]
[[Category:Box templates]]
*[[Module:Political party/K|Political party/K]]
*[[Module:Political party/L|Political party/L]]
*[[Module:Political party/M|Political party/M]]
*[[Module:Political party/N|Political party/N]]
*[[Module:Political party/O|Political party/O]]
*[[Module:Political party/P|Political party/P]]
*[[Module:Political party/Q|Political party/Q]]
*[[Module:Political party/R|Political party/R]]
*[[Module:Political party/S|Political party/S]]
*[[Module:Political party/T|Political party/T]]
*[[Module:Political party/U|Political party/U]]
*[[Module:Political party/V|Political party/V]]
*[[Module:Political party/W|Political party/W]]
*[[Module:Political party/X|Political party/X]]
*[[Module:Political party/Y|Political party/Y]]
*[[Module:Political party/Z|Political party/Z]]
{{div col end}}
<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->


}}</includeonly>
}}</includeonly>

Latest revision as of 17:33, 2 October 2025

Template:Module rating Template:High-use Template:Lua

Usage

Template:Mlx

Parameters

Template:Transcluded section Template:Trim

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 the Latin alphabet (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): <syntaxhighlight lang=lua> local alternate = { 

   ....

["Labour and Co-operative"] = "Labour Party (UK)", ["Labour Co-operative"] = "Labour Party (UK)", 

   ...

} </syntaxhighlight> 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

<syntaxhighlight lang=lua> local full = { 

   ....

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

   ...

} </syntaxhighlight> 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 basic 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, 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 Template:Em 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

Template:Div col

Template:Div col end

Retrieved from "https://balkavanians.com/wiki/index.php?title=Module:Political_party/doc&oldid=791"