Template:Regionlist

From Wikivoyage
Jump to navigation Jump to search
[view] [edit] [history] [purge] Template-info.svg Template documentation

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.

[Edit template data]

Template parameters

ParameterDescriptionTypeStatus
Region Mapregionmap

Name of image file showing the regions within a geographic area.

Example
franceregions.jpg
Filesuggested
Region Interactive MapregionInteractiveMap

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
Stringsuggested
Region Map Sizeregionmapsize

Size in pixels of the map to be shown. Default is 350px.

Example
450px
Stringsuggested
Region Map Alignregionmapalign

Alignment of the displayed map

Example
"right" or "left"
Stringsuggested
Region Map Textregionmaptext

Caption that will show up under the map name

Example
Regions of Italy
Stringsuggested
Region Map LatituderegionmapLat

Decimal latitude (GPS coordinates) for interactive map output

Example
41.7695
Numbersuggested
Region Map LongituderegionmapLong

Decimal longitude (GPS coordinates) for interactive map output

Example
-87.7032
Numbersuggested
Region Map ZoomregionmapZoom

Interactive map's Openstreetmap level of zoom (higher is closer zoom)

Example
14
Numbersuggested
showshow

no description

Unknownoptional
regionmobilemapsizeregionmobilemapsize

no description

Unknownoptional
1st region nameregion1name

First specified region: Name of a region within the area that regions will be specified for

Example
[[Central Italy]]
Stringsuggested
1st region colorregion1color

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
Stringsuggested
1st region's subregionsregion1items

First specified region: a list of that region's subregions.

Example
[[Tuscany]], [[Marche]], [[Umbria]], [[Lazio]], and [[Abruzzo]]
Stringsuggested
1st region descriptionregion1description

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.
Stringsuggested
2nd region nameregion2name

Second specified region: Name of a region within the area that regions will be specified for

Stringsuggested
2nd region colorregion2color

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.

Stringsuggested
2nd region's subregionsregion2items

Second specified region: a list of that region's subregions.

Stringsuggested
2nd region descriptionregion2description

Second specified region: a brief description of region, such as what the region is known for.

Stringsuggested
3rd region nameregion3name

Third specified region: Name of a region within the area that regions will be specified for

Stringoptional
3rd region colorregion3color

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.

Stringoptional
3rd region's subregionsregion3items

Third specified region: a list of that region's subregions.

Stringoptional
3rd region descriptionregion3description

Third specified region: a brief description of region, such as what the region is known for.

Stringoptional
4th region nameregion4name

Fourth specified region: Name of a region within the area that regions will be specified for

Stringoptional
4th region colorregion4color

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.

Stringoptional
4th region's subregionsregion4items

Fourth specified region: a list of that region's subregions

Stringoptional
4th region descriptionregion4description

Fourth specified region: a brief description of region, such as what the region is known for.

Stringoptional
5th region nameregion5name

Fifth specified region: Name of a region within the area that regions will be specified for

Stringoptional
5th region colorregion5color

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.

Stringoptional
5th region's subregionsregion5items

Fifth specified region: a list of that region's subregions.

Stringoptional
5th region descriptionregion5description

Fifth specified region: a brief description of region, such as what the region is known for.

Stringoptional
6th region nameregion6name

Sixth specified region: Name of a region within the area that regions will be specified for

Stringoptional
6th region colorregion6color

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.

Stringoptional
6th region's subregionsregion6items

Sixth specified region: a list of that region's subregions.

Stringoptional
6th region descriptionregion6description

Sixth specified region: a brief description of region, such as what the region is known for.

Stringoptional
7th region nameregion7name

Seventh specified region: Name of a region within the area that regions will be specified for

Stringoptional
7th region colorregion7color

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.

Stringoptional
7th region's subregionsregion7items

Seventh specified region: a list of that region's subregions.

Stringoptional
7th region descriptionregion7description

Seventh specified region: a brief description of region, such as what the region is known for.

Stringoptional
8th region nameregion8name

Eighth specified region: Name of a region within the area that regions will be specified for

Stringoptional
8th region colorregion8color

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.

Stringoptional
8th region's subregionsregion8items

Eighth specified region: a list of that region's subregions.

Stringoptional
8th region descriptionregion8description

Eighth specified region: a brief description of region, such as what the region is known for.

Stringoptional
9th region nameregion9name

Ninth specified region: Name of a region within the area that regions will be specified for

