Template:Regionlist

Template documentation

This documentation is transcluded from Template:Regionlist/doc. (edit | history)
Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.

This template is used to display a color-coded map of regions and a legend with the region color, name and description. Use of this template is as follows:

{{Regionlist
| regionmap=The name of the region map
| regionmaptext=Text to display under the map image
| regionmapsize=The size of the map in px. Defaults to 350px if not passed

| region1name=The name of the first region
| region1color=The HTML color code to use in the legend for the first region
| region1items=An optional list of items to appear in parentheses next to the region name
| region1description=A description of the region
}}

The parameters above should be repeated for additional regions, but replace "region1" with "region2", "region3", etc. An example usage of this template with real data follows (descriptions have been truncated for readability):

{{Regionlist
| regionmap=Map-USA-Regions01.png
| regionmaptext=Regions of the USA
| regionmapsize=300px

| region1name=[[California]]
| region1color=#e0fa92
| region1items=
| region1description=In some ways quintessentially American, and in...

| region2name=[[Pacific Northwest (United States of America)|Pacific Northwest]]
| region2color=#38911c
| region2items=[[Washington (state)|Washington]], [[Oregon]]
| region2description=The pleasantly mild Pacific Northwest offers...
}}

Dual maps

Where a page has both a static and a dynamic region map, it's possible to hide one in the background and switch between the two. Examples of this feature are East China and Kootenays.

Base parameter

To enable the toggle feature, add the following to the region list template:

| regionInteractiveMap=map1

This parameter will activate a dynamic map behind the static map, and provide a link to switch between the maps. If there are mapshapes to display in the dynamic map, they will need to have the "group=map1" parameter added.

Example:

