Template:Historical populations/doc

This is a documentation subpage for Template:Historical populations.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 53,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Historical populations (sandbox)

{{Historical populations}} is used as an information box on pages showing each census year with a population and a percent gain/loss comparison. It is intended to combine the functionalities of two existing templates, Template:US Census population and Template:Histpop, the former of which is specialized for the United States, and the latter of which lacks many features of the former.

Usage

This template takes a series of parameters in the form |date |population. This template does not require any more than that. This template will take between 0 and 50 entries; any more will be ignored.

Full syntax

{{Historical populations
|title        = 
|align        =
|clear        =
|direction    =
|percentages  = 
|state        = 
|type         = 
|shading      = 
|width        = 
|subbox       =
|pop_name     =
|year_name    =
|percent_name =
|footnote     = 
|source       = 
|graph-pos    =
|graph-width  =
|graph-height =
|percol       =
|cols         =
|perrow       =
|rows         =
|date |population
|date |population
|date |population
|date |population
|date |population
|date |population
|date |population
}}

Parameters

Template parameters for Template:Historical populations
Parameter	Description
date_n	Ideally, a four-digit year, but can be anything. Usually a multiple of 10, but does not have to be.
population_n	The population of row n. Must be a plain number with no formatting (commas, etc.).
title	Optional. The title of the table. `Historical population` (Default)
align	Optional. The alignment of the table on the page. `right` (Default) `left` `center` `none`
clear	Optional. Use to clear any left or right floating elements nearby. `right` (Default if align = right) `left` (Default if align = left) `none` (Default if align = none) `both`
direction	Optional. How the box is arranged on the page. `vertical` (Default) `horizontal`
percentages	Optional. Whether to include an automatically generated column of percent differences. This works best with linear lists (1900, 1910, 1920, etc.). Alternately, you can specify "pagr" to display annual growth rates (per annum growth rate) using the formula from Population growth. `on` (Default) `pagr` `off`
state	Optional. The collapsed state of the table. Set it to `collapsed` to collapse the table by default. `none` (Default) `collapsed`
type	Optional. This is designed to add functionality specific to different regions or types of information. Currently the only value that does anything is `US` (or the obsolescent `USA`). `none` (Default) `US` Will link each year to the relevant United States census entry. Years that do not have entries will be left alone. Please think of more ideas for this feature.
shading	Optional. Whether to mark off every five entries with a line, to facilitate reading. This works best with large, linear lists (such as the US Census, which has been taken every 10 years for over 200 years), but should probably be turned off for small or irregular lists (e.g., less than 10 entries), where it could be confusing. `on` (Default) `off`
width	Optional. The width of the table (or of each block of columns). Can be any valid CSS `width` value. `15em` (Default)
pop_name	Optional. The text in the column header of the population data. `{{abbr\|Pop.\|Population}}` (Default, displays as Pop.)
footnote	Optional. Free-form footnote. Can be used as a variant to, or in addition to, the source parameter.
source	Optional. Displayed as a footnote under the table with the text "Source:" inserted automatically. Every table should indicate the source of the data.
graph-pos	Optional. Adds an automatically generated graph at the top (with `\|graph-pos=top`) or bottom (with `\|graph-pos=bottom`)
graph-width	Optional. Overrides the default width of the graph. Should not be necessary in most cases.
graph-height	Optional. Overrides the default height of the graph. Should not be necessary in most cases.
cols	Optional. Total number of columns of data (default is `1`). This is useful for very long tables, or when `\|align=none`.

Examples

United States

Historical population
Year	Pop.	±%
1890	1,046,964	—
1900	1,293,697	+23.6%
1910	1,549,008	+19.7%
1920	1,823,779	+17.7%
1930	1,950,961	+7.0%
1940	1,931,334	−1.0%
1950	2,071,605	+7.3%
1960	2,002,512	−3.3%
1970	1,948,609	−2.7%
1980	1,688,210	−13.4%
1990	1,585,577	−6.1%
2000	1,517,550	−4.3%
2006 (est.)	1,448,394	−4.6%
Source: "American FactFinder". United States Census Bureau.

The following code will yield the table on the right:

{{Historical populations
|type = US
|source = {{subst:Historical populations/USCensusRef}}
|1890 |1046964
|1900 |1293697
|1910 |1549008
|1920 |1823779
|1930 |1950961
|1940 |1931334
|1950 |2071605
|1960 |2002512
|1970 |1948609
|1980 |1688210
|1990 |1585577
|2000 |1517550
|2006 (est.)
      |1448394
}}

Smaller areas

Historical population
Year	Pop.
1845	749
1951	6,717
1960	6,984
1970	31,752
1980	34,758
1990	35,888
2000	39,317
Note: Sandefjord and Sandar were merged in 1970. Source: SSB

The following code will yield the table on the right:

{{Historical populations
|width = 10em
|shading = off
|percentages = off
|1845 |749
|1951 |6717
|1960 |6984
|1970 |31752
|1980 |34758
|1990 |35888
|2000 |39317
|footnote=Note: Sandefjord and [[Sandar, Norway|Sandar]] were merged in 1970.
|source = [http://www.ssb.no SSB]
}}

Non-regular date ranges

Population census
Year	Pop.	±% p.a.
1903	219,928	—
1960	1,138,611	+2.93%
1970	1,330,788	+1.57%
1975	1,479,116	+2.14%
1980	1,630,485	+1.97%
1990	1,601,234	−0.18%
1995	1,654,761	+0.66%
2000	1,581,082	−0.91%
2007	1,660,714	+0.70%
2010	1,652,171	−0.17%

For non-regular date ranges, use percentages=pagr to show annual growth rate percentages.

{{Historical populations
| title= Population census
| percentages = pagr
| 1903 |219928
| 1960 |1138611
| 1970 |1330788
| 1975 |1479116
| 1980 |1630485
| 1990 |1601234
| 1995 |1654761
| 2000 |1581082
| 2007 |1660714
| 2010 |1652171
}}

Two columns

For a multicolumn non-floating table, use align=none and cols=2

{{Historical populations
| title= Population census
| percentages = pagr
| align = none
| cols = 2
| 1903 |219928
| 1960 |1138611
| 1970 |1330788
| 1975 |1479116
| 1980 |1630485
| 1990 |1601234
| 1995 |1654761
| 2000 |1581082
| 2007 |1660714
| 2010 |1652171
}}

Population census

Year	Pop.	±% p.a.
1903	219,928	—
1960	1,138,611	+2.93%
1970	1,330,788	+1.57%
1975	1,479,116	+2.14%
1980	1,630,485	+1.97%

Year	Pop.	±% p.a.
1990	1,601,234	−0.18%
1995	1,654,761	+0.66%
2000	1,581,082	−0.91%
2007	1,660,714	+0.70%
2010	1,652,171	−0.17%

Two columns with graph

For a multicolumn non-floating table with a bottom graph, use align=none and cols=2 and graph-pos=bottom

{{Historical populations
| title= Population census
| percentages = pagr
| align = none
| cols = 2
| graph-pos = bottom
| 1903 |219928
| 1960 |1138611
| 1970 |1330788
| 1975 |1479116
| 1980 |1630485
| 1990 |1601234
| 1995 |1654761
| 2000 |1581082
| 2007 |1660714
| 2010 |1652171
}}