User:SMcCandlish/Template:Cue sports navbox

Editing this template

Organizational structure: It is arranged in the following order: Pool games, carom games, other games (snooker first since it is a major sport), and lastly supporting materials. Pool and carom are listed first because they are broad categories, and pool is listed above carom because it has orders of magnitude more players and popularity (despite being historically subordinate.) Bold indicates games currently subject to widespread international competition; italics indicates a major resource, and the left heading column includes links to the top-most levels of these article hierarchies. Within the pool, carom and "other" lines, the major professional games are listed first, then games for which regulated rules exist (with priority given to those that don't require uncommon additional equipment), then extant folk games, then effectively extinct but historically important games, then marginally related ones (ball-less or cueless) last.

Usage

Place {{Cue sports nav}} near the bottom of relevant articles (but not templates, categories, etc.), just above the DEFAULTSORT (if present) and categories (and after any similar template if there is already one present that more closely addresses the subject, such as a film/director/actor/genre nav box on the page for The Hustler.)

Do not "subst:" this template.

There are two optional parameters (one with two possible values):

• |snooker — Used in one of two forms to indicate the article's relation to the topic of snooker:

• |snooker=only — Causes the "Snooker" navigation features to appear, and the more general "Cue sports" features to collapse ("hide") by default; use is principally intended for snooker tournament articles and bios of snooker-only players
• |snooker=both — Causes the "Snooker" features to appear along with the "Cue sports" features; use is principally intended for the main snooker article, and for bios of notable players of both snooker and some other cue sport such as nine-ball or English billiards.

• |main=no — Causes the entire thing (with or without the "Snooker" menu) to autocollapse if two or more other navigation templates are present; use this when the article is not principally a cue sports article (e.g. an article about a film that happens to be about cue sports). Otherwise, the template will "assert itself" and remain (or at least have its top half remain) uncollapsed by default.

Do not use "|snooker=no" or "|main=yes" or other made-up variations; they are not valid and will not do anything useful. Please note also that the parameters and their values are case-sensitive: "|Snooker=only" and "|snooker=Only" are not valid.

Examples

For a "generic" cue sports article (e.g. Billiard ball), or one about a non-snooker player (e.g. Irving Crane):

{{Cue sports nav}}

Result:

For a snooker-focused article that doesn't involve other cue sports (e.g. Snooker rules); note that the "Cue sport" section collapses by default, because it won't be of particular relevance to the majority of readers (but remains available because it will be for some of them):

{{Cue sports nav|snooker=only}}

Result:

For an article that directly relates to both snooker and other cue sports (e.g. Steve Davis who is also a nine-baller); note that the "Cue sport" section autocollapses because of the large number of navigation templates present; if they were not, it would be expanded by default:

{{Cue sports nav|snooker=both}}

Result:

For an article that only peripherally relates to cue sports (e.g. The Hustler (film)); note that it autocollapses because of the large number of navigation templates present:

{{Cue sports nav|main=no}}

Result:

For an article that only peripherally relates to snooker but not to any other cue sports (e.g. Billy the Kid and the Green Baize Vampire); note that the entire thing autocollapses because of the large number of navigation templates present:

{{Cue sports nav|snooker=only|main=no}}

Result:

For an article that only peripherally relates to both snooker and some other cue sport (e.g. Phenolic resin); note that the entire thing autocollapses because of the large number of navigation templates present, but if they were not then both parts would be expanded until such time as other nav tags were added, in which case they would both autocollapse like the immediately-above example (I'm not sure that's correct actually...):

{{Cue sports nav|snooker=both|main=no}}

Result: