>Turnagra: Updating to include alts for image caption

2024-08-24T06:07:41Z

Updating to include alts for image caption

New page

{{Documentation subpage}}

{{Uses Infobox settlement}}
{{Lua|Module:Infobox|Module:InfoboxImage|Module:String|Module:Check for unknown parameters}}

== Usage ==
All values except 'name' are optional. All information should be cited within the article.

{| style="background: transparent;"
|<syntaxhighlight lang="wikitext">{{Infobox New Zealand suburb
| name =
| image =
| img_caption =
| etymology =
| nickname =
| map =
| map_caption =
| location_map =
| coordinates =
| city =
| council =
| ward =
| board =
| sub_board =
| community_board =
| established =
| area =
| population =
| popsource = <ref></ref>
| popdate =
| postcode =
| trainstations =
| railwaystations =
| ferryterminals =
| buswaystations =
| airports =
| hospitals =
}}</syntaxhighlight>
|}

== Parameter descriptions ==
*'''name''' - name of the suburb. Where the article name has a qualifier (like "Devonport, New Zealand") please omit the qualifier {{em|unless}} there is a second New Zealand version of the suburb.
*'''image''' - link to an image of the suburb here. This should {{em|not}} be a map (these go further below). Use the full name, including the ".jpg" (or whatever the filetype) suffix, but {{em|without}} the "File:".
**'''img_caption''', '''image_caption''' or '''caption1''' - caption of the picture.
*'''map''' - provide a map image if available, see 'image' above for syntax.
*'''caption2''' - provide a caption in the line of 'Location of (spell out 'name' by hand) in (spell out 'city1' by hand).
*'''location map''' - for use with [[:Template:Location map]], available New Zealand maps are in [[:Category:New Zealand location map modules]]
*'''coordinates''' - for use with [[:Template:Location map]]
*'''city1''' - this is the city the suburb is in.
*'''council''' - this is the primary local authority for the suburb. Usually it will be a city council, but may occasionally be a district or unitary council.
*'''ward''' - defined ward of the city.
*'''board''' - this is the local board established for the suburb as defined by either the [https://www.legislation.govt.nz/act/public/2009/0032/latest/whole.html#DLM2044938 Local Government (Auckland Council) Act 2009, sections 10-13] or the [[Local Government Act 2002]] [https://www.legislation.govt.nz/act/public/2002/0084/latest/whole.html#DLM6242020 part 4, subpart 1A]. '''Presently only in use in Auckland.'''
*'''community board''' - this is the community board established for the suburb as defined by the Local Government Act 2002 [https://www.legislation.govt.nz/act/public/2002/0084/latest/whole.html#DLM171867 part 4, subpart 2]. '''For use outside Auckland.'''
*'''established''' - approximate year suburb was established. May in some cases be pre-European, but only if there was reasonable continuity.
*'''area''' - area for the size of the suburb in hectares. The "ha" will be added automatically.
**'''arearef''' or '''areasource''' - reference for the area figure.
*'''population''' - population size. Please use thousand-commas as in "10,200".
**'''popdate''' - date for the population count.
**'''popref''' or '''popsource''' - reference for the population count.
*'''trainstations''' - local train stations (local only please, NOT the closest). '''Only for use in Auckland suburbs.'''
*'''railwaystations''' - local railway stations (local only please, NOT the closest). '''For use everywhere except Auckland.'''
*'''ferryterminals''' - local ferry terminals (local only please, NOT the closest).
*'''buswaystations''' - local busway stations (local only please, NOT the closest). '''Only for use in Auckland suburbs along the [[Northern Busway, Auckland|Northern Busway]].'''
*'''airports''' - local airports (local only please, NOT the closest). This {{em|does}} include smaller airfields and heliports (but not single helicopter landing pads such as for a hospital), as long as regular activity exists.
*'''hospitals''' - local hospitals (local only please, NOT the closest). This {{em|excludes}} most medical centres - hospitals as defined here would need to have in-patients (patients staying overnight) or be {{em|especially}} large/notable medical centres without inpatients.
* <s>'''north''', '''northeast''' ... - location of the suburb with the surrounding suburbs. Restrict to one each per direction, unless there are clearly more than one in that direction ''directly adjacent'' (should not happen, there are rarely more than 8 directly surrounding suburbs!) Note that this field ''can'' be filled with non-suburb links such as [[Wellington Harbour]]. If such a non-suburb link is used, please put in ''round brackets'' such as the following example: ([[Waitākere Ranges]]).</s>
:Compass points are now deprecated. Please consider adding {{tl|Adjacent place}} to the article.

== TemplateData ==
[[Wikipedia:TemplateData|TemplateData]] is used by TemplateWizard, [[Wikipedia:VisualEditor|VisualEditor]] and other tools.

<templatedata>
{
"params": {
"name": {
"label": "Suburb name",
"description": "If left empty, the infobox will use the article title",
"example": "Vogeltown",
"suggested": true
},
"image": {
"label": "Image",
"description": "The primary image of the suburb",
"type": "wiki-file-name",
"suggested": true
},
"etymology": {},
"nickname": {},
"map": {
"label": "Map"
},
"location_map": {},
"coordinates": {},
"region": {},
"council": {
"label": "Council",
"description": "Primary local authority for the suburb. Usually it will be a city council, but may be a district or unitary council. Wikilink where appropriate."
},
"ward": {},
"community_board": {
"label": "Community board",
"description": "The community board established for the suburb as defined by the Local Government Act 2002. For use outside Auckland."
},
"sub_board": {},
"established": {
"label": "Year established",
"description": "Year suburb was established. May in some cases be pre-European, but only if there was continuity.",
"type": "number"
},
"arearef": {
"aliases": [
"areasource"
],
"label": "Area reference",
"description": "Reference for area data, using <ref> … </ref>"
},
"area": {
"aliases": [
"area_ha"
],
"label": "Area",
"description": "Size of the suburb in hectares"
},
"popdate": {
"label": "Population date"
},
"popref": {
"label": "Population reference",
"aliases": [
"popsource"
],
"description": "Reference for population data, using <ref> … </ref>"
},
"population": {
"label": "Population"
},
"postcode": {
"label": "Postcode",
"description": "Postcode for the suburb. If suburb has multiple, use 'postcodes'."
},
"trainstations": {},
"railwaystations": {},
"ferryterminals": {},
"buswaystations": {},
"airports": {},
"hospitals": {},
"north": {
"deprecated": "Use {{Adjacent place}} instead"
},
"northeast": {
"deprecated": "Use {{Adjacent place}} instead"
},
"east": {
"deprecated": "Use {{Adjacent place}} instead"
},
"southeast": {
"deprecated": "Use {{Adjacent place}} instead"
},
"south": {
"deprecated": "Use {{Adjacent place}} instead"
},
"southwest": {
"deprecated": "Use {{Adjacent place}} instead"
},
"west": {
"deprecated": "Use {{Adjacent place}} instead"
},
"northwest": {
"deprecated": "Use {{Adjacent place}} instead"
},
"board": {
"label": "Local board (Auckland)",
"description": "The local board established for the suburb. Only for use in Auckland."
},
"img_caption": {
"aliases": [
"caption1", "image_caption"
],
"label": "Image caption"
},
"map_caption": {
"aliases": [
"caption2"
],
"label": "Map caption"
},
"city": {
"aliases": [
"city1"
],
"label": "City",
"description": "The city that contains the suburb. Should usually be wikilinked.",
"example": "[[Hamilton, New Zealand|Hamilton]]",
"suggested": true
},
"postcodes": {
"label": "Postcodes",
"description": "Postcodes for the suburb. Use 'postcode' if there is only one."
},
"trainstation": {},
"railwaystation": {},
"ferryterminal": {},
"buswaystation": {},
"airport": {},
"hospital": {}
},
"description": "Infobox for suburbs in New Zealand",
"paramOrder": [
"name",
"image",
"img_caption",
"etymology",
"nickname",
"map",
"map_caption",
"location_map",
"coordinates",
"city",
"region",
"council",
"ward",
"community_board",
"board",
"sub_board",
"established",
"area",
"arearef",
"population",
"popref",
"popdate",
"postcode",
"postcodes",
"trainstation",
"trainstations",
"railwaystation",
"railwaystations",
"ferryterminal",
"ferryterminals",
"buswaystation",
"buswaystations",
"airport",
"airports",
"hospital",
"hospitals",
"north",
"northeast",
"east",
"southeast",
"south",
"southwest",
"west",
"northwest"
],
"format": "block"
}
</templatedata>

== Tracking category ==
* {{clc|Pages using infobox New Zealand suburb with unknown parameters}}

== See also ==
* {{tl|Infobox settlement}}

<includeonly>{{basepage subpage|

[[Category:Oceania country subdivision infobox templates|New Zealand Suburbs]]
[[Category:Templates that add a tracking category]]
}}</includeonly>

Template:Infobox New Zealand suburb/doc - Revision history

>Turnagra: Updating to include alts for image caption