Difference between revisions of "Template:Infobox census/doc"
Jump to navigation
Jump to search
imported>ItsPugle (Updating with region) |
imported>ItsPugle (Expanding) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{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. | ||
== Usage == | == Usage == | ||
| − | < | + | {{Parameter names example |
| − | { | + | | _italic = yes |
| + | | name | ||
| + | | logo | ||
| + | | logo_size | ||
| + | | image | ||
| + | | image_size | ||
| + | | 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 | ||
| + | }} | ||
| + | |||
| + | <pre> | ||
| + | {{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 = | ||
| + | }} | ||
| + | </pre> | ||
| + | |||
| + | === TemplateData === | ||
| + | {{Format TemplateData| | ||
| + | | JSON = { | ||
"description": "Infobox to be used for pages for censuses.", | "description": "Infobox to be used for pages for censuses.", | ||
"params": { | "params": { | ||
| Line 81: | Line 142: | ||
"description": "Change in percentage points versus the last census.", | "description": "Change in percentage points versus the last census.", | ||
"type": "string" | "type": "string" | ||
| − | |||
| − | |||
| − | |||
}, | }, | ||
"region_type": { | "region_type": { | ||
| Line 170: | Line 228: | ||
"description": "This parameter is used when the census doesn't span an entire country, for example, only a state or territory.", | "description": "This parameter is used when the census doesn't span an entire country, for example, only a state or territory.", | ||
"type": "string" | "type": "string" | ||
| + | }, | ||
| + | "annual_percent_change": { | ||
| + | "deprecated": "Please use percent_change" | ||
} | } | ||
}, | }, | ||
| Line 210: | Line 271: | ||
"format": "block" | "format": "block" | ||
} | } | ||
| − | + | }} | |
<includeonly> | <includeonly> | ||
Revision as of 09:20, 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 =
}}
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 | Please use either "em" or "rem". | String | optional |
| Logo caption | logo_caption | String | optional | |
| Image | image | File | optional | |
| Image size | image_size | Please use either "em" or "rem". | 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 | 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 | 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 |
| annual_percent_change | annual_percent_change | Unknown | deprecated Please use percent_change |
|
Format: block