Template:Gloss/doc
 | This is a documentation subpage for Template:Gloss and Template:Glossend. It may contain usage information, categories and other content that is not part of the original template page. |
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
|id=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.|style=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 {{term}} is used in template-structured glossaries to create terms to be defined, that are properly structured, have semantic value, and can be linked to as if independent sections. It is a wrapper for Basic usage:
Inline templates, reference citations, wikimarkup styles, etc., can be applied to the term in the second parameter (
More complex usage is typically:
or
or
If the second or
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 {{anchors}} can also be used in the
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 {{lang}} template and the ISO 639 language codes as documented at that template:
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 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 {{defn}} is used in template-structured glossaries to create definitions of terms.
It is a wrapper for Basic usage:
Links, inline templates, reference citations, wikimarkup styles, etc., can be applied to the definition. Technically, the
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
or
This is a very robust method, because it permits complex content like block quotations, nested lists, {{main}} cross-reference hatnotes, and other block-level markup inside each definition. The definitions can also be independently linked. 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 {{anchor}} template, or name the definition with its {{term}} or an abbreviation thereof (must be unique on the page for each term, but should be the same for multiple definitions of the same term). This is done with the
The IDs blubbermonster-defn1, blubbermonster-defn2, and snorkelweasel_noun-defn1 are all individually linkable, e.g. as There is no {{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 |