Template:Gloss
Usage
[edit source]The template {{gloss}} is used with {{glossend}} to explicitly bracket a glossary or glossary-like description list (also called a definition list or association list), especially in a template-structured glossary, although such lists can be used more generally. This is required for template=structured glossaries, and is good practice anywhere description/definition lists are used for glossaries. The template pair invoke the <dl>...</dl> description list HTML element. Unfortunately, the {{dl}} mnemonic is not available as a redirect as of this writing.
The pair of templates incidentally prevent Wikiversity's MediaWiki software engine from auto-creating redundant definition list code (<dl>...</dl>) around terms and definitions if they have blank lines between them, as they often do, especially in non-structured glossaries.
Typical usage:
{{gloss}}
{{term|1=term}}
{{defn|1=Definition.}}
{{glossend}}
Parameters
- Template:Para can be used to assign a one-word ID name (which must begin with an alphabetic letter) to the glossary. This can be used as a #link target, and could have other metadata uses.
- Template:Para will pass CSS styling on to the
<dl>element. I.e., this styles the definition list itself, as a container, not the individual terms and definitions with it. There is rarely any reason to do this.
Examples
This shows both a very simple and a rather complex instance in a structured glossary:
|
|
Scope
This family of templates, like the underlying definition list code, is primarily intended for definitional uses, but can have other applications. The HTML 4.01 Specification itself says:
Definition lists...generally consist of a series of term/definition pairs (although definition lists may have other applications). Thus, when advertising a product, one might use a definition list:
- Lower cost
- The new version of this product costs significantly less than the previous one!
- Easier to use
- We've changed the product so that it's much easier to use!
- Safe for kids
- You can leave your kids alone in a room with this product and they won't get hurt (not a guarantee).
Thus, editors should feel free to use definition list markup as an alternative to bulleted or numbered lists when the material is well-suited to definition list presentation.
Usage
| ||||
|---|---|---|---|---|
|
The template Basic usage:
Inline templates, reference citations, wikimarkup styles, etc., can be applied to the term in the second parameter (Template:Para or Template:Para) as long as it remains without markup in the first parameter (Template:Para or Template:Para. Technically, the explicit parameter names are optional if the term or content does not contain the "=" character, but as any editors can add material, including templates or URLs with this character in them, it is always safest to explicitly name the parameters.
More complex usage is typically:
or
or
If the second or Template:Para parameter is styled with wikimarkup, linked, or otherwise altered inside the template, the term must also be retained in unstyled form as the first or Template:Para parameter. Failing to do so will cause the template to malfunction, since it must have a "clean" term name to use as the
Style cannot be applied around the template, either, as it is a container for content (the term), not content itself (and doing so will produce invalid markup that will have unpredictable results depending upon browser):
For the same reasons that links to other pages are discouraged in headings, links are also discouraged in glossary terms:
Again, as with the first parameter (the term) itself, if the " numbered:
or named:
The template
As with styled terms, the second parameter must be used to provide the "bare" term. It is not necessary to add the term itself to the
(Strictly speaking, this fact has nothing to do with this template, but may be of use to editors who are converting from one glossary style to the other.) Two or more Example: {{term|1=asprin}}
{{defn|1=A mild analgesic of the non-steroidal anti-inflammatory drug (NSAID) family...}}
{{term|1=heroin}}
{{term|1=diacetylmorphine|multi=y}}
{{term|1=diamorpine|multi=y}}
{{defn|1=A synthetic narcotic drug of the opiate family...}}
{{term|1=ranitidine}}
{{defn|1=An antacid of the proton pump inhibitor family...}}
Result:
To indicate the language of a non-English term, use the
This shows no visual change for most languages: {{term|1=esprit de corp |content={{lang-fr|esprit de corps}}s}}
which renders as:
The template has no The Template:Para parameter will pass CSS styling on to the This shows both a very simple and a rather complex instance:
Images, hatnotes and other "add-in" content intended to immediately follow the
What this template does on the technical level is wrap the term in the |
Usage
| |||||||||
|---|---|---|---|---|---|---|---|---|---|
|
The template Basic usage:
Links, inline templates, reference citations, wikimarkup styles, etc., can be applied to the definition. Technically, the Template:Para part is optional if the content of the definition does not contain the "=" character, but as any editors can add content, including templates with this character in them, it is always safest to explicitly name the parameter. The Template:Para parameter can also be called Template:Para for those who don't care for numeric parameters.
More complex usage is typically:
Images, hatnotes and other "add-in" content intended to immediately follow the
If a single
Because of the uneven length of definitions, it is usually more convenient to put the Template:Para before the Template:Para description:
or
This is a very robust method, because it permits complex content like block quotations, nested lists, Use of a hatnote with a numbered definition requires manual numbering or it will look weird:
To enable a link directly to a specific definition, you can manually add an
The IDs blubbermonster-defn1, blubbermonster-defn2, and snorkelweasel_noun-defn1 are all individually linkable, e.g. as There is no Template:Para parameter, as on English Wikiversity all definitions are necessarily in English. For uses of glossary markup for non-glossary purposes in which some content may be in a foreign language, use language templates. E.g. in a list of film title translations formatted using glossary markup: {{gloss}}
{{term|1=Titles of La Vie en Rose in various languages |content=Titles of ''[[La Vie en Rose]]'' in various languages}}
{{defn|1=French: ''{{lang|fr|La Vie en Rose}}''}}
{{defn|1=English: ''Life in Pink''}}
...
{{glossend}}
This shows both a very simple and a rather complex instance:
Applying CSS styles to the definition
The Template:Para parameter will pass CSS styling on to the |
