View source for Template:Infobox outbreak/doc

{{Documentation subpage}}
{{High-use|info=It is used on the high-profile COVID articles.}}
{{Lua|Module:Infobox|Module:InfoboxImage|Module:String2}}

<!--
{{Uses Wikidata|P1995}}

-->

== Usage ==
This template is used for disease outbreaks.
{{Parameter names example|_template=|name|map1|alt1|legend1|map2|alt2|legend2|map3|alt3|legend3|map4|alt4|legend4|map5|alt5|legend5|disease|virus_strain|location|first_outbreak|first_reported|index_case|arrival_date|date|origin|source|type|confirmed_cases|active_cases|suspected_cases|severe_cases|hospitalized_cases|critical_cases|ventilator_cases|recovery_cases|deaths|fatality_rate|territories|total_ili|website|image| image_size|image_upright|alt|caption}}
<pre style="overflow:auto;">
{{Infobox outbreak
| name          =
| width         =
| image         =
| image_size    =
| image_upright =
| alt           =
| caption       =
| map1          =
| legend1       =
| map2          =
| legend2       =
| map3          =
| legend3       =
| map4          =
| legend4       =
| map5          =
| legend5       =
| disease       =
| virus_strain  = <!-- or | bacteria_strain = -->
                 <!-- or | parasite_strain = -->
                 <!-- or | pathogen_strain = -->
| location      =

| first_outbreak = <!-- Indicates first outbreak globally-->
| first_reported = <!-- Media or historical report, (evidence of prior circulation) -->
                  <!-- If first outbreak and first report are the same, choose one!-->

| index_case     =    <!-- National or international depending on article level -->
| arrival_date   = <!-- or | dates = -->
| date           =
| source         = <!-- Animal or other reservoir -->
| type           =
| confirmed_cases =
| active_cases    =
| suspected_cases =
| severe_cases    =
| hospitalized_cases = <!-- or | hospitalised_cases = -->
| critical_cases     = 
| ventilator_cases   =
| ecmo_cases      =
| recovery_cases  =
| deaths          =
| fatality_rate   =
| test_positivity_rate = <!-- Indicates test positivity rate -->
| territories     =
| total_ili       =
| website         =
| vaccinations    = <!-- A list in here will be shown without bullet points -->

}}</pre>

Note: {{param|width}} is currently ineffective.

==TemplateData==

