Difference between revisions of "Template:Infobox constituency/doc"
imported>AquaDTRS (→Parameters: converted to TemplateData) |
imported>AquaDTRS (update TemplateData) |
||
| Line 187: | Line 187: | ||
}, | }, | ||
"abolished": { | "abolished": { | ||
| − | "description": "The year the constituency was abolished. If the parameter is used, the infobox header will include the word 'Former'. " | + | "description": "The year the constituency was abolished. If the parameter is used, the infobox header will include the word 'Former'. ", |
| + | "type": "number" | ||
}, | }, | ||
"type": { | "type": { | ||
| Line 194: | Line 195: | ||
}, | }, | ||
"parl_name": { | "parl_name": { | ||
| − | "description": "The | + | "description": "The wikilink of the parliament name", |
"suggested": true, | "suggested": true, | ||
| − | "label": "Parliament name" | + | "label": "Parliament name", |
| + | "example": "Parliament of Singapore, Legisltive Council of Hong Kong" | ||
}, | }, | ||
"map1": { | "map1": { | ||
| Line 202: | Line 204: | ||
"type": "string", | "type": "string", | ||
"suggested": true, | "suggested": true, | ||
| − | "label": "Map name 1" | + | "label": "Map name 1", |
| + | "example": "typing 'XXX' generates [[File:XXX Constituency.svg]]" | ||
}, | }, | ||
"map_size": { | "map_size": { | ||
"description": "The map size in pixels", | "description": "The map size in pixels", | ||
| − | "label": "Map size" | + | "label": "Map size", |
| + | "example": "240, 240px" | ||
}, | }, | ||
"image": { | "image": { | ||
"description": "Full filename of a map image", | "description": "Full filename of a map image", | ||
"type": "wiki-file-name", | "type": "wiki-file-name", | ||
| − | "label": "Image 1" | + | "label": "Image 1", |
| + | "example": "Image:XXX-constituency.png" | ||
}, | }, | ||
"image_size": { | "image_size": { | ||
"description": "The map image size in pixels", | "description": "The map image size in pixels", | ||
| − | "label": "Image size" | + | "label": "Image size", |
| + | "example": "240, 240px" | ||
}, | }, | ||
"map_entity": { | "map_entity": { | ||
| Line 234: | Line 240: | ||
"label": "Map name 2", | "label": "Map name 2", | ||
"description": "Filename of map ending with .svg", | "description": "Filename of map ending with .svg", | ||
| − | "type": "string" | + | "type": "string", |
| + | "example": "typing 'XXX' generates [[File:XXX.svg]]" | ||
}, | }, | ||
"image2": { | "image2": { | ||
"label": "Image 2", | "label": "Image 2", | ||
"description": "Full filename of a map image", | "description": "Full filename of a map image", | ||
| − | "type": "wiki-file-name" | + | "type": "wiki-file-name", |
| + | "example": "Image:XXX-constituency.png" | ||
}, | }, | ||
"region": { | "region": { | ||
| Line 251: | Line 259: | ||
"label": "Map name 3", | "label": "Map name 3", | ||
"description": "Filename of map ending with .svg", | "description": "Filename of map ending with .svg", | ||
| − | "type": "string" | + | "type": "string", |
| + | "example": "typing 'XXX' generates [[File:XXX.svg]]" | ||
}, | }, | ||
"image3": { | "image3": { | ||
"label": "Image 3", | "label": "Image 3", | ||
"description": "Full filename of a map image", | "description": "Full filename of a map image", | ||
| − | "type": "wiki-file-name" | + | "type": "wiki-file-name", |
| + | "example": "Image:XXX-constituency.png" | ||
}, | }, | ||
"caption3": { | "caption3": { | ||
| Line 265: | Line 275: | ||
"label": "Map name 4", | "label": "Map name 4", | ||
"description": "Filename of map", | "description": "Filename of map", | ||
| − | "type": "string" | + | "type": "string", |
| + | "example": "typing 'XXX' generates [[File:XXX]]" | ||
}, | }, | ||
"image4": { | "image4": { | ||
"label": "Image 4", | "label": "Image 4", | ||
"description": "Full filename of a map image", | "description": "Full filename of a map image", | ||
| − | "type": "wiki-file-name" | + | "type": "wiki-file-name", |
| + | "example": "Image:XXX-constituency.png" | ||
}, | }, | ||
"caption4": { | "caption4": { | ||
| Line 277: | Line 289: | ||
}, | }, | ||
"district_label": { | "district_label": { | ||
| − | "label": "District | + | "label": "District label", |
"description": "Label for the district parameter, otherwise shows as 'District'. " | "description": "Label for the district parameter, otherwise shows as 'District'. " | ||
}, | }, | ||
| Line 285: | Line 297: | ||
"region_label": { | "region_label": { | ||
"description": "Label for the region parameter, otherwise shows as 'Region'. ", | "description": "Label for the region parameter, otherwise shows as 'Region'. ", | ||
| − | "label": "Region | + | "label": "Region label" |
}, | }, | ||
"polling_divisions": { | "polling_divisions": { | ||
| Line 292: | Line 304: | ||
}, | }, | ||
"population": { | "population": { | ||
| − | "description": "The total population within the constituency. " | + | "description": "The total population within the constituency. ", |
| + | "type": "number" | ||
}, | }, | ||
"electorate": { | "electorate": { | ||
"description": "The number of eligible voters within the constituency. ", | "description": "The number of eligible voters within the constituency. ", | ||
| − | "suggested": true | + | "suggested": true, |
| + | "type": "number" | ||
}, | }, | ||
"towns": { | "towns": { | ||
| Line 312: | Line 326: | ||
"abolished_label": { | "abolished_label": { | ||
"description": "Label for the abolished parameter, otherwise shows as 'Abolished'. ", | "description": "Label for the abolished parameter, otherwise shows as 'Abolished'. ", | ||
| − | "label": "Abolished | + | "label": "Abolished label" |
}, | }, | ||
"seats": { | "seats": { | ||
"description": "(replaces Number of members) The number of seats in Parliament represented by the constituency. ", | "description": "(replaces Number of members) The number of seats in Parliament represented by the constituency. ", | ||
"suggested": true, | "suggested": true, | ||
| − | "label": "Seats" | + | "label": "Seats", |
| + | "type": "number" | ||
}, | }, | ||
"party_label": { | "party_label": { | ||
"description": "Label for the party parameter, otherwise shows as 'Party'. ", | "description": "Label for the party parameter, otherwise shows as 'Party'. ", | ||
| − | "label": "Party | + | "label": "Party label" |
}, | }, | ||
"party": { | "party": { | ||
| Line 333: | Line 348: | ||
], | ], | ||
"description": "Label for the members parameter, otherwise shows as 'Member(s)'.", | "description": "Label for the members parameter, otherwise shows as 'Member(s)'.", | ||
| − | "label": "Member(s) | + | "label": "Member(s) label" |
}, | }, | ||
"member": { | "member": { | ||
| Line 368: | Line 383: | ||
"blank1_name": { | "blank1_name": { | ||
"description": "Label for extra parameter 1", | "description": "Label for extra parameter 1", | ||
| − | "label": "Extra parameter 1 | + | "label": "Extra parameter 1 label" |
}, | }, | ||
"blank1_info": { | "blank1_info": { | ||
| Line 376: | Line 391: | ||
"blank2_name": { | "blank2_name": { | ||
"description": "Label for extra parameter 2", | "description": "Label for extra parameter 2", | ||
| − | "label": "Extra parameter 2 | + | "label": "Extra parameter 2 label" |
}, | }, | ||
"blank2_info": { | "blank2_info": { | ||
| Line 384: | Line 399: | ||
"blank3_name": { | "blank3_name": { | ||
"description": "Label for extra parameter 3", | "description": "Label for extra parameter 3", | ||
| − | "label": "Extra parameter 3 | + | "label": "Extra parameter 3 label" |
}, | }, | ||
"blank3_info": { | "blank3_info": { | ||
| Line 392: | Line 407: | ||
"blank4_name": { | "blank4_name": { | ||
"description": "Label for extra parameter 4", | "description": "Label for extra parameter 4", | ||
| − | "label": "Extra parameter 4 | + | "label": "Extra parameter 4 label" |
}, | }, | ||
"blank4_info": { | "blank4_info": { | ||
| Line 400: | Line 415: | ||
"blank5_name": { | "blank5_name": { | ||
"description": "Label for extra parameter 5", | "description": "Label for extra parameter 5", | ||
| − | "label": "Extra parameter 5 | + | "label": "Extra parameter 5 label" |
}, | }, | ||
"blank5_info": { | "blank5_info": { | ||
| Line 407: | Line 422: | ||
}, | }, | ||
"constituency_link": { | "constituency_link": { | ||
| − | "description": "The wikilink | + | "description": "The wikilink of the constituency", |
"label": "Constitutency wikilink" | "label": "Constitutency wikilink" | ||
}, | }, | ||
"elects_howmany": { | "elects_howmany": { | ||
"label": "Number of members", | "label": "Number of members", | ||
| − | "description": "The number of people elected to Parliament by the constitutency." | + | "description": "The number of people elected to Parliament by the constitutency.", |
| + | "type": "number" | ||
}, | }, | ||
"area": { | "area": { | ||
Revision as of 20:49, 4 July 2020
| 40px | This is a documentation subpage for Template:Infobox constituency. It contains usage information, categories and other content that is not part of the original template page. |
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
TemplateData for Infobox constituency
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Name | name | The name of the electoral district | String | required |
| Native name | nativename | The native name of the constitutency | Unknown | optional |
| Type | type | The type of electoral district | Unknown | suggested |
| Constitutency wikilink | constituency_link | The wikilink of the constituency | Unknown | optional |
| Parliament name | parl_name | The wikilink of the parliament name
| Unknown | suggested |
| Map name 1 | map1 | Filename of map ending with Constituency.svg
| String | suggested |
| Map name 2 | map2 | Filename of map ending with .svg
| String | optional |
| Map name 3 | map3 | Filename of map ending with .svg
| String | optional |
| Map name 4 | map4 | Filename of map
| String | optional |
| Map size | map_size | The map size in pixels
| Unknown | optional |
| Map entity | map_entity | The location of a specified entity on a map | String | optional |
| Map year | map_year | The year of the general election in which the map boundaries were drawn | Number | optional |
| Image 1 | image | Full filename of a map image
| File | optional |
| Image 2 | image2 | Full filename of a map image
| File | optional |
| Image 3 | image3 | Full filename of a map image
| File | optional |
| Image 4 | image4 | Full filename of a map image
| File | optional |
| Image size | image_size | The map image size in pixels
| Unknown | optional |
| Caption 1 | caption | Caption for map/image 1 | Unknown | optional |
| Caption 2 | caption2 | Caption for map/image 2 | Unknown | optional |
| Caption 3 | caption3 | Caption for map/image 3 | Unknown | optional |
| Caption 4 | caption4 | Caption for map/image 4 | Unknown | optional |
| District label | district_label | Label for the district parameter, otherwise shows as 'District'. | Unknown | optional |
| District | district | The district(s) in which the constituency is located at. | Unknown | optional |
| Region label | region_label | Label for the region parameter, otherwise shows as 'Region'. | Unknown | optional |
| Region | region | The region, state or province in which the constituency is located at. | Unknown | optional |
| Polling divisions | polling_divisions | Name of the polling divisions | Unknown | optional |
| Population | population | The total population within the constituency. | Number | optional |
| Electorate | electorate | The number of eligible voters within the constituency. | Number | suggested |
| Major settlements | towns | Major settlements near the constituency | Unknown | optional |
| Area | area | The area of the constituency
| Unknown | optional |
| Future? | future | If set to any value, the sub-header will display as 'Future constituency'. | Unknown | optional |
| Year | year | The year the constituency was first established. | Number | optional |
| Abolished label | abolished_label | Label for the abolished parameter, otherwise shows as 'Abolished'. | Unknown | optional |
| Abolished | abolished | The year the constituency was abolished. If the parameter is used, the infobox header will include the word 'Former'. | Number | optional |
| Number of members | elects_howmany | The number of people elected to Parliament by the constitutency. | Number | optional |
| Seats | seats | (replaces Number of members) The number of seats in Parliament represented by the constituency. | Number | suggested |
| Party label | party_label | Label for the party parameter, otherwise shows as 'Party'. | Unknown | optional |
| Party | party | The governing party of the electoral district. | Unknown | suggested |
| Member(s) label | member_label members_label | Label for the members parameter, otherwise shows as 'Member(s)'. | Unknown | optional |
| Member(s) | member members | The number of people governing the constituency. | Unknown | optional |
| Local council label | local_council_label | Label for the local_council parameter, otherwise shows as 'Local council'. | Unknown | optional |
| Local council | local_council | The name of the local council or office in charge of the constituency. | Unknown | optional |
| Subdivisions label | parts_label | Label for the parts parameter, otherwise shows as 'Subdivisions'. | Unknown | optional |
| Subdivisions | parts | Name of subdivisions | Unknown | optional |
| Created from | previous | The name of the previous electoral district in which the current electoral district was carved out or merged from. | Unknown | optional |
| Replaced by | next | The name of the new electoral district carved out or merged from the current electoral district. | Unknown | optional |
| Extra parameter 1 label | blank1_name | Label for extra parameter 1 | Unknown | optional |
| Extra parameter 1 | blank1_info | Extra parameter 1 | Unknown | optional |
| Extra parameter 2 label | blank2_name | Label for extra parameter 2 | Unknown | optional |
| Extra parameter 2 | blank2_info | Extra parameter 2 | Unknown | optional |
| Extra parameter 3 label | blank3_name | Label for extra parameter 3 | Unknown | optional |
| Extra parameter 4 | blank3_info | Extra parameter 3 | Unknown | optional |
| Extra parameter 4 label | blank4_name | Label for extra parameter 4 | Unknown | optional |
| Extra parameter 4 | blank4_info | Extra parameter 4 | Unknown | optional |
| Extra parameter 5 label | blank5_name | Label for extra parameter 5 | Unknown | optional |
| Extra parameter 5 | blank5_info | Extra parameter 5 | Unknown | optional |