View source for Template:Infobox mine/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Coordinates|Module:Check for unknown parameters}}

==Blank infobox==
{{Generic template demo
| name
| image
| width
| caption
| alt
| <!-- pushpin_map -->
| <!-- pushpin_mapsize -->
| <!-- pushpin_map_alt -->
| <!-- pushpin_map_caption -->
| <!-- pushpin_image -->
| <!-- pushpin_label -->
| <!-- pushpin_label_position -->
| coordinates = ''Use {{tl|Coord}}''
| location
| place
| state/province
| country
| subdivision_type
| state/province
| country
| products
| amount
| financial year
| type
| greatest depth
| discovery year
| opening year
| active years
| closing year
| owner
| official website
| acquisition year
| module <!-- or 'embedded' or 'nrhp' -->
}}

<pre style="overflow:auto;">
{{Infobox mine
| name               = 
| image              = 
| width              = 
| caption            = 
| alt                = 
| pushpin_map        = 
| pushpin_mapsize    = 
| pushpin_map_alt    = 
| pushpin_map_caption= 
| pushpin_image      = 
| pushpin_label      = 
| pushpin_label_position = 
| coordinates        = <!-- {{Coord|latitude|N/S|longitude|E/W|display=inline,title}} -->
| place              = 
| subdivision_type   = 
| state/province     = 
| country            = 
| products           = 
| amount             = <!--include units--> 
| financial year     = 
| type               = 
| greatest depth     = 
| discovery year     =
| opening year       = <!-- {{Start date|YYYY}} -->
| active years       = <!-- use only if inactive for a period of time-->
| closing year       = <!-- {{End date|YYYY}} -->
| owner              =
| official website   = <!-- {{URL|example.com}} -->
| acquisition year   = 
| module             = <!-- or 'embedded' or 'nrhp' -->
}}
</pre>

==Parameters==

=== Name and image ===
* '''name''' = The common name of the mine.
* '''image''' = An image of the mine (without the prefix "Image:").
* '''width''' = Image width e.g. ''200px''
* '''caption''' = Caption for the image.
* '''alt''' = alternative text for the image, if the image has not yet loaded. Also controls the text displayed when the image is hovered over.

=== Location map ===
* '''pushpin_map''' = Name of a location map definition (not a File: or Image: name) which can use with [[Template:Location map]] (i.e. "USA Colorado" would generate <nowiki>{{Location map|USA Colorado}}</nowiki> which uses map definitions from [[Module:Location map/data/USA Colorado]]).
* '''pushpin_mapsize''' = Optional. The width to display the pushpin map, in pixels. Just the number, no "px". If the parameter is omitted or value left empty, defaults to ''220''.
* '''pushpin_map_alt''' = Optional. [[Wikipedia:Alternative text for images|Alt text]] for the pushpin map.
* '''pushpin_map_caption''' = Optional. Caption to display below the pushpin map.
* '''pushpin_image''' = Optional. File name of a different image using same map coordinates.
* '''pushpin_label''' = Optional. The label to place next to the pushpin coordinate marker. Defaults to the value of the '''name''' parameter.
* '''pushpin_label_position''' = Optional. The position of the label on the pushpin map relative to the pushpin coordinate marker. Valid options are ''left'', ''right'', ''top'', ''bottom'', and ''none''. Defaults to ''right''.

=== Coordinates ===
* '''coordinates''' = [[Geographic coordinate system|Geographic coordinates]], using the {{tl|Coord}} template (with {{para|display|inline,title}}). Unless a value for <code>type:</code> is specified, <code>type:landmark</code> is automatically added; unless a value for <code>region:</code> is specified, the template attempts to convert {{para|country}} and {{para|state/province}} into a valid region code which is automatically added. See {{tl|Coord}} for more information on how to use it.

=== Location ===
* '''place''' =
* '''subdivision_type''' = state/province (affects label for the next entry)
* '''state/province''' =
* '''country''' = 
* ''the coordinates are displayed below the country''

=== Production ===
* '''products''' = what the mine produces/produced: e.g. silver, zinc, bauxite. May list more than one
* '''amount''' = mine production (with unit, e.g. tons, troy ounces, etc.)
* '''financial year''' = year of above the production figure, or "lifetime"
* '''type''' = e.g. open-pit, underground, etc.
* '''greatest depth''' =

=== History ===
* '''discovery year''' = Year mine/deposit was discovered.
* '''opening year''' = Year mine opened. Use {{Tl|Start date}}.
* '''active years''' = Use if mine opened and closed more than once. Such as 1990-1995, 1997-2002; use {{Tl|Start date}} for the first one only.
* '''closing year''' = Year mine closed. Use {{Tl|End date}}.

=== Owner ===
* '''owner''' = 
* '''official website''' = use {{Tl|URL}}
* '''acquisition year''' = year current owner acquired the mine.

