View source for Template:Infobox weather event/Effects/doc

{{#if: {{yesno|{{{maindoc|}}}}} ||
{{Documentation subpage}}

== Usage ==
}}
This subbox provides a tally of weather event effects. This includes direct storm casualties, damages (in USD), affected regions, and infrastructural damages. The {{para|casualties}} parameter can be used to combine the {{para|fatalities}}, {{para|injuries}}, and {{para|missing}} parameters, should there be minimal or no casualties.

This box will show damages and losses in United States dollars by default. Adding a {{para|year}} parameter will also indicate the year when displaying monetary values for contextualizing cost at a specific point in time.

References may be added with {{para|refs}} or {{para|references}}. However, as much as possible, avoid placing references directly into the box and instead use article content to place references. You may also use {{para|IBTrACS}} to link to the storm's International Best Track Archive for Climate Stewardship (IBTrACS) entry. Using both will make both appear at the bottom row; using only references will make the row height shrink to cut down on unnecessary whitespace.

{| class="wikitable" width="100%"
! Wikitext
! Output
|-
| style="width: 100%" | <syntaxhighlight lang="wikitext" line>
{{Infobox weather event/Effects
| year = 2021 <!-- Used for damages. -->
| casualties = 37 (22 dead, 14 injured, 1 missing)
| fatalities = 22
| injuries = 14
| missing = 1
| evacuated = 500
| damage = 2400000
| losses = 31000000
| areas = [[United States]], [[Canada]], [[Mexico]], [[Cuba]]
| outages = 163,000
| houses-destroyed = 2,124,000
| ibtracs = XXXXX
| refs = {{fake ref}}{{fake ref|2}}
}}
</syntaxhighlight>
| {{Infobox weather event
| name =
| no-history = yes
}}{{Infobox weather event/Effects
| year = 2021 <!-- Used for damages. -->
| casualties = 37 (22 dead, 14 injured, 1 missing)
| fatalities = 22
| injuries = 14
| missing = 1
| evacuated = 500
| damage = 2400000
| losses = 31000000
| areas = [[United States]], [[Canada]], [[Mexico]], [[Cuba]]
| outages = 163,000
| houses-destroyed = 2,124,000
| ibtracs = XXXXX
| refs = {{fake ref}}{{fake ref|2}}
}}{{Infobox weather event/Footer}}
|}

Damages and economic losses can be set to a different currency using {{para|currency}} (or {{para|damage-currency}} and {{para|losses-currency}}), and a United States dollar-equivalent conversion can be provided. This can help contextualize weather events which impact a specific area. To set the USD conversion by hand, you can use {{para|usd-damages}} and {{para|usd-losses}} respectively. You can also opt to do these conversions automatically, as long as you provide a year and an ISO country code using {{para|country}}. Note that damages and losses are '''not multiplied'''. If the damages are 3 billion United States dollars, write {{para|damages|3000000000}}, not {{para|damages|3000}}.

The {{para|year}} parameter need not be the year that the event made impact, but rather a year relatively close to the year that it made impact, such that damages and losses can be calculated automatically.

When additional context is required, one may use {{para|damages-suffix}} to insert footnotes. {{para|damages-prefix}} can be used to insert symbols prior to the figure. <code>losses</code> also has suffix and prefix parameters, {{para|losses-suffix}} and {{para|losses-prefix}}, respectively.

{| class="wikitable" width="100%"
! Wikitext
! Output
|-
| style="width: 100%" | <syntaxhighlight lang="wikitext" line>
{{Infobox weather event/Effects
| year = 2021 <!-- Used for damages. -->
| currency = PHP <!-- Will control both damages and economic losses -->
| country = PHL <!-- Controls currency conversions -->
| damage = 2400000
| damage-country = PHL
| losses = 31000000 <!-- Will fall back to currency in `|damage=currency=` by default -->
| refs = {{fake ref}}{{fake ref|2}}
}}
</syntaxhighlight>
| {{Infobox weather event
| name =
| no-history = yes
}}{{Infobox weather event/Effects
| year = 2021 <!-- Used for damages. -->
| currency = PHP <!-- Will control both damages and economic losses -->
| country = PHL <!-- Controls currency conversions -->
| damage = 2400000
| damage-country = PHL
| losses = 31000000 <!-- Will fall back to currency in `|damage=currency=` by default -->
| refs = {{fake ref}}{{fake ref|2}}
}}{{Infobox weather event/Footer}}
|}

