Template:Glossary link/doc

Usage
The template ' and its variant ' ( for short) are templates for creating structured links to particular entries in topical glossaries.


 * is a meta-template for creating templates for specific major glossary articles (e.g. the template for Glossary of cue sports terms); it is not usually used directly in an article. Please categorize any derived, topical glossary link templates that use this meta-template into Category:Glossary link templates (this is usually done at the bottom of the template's /doc page, so that the category is not inside the template itself and it not accidentally transcluded into the articles that use the template).
 * usually used directly in the glossary article itself, and is not a meta-template.

The documentation below explains how to use them for your topic's template-structured glossary. Like the wrapper, and the glossary  template, it uses the  HTML element properly. (Note that necessarily does not use it;  should only be used once per term on a single page, at the defining appearance of it, and is used by  inside the glossary.)

creates a normal blue link. To prevent the "sea of blue" effect, uses the light dashed underline style that has become a de facto Web standard for definitional markup.

Tech detail: By using an internal with its own independent   attribute for a tool tip, it sets this up in a way that does not violate the very geeky and backasswards HTML5 specs on the handing of the   attribute of, which is the exact term defined, not its definition.

Due to lack of what would be a pretty sophisticated facility in the MediaWiki parser, there is no way to have the definition in the glossary be pulled into a pop-up tooltip on mouseover, which would be really cool. Maybe someday. For now, it shows the glossary article title (if on another page) and what the entry's name is, as specified by the template, which is where the reader will go if they click on the glossary link. This replaces the default Wikipedia tooltip for such a link, which would only give the article title.

Syntax (basic use cases)

 * Linking from regular article prose to glossary entries:
 * Use a term as it appears in a separate glossary article: – gives:
 * Use an alternative term, linking to the related term in a separate glossary article: – gives:
 * Use a partially piped link:  – gives: s


 * by this template and the corresponding in the glossary (the original version as specified in, even if it's "uTriCle", it will also work):  – gives:  (note the link target). In other words,   is not necessary.
 * This means that for entries that begin with (or otherwise contain) upper case, a lower-case anchor must exist. does this automatically, but if the target glossary is not template-structured, a manual  or  will be need to be added.
 * If there is some circumstance in which this is not practical/desirable for a particular term, the lower-casing can be turned off with no:

Normally this is done with a derived, glossary-specific wrapper template. For example, can be done simply with.
 * Use a term as it appears in the glossary section of the same article: – gives:
 * Same but less visually intrusive: or  – gives:
 * Use an alternative term, linking to a related term in the glossary section of the same article: – gives:
 * Same but less visually intrusive: or  – gives:

We use the (short name: ) variant to not plaster the page with blue links; ones that go to full articles on terms will thus stand out from links to other short definitions in the same glossary:
 * Linking between glossary entries on the same page:
 * Use a term as it appears within the same glossary page: – gives:
 * Use an alternative term, linking to the related term within the same glossary page: – gives:

Normally this is done with the shortcut;  and  are equivalent. However, in an especially long page, if you run into the template transclusion limit, you can use a plain-wikicode link to the entry, e.g..
 * Use a term as it appears on a different page of the same multi-page glossary: – gives:
 * Use an alternative term, linking to the related term on a different page of the same multi-page glossary: – gives:

Because is short, simple, and requires no undefined parameter, there is no need or use for a wrapper template for a specific glossary (e.g., do not create a  to go along with ).

Syntax (geeky version)

 * results in:
 * results in:
 * results in:
 * results in:
 * results in:
 * results in:

The variant works exactly the same, but is used inside the glossary itself to provide cross-references between entries, and is also used when the same term is linked twice in other articles (e.g. because the article is very long). Its only difference from is that it does not use, since it is only supposed to be used once per page per term, and it does not blue-link the link, since we don't want to create a "sea of blue" link mess.
 * results in:
 * results in:

Parameters
Each version of the template takes up to three parameters for its data:

Limitations : The glossary and term parameters cannot have any HTML or wiki markup; they are basically parts of URLs (namely ).
 * the title of the glossary article to be linked to
 * This is part of the URL to be generated; it
 * It is case-sensitive in that it has to resolve to the actual article page in the same way as a  wikilink.
 * the term entry in the glossary to be linked to (or any  for it)
 * This is part of the URL to be generated; it
 * Glossary-specific templates based on this meta-template need to mention this prominently in their documentation.
 * This parameter can also be done as 1 or the first unnamed parameter. It be unnamed when creating a glossary-specific wrapper template from the meta-template, because you cannot guarantee that input will not contain a = character.
 * It is not case-sensitive and will be reduced to lower-case (that behavior can be turned off with no below, e.g. for proper names that do not have any reason to have a lowercase anchor).
 * the actual text in the article to be linked from, if different from the term linked.
 * This parameter can be styled, templated, etc. (though cannot contains links – it's going to become the link). Styling can also be applied before and after the entire template, of course.
 * This is case-sensitive, in that it's going to display whatever you put into it.

A color parameter allows the color of the text to be changed. This should be done when the rest of the text is also another color for some reason, e.g. because of white text in a dark-background table cell in a navbox or infobox. The parameter will accept established HTML/CSS color names (e.g. ) and hex values (e.g.  ), and is spelled " " since this is the spelling used by HTML and CSS.

Some little-used parameters that are there just in case:


 * no (or any other value like n, false, 0) – a switch to turn off the automatic lower-casing of the  anchor derived from the 1 or term entry, if that target content has no all-lowercase anchor defined at it (by  automatically or by a manually added ) and creating one is not desirable (e.g. because it would be something unituitive and otherwise useless like "jane w. smith" for a biographical entry)
 * an_ID – an anchor ID (no spaces, must begin with alphabetic letter) for #linking and possibly other purposes
 * arbitrary:css; – CSS directives for custom-styling the instance
 * css_class – a CSS class or classes (separated by spaces not commas if more than one); by default it already includes  or   (in the template with the respectively matching name) for custom user CSS.

Example code
The template for cue sports:

The variant is used (as )  such an article as Glossary of cue sports terms:

is the glossary entry's link anchor. The optional  is the displayed text of the link. Examples: or

Fuller syntax of is: Here, it is specifying a glossary page, which is needed if a large glossary has been split across multiple pages; and uses named parameters, which would be necessary if the input into them contained an = character.

For real-use application, see Template:Cuegloss/doc, the Glossary of cue sports terms article, and articles like Nine-ball that use the template to link to terms in the glossary.