Stringoptional
9th region colorregion9color

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.

Stringoptional
9th region's subregionsregion9items

Ninth specified region: a list of that region's subregions.

Stringoptional
9th region descriptionregion9description

Ninth specified region: a brief description of region, such as what the region is known for.

Stringoptional
10th region nameregion10name

Tenth specified region: Name of a region within the area that regions will be specified for

Stringoptional
10th region colorregion10color

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.

Stringoptional
10th region's subregionsregion10items

Tenth specified region: a list of that region's subregions.

Stringoptional
10th region descriptionregion10description

Tenth specified region: a brief description of region, such as what the region is known for.

Stringoptional
11th region nameregion11name

Eleventh specified region: Name of a region within the area that regions will be specified for

Stringoptional
11th region colorregion11color

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.

Stringoptional
11th region's subregionsregion11items

Eleventh specified region: a list of that region's subregions.

Stringoptional
11th region descriptionregion11description

Eleventh specified region: a brief description of region, such as what the region is known for.

Stringoptional
12th region nameregion12name

Twelfth specified region: Name of a region within the area that regions will be specified for

Stringoptional
12th region colorregion12color

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.

Stringoptional
12th region's subregionsregion12items

Twelfth specified region: a list of that region's subregions.

Stringoptional
12th region descriptionregion12description

Twelfth specified region: a brief description of region, such as what the region is known for.

Stringoptional
13th region nameregion13name

Thirteenth specified region: Name of a region within the area that regions will be specified for

Stringoptional
13th region colorregion13color

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.

Stringoptional
13th region's subregionsregion13items

Thirteenth specified region: a list of that region's subregions.

Stringoptional
13th region descriptionregion13description

Thirteenth specified region: a brief description of region, such as what the region is known for.

Stringoptional
14th region nameregion14name

Fourteenth specified region: Name of a region within the area that regions will be specified for

Stringoptional
14th region colorregion14color

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.

Stringoptional
14th region's subregionsregion14items

Fourteenth specified region: a list of that region's subregions.

Stringoptional
14th region descriptionregion14description

Fourteenth specified region: a brief description of region, such as what the region is known for.

Stringoptional
15th region nameregion15name

Fifteenth specified region: Name of a region within the area that regions will be specified for

Stringoptional
15th region colorregion15color

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.

Stringoptional
15th region's subregionsregion15items

Fifteenth specified region: a list of that region's subregions.

Stringoptional
15th region descriptionregion15description

Fifteenth specified region: a brief description of region, such as what the region is known for.

Stringoptional
16th region nameregion16name

Sixteenth specified region: Name of a region within the area that regions will be specified for

Stringoptional
16th region colorregion16color

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.

Stringoptional
16th region's subregionsregion16items

Sixteenth specified region: a list of that region's subregions.

Stringoptional
16th region descriptionregion16description

Sixteenth specified region: a brief description of region, such as what the region is known for.

Stringoptional
17th region nameregion17name

Seventeenth specified region: Name of a region within the area that regions will be specified for

Stringoptional
17th region colorregion17color

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.

Stringoptional
17th region's subregionsregion17items

Seventeenth specified region: a list of that region's subregions

Stringoptional
17th region descriptionregion17description

Seventeenth specified region: a brief description of region, such as what the region is known for.

Stringoptional
18th region nameregion18name

Eighteenth specified region: Name of a region within the area that regions will be specified for

Stringoptional
18th region colorregion18color

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.

Stringoptional
18th region's subregionsregion18items

Eighteenth specified region: a list of that region's subregions.

Stringoptional
18th region descriptionregion18description

Eigteenth specified region: a brief description of region, such as what the region is known for.

Stringoptional
19th region nameregion19name

Nineteenth specified region: Name of a region within the area that regions will be specified for

Stringoptional
19th region colorregion19color

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.

Stringoptional
19th region's subregionsregion19items

Nineteenth specified region: a list of that region's subregions.

Stringoptional
19th region descriptionregion19description

Nineteenth specified region: a brief description of region, such as what the region is known for.

Stringoptional
20th region nameregion20name

Twentieth specified region: Name of a region within the area that regions will be specified for

Stringoptional
20th region colorregion20color

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.

Stringoptional
20th region's subregionsregion20items

Twentieth specified region: a list of that region's subregions.

Stringoptional
20th region descriptionregion20description

Twentieth specified region: a brief description of region, such as what the region is known for.

Stringoptional