{{mapshape|type=geoshape|fill=#dcb8b8|wikidata=Q14925052|group=map1}}

Some things to note:

• The static and dynamic maps will have identical dimensions so the layout of the article is not affected.
• The center and the zoom of the map will be autoset according to the POI shown in the map.
• To set a dymanic map for a second static map on the same page, it's necessary to specify a different value in the regionInteractiveMap parameter (e.g. map2) and match it to group parameter in the {{mapshape}}.

Optional parameters

To center the map at a different point or to apply a different zoom level, use the following optional parameters.

| regionmapLat=Center latitude
| regionmapLong=Center longitude
| regionmapZoom=Map zoom level

Template for identifying regions (sub areas) that are within a geographic footprint.

Template parameters[Edit template data]

Parameter		Description	Type	Status
Region Map	regionmap	Name of image file showing the regions within a geographic area. Example franceregions.jpg	File	suggested
Region Interactive Map	regionInteractiveMap	If you want to include an interactive Openstreetmap map of the geographic area that the regions fall within, then specify a map name (specified name will not be rendered). Ensure that the map name is not already specified within the article. Example map1	String	suggested
Region Map Size	regionmapsize	Size in pixels of the map to be shown. Default is 350px. Example 450px	String	suggested
Region Map Align	regionmapalign	Alignment of the displayed map Suggested values left right center Example "right" or "left"	String	suggested
Region Map Text	regionmaptext	Caption that will show up under the map name Example Regions of Italy	String	suggested
Region Map Latitude	regionmapLat	Decimal latitude (GPS coordinates) for interactive map output Example 41.7695	Number	suggested
Region Map Longitude	regionmapLong	Decimal longitude (GPS coordinates) for interactive map output Example -87.7032	Number	suggested
Region Map Zoom	regionmapZoom	Interactive map's Openstreetmap level of zoom (higher is closer zoom) Example 14	Number	suggested
show	show	no description	Unknown	optional
regionmobilemapsize	regionmobilemapsize	no description	Unknown	optional
1st region name	region1name	First specified region: Name of a region within the area that regions will be specified for Example [[Central Italy]]	String	suggested
1st region color	region1color	First specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region. Example #b5d29f	String	suggested
1st region's subregions	region1items	First specified region: a list of that region's subregions. Example [[Tuscany]], [[Marche]], [[Umbria]], [[Lazio]], and [[Abruzzo]]	String	suggested
1st region description	region1description	First specified region: a brief description of region, such as what the region is known for. Example This region breathes history of the Roman Empire and has some of the world's most famous landmarks.	String	suggested
2nd region name	region2name	Second specified region: Name of a region within the area that regions will be specified for	String	suggested
2nd region color	region2color	Second specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	suggested
2nd region's subregions	region2items	Second specified region: a list of that region's subregions.	String	suggested
2nd region description	region2description	Second specified region: a brief description of region, such as what the region is known for.	String	suggested
3rd region name	region3name	Third specified region: Name of a region within the area that regions will be specified for	String	optional
3rd region color	region3color	Third specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
3rd region's subregions	region3items	Third specified region: a list of that region's subregions.	String	optional
3rd region description	region3description	Third specified region: a brief description of region, such as what the region is known for.	String	optional
4th region name	region4name	Fourth specified region: Name of a region within the area that regions will be specified for	String	optional
4th region color	region4color	Fourth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
4th region's subregions	region4items	Fourth specified region: a list of that region's subregions	String	optional
4th region description	region4description	Fourth specified region: a brief description of region, such as what the region is known for.	String	optional
5th region name	region5name	Fifth specified region: Name of a region within the area that regions will be specified for	String	optional
5th region color	region5color	Fifth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
5th region's subregions	region5items	Fifth specified region: a list of that region's subregions.	String	optional
5th region description	region5description	Fifth specified region: a brief description of region, such as what the region is known for.	String	optional
6th region name	region6name	Sixth specified region: Name of a region within the area that regions will be specified for	String	optional
6th region color	region6color	Sixth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
6th region's subregions	region6items	Sixth specified region: a list of that region's subregions.	String	optional
6th region description	region6description	Sixth specified region: a brief description of region, such as what the region is known for.	String	optional
7th region name	region7name	Seventh specified region: Name of a region within the area that regions will be specified for	String	optional
7th region color	region7color	Seventh specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
7th region's subregions	region7items	Seventh specified region: a list of that region's subregions.	String	optional
7th region description	region7description	Seventh specified region: a brief description of region, such as what the region is known for.	String	optional
8th region name	region8name	Eighth specified region: Name of a region within the area that regions will be specified for	String	optional
8th region color	region8color	Eighth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
8th region's subregions	region8items	Eighth specified region: a list of that region's subregions.	String	optional
8th region description	region8description	Eighth specified region: a brief description of region, such as what the region is known for.	String	optional
9th region name	region9name	Ninth specified region: Name of a region within the area that regions will be specified for	String	optional
9th region color	region9color	Ninth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
9th region's subregions	region9items	Ninth specified region: a list of that region's subregions.	String	optional
9th region description	region9description	Ninth specified region: a brief description of region, such as what the region is known for.	String	optional
10th region name	region10name	Tenth specified region: Name of a region within the area that regions will be specified for	String	optional
10th region color	region10color	Tenth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
10th region's subregions	region10items	Tenth specified region: a list of that region's subregions.	String	optional
10th region description	region10description	Tenth specified region: a brief description of region, such as what the region is known for.	String	optional
11th region name	region11name	Eleventh specified region: Name of a region within the area that regions will be specified for	String	optional
11th region color	region11color	Eleventh specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
11th region's subregions	region11items	Eleventh specified region: a list of that region's subregions.	String	optional
11th region description	region11description	Eleventh specified region: a brief description of region, such as what the region is known for.	String	optional
12th region name	region12name	Twelfth specified region: Name of a region within the area that regions will be specified for	String	optional
12th region color	region12color	Twelfth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
12th region's subregions	region12items	Twelfth specified region: a list of that region's subregions.	String	optional
12th region description	region12description	Twelfth specified region: a brief description of region, such as what the region is known for.	String	optional
13th region name	region13name	Thirteenth specified region: Name of a region within the area that regions will be specified for	String	optional
13th region color	region13color	Thirteenth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
13th region's subregions	region13items	Thirteenth specified region: a list of that region's subregions.	String	optional
13th region description	region13description	Thirteenth specified region: a brief description of region, such as what the region is known for.	String	optional
14th region name	region14name	Fourteenth specified region: Name of a region within the area that regions will be specified for	String	optional
14th region color	region14color	Fourteenth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
14th region's subregions	region14items	Fourteenth specified region: a list of that region's subregions.	String	optional
14th region description	region14description	Fourteenth specified region: a brief description of region, such as what the region is known for.	String	optional
15th region name	region15name	Fifteenth specified region: Name of a region within the area that regions will be specified for	String	optional
15th region color	region15color	Fifteenth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
15th region's subregions	region15items	Fifteenth specified region: a list of that region's subregions.	String	optional
15th region description	region15description	Fifteenth specified region: a brief description of region, such as what the region is known for.	String	optional
16th region name	region16name	Sixteenth specified region: Name of a region within the area that regions will be specified for	String	optional
16th region color	region16color	Sixteenth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
16th region's subregions	region16items	Sixteenth specified region: a list of that region's subregions.	String	optional
16th region description	region16description	Sixteenth specified region: a brief description of region, such as what the region is known for.	String	optional
17th region name	region17name	Seventeenth specified region: Name of a region within the area that regions will be specified for	String	optional
17th region color	region17color	Seventeenth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
17th region's subregions	region17items	Seventeenth specified region: a list of that region's subregions	String	optional
17th region description	region17description	Seventeenth specified region: a brief description of region, such as what the region is known for.	String	optional
18th region name	region18name	Eighteenth specified region: Name of a region within the area that regions will be specified for	String	optional
18th region color	region18color	Eighteenth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
18th region's subregions	region18items	Eighteenth specified region: a list of that region's subregions.	String	optional
18th region description	region18description	Eigteenth specified region: a brief description of region, such as what the region is known for.	String	optional
19th region name	region19name	Nineteenth specified region: Name of a region within the area that regions will be specified for	String	optional
19th region color	region19color	Nineteenth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
19th region's subregions	region19items	Nineteenth specified region: a list of that region's subregions.	String	optional
19th region description	region19description	Nineteenth specified region: a brief description of region, such as what the region is known for.	String	optional
20th region name	region20name	Twentieth specified region: Name of a region within the area that regions will be specified for	String	optional
20th region color	region20color	Twentieth specified region: The hex code for a colour that will be displayed in association with the region Colour intended to help visually distinguish the region from other listed regions. If showing a map, the selected colour should match the colour shown on the map to depict the region.	String	optional
20th region's subregions	region20items	Twentieth specified region: a list of that region's subregions.	String	optional
20th region description	region20description	Twentieth specified region: a brief description of region, such as what the region is known for.	String	optional