User:SMcCandlish/WikiProject Cue sports banner/doc

From Wikipedia, the free encyclopedia

This template employs intricate features of template syntax. You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.

Template:WikiProject Sports is a talk page template that is used as a shortcut to other pages in the WikiProject. It is also used as a way of assessing articles. You should supply the correct assessment when you add this template to a talk page.

Please note: This template should be transcluded — {{Cue sports project}} — and not substituted — {{subst:...}} — because it employs conditional code. Transclusion also allows easy updating of all the Project's talk pages without having to edit hundreds or thousands of pages.

[edit] Usage

[edit] Basic

{{Cue sports project
|bio=
|class=
|importance=
|attention=
|needs-infobox=
|needs-photo=
|small=
}}

• bio: Answer yes if the article is a biography of someone(s), living or deceased, otherwise remove this line.
• class: Options are Stub, Start, B, GA, A, and FA, in order of ascending quality. Other options include Dab, Template, Cat, NA (for disambiguation pages, templates, categories, and misc. non-articles, respectively). If blank, this will default as Unassessed. Descriptions of the options can be found at the quality scale. Note: Please be aware that ratings of GA, A and FA have required consensus approval processes, and articles should not be rated Start or B-class without meeting the criteria for such an assessement.
• importance: Top, High, Mid, Low, NA. If blank, this will default to Unknown priority. NA is "not applicable" (for templates, categories, disambiguation pages and other non-articles). Descriptions of the options can be found at importance scale. Note: Please be aware that a rating of Top has a required consensus approval process, and articles should not be rated High or Mid priority without meeting the criteria for such an assessement. The vast majority of cue sports articles are Low priority and should probably not be rated higher by anyone who is not an active, long-term member of one of the relevant active WikiProjects, because it is used by the Wikipedia 1.0 process.
• attention: Answer yes if the page needs immediate attention, otherwise remove this line. Note: This is for serious problems, not just because the article is a stub or needs some copyediting.
• needs-infobox: Answer yes if the article lacks an appopriate infobox, otherwise remove this line.
• needs-photo: Answer yes to request that a photograph or illustration be added, otherwise remove this line. This is for articles with no (useful) pictures; to suggest additional pictures for an already well-illustrated article, use the article's talk page.
• small: Answer yes to make the template small and along the right side of the page (as opposed to at the top), otherwise remove this line.

[edit] Extended

This extended documentation is principally for the use of article assessors from WikiProjects. The average editor does not need to use them.

{{Cue sports project
|bio=
|class=
|c-proj=
|importance=
|i-proj=
|attention=
|s-peer-review=
|s-old-peer-review=
|b-peer-review=
|b-old-peer-review=
|needs-infobox=
|needs-photo=
|small=
}}

• bio: Answer yes if the article is a biography of someone(s), living or deceased, otherwise remove this line.
• class: Options are Stub, Start, B, GA, A, and FA, in order of ascending quality. Other options include Dab, Template, Cat, NA (for disambiguation pages, templates, categories, and misc. non-articles, respectively). If blank, this will default as Unassessed. Descriptions of the options can be found at the quality scale. Note: Please be aware that ratings of GA, A and FA have required consensus approval processes, and articles should not be rated Start or B-class without meeting the criteria for such an assessement.
• c-proj: The name of the WikiProject (without the "Wikipedia:" part, e.g. WikiProject Biography) that assigned the class assessment, if it wasn't WikiProject Sports (the default), otherwise remove this line. Note: If two projects differ on an article's class the most conservative (i.e. least favorable) class assessement applies.
• importance: Top, High, Mid, Low, NA. If blank, this will default to Unknown priority. NA is "not applicable" (for templates, categories, disambiguation pages and other non-articles). Descriptions of the options can be found at importance scale. Note: Please be aware that a rating of Top has a required consensus approval process, and articles should not be rated High or Mid priority without meeting the criteria for such an assessement. The vast majority of cue sports articles are Low priority and should probably not be rated higher by anyone who is not an active, long-term member of one of the relevant active WikiProjects, because it is used by the Wikipedia 1.0 process.
• i-proj: The name of the WikiProject (without the "Wikipedia:" part, e.g. WikiProject China) that assigned the importance assessment, if it wasn't WikiProject Sports (the default), otherwise remove this line. Note: In contrast to class, If two projects differ on an article's importance (priority), the most liberal (i.e. most favorable) priority assessement applies. Note further: Other WikiProjects always supersede WikiProject Biography's importance/priority rating, because WP:BIO does not actually use this parameter except sometimes for sorting in some subprojects. WP:BIO assessors should not replace an existing priority rating with one from WP:BIO, and assessors from other projects should replace any left by WP:BIO, as they are moot for WP 1.0 purposes.
• attention: Answer yes if the page needs immediate attention, otherwise remove this line. Note: This is for serious problems, not just because the article is a stub or needs some copyediting.
• s-peer-review: Answer yes if the page is currently nominated for Peer Review by WikiProject Sports, otherwise remove this line. Note: This is not used for Wikipedia-wide peer review.
• s-old-peer-review: Answer yes if the article has alread received a Peer Review from WikiProject Sports per the option above, otherwise remove this line.
• b-peer-review: Answer yes if the page is currently nominated for Peer Review by WikiProject Biography, otherwise remove this line. Note: This is not used for Wikipedia-wide peer review.
• b-old-peer-review: Answer yes if the article has alread received a Peer Review from WikiProject Biography per the option above, otherwise remove this line.
• needs-infobox: Answer yes if the article lacks an infobox, otherwise remove this line.
• needs-photo: Answer yes to request that a photograph or illustration be added, otherwise remove this line. This is for articles with no (useful) pictures; to suggest additional pictures for an already well-illustrated article, use the article's talk page.
• small: Answer yes to make the template small and along the right side of the page (as opposed to at the top), otherwise remove this line.

[edit] Examples

[edit] Minimal

{{User:SMcCandlish/Sandbox/Template|class=Stub|importance=Low}}

This yields:

User:SMcCandlish/Sandbox/Template

[edit] Maximal

An almost absurd example demonstrates that the maximum size is still much smaller than the equivalent using multiple old-school templates, in which there would be three WikiProject banners, two of them oversized because of assessments, plus the infobox and picture banners.

{{User:SMcCandlish/Sandbox/Template
|bio=yes
|class=B
|c-proj=WikiProject Biography
|importance=Mid
|i-proj=WikiProject Biography
|attention=yes
|s-peer-review=yes
|s-old-peer-review=yes
|b-peer-review=yes
|b-old-peer-review=yes
|needs-infobox=yes
|needs-photo=yes
}}

This yields:

User:SMcCandlish/Sandbox/Template