>Joy: document mapframe parameters with local defaults

2025-03-01T16:50:30Z

document mapframe parameters with local defaults

New page

{{Documentation subpage}}

{{Lua|Module:Infobox|Module:InfoboxImage|Module:String|Module:Coordinates|Module:Check for unknown parameters}}

==Usage==
{{Infobox valley
| name = Oak Creek Canyon
| photo = Oak Creek Canyon 02.jpg
| photo_size = 235
| photo_caption = South view, from above north terminus ([[Coconino Plateau]]) [[Coconino Sandstone]] cliffs above [[Hermit Shale]],<ref>Chronic, Halka. ''Roadside Geology of Arizona,'' c. 1983, 23rd printing, 321 pages, (''US 89A Flagstaff to Arizona''), pp. 233-236, map ref, pg. 192.</ref> on west canyon wall
| length = {{convert|12|mi|km}}
| direction = North-South
| width = {{convert|0.8|to|2.5|mi|km}}
| coordinates = {{coord|34|54|45|N|111|43|37|W|display=inline}}
| map = Arizona
| map_size = 180
| map_caption = Location in Arizona, northeast of [[Verde River]]
| label = Oak Creek Canyon
| label_position = top
| traversed = [[Arizona State Route 89A]]
}}

=== Blank template ===
<syntaxhighlight lang="wikitext" style="width: 35em;">
{{Infobox valley
| name = {{subst:BASEPAGENAME}}
| other_name =
| native_name = {{native name}} or {{native name list}}
| translation =
| photo =
| photo_caption =

| map =
| map_image =
| map_caption =
| mapframe =

| location =
| country =
| region =
| state =
| district =
| city =
| relief =
| label =
| label_position =
| coordinates = {{coord}}
| coordinates_ref =

| elevation =
| elevation_m =
| elevation_ft =
| elevation_ref =
| length =
| length_mi =
| length_km =
| length_orientation =
| length_note =
| width =
| width_mi =
| width_km =
| width_orientation =
| width_note =
| area =
| area_mi2 =
| area_km2 =
| depth =
| depth_ft =
| depth_m =
| type =
| age =
| border =
| topo =
| traversed =
| river =

| footnotes =
| embed =
}}</syntaxhighlight>

=== Example ===
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Infobox valley
| name = Oak Creek Canyon
| photo = Oak Creek Canyon 02.jpg
| photo_size = 235
| photo_caption = South view, from above north terminus ([[Coconino Plateau]]) [[Coconino Sandstone]] cliffs above [[Hermit Shale]],<ref>Chronic, Halka. ''Roadside Geology of Arizona,'' c. 1983, 23rd printing, 321 pages, (''US 89A Flagstaff to Arizona''), pp. 233-236, map ref, pg. 192.</ref> on west canyon wall
| length = {{convert|12|mi|km}}
| direction = North-South
| width = {{convert|0.8|to|2.5|mi|km}}
| coordinates = {{coord|34|54|45|N|111|43|37|W|display=inline,title}}
| map = Arizona
| map_size = 180
| map_caption = Location in Arizona, northeast of [[Verde River]]
| label = Oak_Creek_Canyon
| label_position = top
| traversed = [[Arizona State Route 89A]]
}}</syntaxhighlight>

