>WOSlinker: /* Usage */ =

2023-05-21T10:28:12Z

Usage: =

New page

{{Documentation subpage}}

This infobox is for use on any census pages. You can list up to ten different census topics, specific the type of subdivision (state/territory etc) that the results are given in, link to the previous and next census, and change the scope of the census.

If {{para|region}} is not blank, it will use a "Region" label for the scope of the census, otherwise it will default to a "Country" label. By scope, we're referring to the geographical area completing the census.

A {{para|date}} is strongly recommended for any census event articles, but can be generally ignored for census program articles. By this, we mean any individual census event (such as the [[2021 Australian census]]) should have a {{para|date}} included, but the census program (the [[Census in Australia]]) doesn't require a date since there is no one specific occurrence. In the latter though, we encourage inclusion of the {{para|previous_year}}, {{para|previous_census}}, {{para|next_year}}, {{para|next_census}} parameters anyways.

== Usage ==
{{Parameter names example
| _italic = yes
| name
| logo
| logo_size
| logo_caption
| image
| image_size
| image_caption
| previous_year
| previous_census
| date
| next_year
| next_census
| region
| region_type
| country
| topic1
| topic2
| topic3
| authority
| website
| participation
| population
| percent_change
| most_populous
| least_populous
| additional_label1
| additional_data1
| additional_label2
| additional_data2
| additional_label3
| additional_data3
| additional_label4
| additional_data4
| additional_label5
| additional_data5
}}

<syntaxhighlight lang="wikitext">
{{Infobox census
| name =
| logo =
| logo_size =
| logo_caption =
| image =
| image_size =
| image_caption =
| previous_year =
| previous_census =
| date =
| next_year =
| next_census =
| region =
| region_type =
| country =
| topic1 =
| topic2 =
| topic3 =
...
| topic10 =
| authority =
| website =
| participation =
| population =
| percent_change =
| most_populous =
| least_populous =
| additional_label1 =
| additional_data1 =
| additional_label2 =
| additional_data2 =
...
| additional_label5 =
| additional_data5 =
}}
</syntaxhighlight>

