>Joy: /* Mapframe maps */ document onByDefault from the code

2024-11-01T12:19:27Z

Mapframe maps: document onByDefault from the code

New page

{{Documentation subpage}}

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

This template can be used to create an infobox for a [[spring (hydrology)|spring]], including [[geyser]]s or [[hot spring]]s.

== Usage ==
{{Parameter names example  | name | spring_name | other_name | photo | image | photo_width | image_size | photo_alt | alt | photo_caption | map_image | map_alt | map_size | map_caption | relief | mark | mark_width | label | label_position | name_origin | location | coordinates = {{coord|0|0}} | coords_ref | mapframe | spring_source | elevation | hot_spring_type | type | provides | magnitude | height | frequency | duration | flow | discharge | temperature | depth | topo | embedded}}
{{Parameter names example | name=Without ''photo_width'' | photo | photo_alt | photo_caption}}

{|
! Commonly used
!
! All parameters
|- style="vertical-align:top;"
|<syntaxhighlight lang="wikitext" style="margin: 0">
{{Infobox spring
| name =
| photo =
| photo_width =
| photo_caption =
| map = 
| map_width =
| map_caption =
| name_origin =
| location =
| elevation =
| coordinates =
| coords_ref =
| mapframe =
| hot_spring_type =
| height =
| duration =
| frequency =
| discharge =
| temperature =
| depth =
}}</syntaxhighlight>
|      
|<syntaxhighlight lang="wikitext" style="margin: 0">
{{Infobox spring
| name =
| other_name =
| photo =
| photo_width =
| photo_alt =
| photo_caption =
| map = 
| relief =
| map_width =
| map_alt =
| map_caption =
| mark =
| mark_width =
| label =
| label_position =
| name_origin =
| location =
| spring_source =
| elevation =
| coordinates =
| coords_ref =
| mapframe =
| hot_spring_type =
| type =
| provides =
| magnitude =
| height =
| duration =
| frequency =
| discharge =
| temperature =
| depth =
| child =
| embedded =
}}</syntaxhighlight>
|}
{{clear}}

