Difference between revisions of "Template:Infobox constituency/doc"

From blackwiki
Jump to navigation Jump to search
imported>AquaDTRS
(updated documentation)
imported>AquaDTRS
(→‎Parameters: converted to TemplateData)
Line 176: Line 176:
 
</pre>
 
</pre>
  
−
== Parameters ==
+
== TemplateData ==
−
The following are parameters used in the infobox:
+
{{TemplateData header}}
−
{| class="wikitable"
+
<templatedata>
−
|-
+
{
−
! Parameter !! Description
+
"params": {
−
|-
+
"name": {
−
|<code>name</code>|| The name of the electoral district.
+
"description": "The name of the electoral district",
−
|-
+
"type": "string",
−
|<code>type</code>|| The type of electoral district.
+
"required": true
−
|-
+
},
−
|<code>constituency_link</code>|| The wikilink to the constituency.
+
"abolished": {
−
|-
+
"description": "The year the constituency was abolished. If the parameter is used, the infobox header will include the word 'Former'. "
−
|<code>parl_name</code>|| The wikilinked name of the Parliament.
+
},
−
|-
+
"type": {
−
|<code>map1, map2, map3, map4</code>
+
"description": "The type of electoral district",
−
| Filename of map images. Up to 4 maps can be displayed.
+
"suggested": true
−
|-
+
},
−
|<code>map_size</code>|| The map size in pixels.
+
"parl_name": {
−
|-
+
"description": "The wikilinked name of the Parliament.",
−
|<code>map_year</code>|| The year the map boundaries were drawn for a general election.
+
"suggested": true,
−
|-
+
"label": "Parliament name"
−
|<code>image, image2, image3, image4</code>
+
},
−
| Filename of images. Up to 4 images can be displayed.
+
"map1": {
−
|-
+
"description": "Filename of map ending with Constituency.svg",
−
|<code>image_size</code>|| The image size in pixels.
+
"type": "string",
−
|-
+
"suggested": true,
−
|<code>caption, caption2, caption3, caption4</code>
+
"label": "Map name 1"
−
| Caption for the displayed images.
+
},
−
|-
+
"map_size": {
−
|<code>district_label</code>||(optional) A replacement label for the <code>district</code> parameter, otherwise shows as 'District'.
+
"description": "The map size in pixels",
−
|-
+
"label": "Map size"
−
|<code>district</code>
+
},
−
| The district(s) in which the constituency is located at.
+
"image": {
−
|-
+
"description": "Full filename of a map image",
−
|<code>region_label</code>
+
"type": "wiki-file-name",
−
| (optional) A replacement label for the <code>region</code> parameter, otherwise shows as 'Region'.
+
"label": "Image 1"
−
|-
+
},
−
|<code>region</code>|| The region, state or province in which the constituency is located at.
+
"image_size": {
−
|-
+
"description": "The map image size in pixels",
−
|<code>population</code>
+
"label": "Image size"
−
| The total population within the constituency.
+
},
−
|-
+
"map_entity": {
−
|<code>electorate</code>
+
"description": "The location of a specified entity on a map",
−
| The number of eligible voters within the constituency.
+
"type": "string",
−
|-
+
"label": "Map entity"
−
|<code>towns</code>|| A list of towns within the constituency.
+
},
−
|-
+
"map_year": {
−
|<code>future</code>
+
"description": "The year of the general election in which the map boundaries were drawn",
−
| (optional) If set to any value, the sub-header will display as 'Future constituency'.
+
"type": "number",
−
|-
+
"label": "Map year"
−
|<code>year</code>
+
},
−
| The year the constituency was first established.
+
"caption": {
−
|-
+
"description": "Caption for map/image 1",
−
|<code>abolished_label</code>|| (optional) A replacement label for the <code>abolished</code> parameter, otherwise shows as 'Abolished'.
+
"label": "Caption 1"
−
|-
+
},
−
|<code>abolished</code>
+
"map2": {
−
| The year the constituency was abolished. If the parameter is used, the infobox header will include the word 'Former'.
+
"label": "Map name 2",
−
|-
+
"description": "Filename of map ending with .svg",
−
|<code>members_label</code>
+
"type": "string"
−
| (optional) A replacement label for the <code>members</code> parameter, otherwise shows as 'Member(s)'.
+
},
−
|-
+
"image2": {
−
|<code>members</code>|| The number of people governing the constituency.
+
"label": "Image 2",
−
|-
+
"description": "Full filename of a map image",
−
|<code>seats</code>
+
"type": "wiki-file-name"
−
| The number of seats in Parliament represented by the constituency.
+
},
−
|-
+
"region": {
−
|<code>elects_howmany</code>
+
"description": "The region, state or province in which the constituency is located at. "
−
| The number of people elected to Parliament by the constituency.
+
},
−
|-
+
"caption2": {
−
|<code>party_label</code>
+
"label": "Caption 2",
−
|(optional) A replacement label for the <code>party</code> parameter, otherwise shows as 'Party'.
+
"description": "Caption for map/image 2"
−
|-
+
},
−
|<code>party</code>
+
"map3": {
−
| The governing party of the electoral district.
+
"label": "Map name 3",
−
|-
+
"description": "Filename of map ending with .svg",
−
|<code>local_council_label</code>
+
"type": "string"
−
| (optional) A replacement label for the <code>local_council</code> parameter, otherwise shows as 'Local council'.
+
},
−
|-
+
"image3": {
−
|<code>local_council</code>|| The name of the local council or office in charge of the constituency.
+
"label": "Image 3",
−
|-
+
"description": "Full filename of a map image",
−
|<code>previous</code>
+
"type": "wiki-file-name"
−
| The name of the previous electoral district in which the current electoral district was carved out or merged from.
+
},
−
|-
+
"caption3": {
−
|<code>next</code>
+
"label": "Caption 3",
−
| The name of the new electoral district carved out or merged from the current electoral district.
+
"description": "Caption for map/image 3"
−
|-
+
},
−
|<code>blank1_name, blank2_name, blank3_name, blank4_name</code>|| (optional) Labels for the extra parameters.
+
"map4": {
−
|-
+
"label": "Map name 4",
−
|<code>blank1_info, blank2_info, blank3_info, blank4_info</code>|| (optional) Extra parameters.
+
"description": "Filename of map",
−
|-
+
"type": "string"
−
|}
+
},
 +
"image4": {
 +
"label": "Image 4",
 +
"description": "Full filename of a map image",
 +
"type": "wiki-file-name"
 +
},
 +
"caption4": {
 +
"label": "Caption 4",
 +
"description": "Caption for map/image 4"
 +
},
 +
"district_label": {
 +
"label": "District Label",
 +
"description": "Label for the district parameter, otherwise shows as 'District'. "
 +
},
 +
"district": {
 +
"description": "The district(s) in which the constituency is located at. "
 +
},
 +
"region_label": {
 +
"description": "Label for the region parameter, otherwise shows as 'Region'. ",
 +
"label": "Region Label"
 +
},
 +
"polling_divisions": {
 +
"label": "Polling divisions",
 +
"description": "Name of the polling divisions"
 +
},
 +
"population": {
 +
"description": "The total population within the constituency. "
 +
},
 +
"electorate": {
 +
"description": "The number of eligible voters within the constituency. ",
 +
"suggested": true
 +
},
 +
"towns": {
 +
"description": "Major settlements near the constituency",
 +
"label": "Major settlements"
 +
},
 +
"future": {
 +
"description": "If set to any value, the sub-header will display as 'Future constituency'. ",
 +
"label": "Future?"
 +
},
 +
"year": {
 +
"description": "The year the constituency was first established.",
 +
"type": "number"
 +
},
 +
"abolished_label": {
 +
"description": "Label for the abolished parameter, otherwise shows as 'Abolished'. ",
 +
"label": "Abolished Label"
 +
},
 +
"seats": {
 +
"description": "(replaces Number of members) The number of seats in Parliament represented by the constituency. ",
 +
"suggested": true,
 +
"label": "Seats"
 +
},
 +
"party_label": {
 +
"description": "Label for the party parameter, otherwise shows as 'Party'. ",
 +
"label": "Party Label"
 +
},
 +
"party": {
 +
"description": "The governing party of the electoral district.",
 +
"suggested": true,
 +
"label": "Party"
 +
},
 +
"member_label": {
 +
"aliases": [
 +
"members_label"
 +
],
 +
"description": "Label for the members parameter, otherwise shows as 'Member(s)'.",
 +
"label": "Member(s) Label"
 +
},
 +
"member": {
 +
"aliases": [
 +
"members"
 +
],
 +
"description": "The number of people governing the constituency.",
 +
"label": "Member(s)"
 +
},
 +
"local_council_label": {
 +
"description": "Label for the local_council parameter, otherwise shows as 'Local council'. ",
 +
"label": "Local council label"
 +
},
 +
"local_council": {
 +
"description": "The name of the local council or office in charge of the constituency. ",
 +
"label": "Local council"
 +
},
 +
"parts_label": {
 +
"label": "Subdivisions label",
 +
"description": "Label for the parts parameter, otherwise shows as 'Subdivisions'. "
 +
},
 +
"parts": {
 +
"label": "Subdivisions",
 +
"description": "Name of subdivisions"
 +
},
 +
"previous": {
 +
"description": "The name of the previous electoral district in which the current electoral district was carved out or merged from. ",
 +
"label": "Created from"
 +
},
 +
"next": {
 +
"description": "The name of the new electoral district carved out or merged from the current electoral district.",
 +
"label": "Replaced by"
 +
},
 +
"blank1_name": {
 +
"description": "Label for extra parameter 1",
 +
"label": "Extra parameter 1 name"
 +
},
 +
"blank1_info": {
 +
"description": "Extra parameter 1",
 +
"label": "Extra parameter 1"
 +
},
 +
"blank2_name": {
 +
"description": "Label for extra parameter 2",
 +
"label": "Extra parameter 2 name"
 +
},
 +
"blank2_info": {
 +
"description": "Extra parameter 2",
 +
"label": "Extra parameter 2"
 +
},
 +
"blank3_name": {
 +
"description": "Label for extra parameter 3",
 +
"label": "Extra parameter 3 name"
 +
},
 +
"blank3_info": {
 +
"description": "Extra parameter 3",
 +
"label": "Extra parameter 4"
 +
},
 +
"blank4_name": {
 +
"description": "Label for extra parameter 4",
 +
"label": "Extra parameter 4 name"
 +
},
 +
"blank4_info": {
 +
"description": "Extra parameter 4",
 +
"label": "Extra parameter 4"
 +
},
 +
"blank5_name": {
 +
"description": "Label for extra parameter 5",
 +
"label": "Extra parameter 5 name"
 +
},
 +
"blank5_info": {
 +
"label": "Extra parameter 5",
 +
"description": "Extra parameter 5"
 +
},
 +
"constituency_link": {
 +
"description": "The wikilink to the constituency",
 +
"label": "Constitutency wikilink"
 +
},
 +
"elects_howmany": {
 +
"label": "Number of members",
 +
"description": "The number of people elected to Parliament by the constitutency."
 +
},
 +
"area": {
 +
"description": "The area of the constituency",
 +
"example": "100 square kilometres"
 +
},
 +
"nativename": {
 +
"label": "Native name",
 +
"description": "The native name of the constitutency"
 +
}
 +
},
 +
"paramOrder": [
 +
"name",
 +
"nativename",
 +
"type",
 +
"constituency_link",
 +
"parl_name",
 +
"map1",
 +
"map2",
 +
"map3",
 +
"map4",
 +
"map_size",
 +
"map_entity",
 +
"map_year",
 +
"image",
 +
"image2",
 +
"image3",
 +
"image4",
 +
"image_size",
 +
"caption",
 +
"caption2",
 +
"caption3",
 +
"caption4",
 +
"district_label",
 +
"district",
 +
"region_label",
 +
"region",
 +
"polling_divisions",
 +
"population",
 +
"electorate",
 +
"towns",
 +
"area",
 +
"future",
 +
"year",
 +
"abolished_label",
 +
"abolished",
 +
"elects_howmany",
 +
"seats",
 +
"party_label",
 +
"party",
 +
"member_label",
 +
"member",
 +
"local_council_label",
 +
"local_council",
 +
"parts_label",
 +
"parts",
 +
"previous",
 +
"next",
 +
"blank1_name",
 +
"blank1_info",
 +
"blank2_name",
 +
"blank2_info",
 +
"blank3_name",
 +
"blank3_info",
 +
"blank4_name",
 +
"blank4_info",
 +
"blank5_name",
 +
"blank5_info"
 +
]
 +
}
 +
