Skabelon:Glossary/doc
 | Dette er dokumentationsundersiden til Skabelon:Glossary og Skabelon:Glossary end. Denne side indeholder information om brug, kategorier samt andet indhold, som ikke er en del af den oprindelige skabelonside. |
Usage
[rediger kildetekst]The template {{glossary}} (a.k.a. {{glossary start}} or {{glossary begin}}) is used with {{glossary end}} 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 (as a technical matter) 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 Wikipedia'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:
{{glossary}}
{{term|1=term}}
{{defn|1=Definition.}}
{{glossary end}}
Parameters
|id=can be used to assign a one-word ID name to the glossary. This can be used as a#idlink 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.|class=will pass one or more space-separate CSS classes on to<dl>element, in addition to the automatically included classglossary. There is rarely any reason to do this.
Examples
This shows both a very simple then a rather complex instance in a structured glossary (including an entry with a block quotation, using the glossary block quotation template, {{gbq}}):
|
|
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 (
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 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
or use
(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=aspirin}}
{{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...}}
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 Skabelon:Dc parameter (and shouldn't – there are too many pitfalls). The HTML5 update:
Most of the restrictions on the content of The The This shows both a very simple then 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
More complex usage is typically:
where 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, Use of a hatnote with a numbered definition requires manual numbering or it will look weird:
HTML5 update:
Most of the restrictions on the content of To enable a link directly to a specific definition, name the definition with its
The IDs blubbermonster-defn1, blubbermonster-defn2, and snorkelweasel_(noun)-defn1 are all individually linkable, e.g. as To add more than one linkable anchor, use the {{anchor}} template at the beginning of the definition's content: There is no {{glossary}}
{{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''}}
...
{{glossary end}}
This shows both a very simple then a rather complex instance:
The The The |