{{#if: {{yesno|{{{maindoc|}}}}} ||
== TemplateData ==
<templatedata>
{
	"params": {
		"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"
		},
		"bodystyle": {
			"label": "Body style",
			"description": "Custom CSS for the box",
			"type": "string",
			"default": "border-collapse: collapse"
		},
		"article": {
			"label": "Article",
			"description": "The article of the weather event, if the infobox is not already on the article. Links the \"overall effects\" header.",
			"type": "wiki-page-name"
		},
		"casualties": {
			"label": "Casualties",
			"description": "Casualties of the event. May be a summary of deaths, injuries, and missing, if the number is low.",
			"example": "4 missing, 2 dead",
			"type": "content",
			"suggested": true
		},
		"deaths": {
			"aliases": [
				"fatalities"
			],
			"label": "Deaths",
			"description": "Human deaths from the event. Avoid including unconfirmed deaths. Include a breakdown by country code if possible.",
			"example": "14",
			"type": "number",
			"suggested": true
		},
		"injuries": {
			"label": "Injuries",
			"description": "Number of injured people from the event. Include a breakdown by country code if possible.",
			"type": "number",
			"suggested": true
		},
		"missing": {
			"label": "Missing",
			"description": "Number of missing people due to the event. Include a breakdown by country code if possible.",
			"type": "number",
			"suggested": true
        },
		"evacuated": {
			"label": "Evacuated",
			"description": "Number of people evacuated due to the event. Include a breakdown by country code if possible.",
			"type": "number",
			"suggested": true
		},
		"damage-prefix": {
			"aliases": [
				"damages-prefix"
			],
			"label": "Damages prefix",
			"description": "Prefix for the damages. Use this to add approximation symbols, such as '~', '<', or '>'.",
			"example": "~",
			"type": "content"
		},
		"damage": {
			"aliases": [
				"damages"
			],
			"label": "Damages",
			"description": "Total damages incurred by the storm. Currency of this value is controlled by 'currency'/'damages currency'.",
			"type": "number",
			"suggested": true
		},
		"currency": {
			"label": "Currency",
			"description": "ISO 4217 code of the currency to be used for damages and economic losses. May be overriden.",
			"type": "string",
			"suggested": true
		},
		"damage-linked": {
			"aliases": [
				"damages-linked"
			],
			"label": "Currency link? (damages)",
			"description": "Whether to link the currency symbol in the display for damages.",
			"type": "boolean"
		},
		"damages-country": {
			"aliases": [
				"damage-country"
			],
			"label": "Country (damages)",
			"description": "The ISO 3166-1 alpha-3 (three-letter country code) for the country whose currency is used for damages. Allows for automatic conversion to United States Dollars. For future-proof articles, supply 'economic-year' as well.",
			"type": "string",
			"suggested": true
		},
		"damages-suffix": {
			"aliases": [
				"damage-suffix"
			],
			"label": "Damages suffix",
			"description": "Suffix for damages. Use this to add references, footnotes, or other content.",
			"type": "content"
		},
		"economic-losses-prefix": {
			"aliases": [
				"losses-prefix"
			],
			"label": "Economic losses prefix",
			"description": "Prefix for the maximum sustained winds. Use this to add approximation symbols, such as '~', '<', or '>'.",
			"example": "~",
			"type": "content"
		},
		"economic-losses": {
			"aliases": [
				"losses"
			],
			"label": "Economic losses",
			"description": "Total economic losses caused by the storm. Currency of this value is controlled by 'currency'/'damages currency'.",
			"type": "number",
			"suggested": true
		},
		"economic-losses-linked": {
			"aliases": [
				"losses-linked"
			],
			"label": "Currency link? (economic losses)",
			"description": "Whether to link the currency symbol in the display for damages.",
			"type": "boolean"
		},
		"usd-economic-losses": {
			"aliases": [
				"usd-losses"
			],
			"label": "USD economic losses",
			"description": "Economic losses in United States dollars. This helps contextualize damages for global readers.",
			"type": "number"
		},
		"economic-losses-country": {
			"aliases": [
				"losses-country"
			],
			"label": "Country (economic losses)",
			"description": "The ISO 3166-1 alpha-3 (three-letter country code) for the country whose currency is used for economic losses. Allows for automatic conversion to United States Dollars. For future-proof articles, supply 'economic-year' as well.",
			"type": "string",
			"suggested": true
		},
		"economic-losses-suffix": {
			"aliases": [
				"losses-suffix"
			],
			"label": "Economic losses suffix",
			"description": "Suffix for the economic losses. Use this to add references, footnotes, or other content",
			"type": "content"
		},
		"areas": {
			"aliases": [
				"affected"
			],
			"label": "Affected areas",
			"description": "Areas affected by the storm. Wikilink each area.",
			"type": "content",
			"suggested": true
		},
		"outages": {
			"label": "Power outages",
			"description": "Power outages caused.",
			"type": "content"
		},
		"houses-destroyed": {
			"label": "Houses destroyed",
			"description": "Number of houses destroyed.",
			"type": "content"
		},
		"refs": {
			"aliases": [
				"references"
			],
			"label": "References",
			"description": "References for the entire effects box. This is commonly used when all data for effects can be found on a single source. This appears at the bottom of the box on its own (or with the storm's IBTrACS link, if an ID was provided).",
			"type": "content",
			"suggested": true
		},
		"IBTrACS": {
			"label": "IBTrACS ID",
			"description": "The IBTrACS ID of the storm. This is the part that comes after \"v04r00-\" on the URL for the storm's IBTrACS page. By default, the ID from Wikidata is used (P4540). Leaving this blank will suppress display; remove it entirely to use Wikidata data.",
			"type": "string"
		},
		"damages-currency": {
			"aliases": [
				"damage-currency"
			],
			"label": "Currency (damages)",
			"description": "ISO 4217 code of the currency to be used for damages. Overrides 'currency'.",
			"type": "number"
		},
		"economic-year": {
			"aliases": [
				"year"
			],
			"label": "Economic year",
			"description": "The year to use as a basis for economic calculations. This powers inflation and currency conversion calculations.",
			"type": "number",
			"suggested": true
		},
		"usd-damages": {
			"aliases": [
				"usd-damage"
			],
			"label": "USD damages",
			"description": "Damages in United States dollars. This helps contextualize damages for global readers.",
			"type": "number"
		},
		"economic-losses-currency": {
			"aliases": [
				"losses-currency"
			],
			"label": "Currency (economic losses)",
			"description": "ISO 4217 code of the currency to be used for economic losses. Overrides 'currency'.",
			"type": "string"
		}
	},
	"description": "A subbox for summarizing the effects of a weather event.",
	"paramOrder": [
		"child",
		"bodystyle",
		"article",
		"casualties",
		"deaths",
		"injuries",
		"missing",
        "evacuated",
		"economic-year",
		"currency",
		"damage",
		"usd-damages",
		"damages-currency",
		"damage-linked",
		"damages-country",
		"damage-prefix",
		"damages-suffix",
		"economic-losses",
		"usd-economic-losses",
		"economic-losses-currency",
		"economic-losses-linked",
		"economic-losses-country",
		"economic-losses-prefix",
		"economic-losses-suffix",
		"areas",
		"outages",
		"houses-destroyed",
		"refs",
		"IBTrACS"
	],
	"format": "block"
}
</templatedata>

<includeonly>
{{sandbox other||
<!-- Categories below this line -->
[[Category:Weather event infobox templates|Effects]]
}}
</includeonly>
}}