== Parameter descriptions ==
{| class="wikitable" style="font-size:90%;"
! Parameter
! Description
|-
| <code>name</code> || Required. Official name of the geothermal feature (e.g. ''Old Faithful Geyser'')
|-
| <code>other_name</code> || If the feature is also commonly known by another name then use this parameter for the alternate name.
|-
| <code>photo</code> || The name of an image file to be displayed. No special formatting is needed. For geysers, a photo of the eruption is preferred.
|-
| <code>photo_width</code> || The image width in pixels. If specified, the maximum width is 280px. If not specified, the image uses ''frameless'' with ''upright=1.1'' which displays it at approximately 110% of the user's default thumbnail size (for most users the image will display at {{#expr:220*1.1 round -1}}px; for logged-in users who have changed the setting at [[Special:Preferences]] the displayed image could range from {{#expr:120*1.1 round -1}}px to {{#expr:400*1.1 round -1}}px). See also: [[Module:InfoboxImage]], [[WP:AUTOSIZE]], [[WP:EIS]], [[WP:IMGSIZE]], and [[MOS:IMGSIZE]].
|-
| <code>photo_alt</code> || Alternate text for the photo for visually impaired readers. See [[WP:ALT]].
|-
| <code>photo_caption</code> || The caption that will display bellow the image. Include month and year of picture, if known.
|-
| colspan="2" style="text-align: center; font-weight: bold;" | Location-related parameters
|-
| <code>map</code> || The name of the [[Template:location map|location map]] to be displayed. See [[#Map display methods|Map display methods]] below. To use a static image, use {{para|map_image}}
|-
| <code>map_image</code> || The file name of a static map image to be displayed. To use a [[Template:location map|location map]], use {{para|map}}.
|-
| <code>map_relief</code> || When the geographical coordinates method is used (see [[#Map display methods|Map display methods]]), any non-blank value (<code>map_relief=yes</code>, <code>map_relief=1</code>, etc.) will cause the template to display a [[relief mapping (computer graphics)|relief map]] image, where available. For additional information, see [[Template:Location map#Relief parameter]].
|-
| <code>map_size</code> or <code>map_width</code> || Width to display the map image in pixels. The default and maximum is 220. For example, <code>map_width=200</code> (not <code>map_px</code>).
|-
| <code>map_alt</code> || Alternative text for the map image, see [[WP:ALT]].
|-
| <code>map_caption</code> || Text displayed below the map image, if required.
|-
| <code>mark</code> || The image to use for the marker. The default is [[:File:Red pog.svg|Red pog.svg]]. See [[Template:Location map]] for more information.
|-
| <code>marker_width</code> || The display width of the marker image in pixels. Default = 8.
|-
| <code>label</code> || Text that will be displayed next to the marker. Works with <code>label_position</code> below.
|-
| <code>label_position</code> || Specifies the position of a label with respect to the marker. Valid values are <code>left</code>, <code>right</code>, <code>top</code>, <code>bottom</code> and <code>none</code>. See <code>label</code> above.
|-
| <code>coordinates</code> || Can be used with <code>{{tl|coord}}</code> template to display geographical coordinates and a pushpin on an optional map.
|-
| <code>coords_ref</code> || Used with {{nowrap| <code><nowiki><ref>...</ref></nowiki></code>}} tags to cite a references.
|-
| <code>mapframe</code> || Map frame using {{tl|infobox mapframe}}, see [[#Mapframe maps]]
|-
| colspan="2" style="text-align: center; font-weight: bold;" | Other parameters
|-
| <code>name_origin</code> || Where did the name of this feature originate? Who named this feature?
|-
| <code>location</code> || Textual description of the location of the feature. The specific location of the geyser first, followed by the general region. For well known geyser regions, use the local group or basin (e.g., ''Lower Geyser Basin, Yellowstone National Park'').
|-
| <code>spring_source</code> || Source for the water for the spring.
|-
| <code>elevation</code> || The elevation of the feature (don't forget to include both feet and meters).
|-
| <code>hot_spring_type</code> || The type of geothermal features. Possible options are [[geyser]], [[fumarole]], [[mud pot]] or [[hot spring]]. Geysers can be cone or fountain geysers. For non-geothermal springs, use <code>type</code>
|-
| <code>type</code> || The type of spring. Possible options are. For geothermal springs, use <code>hot_spring_type</code>
|-
| <code>provides</code> || Body of water into which the spring discharges.
|-
| <code>height</code> || For geysers, the minimum to maximum height of an eruption (e.g. - 15 - 20 minutes)
|-
| <code>duration</code> || For geysers, the minimum to maximum duration of an eruption
|-
| <code>frequency</code> || For geysers, the average frequency of an eruption
|-
| <code>discharge</code> || Water discharge for a geyser or a flowing spring
|-
| <code>magnitude</code> || The magnitude of the discharge as measured by the [[Spring (hydrology)#Classification|spring classification scale]]
|-
| <code>temperature</code> || For pools, the average temperature of the water in degrees Fahrenheit and Celsius
|-
| <code>depth</code> || For pools, the average depth of the feature
|-
| <code>child</code> || Used to embed this template in another. See [[#Template embedding|below]].
|-
| <code>embedded</code> || Used to embed another template in this one. See [[#Template embedding|below]].
|}

==Map display methods==
This template uses [[Template:Location map]]. For more details, see the documentation for that template.

===Simple map image method===
Any map image can be displayed by specifying the name of the image file. Notice that when a photo and a map are specified the map will appear at the bottom of the infobox and that if no photo is specified the map will be displayed at the top.

{{Infobox spring
| name = Daisy Geyser
| photo = Daisy Geyser erupting in Yellowstone National Park edit.jpg
| photo_width = 
| photo_caption = Daisy Geyser during an eruption
| map_image = NorthernSectionUpperGeyserBasin-Daisy.jpg
| map_caption = Map of Upper Geyser Basin
| map_size = 200
| name_origin = Hague Geological Surveys, 1880s
| location = Upper Geyser Basin, Yellowstone National Park, [[Teton County, Wyoming]]
| coordinates = {{coord|44|28|12|N|110|50|42|W|display=inline}}
| coords_ref =
| elevation = {{convert|7329|ft|0}}
| temperature = 84.5 °C (184.1 °F)
}}
<syntaxhighlight lang="wikitext" style="overflow:auto; font-size: 90%;">
{{Infobox spring
| name = Daisy Geyser
| photo = Daisy Geyser erupting in Yellowstone National Park edit.jpg
| photo_width = 
| photo_caption = Daisy Geyser during an eruption
| map_image = NorthernSectionUpperGeyserBasin-Daisy.jpg
| map_caption = Map of Upper Geyser Basin
| map_size = 200
| name_origin = Hague Geological Surveys, 1880s
| location = Upper Geyser Basin, Yellowstone National Park, [[Teton County, Wyoming]]
| coordinates = {{coord|44|28|12|N|110|50|42|W|display=inline}}
| coords_ref =
| elevation = {{convert|7329|ft|0}}
| temperature = 84.5 °C (184.1 °F)
}}
</syntaxhighlight>
{{clear}}

{{Infobox spring
| name = Big Cone
| photo = Big cone.jpg
| photo_width = 400px 
| photo_caption = Big Cone Geyser
| map_image = WestThumbGeyserBasin-Big Cone.jpg
| map_caption = West Thumb Geyser Basin
| map_alt = Map shows Big Cone is in the West Thumb Geyser Basin.
| map_size =
| location = West Thumb Geyser Basin, Yellowstone National Park, [[Teton County, Wyoming]]
| coordinates = {{coord|44|25|03|N|110|34|14|W|type:landmark_region:US-WY|display=inline}}
| coords_ref =
| elevation = {{convert|7864|ft|m|1}}
}}
<syntaxhighlight lang="wikitext" style="overflow:auto; font-size: 90%;">
{{Infobox spring
| name = Big Cone
| photo = Big cone.jpg
| photo_width = 400px 
| photo_caption = Big Cone Geyser
| map_image = WestThumbGeyserBasin-Big Cone.jpg
| map_caption = West Thumb Geyser Basin
| map_alt = Map shows Big Cone is in the West Thumb Geyser Basin.
| map_size =
| location = West Thumb Geyser Basin, Yellowstone National Park, [[Teton County, Wyoming]]
| coordinates = {{coord|44|25|03|N|110|34|14|W|type:landmark_region:US-WY}}
| coords_ref =
| elevation = {{convert|7864|ft|m|1}}
}}
</syntaxhighlight>
{{clear}}

===Geographical coordinate method===

A mark can be superimposed on one of a set of special map templates. If a valid map name is specified this is the method the template will attempt to use. To display a mark, the geographic coordinates must be specified using the {{tl|Coord}} template. See the documentation for {{tl|Location map}}. The parameters for this template correspond with a subset of the parameters for Template:Location map. A map template can be found using these sources:

:[[Template:Location map/List|List of templates]] - Many of the items listed here are redirects and a few templates may not function as expected.
:[[:Category:Location map templates]] - templates sorted by category.
:[[Special:WhatLinksHere/Template:Location map/Info]] - a search that might help.
:[[Special:Prefixindex/Template:Location map]] - another search that might help.

All of the names begin with the words "Location map" followed by the area covered. The value you need to specify is the area name. The map template for the for Alberta, Canada is [[Module:Location map/data/Canada Alberta]]. In this case specify <code>map=Canada Alberta</code> or, in this case, <code>map=Alberta</code>. The following example does not produce output that is optimum for use with the geysers of Yellowstone but demonstrates the method.

{{Infobox spring
| name = Big Alcove Spring
| map = USA Wyoming
| map_alt = Big Alcove Spring is located in the northwestern Wyoming
| map_caption = Location of Big Alcove Spring in Wyoming
| map_width = 200
| label = Big Alcove Spring
| coordinates = {{coord|44|43|8|N|110|42|24|W|region:US-WY|display=inline }}
}}
<syntaxhighlight lang="wikitext" style="overflow:auto; font-size: 90%;">
{{Infobox spring
| name = Big Alcove Spring
| map = USA Wyoming
| map_alt = Big Alcove Spring is located in the northwestern Wyoming
| map_caption = Location of Big Alcove Spring in Wyoming
| map_width = 200
| label = Big Alcove Spring
| coordinates = {{coord|44|43|8|N|110|42|24|W|region:US-WY|display=inline }}
}}
</syntaxhighlight>

The label is optional. By default it is usually displayed to the left of the mark.
{{clear}}

===Mapframe maps===

{{Infobox mapframe/doc/parameters
| mapframe = onByDefault if there is no {{para|pushpin map}}
| mapframe-zoom = 5
| mapframe-marker = hot-spring
| mapframe-marker-color = #A8BDEC
| mapframe-width = 250
| mapframe-frame-width = 250
}}

== Template embedding ==
This template can be embedding in another infobox template by adding the code <code><nowiki>|child=yes</nowiki></code>. To embed another template in this one use <code><nowiki>|embedded={{Infobox ...</nowiki></code>.

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

== Tracking category ==
* {{clc|Pages using infobox spring with unknown parameters}}

<includeonly>{{basepage subpage|

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

Template:Infobox spring/doc - Revision history

>Joy: /* Mapframe maps */ document onByDefault from the code