</templatedata>
  
 
== Example ==
 
== Example ==

Revision as of 20:33, 4 July 2020

This template is used to provide an infobox for electoral districts.

Usage

Basic Version

This is a basic version of the template that is suitable for general use; most optional parameters have been removed. Template:Parameter names example 

{{Infobox constituency
|name              = 
|type              = 
|constituency_link = 
|parl_name         = <!-- name of the law making body -->
|map1              = 
|map_size          = 
|image             = 
|image_size        =
|map_entity        = 
|map_year          = 
|caption           = 
|district          = 
|region            = 
|population        = 
|electorate        = 
|towns             = 
|future            = 
|year              = <!-- year of establishment -->
|abolished         = 
|members           = 
|seats             = 
|elects_howmany    = 
|party             = 
|local_council     = 
|next              = 
|previous          = 
}}

Full Blank Template

This is the full version of the template with all its optional parameters displayed. Template:Parameter names example 

{{Infobox constituency
|name              = 
|type              = 
|constituency_link = 
|parl_name         = <!-- name of the law making body -->
|map1              = 
|map_size          = 
|image             = 
|image_size        =
|map_entity        = 
|map_year          = 
|caption           = 
|map2              = 
|image2            = 
|caption2          = 
|map3              = 
|image3            = 
|caption3          = 
|map4              = 
|image4            = 
|caption4          = 
|district_label    = <!-- can be State/Province, region, county -->
|district          = 
|region_label      = <!-- can be State/Province, region, county -->
|region            = 
|population        = 
|electorate        = 
|towns             = 
|future            = 
|year              = <!-- year of establishment -->
|abolished_label   = 
|abolished         = 
|members_label     = 
|members           = 
|seats             = 
|elects_howmany    = 
|party_label       = <!-- defaults to "Party" -->
|party             = 
|local_council_label = 
|local_council     = 
|next              = 
|previous          = 
|blank1_name       = 
|blank1_info       = 
|blank2_name       = 
|blank2_info       = 
|blank3_name       = 
|blank3_info       = 
|blank4_name       = 
|blank4_info       = 
}}

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Infobox constituency

