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:

| 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):

| 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 mapsEdit

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 parameterEdit

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.



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 parametersEdit

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