Difference between revisions of "Template:Infobox census/doc"
Jump to navigation
Jump to search
imported>ItsPugle (Expanding) |
imported>ItsPugle (Updating TemplateData) |
||
| Line 31: | Line 31: | ||
| most_populous | | most_populous | ||
| least_populous | | least_populous | ||
| + | | additional_label1 | ||
| + | | additional_data1 | ||
| + | | additional_label2 | ||
| + | | additional_data2 | ||
| + | | additional_label3 | ||
| + | | additional_data3 | ||
| + | | additional_label4 | ||
| + | | additional_data4 | ||
| + | | additional_label5 | ||
| + | | additional_data5 | ||
}} | }} | ||
| Line 60: | Line 70: | ||
| most_populous = | | most_populous = | ||
| least_populous = | | least_populous = | ||
| + | | additional_label1 = | ||
| + | | additional_data1 = | ||
| + | | additional_label2 = | ||
| + | | additional_data2 = | ||
| + | ... | ||
| + | | additional_label5 | ||
| + | | additional_data5 | ||
}} | }} | ||
</pre> | </pre> | ||
| Line 65: | Line 82: | ||
=== TemplateData === | === TemplateData === | ||
{{Format 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_census":{ | |
| − | + | "label":"Previous census page", | |
| − | + | "description":"Page name for the previous census.", | |
| − | + | "example":"2016 Australian census", | |
| − | + | "type":"wiki-page-name" | |
| − | + | }, | |
| − | + | "previous_year":{ | |
| − | + | "label":"Previous census year", | |
| − | + | "description":"Year of the previous census.", | |
| − | + | "example":"2016", | |
| − | + | "type":"number" | |
| − | + | }, | |
| − | + | "next_census":{ | |
| − | + | "label":"Next census page", | |
| − | + | "description":"Page name for the next census.", | |
| − | + | "example":"2025 Australian census", | |
| − | + | "type":"wiki-page-name" | |
| − | + | }, | |
| − | + | "next_year":{ | |
| − | + | "label":"Next census year", | |
| − | + | "description":"Year of the next census.", | |
| − | + | "example":"2025", | |
| − | + | "type":"number" | |
| − | + | }, | |
| − | + | "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." | |
| − | + | }, | |
| − | + | "date":{ | |
| − | + | "label":"Census date", | |
| − | + | "type":"date", | |
| − | + | "suggested":true | |
| − | + | }, | |
| − | + | "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" | ||
} | } | ||
}} | }} | ||
Revision as of 22:46, 7 November 2020
| This is a documentation subpage for Template:Infobox census. It contains usage information, categories and other content that is not part of the original template page. |
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 |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.
Usage
Template:Parameter names example
{{Infobox census
| name =
| logo =
| logo_size =
| image =
| image_size =
| 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
}}
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.
TemplateData for Infobox census
Infobox to be used for pages for censuses.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Name of the census | name | The name of the census, although not necessarily the page name. For example, the 2021 United Kingdom census is called "Census 2021"
| String | required |
| Logo | logo | File | suggested | |
| Logo size | logo_size | String | optional | |
| Logo caption | logo_caption | String | optional | |
| Image | image | File | optional | |
| Image size | image_size | String | optional | |
| Image caption | image_caption | String | optional | |
| Previous census page | previous_census | Page name for the previous census.
| Page | optional |
| Previous census year | previous_year | Year of the previous census.
| Number | optional |
| Next census page | next_census | Page name for the next census.
| Page | optional |
| Next census year | next_year | Year of the next census.
| Number | optional |
| Country | country | Please only use this parameter if the census covers an entire country. If not, use region.
| String | suggested |
| Census date | date | Date | suggested | |
| Population recorded | population | Population value recorded in the census. | Number | optional |
| Population percentage point change | percent_change | Change in percentage points versus the last census. | String | optional |
| Region type | region_type | 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.
| String | optional |
| Most populous region | most_populous | Page | optional | |
| Least populous region | least_populous | Page | optional | |
| Census authority | authority | Operating authority for the census.
| String | optional |
| Census website | website | Please use the URL template. | URL | optional |
| Trial census date | trial_census | Data of a trial census, if run. | Date | optional |
| Census participation | participation | String | optional | |
| First topic | topic1 | You can add up to 10 different topics to be investigated in the census, such as "housing", "employment", "education" etc | String | optional |
| Second topic | topic2 | Requires topic1 to not be empty to display. | String | optional |
| Third topic | topic3 | Requires topic1 to not be empty to display. | String | optional |
| Fourth topic | topic4 | Requires topic1 to not be empty to display. | String | optional |
| Fifth topic | topic5 | Requires topic1 to not be empty to display. | String | optional |
| Sixth topic | topic6 | Requires topic1 to not be empty to display. | String | optional |
| Seventh topic | topic7 | Requires topic1 to not be empty to display. | String | optional |
| Eighth topic | topic8 | Requires topic1 to not be empty to display. | String | optional |
| Ninth topic | topic9 | Requires topic1 to not be empty to display. | String | optional |
| Tenth topic | topic10 | Requires topic1 to not be empty to display. | String | optional |
| Region for the census | region | This parameter is used when the census doesn't span an entire country, for example, only a state or territory.
| String | optional |
| Additional data label 1 | additional_label1 | Use this, paired with additional_data1, to add any additional results from the census | String | optional |
| Additional data 1 | additional_data1 | Use this, paired with additional_label1, to add any additional results from the census | String | optional |
| Additional data label 2 | additional_label2 | Use this, paired with additional_data2, to add any additional results from the census | String | optional |
| Additional data 2 | additional_data2 | Use this, paired with additional_label2, to add any additional results from the census | String | optional |
| Additional data label 3 | additional_label3 | Use this, paired with additional_data3, to add any additional results from the census | String | optional |
| Additional data 3 | additional_data3 | Use this, paired with additional_label3, to add any additional results from the census | String | optional |
| Additional data label 4 | additional_label4 | Use this, paired with additional_data4, to add any additional results from the census | String | optional |
| Additional data 4 | additional_data4 | Use this, paired with additional_label4, to add any additional results from the census | String | optional |
| Additional data label 5 | additional_label5 | Use this, paired with additional_data5, to add any additional results from the census | String | optional |
| Additional data 5 | additional_data5 | Use this, paired with additional_label5, to add any additional results from the census | String | optional |
| annual_percent_change | annual_percent_change | Unknown | deprecated Please use percent_change |
|
Format: block