{{update|type=TemplateData|date=March 2020}}
{{TemplateData header}}
{{collapse top|title=TemplateData}}
<templatedata>
{
	"description": "Infobox for pandemics",
	"format": "{{_\n| _______________ = _\n}}\n",
	"params": {
		"name": {
			"label": "Name",
			"description": "The name of the pandemic, appearing above the infobox in bold",
			"type": "string",
			"suggested": true
		},
		"width": {
			"label": "Width (ineffective)",
			"description": "The width of the infobox in px, pt, em or % (ineffective)",
			"example": "200px",
			"type": "line",
			"deprecated": true
		},
		"map1": {
			"label": "Map 1",
			"description": "A map of the pandemic, appearing below \"image\" but above the data",
			"type": "wiki-file-name"
		},
		"alt1": {
			"label": "Alt text for map 1",
			"description": "The alt text for map 1, for use when the image doesn't load or by screen readers or search engines",
			"type": "string"
		},
		"legend1": {
			"label": "Legend for map 1",
			"description": "Legend for map 1, appearing as a caption underneath the map",
			"type": "content"
		},
		"map2": {
			"label": "Map 2",
			"description": "A second map of the pandemic, appearing below map 1",
			"type": "wiki-file-name"
		},
		"alt2": {
			"label": "Alt text for map 2",
			"description": "The alt text for map 2, for use when the image doesn't load or by screen readers or search engines",
			"type": "string"
		},
		"legend2": {
			"label": "Legend for map 2",
			"description": "Legend for map 2, appearing as a caption underneath the map",
			"type": "content"
		},
		"map3": {
			"label": "Map 3",
			"description": "A third map of the pandemic, appearing below map 2",
			"type": "wiki-file-name"
		},
		"alt3": {
			"label": "Alt text for map 3",
			"description": "The alt text for map 3, for use when the image doesn't load or by screen readers or search engines",
			"type": "string"
		},
		"legend3": {
			"label": "Legend for map 3",
			"description": "Legend for map 3, appearing as a caption underneath the map",
			"type": "content"
		},
		"map4": {
			"label": "Map 4",
			"description": "A fourth map of the pandemic, appearing below map 3",
			"type": "wiki-file-name"
		},
		"alt4": {
			"label": "Alt text for map 4",
			"description": "The alt text for map 4, for use when the image doesn't load or by screen readers or search engines",
			"type": "string"
		},
		"legend4": {
			"label": "Legend for map 4",
			"description": "Legend for map 4, appearing as a caption underneath the map",
			"type": "content"
		},
		"map5": {
			"label": "Map 5",
			"description": "A fifth map of the pandemic, appearing below map 4",
			"type": "wiki-file-name"
		},
		"alt5": {
			"label": "Alt text for map 5",
			"description": "The alt text for map 5, for use when the image doesn't load or by screen readers or search engines",
			"type": "string"
		},
		"legend5": {
			"label": "Legend for map 5",
			"description": "Legend for map 5, appearing as a caption underneath the map",
			"type": "content"
		},
		"disease": {
			"label": "Disease",
			"description": "The name of the disease involved in the pandemic",
			"type": "line",
			"suggested": true
		},
		"virus_strain": {
			"label": "Virus strain",
			"description": "The virus strain involved in the pandemic (if applicable)",
			"type": "line"
		},
		"bacteria_strain": {
			"label": "Bacteria strain",
			"description": "The bacteria strain involved in the pandemic (if applicable)",
			"type": "line"
		},
		"parasite_strain": {
			"label": "Parasite strain",
			"description": "The parasite strain involved in the pandemic (if applicable)",
			"type": "line"
		},
		"pathogen_strain": {
			"label": "Pathogen strain",
			"description": "The pathogen strain involved in the pandemic (if applicable)",
			"type": "line"
		},
		"location": {
			"label": "Location",
			"description": "The location affected by the pandemic",
			"type": "line"
		},
		"first_case": {
			"label": "First case",
			"description": "The first case of the pandemic (if known)",
			"type": "line"
		},
		"arrival_date": {
			"label": "Arrival date",
			"description": "The date the pandemic arrived to the relevant location (if applicable)",
			"type": "line"
		},
		"date": {
			"label": "Date",
			"description": "The date of the pandemic",
			"type": "line"
		},
		"origin": {
			"label": "Origin",
			"description": "The origin of the pandemic",
			"type": "line"
		},
		"confirmed_cases": {
			"label": "Confirmed cases",
			"description": "The number of confirmed total cases related to the pandemic",
			"type": "line"
		},
		"active_cases": {
			"label": "Active cases",
			"description": "The number of confirmed active cases related to the pandemic",
			"type": "line"
		},
		"suspected_cases": {
			"label": "Suspected cases",
			"description": "The number of suspected cases related to the pandemic (adds a double-dagger note at the bottom of the infobox)",
			"type": "line"
		},
		"recovery_cases": {
			"label": "Recovered",
			"description": "The number of people known to have recovered from the pandemic",
			"type": "line"
		},
		"deaths": {
			"label": "Deaths",
			"description": "The number of people known to have died from the pandemic",
			"type": "line"
		},
		"fatality_rate": {
			"label": "Fatality Rate",
			"description": "The ratio of deaths compared to the total number of people diagnosed with the disease",
			"type": "line"
		},
		"territories": {
			"label": "Territories",
			"description": "The territories affected by the pandemic",
			"type": "line"
		},
		"total_ili": {
			"label": "Total ILI cases",
			"description": "The total number of cases of an influenza-like illness (ILI) (if applicable)",
			"type": "line"
		},
		"website": {
			"label": "Official website",
			"description": "An official website related to the pandemic",
			"type": "line"
		},
		"image": {
			"label": "Image",
			"description": "An image related to the pandemic, appearing below the title but above any maps",
			"type": "wiki-file-name"
		},
		"image_size": {
			"label": "Image size",
			"description": "The image width in pixels (\"px\" is automatically added if omitted); overrides image scale. Default is 220px (unless changed in user preferences).",
			"type": "number"
		},
		"image_upright": {
			"label": "Image scale",
			"description": "A scale to apply to the size of the image",
			"example": "1.5, yes (for 0.75)",
			"type": "number"
		},
		"alt": {
			"label": "Alt text for image",
			"description": "The alt text for the image, for use when the image doesn't load or by screen readers or search engines",
			"type": "string"
		},
		"caption": {
			"label": "Image caption",
			"description": "A caption for the image",
			"type": "content"
		},
		"dates": {
			"label": "Dates",
			"description": "The dates between which the pandemic took place (if \"Arrival date\" is used, it replaces this)",
			"type": "line"
		},
		"type": {
			"label": "Type",
			"description": "The type of pandemic",
			"type": "line"
		},
		"severe_cases": {
			"label": "Severe cases",
			"description": "The number of severe cases of the pandemic",
			"type": "line"
		},
		"hospitalized_cases": {
			"label": "Hospitalized cases",
			"description": "The number of people who have required hospitalization due to the pandemic - specify current or cumulative",
			"aliases": [
				"hospitalised_cases"
			],
			"type": "line"
		},
		"critical_cases": {
			"label": "Critical cases",
			"description": "The number of people who have required critical care/ICU level care due to the pandemic - specify current or cumulative",
			"type": "line"
		},
		"ventilator_cases": {
			"label": "Ventilator cases",
			"description": "For respiratory pandemics. The number of people who have required ventilator support due to the pandemic - specify current or cumulative",
			"type": "line"
		},
		"ecmo_cases": {
			"label": "ECMO cases",
			"description": "The number of people who have required extracorporal membrane oxygenation due to the pandemic - specify current or cumulative",
			"type": "line"
		},
		"map1_size": {},
		"map1_upright": {},
		"map2_size": {},
		"map2_upright": {},
		"map3_size": {},
		"map3_upright": {},
		"map4_size": {},
		"map4_upright": {},
		"map5_size": {},
		"map5_upright": {},
		"source": {},
		"first_outbreak": {},
		"first_reported": {},
		"first_report": {},
		"index_case": {},
		"vaccinations": {
			"label": "Vaccination stats",
			"description": "Vaccination statistics in any format. A bulleted list will be shown without bullets which is helpful to show first dose, second dose, etc.",
			"type": "content"
		}
	},
	"paramOrder": [
		"name",
		"image",
		"image_size",
		"image_upright",
		"caption",
		"alt",
		"map1",
		"legend1",
		"alt1",
		"map2",
		"legend2",
		"alt2",
		"map3",
		"legend3",
		"alt3",
		"map4",
		"legend4",
		"alt4",
		"map5",
		"legend5",
		"alt5",
		"disease",
		"virus_strain",
		"bacteria_strain",
		"parasite_strain",
		"pathogen_strain",
		"location",
		"first_case",
		"arrival_date",
		"dates",
		"date",
		"origin",
		"type",
		"confirmed_cases",
		"active_cases",
		"suspected_cases",
		"severe_cases",
		"hospitalized_cases",
		"critical_cases",
		"ventilator_cases",
		"ecmo_cases",
		"recovery_cases",
		"deaths",
		"fatality_rate",
		"territories",
		"total_ili",
		"website",
		"width",
		"map1_size",
		"map1_upright",
		"map2_size",
		"map2_upright",
		"map3_size",
		"map3_upright",
		"map4_size",
		"map4_upright",
		"map5_size",
		"map5_upright",
		"source",
		"first_outbreak",
		"first_reported",
		"first_report",
		"index_case",
		"vaccinations"
	]
}
</templatedata>
{{collapse bottom}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Medicine infobox templates|Pandemic]]
}}</includeonly>