=== TemplateData ===
{{Format TemplateData|
JSON = {
"description":"Infobox to be used for pages for censuses.",
"params":{
"name":{
"label":"Name of the census",
"description":"The name of the census, although not necessarily the page name. For example, the 2021 United Kingdom census is called \"Census 2021\"",
"example":"Census 2021",
"type":"string",
"required":true
},
"logo":{
"label":"Logo",
"type":"wiki-file-name",
"suggested":true
},
"logo_size":{
"label":"Logo size",
"type":"string"
},
"logo_caption":{
"label":"Logo caption",
"type":"string"
},
"image":{
"label":"Image",
"type":"wiki-file-name"
},
"image_size":{
"label":"Image size",
"type":"string"
},
"image_caption":{
"label":"Image caption",
"type":"string"
},
"previous_year":{
"label":"Previous census year",
"description":"Year of the previous census.",
"example":"2016",
"type":"number"
},
"previous_census":{
"label":"Previous census page",
"description":"Page name for the previous census.",
"example":"2016 Australian census",
"type":"wiki-page-name"
},
"date":{
"label":"Census date",
"type":"date",
"suggested":true,
"description":"This parameter should always be used for census events (2021 Australian census), however may be ignored for census program pages (Census in Australia)."
},
"next_year":{
"label":"Next census year",
"description":"Year of the next census. If the article for the next census does not exist, you should still put in the year, but ignore the \"next_census\" parameter",
"example":"2025",
"type":"number"
},
"next_census":{
"label":"Next census page",
"description":"Page name for the next census. If this page does not exist yet, please ignore this until such time.",
"example":"2025 Australian census",
"type":"wiki-page-name"
},
"country":{
"label":"Country",
"example":"Australia",
"type":"string",
"suggested":true,
"description":"Please only use this parameter if the census covers an entire country. If not, use region."
},
"population":{
"label":"Population recorded",
"description":"Population value recorded in the census.",
"type":"number"
},
"percent_change":{
"label":"Population percentage point change",
"description":"Change in percentage points versus the last census.",
"type":"string"
},
"region_type":{
"label":"Region type",
"example":"province",
"description":"This is for setting the type of region that most and least populous data is provided in (could be state etc, could be city etc). Generally, go for the highest-level, such as state, over something like suburb or city.",
"type":"string"
},
"most_populous":{
"label":"Most populous region",
"type":"wiki-page-name"
},
"least_populous":{
"label":"Least populous region",
"type":"wiki-page-name"
},
"authority":{
"label":"Census authority",
"description":"Operating authority for the census.",
"example":"Office of National Statistics",
"type":"string"
},
"website":{
"label":"Census website",
"description":"Please use the URL template.",
"type":"url"
},
"trial_census":{
"label":"Trial census date",
"description":"Data of a trial census, if run.",
"type":"date"
},
"participation":{
"label":"Census participation",
"type":"string"
},
"topic1":{
"label":"First topic",
"description":"You can add up to 10 different topics to be investigated in the census, such as \"housing\", \"employment\", \"education\" etc",
"type":"string"
},
"topic2":{
"label":"Second topic",
"description":"Requires topic1 to not be empty to display.",
"type":"string"
},
"topic3":{
"label":"Third topic",
"description":"Requires topic1 to not be empty to display.",
"type":"string"
},
"topic4":{
"label":"Fourth topic",
"description":"Requires topic1 to not be empty to display.",
"type":"string"
},
"topic5":{
"label":"Fifth topic",
"description":"Requires topic1 to not be empty to display.",
"type":"string"
},
"topic6":{
"label":"Sixth topic",
"description":"Requires topic1 to not be empty to display.",
"type":"string"
},
"topic7":{
"label":"Seventh topic",
"description":"Requires topic1 to not be empty to display.",
"type":"string"
},
"topic8":{
"label":"Eighth topic",
"description":"Requires topic1 to not be empty to display.",
"type":"string"
},
"topic9":{
"label":"Ninth topic",
"description":"Requires topic1 to not be empty to display.",
"type":"string"
},
"topic10":{
"label":"Tenth topic",
"description":"Requires topic1 to not be empty to display.",
"type":"string"
},
"region":{
"label":"Region for the census",
"example":"Queensland",
"description":"This parameter is used when the census doesn't span an entire country, for example, only a state or territory.",
"type":"string"
},
"additional_label1":{
"label":"Additional data label 1",
"description":"Use this, paired with additional_data1, to add any additional results from the census",
"type":"string"
},
"additional_data1":{
"label":"Additional data 1",
"description":"Use this, paired with additional_label1, to add any additional results from the census",
"type":"string"
},
"additional_label2":{
"label":"Additional data label 2",
"description":"Use this, paired with additional_data2, to add any additional results from the census",
"type":"string"
},
"additional_data2":{
"label":"Additional data 2",
"description":"Use this, paired with additional_label2, to add any additional results from the census",
"type":"string"
},
"additional_label3":{
"label":"Additional data label 3",
"description":"Use this, paired with additional_data3, to add any additional results from the census",
"type":"string"
},
"additional_data3":{
"label":"Additional data 3",
"description":"Use this, paired with additional_label3, to add any additional results from the census",
"type":"string"
},
"additional_label4":{
"label":"Additional data label 4",
"description":"Use this, paired with additional_data4, to add any additional results from the census",
"type":"string"
},
"additional_data4":{
"label":"Additional data 4",
"description":"Use this, paired with additional_label4, to add any additional results from the census",
"type":"string"
},
"additional_label5":{
"label":"Additional data label 5",
"description":"Use this, paired with additional_data5, to add any additional results from the census",
"type":"string"
},
"additional_data5":{
"label":"Additional data 5",
"description":"Use this, paired with additional_label5, to add any additional results from the census",
"type":"string"
},
"annual_percent_change":{
"deprecated":"Please use percent_change"
}
},
"paramOrder":[
"name",
"previous_year",
"previous_census",
"date",
"next_year",
"next_census",
"logo",
"logo_size",
"image",
"image_size",
"logo_caption",
"image_caption",
"region",
"country",
"topic1",
"topic2",
"topic3",
"topic4",
"topic5",
"topic6",
"topic7",
"topic8",
"topic9",
"topic10",
"trial_census",
"authority",
"website",
"participation",
"population",
"percent_change",
"region_type",
"most_populous",
"least_populous",
"additional_label1",
"additional_data1",
"additional_label2",
"additional_data2",
"additional_label3",
"additional_data3",
"additional_label4",
"additional_data4",
"additional_label5",
"additional_data5",
"annual_percent_change"
],
"format":"block"
}
}}

<includeonly>
{{Sandbox other | |

[[Category:Demography templates]]
[[Category:Society and social science infobox templates|Census]]
}}</includeonly>

Template:Infobox census/doc - Revision history

>WOSlinker: /* Usage */ =