Teamplaid:Cuegloss/documentation

The {{Cuegloss}} template is used to create links from a word or phrase to corresponding entries in the Glossary of cue sports terms article. Example: stakehorse. It makes proper use of the <dfn> HTML element (as documented at the parent meta-template, Teamplaid:Glossary link). The {{Glossary link internal}} variant, which does not use that markup (it is reserved for term entries), is usually used only inside the glossary itself, for cross-references to other entries within it, though 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|term in glossary|text in article}}

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|text in article that is a term in glossary}}

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

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

or (in Glossary of cue sports terms itself, or for duplicate links in same article):

• {{Glossary link internal|term in glossary|text in article}}

This template makes it very simple to add links, in article prose, talk pages, etc., to entries in the Glossary of cue sports terms, a stand-alone glossary list article. It takes one or two parameters, depending on needs, as detailed below.

If term in glossary (or text in article that is a term in glossary) contains a double quote (") character, it must be escaped as " or the second half of tooltip will not show up [Note to maintainers: This should be fixed at Teamplaid:Glossary link and Teamplaid:Glossary link internal with URL encoding or some other form of detection and escaping.]:      Right: {{cuegloss|"D", the|the "D"}} which gives the "D"
     Wrong: {{cuegloss|"D", the|the "D"}} which gives the "D" It is easiest to simply create an Anchor in the glossary at that entry with {{Anchor|the D|...}}, so we can do {{cuegloss|the D|the "D"}}. This has already been done for this entry, but keep this in mind when adding any new entries that include double quotes.

Wikitext example:

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

Result:

     In bank pool, all shots must be banked.

This template also supports this sort of usage, exactly as a regular wikilink would: {{Cuegloss|Bank shot|bank}}ed.

The first parameter is the exact name of the term to be linked to in Glossary of cue sports terms (or any alias of it as defined in the glossary with {{Anchor}}), and the second parameter is the text string to be wikilinked from in the article. Lower-case versions of the

For example, in this case the term to be defined is covered at Glossary of cue sports terms#bank shot, so Bank shot is the first parameter. The second parameter is optional if the text string to be wikilinked from in the article is exactly the same (including case, plurality, etc.) as the glossary term (or alternative {{anchor}}) in the first parameter:

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

Result:

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