===Parameters===
{| class="wikitable" style="font-size:90%; margin:auto; width:100%"
! Parameter
! Description
|-
|'''name'''
| Name of the valley. If more than one valley by the name exists, the article is likely disambiguated but this name in the infobox should be the undisambiguated name.
|-
|'''other_name'''
| Other English name for the valley if relatively well known.
|-
|'''native_name'''
| non-English name of valley (if not main name) – use {{tlx|native name}} or, for multiple names, use {{tlx|native name list}}
|-
|'''translation'''
| Translation of native name (if not main name)
|-
|'''photo'''
| Photograph of the valley. Preferably a distance shot to show most/all of the valley. Do not include the "File:" prefix. If uploading a new image, please put them on [[Wikimedia Commons|Commons]] so they can be easily used by the other language Wikipedias.
|-
|'''photo_size'''
| Specify the width of the photo in pixels. For example, <code>photo_size = 200</code> with no "px". If no value is specified, the default width is 288 pixels. A standard horizontal photographic composition will generally display well at 288px. A standard vertical composition may need to be adjusted to 180 or 220 pixels.
|-
|'''photo_alt'''
| Alt text for the photo, primarily for visually impaired readers. See ''[[Wikipedia:Alternative text for images]]''.
|-
|'''photo_caption'''
| Description of the photograph which is displayed below.
|-
|'''map'''
| The name of a location map as per [[Template:Location map]] (e.g. ''Indonesia'' or ''Russia''). The coordinates in the coordinates field will be used to position a pushpin coordinate marker and label on the map '''automatically'''. To use a static image, use {{para|map_image}}
|-
| '''map_image'''
| The file name of a static map image to be displayed. To use a [[Template:location map|location map]], use {{para|map}}.
|-
|'''map_size'''
| Must be entered as only a number—'''no need for px'''. The default value is 250.
|-
|'''map_alt'''
| Alt text for the map, primarily for visually impaired readers. See ''[[Wikipedia:Alternative text for images#Maps|Alt text for maps]]''.
|-
|'''map_caption'''
| Fill out if a map caption is desired. If not specified, '''location''' will be used.
|-
|'''location'''
| Province or state first, followed by country. For USA, the county is optional but if given, be provided before the state. If a pushpin map is being used, the location will be used for the map's caption unless the map_caption parameter is set.
|-
|'''country''' '''country1''','''country2''',...
|One or more countries that the valley lies in
|-
|'''region''' '''region1''','''region2''',...
|One or more regions (e.g., deserts) that the valley lies in
|-
|'''district''' '''district1''','''district2''',...
|One or more districts (e.g., U.S. counties) that the valley lies in
|-
|'''city''' '''city1''','''city2''',...
|One or more population centers within the valley
|-
|'''relief'''
| If a location map template is specified, relief=1 will attempt to display a relief map if one is available. To force the default map image to display use {{para|map_relief|0}}.
|-
|'''label'''
| Label to be used for the valley's location on the map. If not specified, the value of the ''name'' parameter is used.
|-
|'''label_position'''
| The position of the label on the pushpin map relative to the pushpin coordinate marker. Valid options are {left, right, top, bottom, none}. If this field is not specified, the default value is ''right''.
|-
|'''coordinates'''
| The latitude and longitude of the valley using the {{tl|coord}} template with ''display=inline,title''. If the article uses a geolinks template in the external links section, do not use the ''display'' parameter.
|-
|'''coordinates_ref'''
| For any references regarding the coordinates reported. <nowiki><ref> </ref></nowiki> tags must be used.
|-
|'''elevation'''
| Elevation of the valley floor. Metres should be used first for all valleys outside of the United States and feet for those within the U.S. For conversions, use '''elevation_m''' for metres to feet or '''elevation_ft''' for feet to metres.
|-
|'''elevation_ref'''
|Reference for the elevation using the standard <nowiki><ref> </ref></nowiki> tags. If elevation_m/elevation_ft was used, the reference must be supplied using this parameter.
|-
|'''length''' '''length_mi''','''length_km'''
|The length of the valley, measured along the longer axis. Use {{tl|convert}} for both metric and US units, or use length_mi or length_km for autoconversion.
|-
|'''length_orientation'''
|The orientation of the longer axis of the valley (e.g., N-S)
|-
|'''length_note'''
|Any notes on the length (e.g., a reference)
|-
|'''width''' '''width_mi''','''width_km'''
|The width of the valley, measured along the shorter axis. Use {{tl|convert}} for both metric and US units, or use width_mi or width_km for autoconversion.
|-
|'''width_orientation'''
|The orientation of the shorter axis of the valley
|-
|'''width_note'''
|Any notes on the width (e.g., a reference)
|-
|'''area''' '''area_mi2''','''area_km2'''
|The area of the valley. Use {{tl|convert}} for both metric and US units, or use area_mi2 or area_km2 for autoconversion.
|-
|'''depth''' '''depth_ft''','''depth_m'''
|The depth of the valley (from rim to floor). Use {{tl|convert}} for both metric and US units, or use depth_ft or depth_m for autoconversion.
|-
|'''type'''
|The geological type of valley (e.g., glacial)
|-
|'''age'''
|The age of the rocks of the valley walls
|-
|'''border''' '''border1''','''border2''',...
|One or more geographic features that are immediately adjacent to the valley.
|-
|'''topo'''
| The name of the [[topographic map]] showing the valley. In Canada, this is usually the [[National Topographic System]] map number while for the USA, it's the map name from the USGS.
|-
|'''traversed'''
|Road or trails that cross or run through the valley
|-
|'''river''' '''river1''','''river2''',...
|One or more rivers that flow into or along the bottom of the valley
|-
|'''footnotes'''
|References to support the infobox information
|-
|'''embed'''
| "yes" if the valley infobox is embedded inside another Infobox
|-
|}
{{clear}}

{{template reference list}}

=== Mapframe maps ===

{{Infobox mapframe/doc/parameters
| mapframe = yes, unless one of these parameters has a value: {{para|map}}, {{para|map_image}}, {{para|image_map}}, {{para|relief}}.
| mapframe-frame-width = 272
| mapframe-wikidata = yes, unless one of these parameters has a value: {{para|mapframe-coordinates}}, {{para|mapframe-coord}}, {{para|coordinates}}, {{para|coords}}
| mapframe-marker = natural
| mapframe-type = river
}}

== Microformat ==
The articles created using this template include an hCard microformat. For more information read [[:Template:UF-hcard-place|this]].

== Tracking category ==
* {{Category link with count |Pages using infobox valley with unknown parameters}}

<includeonly>{{Sandbox other||

[[Category:Place infobox templates|Valley]]
[[Category:Embeddable templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>

Template:Infobox valley/doc - Revision history

>Joy: document mapframe parameters with local defaults