Template:Cuegloss/doc

From Sarkarverse
Jump to navigation Jump to search

The {{cuegloss}} template is used to create links from a word or phrase to corresponding entry in the glossary of cue sports terms article. It makes proper use of the <dfn> HTML element (as documented at the parent meta-template, Template: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:

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

or (in glossary of cue sports terms itself, or for duplicate links in same 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 contains a double quote (") character, it must be escaped as &quot; or the second half of tooltip (the term in glossary) will not show up:

Right: {{cuegloss|&quot;D&quot;, the|the "D"}} which gives the "D"
Wrong: {{cuegloss|"D", the|the "D"}} which gives the "D"

Wikitext:

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. 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. Please note that the id= parameters that are generated for linkable glossary terms are case-sensitive (in every browser except Internet Explorer under Windows). That is, {{Cuegloss|Object ball|object ball}} and {{Cuegloss|object ball|object ball}} are not equivalent.

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.