No description.

Template parameters

ParameterDescriptionTypeStatus
Namename

The name of the electoral district

Stringrequired
Native namenativename

The native name of the constitutency

Unknownoptional
Typetype

The type of electoral district

Unknownsuggested
Constitutency wikilinkconstituency_link

The wikilink to the constituency

Unknownoptional
Parliament nameparl_name

The wikilinked name of the Parliament.

Unknownsuggested
Map name 1map1

Filename of map ending with Constituency.svg

Stringsuggested
Map name 2map2

Filename of map ending with .svg

Stringoptional
Map name 3map3

Filename of map ending with .svg

Stringoptional
Map name 4map4

Filename of map

Stringoptional
Map sizemap_size

The map size in pixels

Unknownoptional
Map entitymap_entity

The location of a specified entity on a map

Stringoptional
Map yearmap_year

The year of the general election in which the map boundaries were drawn

Numberoptional
Image 1image

Full filename of a map image

Fileoptional
Image 2image2

Full filename of a map image

Fileoptional
Image 3image3

Full filename of a map image

Fileoptional
Image 4image4

Full filename of a map image

Fileoptional
Image sizeimage_size

The map image size in pixels

Unknownoptional
Caption 1caption

Caption for map/image 1

Unknownoptional
Caption 2caption2