=== Embedding other templates ===
The <code>module=</code>, <code>embedded=</code>, or <code>nrhp=</code> parameters can be used for embedding other templates into this infobox (see [[Wikipedia:Infobox modules]]):

<pre style="overflow: auto;">
{{Infobox mine
| name = 
...
| module = <!-- or 'embedded' or 'nrhp' -->
  {{Infobox ABC
  | embed = yes <!-- or child=yes or subbox=yes-->
  ...
  }}
}}
</pre>

== Example ==
<!--a somewhat humorous example, using a legendary mine-->
{{Infobox mine
| name               = Lost Dutchman's Mine
| image              = SUPERSTITIONS AZ15.jpg
| width              = 250px
| caption            = Supersition Mountains
| alt                = The Praying Hands Formation, near the mine
| pushpin_map        = Arizona
| pushpin_mapsize    = 200px
| pushpin_map_alt    = 
| pushpin_map_caption= 
| pushpin_image      = 
| pushpin_label      = 
| pushpin_label_position = 
| coordinates        = {{coord|33.42598|N|111.12266|W|display=inline,title}}
| place              = [[Superstition Mountains]]
| subdivision_type   = State
| state/province     = [[Arizona]]
| country            = United States
| products           = Gold
| amount             = 50,000 troy ounces
| financial year     = Lifetime
| type               = Underground
| greatest depth     = 
| discovery year     =
| opening year       = {{Start date|1875}}
| active years       = <!-- use only if inactive for a period of time-->
| closing year       = {{End date|1883}}
| owner              = Jacob Waitz
| official website   = {{URL|http://www.example.com}}
| acquisition year   = 
| module             = 
}}

<pre style="overflow:auto;">
{{Infobox mine
| name               = Lost Dutchman's Mine
| image              = SUPERSTITIONS AZ15.jpg
| width              = 250px
| caption            = Supersition Mountains
| alt                = The Praying Hands Formation, near the mine
| pushpin_map        = Arizona
| pushpin_mapsize    = 200px
| pushpin_map_alt    = 
| pushpin_map_caption= 
| pushpin_image      = 
| pushpin_label      = 
| pushpin_label_position = 
| coordinates        = {{coord|33.42598|N|111.12266|W|display=inline,title}}
| place              = [[Superstition Mountains]]
| subdivision_type   = State
| state/province     = [[Arizona]]
| country            = United States
| products           = Gold
| amount             = 50,000 troy ounces
| financial year     = Lifetime
| type               = Underground
| greatest depth     = 
| discovery year     =
| opening year       = {{Start date|1875}}
| active years       = <!-- use only if inactive for a period of time-->
| closing year       = {{End date|1883}}
| owner              = Jacob Waitz
| official website   = {{URL|http://www.example.com}}
| acquisition year   = 
| module             = 
}}
</pre>
{{clear}}

== Microformat ==
{{UF-hcard-geo}}

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

== TemplateData ==
{{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"params": {
		"name": {},
		"image": {},
		"width": {},
		"caption": {},
        "alt": {},
		"location": {},
		"place": {},
		"state/province": {},
		"country": {},
		"pushpin_map": {},
		"pushpin_label_position": {},
		"pushpin_label": {},
		"official_name": {},
		"pushpin_map_alt": {},
		"coordinates": {},
		"pushpin_map_caption": {},
		"map_caption": {},
		"pushpin_mapsize": {},
		"pushpin_image": {},
		"subdivision_type": {},
		"products": {},
		"amount": {},
		"type": {},
		"financial year": {},
		"greatest depth": {},
		"opening year": {},
		"active years": {},
		"closing year": {},
		"nrhp": {},
		"owner": {},
		"official website": {},
		"acquisition year": {},
		"embedded": {},
		"module": {},
		"discovery year": {}
	},
	"paramOrder": [
		"name",
		"image",
		"width",
		"caption",
        "alt",
		"location",
		"place",
		"state/province",
		"country",
		"pushpin_map",
		"pushpin_label_position",
		"pushpin_label",
		"official_name",
		"pushpin_map_alt",
		"coordinates",
		"pushpin_map_caption",
		"map_caption",
		"pushpin_mapsize",
		"pushpin_image",
		"subdivision_type",
		"products",
		"amount",
		"type",
		"financial year",
		"greatest depth",
		"discovery year",
		"opening year",
		"active years",
		"closing year",
		"nrhp",
		"owner",
		"official website",
		"acquisition year",
		"embedded",
		"module"
	]
}
</templatedata>
{{Collapse bottom}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Mining templates]]
[[Category:Business infobox templates|Mine]]
[[Category:Infobox templates with module parameter|Mine]]
[[Category:Templates that add a tracking category|{{PAGENAME}}]]
}}</includeonly>