Khon 模板:Infobox weather event/doc ke ngièn-sṳ́-mâ

{{Documentation subpage}}
{{High-use}}
{{see also|Template:Infobox weather event/doc/FAQ}}
{{TemplateStyles|Template:Infobox weather event/styles.css}}
{{Lua|Module:Storm categories|Module:InfoboxImage|Module:Template wrapper|Module:Check for unknown parameters}}
{{Infobox weather event/doc/adoption}}
This template creates a completely modular weather infobox, which aims to support almost all severe weather events and allow modularity. Each of the subboxes are developed with modularity in mind. TemplateData will be available for these boxes soon to ease adding infoboxes to existing articles.

The primary infobox (this infobox) allows for a storm's image, name, and meteorological history. Meteorological data such as storm category and intensity or other data such as damages and deaths, are provided through subboxes. {{notice|All usages must be followed by [[Template:Infobox weather event/Footer]] to close the infobox (exceptions apply; see [[#Header|below]]). Please keep this in mind when replacing templates like {{t|Infobox storm}} which did not require a footer.}}

This infobox aims to replace the current weather-related infoboxes: {{t|Infobox tropical cyclone}}, {{t|Infobox storm}}, and {{t|Infobox tropical cyclone current}}. See [[Template:Infobox weather event/Feature parity]] for a comparison of parameters in other infoboxes with this infobox. Please do not use this infobox on flood articles since its usage is controversial. Please use {{t|Infobox flood}} instead.

== Usage ==

Winds and gusts units are always in knots. Pressure is always in millibars/hectopascals. These are non-configurable values in order to standardize and maintain consistency between all boxes. Damages are always in United States dollars, unless explicitly set with {{para|currency}}.

=== Basic ===
A very minimal box can be created using the following wikitext.
{| class="wikitable" style="width: 100%"
! style="width: 100%" | Wikitext
! Output
|-
|<syntaxhighlight lang="wikitext">{{Infobox weather event
| name = Typhoon Tip <!-- This is pre-supplied by the article name. -->
| image = File:TIP_1979-10-12-2333.jpg
| caption = Typhoon Tip at its record peak intensity on October 12
| formed = October 4, 1979
| extratropical = October 19, 1979
| dissipated = October 24, 1979
| footer = yes <!-- For display purposes. -->
}}</syntaxhighlight>
|{{Infobox weather event
| name = Typhoon Tip <!-- This is pre-supplied by the article name. -->
| image = File:Tip 1979-10-12 2333Z.jpg
| caption = Typhoon Tip at its record peak intensity on October 12
| formed = October 4, 1979
| extratropical = October 19, 1979
| dissipated = October 24, 1979
| footer = yes <!-- For display purposes. -->
}}
|}

=== Header ===
Up to two images can be displayed by the box at a given time. The image displayed may be the storm's satellite image (using {{para|image}}), its track map (using {{para|track}}), its forecast map (using {{para|forecast}}), or a combination of the two. The track map and forecast map may not be shown together. Caption, alternative text, and sizing can be set relative to each of the images above
{| class="wikitable" style="width: 100%"
! Main parameter !! Caption !! Alternative text !! Upright (scaling) !! Width
|-
| {{para|image}} || {{para|caption}} || {{para|alt}} || {{para|image-upright}} || {{para|image-width}}
|-
| {{para|track}} || {{para|track-caption}} || {{para|track-alt}} || {{para|track-upright}} || {{para|track-width}}
|-
| {{para|forecast}} || {{para|forecast-caption}} || {{para|forecast-alt}} || {{para|forecast-upright}} || {{para|forecast-width}}
|}

All parameters of {{t|Infobox weather event/History}} is usable in the header box. You can add in another meteorological history section for long-lasting storms which experienced different stages.

If the event is a single event and does not need meteorological info, effects, or a footer, {{para|footer|yes}} can be set to immediately close the template, skipping the need for a footer.

=== [[Template:Infobox weather event/History|History]] ===
{{Infobox weather event/History/doc|maindoc=yes}}

