View source for Template:WikiProject Canada/doc

{{documentation subpage}}
{{high-use}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->

==About this template==
This template is the project banner for '''[[Wikipedia:WikiProject Canada|WikiProject Canada]]''' and can also act as a banner for several of its child-projects. (Other banners exist for related projects like {{tl|WikiProject Canadian football}} and {{tl|WikiProject Canada Roads}}.)

The template is to be placed on '''talk pages''' (only) of the articles identified as being within the Project's scope (at or near the top of the talkpage).

This template automatically assigns the category [[:Category:WikiProject Canada articles]] to the articles' talk pages. This category and other associated Project categories are used in various ways by the Project in the overall management of the Project's workload.

This template contains optional parameters, details of usage are given below.

==Usage instructions==
General syntax options for this template are as follows:
<syntaxhighlight lang="wikitext">{{WikiProject Canada |class= |importance=}}</syntaxhighlight>
The parameters are named, and (if used) must be entered exactly as-is (note, all are lowercase).

The ''class'' and ''importance'' parameters are associated with the Project's '''[[WikipediaWikipedia:Version 1.0 Editorial Team/Assessment|article assessment and rating scheme]]'''. These parameters add a category to the talkpage, which category depends on the values chosen.

Other parameters can be added to further identify the article or change its shape. Full syntax options for this template are as follows:

<syntaxhighlight lang="wikitext">{{WikiProject Canada
|class=
|importance=
|auto=
|needs-photo=

|on=
|qc=
|ns=
|nb=
|mb=
|bc=
|pe=
|sk=
|ab=
|nl=
|nt=
|yt=
|nu=

|montreal=
|montreal-importance=
|ottawa=
|ottawa-importance=
|toronto=
|toronto-importance=
|vancouver=
|vancouver-importance=

|cangov=
|canlaw=
|cinema=
|community=
|education=
|geography=
|history=
|military=
|music=
|ppap=
|riding=
|sport=
|tvshow=
|WPCan10k=
}}</syntaxhighlight>

== Parameter values ==

=== Class ===
This optional parameter records the Project '''quality assessment rating''' currently assigned to the particular article on whose talkpage the project banner appears.

If unassigned, or an invalid value is given, the parameter defaults to "unassigned" and the template places the talkpage into [[:Category:Unassessed Canada-related articles]].

Valid values for this parameter, their associated meanings and categories are given in the table below. Values should be typed as shown (e.g. ''|class=GA'' ):
{| class="wikitable" align="center" style="font-size:90%; width:90%;"
|-
|+'''Class parameter values''' ([[:Category:Canada-related articles by quality]])
|-
!width="10%"|Value
!width="65%"|Meaning
!width="25%"|Category
|-
|'''FA'''||Featured-class articles; the article has passed through the [[WP:FA|featured article]] review process.||[[:Category:FA-Class Canada-related articles|FA-Class Canada-related articles]]
|-
|'''A'''||A-class articles; could be submitted as a [[WP:FAC|Featured article candidate]]; probably could use some small updates to make it Featured quality.||[[:Category:A-Class Canada-related articles|A-Class Canada-related articles]]
|-
|'''GA'''||Good-class articles; the article has passed through the [[WP:GA|good article]] review process.||[[:Category:GA-Class Canada-related articles|GA-Class Canada-related articles]]
|-
|'''B'''||B-class articles; could be submitted as a [[WP:GAN|Good article nominee]]; probably could use some updates or may lack some features from the [[WP:WIAGA|Good article criteria]], but it presents a good overview of the subject.||[[:Category:B-Class Canada-related articles|B-Class Canada-related articles]]
|-
|'''C'''||C-class articles; provides adequate coverage of the subject, but could still use a lot of work before being submitted as a good article nominee.||[[:Category:C-Class Canada-related articles|C-Class Canada-related articles]]
|-
|'''Start'''||Start-class articles; the article is more than a stub, but may lack some important aspects of the topic's discussion.||[[:Category:Start-Class Canada-related articles|Start-Class Canada-related articles]]
|-
|'''Stub'''||Stub-class articles; the article is a stub; it likely contains one of the [[Wikipedia:Stub templates|stub templates]].||[[:Category:Stub-Class Canada-related articles|Stub-Class Canada-related articles]]
|-
|'''FL'''||Featured-class lists; the article has passed through the [[WP:FL|featured list]] review process.  They are sorted with the featured articles.||[[:Category:FL-Class Canada-related articles|FL-Class Canada-related articles]]
|-
|'''List'''||The article is a [[WP:LIST|list]] that has not yet passed the [[WP:FL|featured list]] review process.||[[:Category:List-Class Canada-related articles|List-Class Canada-related articles]]
|-
|'''Category'''||Category-class articles||[[:Category:Category-Class Canada-related articles|Category-Class Canada-related articles]]
|-
|'''Template'''||Template-class articles||[[:Category:Template-Class Canada-related articles|Template-Class Canada-related articles]]
|-
|'''NA'''||Not applicable; the page is not an article and should not be rated; it could be an image or category, for example.||[[:Category:NA-Class Canada-related articles|NA-Class Canada-related articles]]
|-
|}

=== Importance ===
This optional parameter records the Project '''priority assessment rating''' currently assigned to the particular article on whose talkpage the project banner appears.

If unassigned, or an invalid value is given, or the ''class'' parameter is set to "NA", the parameter defaults to "unassigned" and the template places the talkpage into [[:Category:Unknown-importance Canada-related articles]].

Valid values for this parameter, their associated meanings and categories are given in the table below. Values should be typed as shown (e.g. ''|importance=Mid'' ):
{| class="wikitable" align="center" style="font-size:90%; width:90%;"
|-
|+'''Importance parameter values''' ([[:Category:Canada-related articles by importance]])
|-
!width="10%"|Value
!width="60%"|Meaning
!width="30"|Category
|-
|'''Top'''||Reserved for the primary articles. These are considered fundamental to the topic and are mostly overview articles with many links, like [[Geography of Canada]] and [[Manitoba]].||[[:Category:Top-importance Canada-related articles|Top-importance Canada-related articles]]
|-
|'''High'''||Major topic about Canada, such as [[Prime Minister of Canada]], or [[Canadian Broadcasting Corporation|CBC]]; and for needed subtopics of "key" articles||[[:Category:High-importance Canada-related articles|High-importance Canada-related articles]]
|-
|'''Mid'''||For general articles on more specialised (sub-)topics; most articles about Canadian topics go here, such as [[Greater Napanee]], [[Clarity Act]], or [[Stompin' Tom Connors]].||[[:Category:Mid-importance Canada-related articles|Mid-importance Canada-related articles]]
|-
|'''Low'''||For still notable, but more highly specialised or even obscure topics; people or things that are only notable in one small region or for a short amount of time; includes most backbench MPs.||[[:Category:Low-importance Canada-related articles|Low-importance Canada-related articles]]
|-
|}

=== Workgroups ===
The template can also be used to add an article to one of WikiProject Canada's workgroups.  Adding any of these parameters will put the article in assessment categories for both WikiProject Canada and the project selected, using the same quality and importance for both.

Workgroup parameters:

====Provinces====
{|class="wikitable"
|-
!width="100px"|Syntax
!Usage
!Remarks
|-
| '''on'''=''yes''||Used for pages in the scope of [[Wikipedia:WikiProject Ontario|WikiProject Ontario]].||
|-
| '''qc'''=''yes''||Used for pages in the scope of [[Wikipedia:WikiProject Quebec|WikiProject Quebec]].||
|-
| '''nb'''=''yes''||Used for pages in the scope of [[Wikipedia:WikiProject New Brunswick|WikiProject New Brunswick]].||
|-
| '''ns'''=''yes''||Used for pages in the scope of [[Wikipedia:WikiProject Nova Scotia|WikiProject Nova Scotia]].||
|-
| '''mb'''=''yes''||Used for pages in the scope of [[Wikipedia:WikiProject Manitoba|WikiProject Manitoba]].||
|-
| '''bc'''=''yes''||Used for pages in the scope of [[Wikipedia:WikiProject British Columbia|WikiProject British Columbia]].||
|-
| '''pe'''=''yes''||Used for pages in the scope of [[Wikipedia:WikiProject Prince Edward Island|WikiProject Prince Edward Island]].||
|-
| '''sk'''=''yes''||Used for pages in the scope of [[Wikipedia:WikiProject Saskatchewan|WikiProject Saskatchewan]].||
|-
| '''ab'''=''yes''||Used for pages in the scope of [[Wikipedia:WikiProject Alberta|WikiProject Alberta]].||
|-
| '''nl'''=''yes''||Used for pages in the scope of [[Wikipedia:WikiProject Newfoundland and Labrador|WikiProject Newfoundland and Labrador]].||
|-
| '''nt'''=''yes''
|rowspan="3"|Used for pages in the scope of  [[Wikipedia:WikiProject Canadian Territories|WikiProject Canadian Territories]]
|[[Northwest Territories]] related
|-
| '''yt'''=''yes''||[[Yukon]] related
|-
| '''nu'''=''yes''||[[Nunavut]] related
|-
|}

====Cities====
Four of the cities projects use their own importance ranking rather than adopting the general project importance ranking.
{|class="wikitable"
|-
!width="100px"|Syntax!!width="100px"|Importance rankings!!Usage!!Remarks
|-
| '''montreal'''=''yes''||montreal-importance=||Used for pages in the scope of [[Wikipedia:WikiProject Montreal|WikiProject Montreal]].||
|-
| '''ottawa'''=''yes''||ottawa-importance=||Used for pages in the scope of [[Wikipedia:WikiProject Ottawa|WikiProject Ottawa]].||
|-
| '''toronto'''=''yes''||toronto-importance=||Used for pages in the scope of [[Wikipedia:WikiProject Toronto|WikiProject Toronto]].||
|-
| '''vancouver'''=''yes''||vancouver-importance=||Used for pages in the scope of [[Wikipedia:WikiProject Vancouver|WikiProject Vancouver]].||
|}

====Other workgroups====
{|class=wikitable
|-
!width=150px|Syntax
!Usage
!Remarks
|-
|'''cangov'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject Governments of Canada|WikiProject Governments of Canada]].|| Does not include people or ridings.  For those, use <code>ppap=yes</code> and <code>riding=yes</code> respectively. 
|-
|'''canlaw'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject Canadian law|WikiProject Canadian law]].||
|-
|'''cinema'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject Film/Canadian cinema task force]].|| Only adds a link. It is assessed using the banner {{tlg|WikiProject Film |Canadian-task-force&#61;yes}}.
|-
|'''community'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject Canadian communities|WikiProject Canadian communities]].||
|-
|'''education'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject Education in Canada|WikiProject Education in Canada]].||
|-
|'''geography'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject Geography of Canada|WikiProject Geography of Canada]].|| Does not include towns. For those, use <code>community=yes</code>.
|-
|'''history'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject History of Canada|WikiProject History of Canada]].|| Does not include historical politicians.  For those, use <code>ppap=yes</code>.
|-
|'''military'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject Military history/Canadian military history task force]].|| Only adds a link. It is assessed using the banner {{tlg|WPMILHIST |Canadian-task-force&#61;yes}}.
|-
|'''music'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject Canadian Music|WikiProject Canadian Music]].||
|-
|'''ppap'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject Political parties and politicians in Canada|WikiProject Political parties and politicians in Canada]].||
|-
|'''riding'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject Electoral districts in Canada|WikiProject Electoral districts in Canada]].||
|-
|'''sport'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject Canadian sport|WikiProject Canadian sport]].||
|-
|'''tvshow'''=''yes'' || Used for pages in the scope of [[Wikipedia:WikiProject Canadian TV shows|WikiProject Canadian TV shows]].||
|-
|'''WPCan10k'''=''yes'' || Used for articles created or improved in [[Wikipedia:WikiProject Canada/The 10,000 Challenge|The 10,000 Challenge]] of WikiProject Canada.|| Alternatively use {{para|Can10k|yes}}
|-
|}

=== Other parameters ===

====Needs photo====
The parameter {{para|needs-photo|yes}} will add a tag indicating that a photo should be added to the article.  If the article is also part of the music wikiproject or any of the city wikiprojects, it will also be put in a category for articles needing photos.

==== Auto ====
When an assessment is done by a bot, it will include {{para|auto|yes}}.  After double-checking the bot's assessment, a user should remove the parameter.

== Example ==
Here is an example from the talk page of [[Speaker of the House of Commons (Canada)]]:
 <syntaxhighlight lang="wikitext">{{WikiProject Canada |class=B |importance=mid |cangov=yes}}</syntaxhighlight>

==TemplateData==
{{cot|TemplateData}}
{{TemplateData header}}
<templatedata>
{
	"params": {
		"category": {},
		"listas": {},
		"auto": {},
		"class": {
			"description": "Class rating of article"
		},
		"importance": {
			"label": "Overall Canadian importance",
			"description": "Importance to knowledge of Canada",
			"example": "Low",
			"default": "Low",
			"autovalue": "Low"
		},
		"selected-article": {},
		"selected-bio": {},
		"needs-photo": {
			"autovalue": "yes",
			"type": "boolean",
			"description": "If the article needs a photo Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no",
			"label": "Needs photo?",
			"aliases": [
				"photo-related"
			]
		},
		"needs-image": {
			"autovalue": "yes",
			"type": "boolean"
		},
		"image-needed": {
			"autovalue": "yes",
			"type": "boolean"
		},
		"photo-needed": {
			"autovalue": "yes",
			"type": "boolean"
		},
		"image-requested": {
			"autovalue": "yes",
			"type": "boolean"
		},
		"montreal": {
			"description": "Whether this article's topic is Montreal-related. Set to ['yes'], otherwise remove parameter.",
			"autovalue": "yes",
			"type": "boolean",
			"label": "Montreal-related?",
			"example": "ye",
			"default": "no"
		},
		"ottawa": {
			"description": "Whether the article's topic is Ottawa-related. Set to ['yes'], otherwise remove parameter.",
			"autovalue": "yes",
			"type": "boolean",
			"label": "Ottawa related?",
			"example": "yes",
			"default": "no"
		},
		"stjohns": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "St. Johns related?",
			"description": "Related to the city of St Johns, NFLD. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"toronto": {
			"description": "Whether the article's topic is Toronto-related. Set to ['yes'], otherwise remove parameter.",
			"default": "no",
			"autovalue": "yes",
			"type": "boolean",
			"example": "yes",
			"label": "Toronto related?"
		},
		"vancouver": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Vancouver related?",
			"description": "Whether this article is Vancouver-related. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"ab": {
			"description": "Whether this topic is related to the province of Alberta. Set to ['yes'], otherwise remove parameter.",
			"autovalue": "yes",
			"type": "boolean",
			"label": "Alberta-related?",
			"example": "yes",
			"default": "no"
		},
		"bc": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "British Columbia related?",
			"description": "Topic is related to the province of British Columbia. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"on": {
			"description": "Whether the topic is related to the province of Ontario. Set to ['yes'], otherwise remove parameter.",
			"autovalue": "yes",
			"type": "boolean",
			"default": "no",
			"label": "Ontario related?",
			"example": "yes"
		},
		"kawartha-lakes": {
			"label": "Kawartha Lakes related?",
			"description": "Kawartha Lakes work group. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"type": "boolean",
			"default": "no",
			"autovalue": "yes"
		},
		"ns": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Nova Scotia related?",
			"description": "Topic is related to the province of Nova Scotia. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"nb": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "New Brunswick related?",
			"description": "Topic is related to the province of New Brunswick. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"mb": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Manitoba related?",
			"description": "Topic is related to the province of Manitoba. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"nl": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Newfoundland and Labrador related?",
			"description": "Topic is related to the province of Newfoundland and Labrador. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"nt": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Northwest-Territories?",
			"description": "Related to Northwest Territories? Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"nu": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Nunavut related?",
			"description": "Topic is related to the Territory of Nunavut. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"pe": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Prince Edward Island related?",
			"description": "Topic is related to the Province of Prince Edward Island. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"qc": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Quebec related?",
			"description": "Topic is related to the province of Quebec. Set to ['yes'], otherwise remove parameter."
		},
		"sk": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Saskatchewan related?",
			"description": "Topic is related to the Province of Saskatchewan. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"yt": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Yukon?",
			"description": "Related to Yukon Territory? Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"gatineau-importance": {
			"default": "Low",
			"label": "Importance to Gatineau?",
			"autovalue": ""
		},
		"montreal-importance": {
			"description": "Importance to topic of Montreal.",
			"default": "Low",
			"label": "Importance to Montreal?",
			"autovalue": ""
		},
		"ottawa-importance": {
			"description": "Importance to topic of Ottawa.",
			"autovalue": "",
			"label": "Importance to Ottawa?"
		},
		"toronto-importance": {
			"description": "Indicates how important to Toronto the article's topic is.",
			"default": "Low",
			"label": "Importance to Toronto?",
			"autovalue": ""
		},
		"vancouver-importance": {
			"description": "Importance to topic of Vancouver.",
			"default": "Low",
			"label": "Importance to Vancouver?",
			"autovalue": ""
		},
		"cangov": {
			"description": "Article topic is about Canadian government. Set to ['yes'], otherwise remove parameter.",
			"autovalue": "yes",
			"type": "boolean",
			"label": "Government of Canada?",
			"example": "yes",
			"default": "no"
		},
		"ppap": {
			"label": "People and Political Parties?",
			"description": "Topic is related to person or parties in Canadian politics. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"type": "boolean",
			"default": "no",
			"autovalue": "yes"
		},
		"riding": {
			"label": "Election riding?",
			"description": "Topic is about a Canadian election riding. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"type": "boolean",
			"default": "no",
			"autovalue": "yes"
		},
		"canlaw": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Law?",
			"description": "Topic is related to Canadian laws. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"cinema": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Canadian cinema?",
			"description": "Related to Canadian cinema. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"community": {
			"autovalue": "yes",
			"type": "boolean"
		},
		"education": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Education related?",
			"description": "Topic is related to education in Canada. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"geography": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Geography related?",
			"description": "Topic is related to the geography of Canada. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"history": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "History related?",
			"description": "Topic is related to the history of Canada. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"military": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Military related?",
			"description": "Topic is related to the military of Canada. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"music": {
			"description": "Whether this topic is related to Canadian music. Set to ['yes'], otherwise remove parameter.",
			"autovalue": "yes",
			"label": "Canadian music related?",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		},
		"sport": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Sports related?",
			"description": "Topic is related to sports in Canada. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		},
		"tvshow": {
			"autovalue": "yes",
			"type": "boolean",
			"label": "Television related?",
			"description": "Topic is related to Canadian television. Set to ['yes'], otherwise remove parameter.",
			"example": "yes",
			"default": "no"
		}
	},
	"description": "Talk page banner for WikiProject Canada"
}
</templatedata>
{{cob}}

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:WikiProject Canada| ]]
[[Category:WikiProject Canada templates]]
}}</includeonly>