Template:Msgloss/doc

From MOASSpedia
Jump to navigation Jump to search

The {{msgloss}} template is used to create links from a word or phrase to corresponding entries in the Glossary of motorsport terms article. Example: grid. 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: From an article to the glossary:

  • {{msgloss|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:

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

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

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

or (in glossary of motorsport 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 motorsport 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 &quot; or the second half of tooltip will not show up [Note to maintainers: This should be fixed at Template:Glossary link and Template:Glossary link internal with URL encoding or some other form of detection and escaping.]:      Right: {{msgloss|&quot;D&quot;, the|the "D"}} which gives the "D"
     Wrong: {{msgloss|"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 {{msgloss|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.