Template:Cuegloss/doc

The {{cuegloss}} template is used to easily create a link from a word or phrase in any article to a corresponding entry in the Glossary of cue sports terms, a stand-alone glossary list article. Example: stakehorse.

Using {{cuegloss|stakehorse}} is a more concise way of doing [[Glossary of cue sports terms#stakehorse|stakehorse]]. and provides a mouse-hover tooltip indicating that the link goes to a glossary entry (this does not interfere with page previews or navigation popups). The template takes one or two parameters, as detail below.

The template makes proper use of the <dfn> HTML element (as documented at the parent meta-template, {{glossary link}}). For linking between entries inside the glossary itself, use {{gli}} ({{glossary link internal}}), which does not use that element (it is reserved for term entries in the glossary). It can also be used in other articles where the same term is linked twice because of article length (<dfn> should only be used once per term per page, as it means "this is the defining instance of this term on this page").

Usage

Syntax: From an article to the glossary:

• {{cuegloss|glossary term|article text}}

If the text being linked matches the name of (or an anchor present at) the glossary entry, regardless of upper or lower case, you can simply do:

• {{cuegloss|article text that is a glossary term}}

It will also handle suffixes like plurals, etc., added onto it:

• {{cuegloss|article text that is a glossary term}}ized

From inside Glossary of cue sports terms itself, to link from one entry to another:

• {{gli|glossary term|article text}}

Parameters

The first parameter is the name of the term to be linked to in Glossary of cue sports terms (or any alias of the term as defined in the glossary with {{anchor}} or {{vanchor}}). {{cuegloss|glossary term}} displays as glossary term. This will be automatically converted to all-lowercase (as is done by the {{Term}} template being linked to in the glossary); thus {{cuegloss|glossary term|article text}} and {{cuegloss|Glossary term|article text}} and {{cuegloss|Glossary Term|article text}} are functionally equivalent. For cases where this might not be desirable, see |lc=no, below.

The second parameter is the visible text string to be wikilinked from in the article ({{cuegloss|glossary term|article text}} displays as: article text). This parameter is optional, used when this displayed text needs to be different from what is put in the first parmeter (which is displayed by default if the second parameter is absent): {{cuegloss|glossary term|glossary term}} and {{cuegloss|glossary term}} are functionally equivalent, so prefer the shorter version. Using a capitalized {{cuegloss|Glossary term}} will display as: Glossary term. But its link goes to the same lowercase "glossary term" target as {{cuegloss|glossary term}}.

The parameter |lc=no (or any other value like |lc=n, |lc=false) can be used to turn off the automatic lower-casing of the link target, for a case in which the glossary entry is upper-case and someone doesn't want to link to a lower-cased anchor for it (e.g. for a proper name). The upper case anchor must exist in the glossary's code.

Limitations

The first parameter cannot contain wikimarkup, link code, or anything else other than plain text; it is part of a URL.

The second parameter may contain wikimarkup, but cannot contain link code; it is the second half of a piped wikilink.

Examples

One parameter:

In bank pool, every shot must be a {{cuegloss|bank shot}}.

In bank pool, every shot must be a bank shot.

Two parameters:

In bank pool, all shots must be {{cuegloss|bank shot|banked}}.

In bank pool, all shots must be banked.

Add a suffix (works exactly the same as with a regular wilklink like [[dog]]s):

In bank pool, all shots must be {{cuegloss|bank shot}}s.

In bank pool, all shots must be bank shots.

Capitalize displayed term:

{{cuegloss|Bank shot}}s are the only shot type used in bank pool.

Bank shots are the only shot type used in bank pool.

Link to uppercase glossary term explicitly:

Balkline billiards introduced the anchor space ({{cuegloss|Parker's box|lc=no}}).

Balkline billiards introduced the anchor space (Parker's box).

(The {{term}} template in the glossary will provide a lowercase anchor automatically, so this is not necessary, but can be done if you prefer it.)