Caption for map/image 2

Unknownoptional
Caption 3caption3

Caption for map/image 3

Unknownoptional
Caption 4caption4

Caption for map/image 4

Unknownoptional
District Labeldistrict_label

Label for the district parameter, otherwise shows as 'District'.

Unknownoptional
Districtdistrict

The district(s) in which the constituency is located at.

Unknownoptional
Region Labelregion_label

Label for the region parameter, otherwise shows as 'Region'.

Unknownoptional
Regionregion

The region, state or province in which the constituency is located at.

Unknownoptional
Polling divisionspolling_divisions

Name of the polling divisions

Unknownoptional
Populationpopulation

The total population within the constituency.

Unknownoptional
Electorateelectorate

The number of eligible voters within the constituency.

Unknownsuggested
Major settlementstowns

Major settlements near the constituency

Unknownoptional
Areaarea

The area of the constituency

Example
100 square kilometres
Unknownoptional
Future?future

If set to any value, the sub-header will display as 'Future constituency'.

Unknownoptional
Yearyear

The year the constituency was first established.

Numberoptional
Abolished Labelabolished_label

Label for the abolished parameter, otherwise shows as 'Abolished'.

Unknownoptional
Abolishedabolished

The year the constituency was abolished. If the parameter is used, the infobox header will include the word 'Former'.

