साचा:Medical cases chart/doc

Description

This template should be used for all outbreak, epidemic and pandemic medical cases charts based on {{Bar box}} to maintain consistency. It displays horizontal bars for up to 5 different classifications of cases for each valid date. It also offers two columns to make numbers explicit and to show relative or absolute changes. It is designed to be flexible, but still standardizes some parts of the chart. This template should be transcluded in other templates, NOT in article pages. Please do not use templates other than {{Medical cases chart}} and, maybe, {{Medical cases chart/Row}} to get away with a custom formatting. Suggest features in the talk page or code it yourself if it's not controversial.

Usage

{{Medical cases chart
|barwidth   = width of the stacked bars area (thin|medium|wide)                        [optional, defaults to: medium]
|numwidth   = max width of the numbers in the right columns (xx or xxxx)<-(n|t|m|w|d)  [optional, defaults to: mm,
                                                                                        see Rows' explanation and examples]
|float      = on what side of the page should the chart be located (left|right|none)   [optional, defaults to: right] 

|pretitle   = text at the beginning of the title                                       [optional]
|disease    = name of the disease
|location   = location of the outbreak the chart is showing
|location2  = broader location such as state/province or country                       [optional]
|location3  = broadest location such as country                                        [optional]
|posttitle  = text at the end of the title                                             [optional]
|outbreak   = name of the main outbreak (for link of the {{navbar}})

|recoveries = display recoveries in the legend (no|n|0)                                [optional]
|altlbl1    = alternate label for the 3rd case classification                          [optional, defaults to: Cases]
|altlbl2    = alternate label for the 4th case classification                          [optional]
|altlbl3    = alternate label for the 5th case classification                          [optional]

|togglesbar = HTML of the toggles bar to show/hide rows                                [optional]  {WIP}

|right1     = heading of the first data column                                         [optional, defaults to: # of cases]
|right2     = heading of the second data column                                        [optional]

|divisor    = manual override of the scaling divisor of the bars                       [optional, defaults to: auto]
|collapsible= whether the rows are collapsible (yes|y|1)                               [optional]  {WIP}
|data       = data lines for each valid date (see Data's and Rows' syntax)

|caption    = caption under the chart                                                  [optional]
}}

Data

The |data= parameter should be populated by a sequence of lines with a format similar to the rows'. The difference is that the parameter separator is the semicolon, ;, and that repetitive parameters, like |divisor=, |numwidth=, and |collapsible=, may be written only once in the body of {{Medical cases chart}}. Using |data= also allows the divisor to be calculated automatically if the parameter is omitted.

|data=date;deaths;recoveries;total cases (3rd classification);4th classification #;5th classification #;1st column #;1st column change;2nd column #;2nd column change;other parameters=values
date;deaths;recoveries;total cases (3rd classification);4th classification #;5th classification #;1st column #;1st column change;2nd column #;2nd column change;other parameters=values
...

Empty values can be represented by sequential semicolons (e.g. ;;). The other parameters=values can be any number of the parameters below and their values, separated by semicolons. See examples.

;alttot1    = ''alternate expression for active cases (3rd classification)''
;alttot2    = ''alternate expression for number in 5th classification''
;firstright1= ''whether a change in the first column is not applicable (n.a.)'' (yes|y|1)
;firstright2= ''whether a change in the second column is not applicable (n.a.)'' (yes|y|1)
;collapsed  = ''manual override of the initial row state'' (yes|y|1)                       {WIP}
;id         = ''manual override of the row id''                                            {WIP}

To convert from the old format, remove {{Medical cases chart/Row| from the beginning and }} from the end of the line, replace all pipes (|) with semicolons (;), and remove any |divisor=, |numwidth=, and |collapsible= parameters from the end (and make sure they are listed in the main template at least once). For example:

{{Medical cases chart/Row|2020-04-15|1921||28059|||28,059|+1058||+4%|divisor=100|numwidth-mmnm}}

becomes

2020-04-15;1921;;28059;;;28,059;+1058;;+4%

Rows

This parameter has been deprecated, and templates using it are added to Category:Templates using Medical cases chart with the rows parameter. The |data= parameter above should be used instead.

Deprecated parameter

The rows parameter should be populated by a sequence of {{Medical cases chart/Row}}. Other bar templates should not be used to keep consistency. The syntax is: {{Medical cases chart/Row |1 = ''valid date'' [defaults to: ⋮, in which case the appropriate changes become (=)] |2 = ''expression for deaths'' |3 = ''expression for recoveries'' |4 = ''expression for total cases (3rd classification)'' |alttot1 = ''alternate expression for active cases (3rd classification)'' |5 = ''expression for number in 4th classification'' |6 = ''expression for total in 5th classification'' |alttot2 = ''alternate expression for number in 5th classification'' |7 = ''number in the first column'' |8 = ''change in the first column'' |firstright1= ''whether a change in the first column is not applicable (n.a.)'' (yes|y|1) |9 = ''number in the second column'' |10 = ''change in the second column'' |firstright2= ''whether a change in the second column is not applicable (n.a.)'' (yes|y|1) |divisor = ''scaling divisor of the bars (bigger value = narrower bars)'' [defaults to: 1] |numwidth = ''max width of the numbers in the right columns'' (xx or xxxx)<-(n|t|m|w|d) [defaults to: mm] |collapsible= ''whether the row is collapsible'' (yes|y|1) {WIP} |collapsed = ''manual override of the initial row state'' (yes|y|1) {WIP} |id = ''manual override of the row id'' {WIP} }} All parameters are optional, although collapsed and id will have no effect if collapsible is not set to true. Ommiting the valid date will treat the row as a date jump, in which no new cases are reported. The expression for total cases has deaths and recoveries automatically subtracted from it. If you want to manually calculate the number in that classification (generally active cases), use alttot1. The same applies to the expression for total in 5th classification and alttot2. The changes in the first and second columns are automatically wrapped in brackets. The divisor should be the same for all rows that can be visible at the same time. numwidth is a sequence of the initials of none, thin, medium, wide and default and it determines the maximum width of each number in the data columns. Therefore, one should be chosen that minimizes the total width, but which doesn't make the numbers break/wrap on mobile view. Using xx or xxxx allocates one or two data columns, respectively.

Examples

{{Medical cases chart
|numwidth=mw

|disease=Green Flu
|location=Savannah|location2=Georgia|location3=United States
|outbreak=2009 Green Flu outbreak

|recoveries=n

|data=
2009-04-13;;;42;;;42;firstright1=y
2009-04-14;;;356;;;356;+748%
2009-04-15;;;1503;;;1,503;+322%
2009-04-16;57;;5915;;;5,915;+294%
2009-04-17;2000;;9500;;;~9,500;+60.6%
}}

Green Flu cases in Savannah, Georgia, United States  ()      Deaths        Active cases
Date			# of cases
2009-04-13		​	42(n.a.)
2009-04-14		​	356(+748%)
2009-04-15		​	1,503(+322%)
2009-04-16		​ ​	5,915(+294%)
2009-04-17		​ ​	~9,500(+60.6%)

{{Medical cases chart
|barwidth=wide
|numwidth=mwwd

|pretitle=Approximate
|disease=Spanish Flu
|location=the World
|posttitle=(excluding Oceania)
|outbreak=1918-20 Spanish Flu pandemic

|altlbl1=Active confirmed
|altlbl2=Suspected
|altlbl3=Estimated

|right1=Confirmed cases
|right2=Including suspected and estimated cases

|divisor=2550
|data=
1918-03-10;(2060-300);(3000-800);6000;;;6000;firstright1=y
1918-07;12600;20000;40000;12000;;alttot2=(34000-15000-8700+40);40000;+500%;10500;firstright2=y
;12600;20000;40000;12000;;alttot2=(34000-15000-8700+40);40000;;10500
1919;100000;250000;;;1000000;;;1mi;+500k

|caption=Foo Bar
}}

Approximate Spanish Flu cases in the World (excluding Oceania)  ()      Deaths        Recoveries        Active confirmed        Suspected        Estimated
Date			Confirmed cases	Including suspected and estimated cases
1918-03-10		​ ​ ​	6000(n.a.)
1918-07		​ ​ ​ ​ ​	40000(+500%)	10500(n.a.)
⋮		​ ​ ​ ​ ​	40000(=)	10500(=)
1919		​ ​ ​		1mi(+500k)
Foo Bar

Applied example

{{2019–20 coronavirus pandemic data/South Korea medical cases chart}}