வார்ப்புரு:Medical cases chart/doc
{{Documentation subpage}}
 {{lua|Module:Medical cases chart}}
 == Description ==
 
 This template should be used for all outbreak, epidemic and pandemic medical cases charts based on {{tl|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 {{tl|Medical cases chart}} and, maybe, {{tl|Medical cases chart/Row}} to get away with a custom formatting. Suggest features in the [[Template_talk:Medical cases chart|talk page]] or code it yourself if it's not controversial.
 
 == Usage ==
 
  &lt;nowiki&gt;{{&lt;/nowiki&gt;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)&lt;-(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 &lt;nowiki&gt;{{&lt;/nowiki&gt;navbar&lt;nowiki&gt;}}&lt;/nowiki&gt;)''
  
  |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]
  &lt;nowiki&gt;}}&lt;/nowiki&gt;
 
 === Data ===
 
 The &lt;code&gt;data&lt;/code&gt; 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, &lt;code&gt;;&lt;/code&gt;, and that repetitive parameters, like &lt;code&gt;divisor&lt;/code&gt;, &lt;code&gt;numwidth&lt;/code&gt; and &lt;code&gt;collapsible&lt;/code&gt;, may be written only once in the body of {{tl2|Medical cases chart}}. See examples.
 
 === Rows ===
 
 The &lt;code&gt;rows&lt;/code&gt; parameter should be populated by a sequence of {{tl2|Medical cases chart/Row}}. Other bar templates should not be used to keep consistency. The syntax is:
 
  &lt;nowiki&gt;{{&lt;/nowiki&gt;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)&lt;-(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}
  &lt;nowiki&gt;}}&lt;/nowiki&gt;
 
 All parameters are optional, although &lt;code&gt;collapsed&lt;/code&gt; and &lt;code&gt;id&lt;/code&gt; will have no effect if &lt;code&gt;collapsible&lt;/code&gt; 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 &lt;code&gt;alttot1&lt;/code&gt;. The same applies to the ''expression for total in 5th classification'' and &lt;code&gt;alttot2&lt;/code&gt;. The changes in the first and second columns are automatically wrapped in brackets. The &lt;code&gt;divisor&lt;/code&gt; should be the same for all rows that can be visible at the same time. &lt;code&gt;numwidth&lt;/code&gt; 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 ==
 
 &lt;pre&gt;
 {{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%
 }}
 &lt;/pre&gt;
 {{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%
 }}
 {{clear}}
 
 &lt;pre&gt;
 {{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
 }}
 &lt;/pre&gt;
 {{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
 }}
 {{clear}}
 
 === Applied example ===
 
 {{Template:2019–20 coronavirus pandemic data/Mainland China medical cases chart}}
 &lt;includeonly&gt;
 [[Category:Infectious disease templates]]
 [[Category:Bar chart templates]]
 [[Category:Graph, chart and plot templates]]