Unknownoptional
Number of memberselects_howmany

The number of people elected to Parliament by the constitutency.

Unknownoptional
Seatsseats

(replaces Number of members) The number of seats in Parliament represented by the constituency.

Unknownsuggested
Party Labelparty_label

Label for the party parameter, otherwise shows as 'Party'.

Unknownoptional
Partyparty

The governing party of the electoral district.

Unknownsuggested
Member(s) Labelmember_label members_label

Label for the members parameter, otherwise shows as 'Member(s)'.

Unknownoptional
Member(s)member members

The number of people governing the constituency.

Unknownoptional
Local council labellocal_council_label

Label for the local_council parameter, otherwise shows as 'Local council'.

Unknownoptional
Local councillocal_council

The name of the local council or office in charge of the constituency.

Unknownoptional
Subdivisions labelparts_label

Label for the parts parameter, otherwise shows as 'Subdivisions'.

Unknownoptional
Subdivisionsparts

Name of subdivisions

Unknownoptional
Created fromprevious

The name of the previous electoral district in which the current electoral district was carved out or merged from.

Unknownoptional
Replaced bynext

The name of the new electoral district carved out or merged from the current electoral district.

Unknownoptional
Extra parameter 1 nameblank1_name

Label for extra parameter 1

Unknownoptional
Extra parameter 1blank1_info

Extra parameter 1

Unknownoptional
Extra parameter 2 nameblank2_name

Label for extra parameter 2

Unknownoptional
Extra parameter 2blank2_info

Extra parameter 2

Unknownoptional
Extra parameter 3 nameblank3_name

Label for extra parameter 3

Unknownoptional
Extra parameter 4blank3_info

Extra parameter 3

Unknownoptional
Extra parameter 4 nameblank4_name

Label for extra parameter 4

Unknownoptional
Extra parameter 4blank4_info

Extra parameter 4

Unknownoptional
Extra parameter 5 nameblank5_name

Label for extra parameter 5

Unknownoptional
Extra parameter 5blank5_info

Extra parameter 5

Unknownoptional

Example

Retrieved from "https://blackwiki.org/index.php?title=Template:Infobox_constituency/doc&oldid=6207763"