Teamplaid:Glossary/documentation
 | This is a documentation subpage for Teamplaid:Glossary and Teamplaid:Glossary end. It contains usage information, categories and other content that is not part of the original teamplaid page. |
Ùsaid - Usage
deasaichThe 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}} {{Defn}} {{Glossary end}}
Paramadairean - Parameters
deasaich|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.
Eisimpleirean - Examples
deasaichThis 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}}):
==A–M==
{{Glossary}}
{{Term|1=applesnorkel}}
{{Defn|1=Definition of Term 1.}}
{{Term|Term=arglefarst |content=''{{Lang|xx|arglefarst}}''{{Anchor|argle-farst|argle farst}} }}
{{Defn|no=1 |Defn=Beginning of first definition of Term 2
{{Gbq|1=Block quotation in first definition of Term 2.}}
Conclusion of first definition of Term 2.
}}
{{Defn|no=2 |Defn=Second definition of Term 2.}}
{{Glossary end}}
|
|
Sgòp - 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.
 | Uses Lua: |
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: {{Glossary}} {{Term|1=Term}} {{Defn}} {{Glossary end}} 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: {{Term}} automatically creates a link Anchor point (an HTML If your glossary has an unusual case in which one entry and another share the exact same name except for case (thus would get the same lower-cased HTML {{Term|Term=foo}}
{{Defn|Definition of lower-case version here ...
{{Term|Term=Foo |id=Foo_2 |content={{Vanchor|Foo}} }}
{{Defn|Definition of proper-name version here ...
You can then link to them as The template {{Anchor}} can also be used in the As with styled terms, the first parameter must be used to provide the "bare" term, the second to provide this extra markup. It is not necessary to add the term itself to the {{anchor}} template when using {{term}}: By contrast, when using semicolon-delimited terms in unstructured glossaries, the term does need to be added explicitly as an Anchor if link anchorage is desired (which is almost always the case): or use {{Vanchor}} (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 {{terms}} can be used for synonyms with a shared definition, though keep in mind that people looking for one and not finding it where they expect it to be alphabetized are liable to assume it is missing if you do not create a cross-reference entry. The parameter 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 {{Lang}} template and the ISO 639 language codes as documented at that template: This shows no visual change for most languages: For all non-English languages this provides many metadata features, but it is essential for those that do not use the Latin alphabet, so that the content displays properly in various browsers. If it is useful to indicate the name of the language, there are individual templates for most languages, with names based on the ISO codes, and which automatically italicize the foreign content: which renders as:
As detailed above, two or more terms, as variations or alternatives, can share definitions. The most common use case for this is presenting the term in two variants of English. Example: {{Term|1=tyre|content={{Lang-en-GB|tyre}} }}
{{Term|1=tire|content={{Lang-en-US|tire}} |multi=y}}
{{Defn|1=A resilient wheel covering usually made of vulcanized rubber.}}
Note the use of Result: In a different format, more appropriate for alphabetical glossaries: {{Term|1=tyre|content={{Lang|en-GB|tyre}} {{Small|({{enUici|British English}})}} }}
{{Term|1=tire|content={{Lang|en-US|tire}} {{Small|({{enUici|American English}})}} |multi=y}}
{{Defn|1=A resilient wheel covering usually made of vulcanized rubber.}}
Result: That example uses the {{Lang}} template with language codes as the first parameter, rather than the {{Lang-xx}} templates. The {{Term}} template has no The HTML5 update:
Most of the restrictions on the content of
id have been removed, so id values no longer have to begin with an [a-z][A-Z] alphabetic character, avoid most punctuation marks, or suffer other such limitations. Wikipedia's MediaWiki engine is smart enough to auto-escape any problematic characters, on the fly.|id= parameter can be used to assign a one-word, case-sensitive ID name to term. It must be unique on the page. This can be used as another #link target, and could have other metadata uses. By default, the |Term= a.k.a. |1= parameter is already set as the ID, and this should rarely be overridden, unless there are two identical terms on the same page creating conflicting IDs. Usually the {{Anchor}} template is used to add more link targets to an entry .
The This shows both a very simple then a rather complex instance:
Images, hatnotes and other "add-in" content intended to immediately follow the {{term}} must be used at the top of (inside) the first {{defn}} of the {{term}}. They cannot be placed between the {{term}} and {{defn}} or it will break the glossary markup. Images can, of course, be placed elsewhere within the {{defn}}, and bottom-notes like {{More}} can be placed at the end of, but inside, a {{defn}}. When used with a multi-definition term, the definition in which the {{ghat}} appears must be manually numbered (usually
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: {{Glossary}} {{Term|1=Term}} {{Defn|1=Definition.}} {{Glossary end}} 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 {{term}} must be used at the top of (inside) the first {{defn}} of the {{term}}. They cannot be placed between the {{term}} and {{defn}} or it will break the Glossary markup. Images can, of course, be placed elsewhere within the {{defn}}, and bottom-notes like {{More}} can be placed at the ends of but inside {{defn}}s.
If a single {{term}} has multiple definitions, they are simply numbered with the
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: {{Term|1=blackjack|content=blackjack{{Anchor|Blackjack}} }}
{{Defn |1={{Main|Blackjack}}}}
{{Defn|no=1|1=A card game in which players attempt to approach 21 but not exceed it.}}
{{Defn|no=2|1=The best possible hand in the game of blackjack, made up of an ace and a card valued at 10 (namely, 10, J, Q, K). }}
HTML5 update:
Most of the restrictions on the content of
id have been removed, so id values no longer have to begin with an [a-z][A-Z] alphabetic character, avoid most punctuation marks, or suffer other such limitations. Wikipedia's MediaWiki engine is smart enough to auto-escape any problematic characters, on the fly.|id=foo value, if any, used in {{term}}). This 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 {{defn}}'s |Term= parameter. This will produce a #-link target ID in the form Term-Defn#, where the # is the number of the definition (see #Multiple definitions for one Term, above), defaulting to "1". Example:
Note that some characters in 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: {{Defn|no=2|1={{Anchor|elit|Elit}}Consectetur adipisicing elit.|Term=blubbermonster}}
There is no {{Glossary}}
{{Term|1=Titles of La Vie en Rose in various languages |content=Titles of ''{{enUici|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 |
Faic cuideachd - Also see
- {{Glossary}} a.k.a. {{Gloss}} – Half of a template pair; uses
<dl>with a class to open the structured glossary definition list that {{glossend}} closes. - {{Glossary end}} a.k.a. {{Glossend}} – The other half of this template pair; uses
</dl>to close the definition list that {{gloss}} opens. - {{Term}} – The glossary term to which the {{defn}} definition applies; a customized
<dt>with a class and an embedded<dfn>. - {{Defn}} – The definition that applies to the {{term}}; uses
<dd>with a class - {{Ghat}} – a hatnote template properly formatted for the top of a {{defn}} definition
- {{Gbq}} a.k.a. {{Gquote}} – a block quotation template properly formatted for inclusion in a {{defn}} definition
- {{Glossary link}} – meta-template for creating shortcut templates for linking to definitions in specific glossaries
- Wikipedia:Manual of Style/Glossaries