=== Tropical cyclones ===
==== Scales ====
Each meteorological agency has a subbox of its own, which links to the correct scale and automatically computes the category of a storm.

===== [[Template:Infobox weather event/NWS|NWS]] =====
{{Infobox weather event/NWS/doc|maindoc=yes}}

===== [[Template:Infobox weather event/JMA|JMA]] =====
{{Infobox weather event/JMA/doc|maindoc=yes}}

===== [[Template:Infobox weather event/MF|MF]] =====
{{Infobox weather event/MF/doc|maindoc=yes}}

===== [[Template:Infobox weather event/IMD|IMD]] =====
{{Infobox weather event/IMD/doc|maindoc=yes}}

===== [[Template:Infobox weather event/Aus|Australian scale]] =====
The Australian scale is used by multiple agencies. Multiple infoboxes are provided, each changing the issuing agency but providing the same scale.

The following templates can be used to show this scale:
* [[Template:Infobox weather event/BOM]]{{snd}}[[Bureau of Meteorology]]
* [[Template:Infobox weather event/BMKG]]{{snd}}[[Meteorology, Climatology, and Geophysical Agency]] (TCWC Jakarta)
* [[Template:Infobox weather event/PNGNWS]]{{snd}}Papua New Guinea National Weather Service
* [[Template:Infobox weather event/FMS]]{{snd}}[[Fiji Meteorological Service]]
* [[Template:Infobox weather event/MetService]]{{snd}}[[MetService|Meteorological Service of New Zealand]]
{{#invoke:Infobox weather event/scalebar|main|scale=Aus}}

==== Non-RSMC scales ====
Scale subboxes also exist for agencies which are not the Regional Specialized Meteorological Center. While the use of the JTWC subbox is generally allowed on all basins besides those which use the Saffir&ndash;Simpson scale (North Atlantic/Eastern Pacific/Central Pacific), other agency subboxes, such as those for the [[PAGASA]] (Philippines), [[Central Weather Bureau|CWB]] (Taiwan; subbox does not exist as of now), and [[Pakistan Meteorological Department|PMD]] (Pakistan; subbox does not exist as of now) should generally be used only when the storm is not recognized by the basin's RSMC.

===== [[Template:Infobox weather event/JTWC|JTWC]] =====
{{Infobox weather event/JTWC/doc|maindoc=yes}}

===== [[Template:Infobox weather event/PAGASA|PAGASA]] =====
{{Infobox weather event/PAGASA/doc|maindoc=yes}}

===== [[Template:Infobox weather event/HKO|HKO]] =====
{{Infobox weather event/HKO/doc|maindoc=yes}}

===== [[Template:Infobox weather event/CMA|CMA]] =====
{{Infobox weather event/CMA/doc|maindoc=yes}}

==== Historical scales ====
These are scales that were used at some point in the past but are no longer in use.

===== [[Template:Infobox weather event/JTWC|NPMOC]] =====
{{Infobox weather event/NPMOC/doc|maindoc=yes}}

===== No scale =====
To display meteorological information in cases where an agency or scale is unavailable (such as in the case of historical storms, e.g. the [[1881 Haiphong typhoon]]), you can directly use the [[Template:Infobox weather event/meteorology|/meteorology]] sub-box. This will remove agency and measurement interval from the box header.

By default, the category "{{storm name|}}" will appear as the category. This can be overridden by setting {{para|category}} to [[Module:Storm categories#Full list of available values|any available storm category ID]].

{| style="width: 100%"
|<syntaxhighlight lang="wikitext">{{Infobox weather event/meteorology
| category = TY
| pressure = 902
}}</syntaxhighlight>
|{{Infobox weather event
| name =
| no-history = yes
}}{{Infobox weather event/meteorology
| category = TY
| pressure = 902
}}{{Infobox weather event/Footer}}
|}

=== [[Template:Infobox weather event/Winter storm|Winter storms]] ===
{{Infobox weather event/Winter storm/doc|maindoc=yes}}

=== [[Template:Infobox weather event/Tornado outbreak|Tornado outbreaks]] ===
{{Infobox weather event/Tornado outbreak/doc|maindoc=yes}}

=== [[Template:Infobox weather event/Tornado family|Tornado families]] ===
{{Infobox weather event/Tornado family/doc|maindoc=yes}}

=== [[Template:Infobox weather event/Tornado|Tornadoes]] ===
{{Infobox weather event/Tornado/doc|maindoc=yes}}

=== [[Template:Infobox weather event/Storm|Generic storms]] ===
{{Infobox weather event/Storm/doc|maindoc=yes}}

=== [[Template:Infobox weather event/Effects|Effects]] ===
{{Infobox weather event/Effects/doc|maindoc=yes}}

=== [[Template:Infobox weather event/Footer|Footer]] ===
{{Infobox weather event/Footer/doc|maindoc=yes}}

== Example ==
=== Article page storm ===
{| style="width: 100%"
|<syntaxhighlight lang="wikitext" line>{{Infobox weather event
| name = Cyclone Matmo–Bulbul
| image = Bulbul 2019-11-09 0742Z.jpg
| caption = Cyclone Bulbul near peak intensity, just before landfall in [[West Bengal]] on November 9
| as = Severe Tropical Storm Matmo
| formed = October 28, 2019
| dissipated = October 31, 2019
}}{{Infobox weather event/JMA
| winds = 50
| pressure = 992
}}{{Infobox weather event/History
| as = Very Severe Cyclonic Storm Bulbul
| formed = November 5, 2019
| dissipated = November 11, 2019
}}{{Infobox weather event/IMD
| winds = 75
| pressure = 976
}}{{Infobox weather event/JTWC
| winds = 105
| pressure = 955
| pressure-prefix = ~
}}{{Infobox weather event/Effects
| year = 2019
| deaths = 43 total
| damages = 3537000000
| affected = [[Vietnam]], [[Laos]], [[Cambodia]], [[Thailand]], [[Myanmar]], [[Andaman and Nicobar Islands]], [[Eastern India]], [[Bangladesh]]
}}{{Infobox weather event/Footer
| season = [[2019 Pacific typhoon season|2019 Pacific typhoon]]<br>and [[2019 North Indian Ocean cyclone season|North Indian Ocean cyclone seasons]]
}}
</syntaxhighlight>
|{{Infobox weather event
| name = Cyclone Matmo–Bulbul
| image = Bulbul 2019-11-09 0742Z.jpg
| caption = Cyclone Bulbul near peak intensity, just before landfall in [[West Bengal]] on November 9
| as = Severe Tropical Storm Matmo
| formed = October 28, 2019
| dissipated = October 31, 2019
}}{{Infobox weather event/JMA
| winds = 50
| pressure = 992
}}{{Infobox weather event/History
| as = Very Severe Cyclonic Storm Bulbul
| formed = November 5, 2019
| dissipated = November 11, 2019
}}{{Infobox weather event/IMD
| winds = 75
| pressure = 976
}}{{Infobox weather event/JTWC
| winds = 105
| pressure = 955
| pressure-prefix = ~
}}{{Infobox weather event/Effects
| year = 2019
| deaths = 43 total
| damages = 3537000000
| affected = [[Vietnam]], [[Laos]], [[Cambodia]], [[Thailand]], [[Myanmar]], [[Andaman and Nicobar Islands]], [[Eastern India]], [[Bangladesh]]
}}{{Infobox weather event/Footer
| season = [[2019 Pacific typhoon season|2019 Pacific typhoon]]<br>and [[2019 North Indian Ocean cyclone season|North Indian Ocean cyclone seasons]]
}}
|}

== Subpages ==
Sub-templates which start with a lowercase character are meta-templates, whereas templates which start with capital characters are expected to be used directly. Note that this list also includes miscellaneous template files (such as [[Template:Infobox weather event/styles.css|styles.css]]).
{{Special:PrefixIndex/Template:Infobox weather event/}}

==Tracking categories==
* {{clc|Pages using infobox weather event with unknown parameters}}

== TemplateData ==
<templatedata>
{
	"params": {
		"1": {
			"label": "Content",
			"description": "Content of the box. May be child boxes. This will enable the footer, so more subboxes cannot be added afterwards.",
			"type": "content"
		},
		"name": {
			"label": "Name",
			"description": "Name of the event. The article title is used by default.",
			"type": "string"
		},
		"child": {
			"label": "Child display?",
			"description": "Whether this is a child box or not. Use `yes`, unless you're using this box standalone.",
			"example": "yes",
			"type": "boolean",
			"default": "yes"
		},
		"image": {
			"label": "Image",
			"description": "Image of the event. If this is a tropical cyclone, consult the WikiProject Tropical cyclones style guide for proper image selection.",
			"type": "wiki-file-name",
			"suggested": true
		},
		"width": {
			"aliases": [
				"image-width",
				"image-size"
			],
			"label": "Image width",
			"description": "Width of the image. When possible, use 'image-upright' instead for accessibility support.",
			"type": "string"
		},
		"image-upright": {
			"label": "Image scale/upright",
			"description": "The sizing scale of the image. '1.0' is the user's selected default image size. '2.0' is twice the user's selected default image size.",
			"type": "number"
		},
		"alt": {
			"label": "Alternate text",
			"description": "Alternate text for the image.",
			"type": "string",
			"suggested": true
		},
		"caption": {
			"label": "Caption",
			"description": "Caption for the image.",
			"type": "content",
			"suggested": true
		},
		"track": {
			"label": "Track map",
			"description": "Track map of the event.  This will be overridden by the forecast map, if one was provided.",
			"type": "wiki-file-name",
			"suggested": true
		},
		"track-width": {
			"aliases": [
				"track-size"
			],
			"label": "Track map size",
			"description": "Width of the track map. When possible, use 'track-upright' instead for accessibility support.",
			"type": "string"
		},
		"track-upright": {
			"label": "Track map scale/upright",
			"description": "The sizing scale of the track map. '1.0' is the user's selected default image size. '2.0' is twice the user's selected default image size.",
			"type": "number"
		},
		"track-alt": {
			"label": "Track map alternate text",
			"description": "Alternate text for the track map.",
			"type": "string"
		},
		"track-caption": {
			"label": "Track map caption",
			"description": "Caption for the track map.",
			"type": "content"
		},
		"forecast": {
			"label": "Forecast map",
			"description": "Forecast map of the event. This will override the track map, if one was provided.",
			"type": "wiki-file-name",
			"suggested": true
		},
		"forecast-width": {
			"aliases": [
				"forecast-size"
			],
			"label": "Forecast map size",
			"description": "Width of the forecast map. When possible, use 'forecast-upright' instead for accessibility support.",
			"type": "string"
		},
		"forecast-upright": {
			"label": "Forecast map scale/upright",
			"description": "The sizing scale of the forecast map. '1.0' is the user's selected default image size. '2.0' is twice the user's selected default image size.",
			"type": "number"
		},
		"forecast-alt": {
			"label": "Forecast map alternate text",
			"description": "Alternate text for the forecast map.",
			"type": "string"
		},
		"forecast-caption": {
			"label": "Forecast map caption",
			"description": "Caption for the forecast map.",
			"type": "content"
		},
		"location": {
			"aliases": [
				"place"
			],
			"label": "Location",
			"description": "Location where the event occurred. Wikilink, if applicable.",
			"type": "content"
		},
		"coordinates": {
			"label": "Coordinates",
			"description": "Coordinates of the event. Use 'lat' and 'lon' instead, when applicable. Do not confuse with current coordinates; those must be in a /Current subbox. Supply this value using {{coord}}.",
			"type": "content"
		},
		"cause": {
			"label": "Cause",
			"description": "Cause of the event.",
			"type": "content"
		},
		"no-history": {
			"label": "No history?",
			"description": "Disables the meteorological history for this infobox.",
			"type": "boolean"
		},
		"as": {
			"label": "Name",
			"description": "Name of the event during the first stage of its existence.",
			"type": "content",
			"suggested": true
		},
		"name-italics": {
			"label": "Name italics?",
			"description": "Set to \"off\" to disable name italics.",
			"type": "string",
			"suggestedvalues": [
				"off"
			]
		},
		"duration": {
			"label": "Duration",
			"description": "The event's duration of existence.",
			"type": "content"
		},
		"date": {
			"label": "Date",
			"description": "The day that the event occurred. Used for single-day events, such as floods and single tornadoes. When possible, use {{start date}}.",
			"type": "content",
			"suggested": true
		},
		"formed": {
			"label": "Formed",
			"description": "The day that the storm formed. When possible, use {{start date}}.",
			"type": "content",
			"suggested": true
		},
		"renamed": {
			"label": "Renamed",
			"description": "The day that the storm was renamed. Use this for storms where the responsible agency is the same (Atlantic–Pacific crossover hurricanes). When possible, use {{start date}}.",
			"type": "content",
			"suggested": true
		},
		"crossed-over": {
			"label": "Crossed over",
			"aliases": [
				"crossed"
			],
			"description": "The day that the storm crossed over to another basin (and thus, received a new name). For storms where the responsible agency is the same (Atlantic–Pacific crossover hurricanes), use \"Renamed\" instead. When possible, use {{start date}}.",
			"type": "content",
			"suggested": true
		},
		"exited": {
			"label": "Exited land",
			"aliases": [
				"exited-land"
			],
			"description": "The day that the storm exited land.",
			"type": "content"
		},
		"remnant low": {
			"label": "Remnant low",
			"aliases": [
				"remnant",
				"low",
				"remnant-low"
			],
			"description": "The day on which the storm transitioned into a remnant low.",
			"type": "content"
		},
		"post-tropical": {
			"label": "Post-tropical",
			"description": "The day that the tropical cyclone became post-tropical.",
			"type": "content"
		},
		"extratropical": {
			"label": "Extratropical",
			"description": "The day that the tropical cyclone became extratropical.",
			"type": "content"
		},
		"extratropical-label": {
			"label": "Extratropical label",
			"description": "The label for the 'extratropical' parameter, if one should be used.",
			"type": "content"
		},
		"dissipated": {
			"label": "Dissipated",
			"description": "The day that the storm dissipated. When possible, use {{end date}}.",
			"type": "content",
			"suggested": true
		},
		"footer": {
			"label": "Footer?",
			"description": "Set to 'true' to include a footer. This will prevent further subboxes from being added.",
			"type": "boolean"
		},
		"bodystyle": {
			"label": "Body style",
			"description": "Custom CSS for the box",
			"type": "string"
		},
		"subtropical": {
			"label": "Subtropical",
			"description": "The day that the tropical cyclone became subtropical. For the transition of extratropical cyclones to tropical cyclones, see \"formed\".",
			"type": "date",
			"suggested": true
		}
	},
	"paramOrder": [
		"name",
		"child",
		"bodystyle",
		"image",
		"width",
		"image-upright",
		"alt",
		"caption",
		"track",
		"track-width",
		"track-upright",
		"track-alt",
		"track-caption",
		"forecast",
		"forecast-width",
		"forecast-upright",
		"forecast-alt",
		"forecast-caption",
		"location",
		"coordinates",
		"cause",
		"no-history",
		"as",
		"name-italics",
		"duration",
		"date",
		"formed",
		"renamed",
		"crossed-over",
		"exited",
		"subtropical",
		"remnant low",
		"post-tropical",
		"extratropical",
		"extratropical-label",
		"dissipated",
		"1",
		"footer"
	],
	"description": "Header for the infobox for weather events, storms, tropical cyclones, nor'easters, tornadoes, tornado outbreaks, winter storms, and any other meteorological event.",
	"format": "block"
}
</templatedata>

<includeonly>{{sandbox other||
<!-- Categories below this line -->
{{DEFAULTSORT:Weather event}}
[[Category:Weather event infobox templates| ]]
[[Category:Infobox templates]]
[[Category:Intricate templates]]
[[Category:Hurricane infobox templates]]
[[Category:Extratropical cyclone infobox templates]]
[[Category:Flood templates]]
}}</includeonly>