Template:Census 2016 AUS/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 13:36, 28 February 2024

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

This template is used on approximately 6,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:

This template allows for the inclusion of direct web links to official 2016 census data into Australian geographical articles. Due to periodic changes/redesigns on the ABS website, these links may change: the advantage of using the template is therefore that all articles using this template will migrate with it.

Usage

General

{{Census 2016 AUS|id= |name= |access-date= |quick=on}}

Lists only

{{Census 2016 AUS|id= |link=yes}}

Parameters

id: ABS ID for the region (note: may be different from 2011, so don't convert across without checking.)
name: ABS Name for the region: e.g. Raymond Terrace (State Suburb).
access-date: Optional parameter to record date accessed in the form dd mmmm yyyy (e.g. 15 November 2024).
quick: This is an optional but widely used parameter. When added at the end, generally as |quick=on, it forces QuickStats instead of a link to the "Census Community Profiles" page.
link: This is an optional parameter that causes a bare link to be generated instead of a citation if |link=yes and is for use in lists such as List of cities in Australia by population#50 largest urban centres by population. When this is the case, the only necessary parameter is id. Other parameters will not be used. This functionality is similar to that provided by {{Census 2006 AUS link}}.

Examples

As a citation (QuickStats)

{{Census 2016 AUS|id=SSC13327|name=Raymond Terrace (State Suburb)|access-date=15 November 2024|quick=on}} produces:
Australian Bureau of Statistics (27 June 2017). "Raymond Terrace (State Suburb)". 2016 Census QuickStats. Retrieved 15 November 2024.

As a citation (Census Community Profiles)

{{Census 2016 AUS|id=SSC13327|name=Raymond Terrace (State Suburb)|access-date=15 November 2024}} produces:
Australian Bureau of Statistics (27 June 2017). "2016 Community Profiles: Raymond Terrace (State Suburb)". 2016 Census of Population and Housing. Retrieved 15 November 2024.

As a bare link

{{Census 2016 AUS|id=SSC13327|link=yes}} produces [1]

Tracking categories

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Census 2016 AUS in articles based on its TemplateData.

TemplateData for Census 2016 AUS

Creates a citation to the Australian Bureau of Statistics for the 2016 Census

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
ABS ID	`id`	ABS ID for the region (called code on the page), please double-check as many have changed since 2011 Example SSC13327	String	required
ABS Name	`name`	ABS Name for the region Example Raymond Terrace (State Suburb)	String	suggested
Access date	`access-date`	Date the information was retrieved from the ABS Example 17 October 2017	Date	suggested
Quick stats?	`quick`	use on for Quick stats, omit for Community Profile Default on Example on	String	suggested
Bare URL?	`link`	yes causes a bare URL to be generated instead of a citation if link=yes and is for use in lists Example yes	String	deprecated

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
+{{High-use}}
-<!-- Categories and interwikis go at the bottom of this page. -->
+<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata -->
+{{Tracks Wikidata|P4093}}
+{{Lua|Module:EditAtWikidata|Module:WikidataCheck}}
 This template allows for the inclusion of direct web links to official 2016 census data into Australian geographical articles. Due to periodic changes/redesigns on the ABS website, these links may change: the advantage of using the template is therefore that all articles using this template will migrate with it.
@@ Line 6: / Line 9: @@
 == Usage ==
 === General ===
+<syntaxhighlight lang="wikitext">
-<pre>
-{{Census 2016 AUS|id= |name= |accessdate= |quick=on}}
+{{Census 2016 AUS|id= |name= |access-date= |quick=on}}
+</syntaxhighlight>
-</pre>
 === Lists only ===
+<syntaxhighlight lang="wikitext">
-<pre>
 {{Census 2016 AUS|id= |link=yes}}
+</syntaxhighlight>
-</pre>
 == Parameters ==
@@ Line 19: / Line 22: @@
 ; <code>id</code>: ABS ID for the region (note: may be different from 2011, so don't convert across without checking.)
 ; <code>name</code>: ABS Name for the region: e.g. Raymond Terrace (State Suburb).
-; <code>accessdate</code>: Optional parameter to record date accessed in the form dd mmmm yyyy (e.g. {{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}).
+; <code>access-date</code>: Optional parameter to record date accessed in the form dd mmmm yyyy (e.g. {{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}).
 ; <code>quick</code>: This is an optional but widely used parameter. When added at the end, generally as {{para|quick|on}}, it forces QuickStats instead of a link to the "Census Community Profiles" page.
 ; <code>link</code>: This is an optional parameter that causes a bare link to be generated instead of a citation if {{para|link|yes}} and is for use in lists such as [[List of cities in Australia by population#50 largest urban centres by population]]. When this is the case, the only necessary parameter is <code>id</code>. Other parameters will not be used. This functionality is similar to that provided by {{tl|Census 2006 AUS link}}.
@@ Line 26: / Line 29: @@
 === As a citation (QuickStats) ===
-* <nowiki>{{Census 2016 AUS|id=SSC13327|name=Raymond Terrace (State Suburb)|accessdate=</nowiki>{{Currentdaymonthyear}}<nowiki>|quick=on}}</nowiki> produces:
+* <nowiki>{{Census 2016 AUS|id=SSC13327|name=Raymond Terrace (State Suburb)|access-date=</nowiki>{{Currentdaymonthyear}}<nowiki>|quick=on}}</nowiki> produces:
-* {{Census 2016 AUS|id=SSC13327|name=Raymond Terrace (State Suburb)|accessdate={{Currentdaymonthyear}}|quick=on}}
+* {{Census 2016 AUS|id=SSC13327|name=Raymond Terrace (State Suburb)|access-date={{Currentdaymonthyear}}|quick=on}}
 === As a citation (Census Community Profiles) ===
-* <nowiki>{{Census 2016 AUS|id=SSC13327|name=Raymond Terrace (State Suburb)|accessdate=</nowiki>{{Currentdaymonthyear}}<nowiki>}}</nowiki> produces:
+* <nowiki>{{Census 2016 AUS|id=SSC13327|name=Raymond Terrace (State Suburb)|access-date=</nowiki>{{Currentdaymonthyear}}<nowiki>}}</nowiki> produces:
-* {{Census 2016 AUS|id=SSC13327|name=Raymond Terrace (State Suburb)|accessdate={{Currentdaymonthyear}}}}
+* {{Census 2016 AUS|id=SSC13327|name=Raymond Terrace (State Suburb)|access-date={{Currentdaymonthyear}}}}
 === As a bare link ===
 * <nowiki>{{Census 2016 AUS|id=SSC13327|link=yes}}</nowiki> produces {{Census 2016 AUS|id=SSC13327|link=yes}}
-<!--
-==Tracking categories==
-* {{clc|Australian Statistical Geography Standard 2016 ID not in Wikidata}}
-* {{clc|Australian Statistical Geography Standard 2016 ID different from Wikidata}}
-* {{clc|Australian Statistical Geography Standard 2016 ID same as Wikidata}}
-* {{cl|Australian Statistical Geography Standard 2016 ID template with no id set}} (exists in template, not created) -->
 ==Tracking categories==
@@ Line 46: / Line 43: @@
 * {{clc|Australian Statistical Geography Standard 2016 ID different from Wikidata}}
 * {{clc|Australian Statistical Geography Standard 2016 ID same as Wikidata}}
-* {{cl|Australian Statistical Geography Standard 2016 ID template with no id set}} (exists in template, not created)
 == See also ==
@@ Line 52: / Line 48: @@
 * {{tl|Census 2006 AUS}}
 * {{tl|Census 2011 AUS}}
+* {{tl|Census 2021 AUS}}
+* {{tl|CensusAU}}
+== TemplateData ==
-==Template Data for the Visual Editor==
+{{TemplateData header}}
 <templatedata>
 {
+	"description": "Creates a citation to the Australian Bureau of Statistics for the 2016 Census",
+	"format": "inline",
 	"params": {
 		"id": {
 			"label": "ABS ID",
-			"description": "ABS ID for the region (called code on the page, please double-check as many have changed since 2011",
+			"description": "ABS ID for the region (called code on the page), please double-check as many have changed since 2011",
 			"example": "SSC13327",
-			"type": "line",
+			"type": "string",
 			"required": true
 		},
@@ Line 68: / Line 69: @@
 			"description": "ABS Name for the region",
 			"example": "Raymond Terrace (State Suburb)",
-			"type": "line",
+			"type": "string",
 			"suggested": true
 		},
-		"accessdate": {
+		"access-date": {
 			"label": "Access date",
 			"description": "Date the information was retrieved from the ABS",
@@ Line 82: / Line 83: @@
 			"description": "use on for Quick stats, omit for Community Profile",
 			"example": "on",
-			"type": "line",
+			"type": "string",
+			"default": "on",
 			"suggested": true
 		},
 		"link": {
-			"label": "Quick stats?",
+			"label": "Bare URL?",
-			"description": "yes causes a bare link to be generated instead of a citation if |link=yes and is for use in lists s. When this is the case, the only necessary parameter is id. Other parameters will not be used. This functionality is similar to that provided by the Template:Census 2006 AUS link}}.",
+			"description": "yes causes a bare URL to be generated instead of a citation if link=yes and is for use in lists",
 			"example": "yes",
-			"type": "line"
+			"type": "string",
+			"deprecated": true
 		}
-	},
+	}
-	"description": "Creates a citation to the Australian Bureau of Statistics for the 2016 Census",
-	"format": "inline"
 }
 </templatedata>
-<includeonly>
+<includeonly>{{Sandbox other||
-<!-- Categories and interwikis go here: -->
+<!-- Categories below this line and interwikis at Wikidata -->
 [[Category:Australian source templates]]
 [[Category:Specific-source templates]]
+[[Category:Templates that add a tracking category]]
-</includeonly>
+}}</includeonly>