Difference between revisions of "Template:Defn/doc"

From blackwiki
Jump to navigation Jump to search
imported>SMcCandlish
imported>Jdaloner
m (updated/adjusted several template calls; adjusted spacing)
Line 10: Line 10:
  
 
<blockquote>
 
<blockquote>
−
{{grey|1={{tlnull|glossary}} }}<br />
+
{{gray|1={{tnull|glossary}} }}<br />
−
{{grey|1={{tlnull|term|1{{=}}<var>term</var>}} }}<br />
+
{{gray|1={{tnull|term|1{{=}}<var>term</var>}} }}<br />
−
{{bxt|1={{tlnull|defn|1{{=}}<var>Definition.</var>}} }}<br />
+
{{bxt|1={{tnull|defn|1{{=}}<var>Definition.</var>}} }}<br />
−
{{grey|1={{tlnull|glossary end}} }}<br />
+
{{gray|1={{tnull|glossary end}} }}<br />
 
</blockquote>
 
</blockquote>
  
 
Links, inline templates, reference citations, wikimarkup styles, etc., can be applied to the definition.  Technically, the {{para|1}} 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 {{para|1}} parameter can also be called {{para|defn}} for those who don't care for numeric parameters.
 
Links, inline templates, reference citations, wikimarkup styles, etc., can be applied to the definition.  Technically, the {{para|1}} 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 {{para|1}} parameter can also be called {{para|defn}} for those who don't care for numeric parameters.
−
* This will work: {{bxt|1={{tlnull|defn|1{{=}}The concept that the mass of a body is a measure of its energy content, expressed by the formula E{{=}}MC²}} }}
+
* This will work: {{bxt|1={{tnull|defn|1{{=}}The concept that the mass of a body is a measure of its energy content, expressed by the formula E{{=}}MC²}} }}
−
* This will work: {{bxt|1={{tlnull|defn|defn{{=}}The concept that the mass of a body is a measure of its energy content, expressed by the formula E{{=}}MC²}} }}
+
* This will work: {{bxt|1={{tnull|defn|defn{{=}}The concept that the mass of a body is a measure of its energy content, expressed by the formula E{{=}}MC²}} }}
 
* This will {{strongbad|fail}}: {{!bxt|1={{tnull|defn|The concept that the mass of a body is a measure of its energy content, expressed by the formula E{{=}}MC²}} }}
 
* This will {{strongbad|fail}}: {{!bxt|1={{tnull|defn|The concept that the mass of a body is a measure of its energy content, expressed by the formula E{{=}}MC²}} }}
  
 
More complex usage is typically:
 
More complex usage is typically:
−
{{bq|{{tlnull|defn|defn{{=}}<var>Definition.</var>&nbsp;|no{{=}}<var>#</var>&nbsp;|term{{=}}<var>term_id</var>}} }}
+
{{quote|{{tnull|defn|defn{{=}}<var>Definition.</var>&nbsp;|no{{=}}<var>#</var>&nbsp;|term{{=}}<var>term_id</var>}} }}
  
 
where {{para|no|<var>#</var>}} gives a leading number for a definition in a list of definitions, and {{para|term|<var>term_id</var>}} provides the name of the term used in the {{tlx|Term}} template to which this definition pertains.
 
where {{para|no|<var>#</var>}} gives a leading number for a definition in a list of definitions, and {{para|term|<var>term_id</var>}} provides the name of the term used in the {{tlx|Term}} template to which this definition pertains.
  
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
−
=== Images, hatnotes and other content ===
+
===Images, hatnotes and other content===
−
|{{pseudoheading|Images, hatnotes and other content|sub=3}} }}
+
|{{fake heading|Images, hatnotes and other content|sub=3}} }}
  
 
Images, [[Template:Ghat|hatnotes]] and other "add-in" content intended to immediately follow the {{tnull|term}} {{em|must be used at the top of (inside) the first {{tnull|defn}} of the {{tnull|term}}.}} They {{strong|cannot}} be placed between the {{tnull|term}} and {{tnull|defn}} or it will break the glossary markup. Images can, of course, be placed elsewhere within the {{tnull|defn}}, and bottom-notes like {{tl|more}} can be placed at the ends of but {{em|inside}} {{tnull|defn}}s.
 
Images, [[Template:Ghat|hatnotes]] and other "add-in" content intended to immediately follow the {{tnull|term}} {{em|must be used at the top of (inside) the first {{tnull|defn}} of the {{tnull|term}}.}} They {{strong|cannot}} be placed between the {{tnull|term}} and {{tnull|defn}} or it will break the glossary markup. Images can, of course, be placed elsewhere within the {{tnull|defn}}, and bottom-notes like {{tl|more}} can be placed at the ends of but {{em|inside}} {{tnull|defn}}s.
Line 37: Line 37:
 
{<nowiki />{term|1{{=}}colour ball&nbsp;|content=&nbsp;colour ball&nbsp;{{tnull|anchor|coloured ball|coloured balls|colour|colours|color ball}}}<nowiki />}<br />
 
{<nowiki />{term|1{{=}}colour ball&nbsp;|content=&nbsp;colour ball&nbsp;{{tnull|anchor|coloured ball|coloured balls|colour|colours|color ball}}}<nowiki />}<br />
 
{{bxt|1=<nowiki>{{defn|1=</nowiki>}}<br />
 
{{bxt|1=<nowiki>{{defn|1=</nowiki>}}<br />
−
{{bxt|<nowiki>[[File:Set of Snookerballs.png|thumb|right|150px|A complete set of snooker balls, with six '''colour balls'''.]]</nowiki>}}<br />
+
{{bxt|<nowiki>[[File:Set of Snookerballs.png|thumb|right|150px|A complete set of snooker balls, with six '''colour balls''']]</nowiki>}}<br />
 
{{bxt|{{tnull|ghat|1{{=}}<nowiki>Also '''coloured ball(s)''', '''colour(s)'''; American spelling '''color'''</nowiki> sometimes also used.}} }}<br />
 
{{bxt|{{tnull|ghat|1{{=}}<nowiki>Also '''coloured ball(s)''', '''colour(s)'''; American spelling '''color'''</nowiki> sometimes also used.}} }}<br />
 
In [<nowiki />[snooker]], any of the {{tnull|cuegloss|object ball}}s that are not {{tnull|cuegloss|red ball|reds}}.<br />
 
In [<nowiki />[snooker]], any of the {{tnull|cuegloss|object ball}}s that are not {{tnull|cuegloss|red ball|reds}}.<br />
Line 50: Line 50:
 
{{term |1=colour ball |content=colour ball {{anchor|coloured ball|coloured balls|colour|colours|color ball}}}}
 
{{term |1=colour ball |content=colour ball {{anchor|coloured ball|coloured balls|colour|colours|color ball}}}}
 
{{defn|1=  
 
{{defn|1=  
−
[[File:Set of Snookerballs.png|thumb|right|150px|A complete set of snooker balls, with six '''colour balls'''.]]
+
[[File:Set of Snookerballs.png|thumb|right|150px|A complete set of snooker balls, with six '''colour balls''']]
 
{{ghat|Also '''coloured ball(s)''', '''colour(s)'''; American spelling '''color''' sometimes also used.}}
 
{{ghat|Also '''coloured ball(s)''', '''colour(s)'''; American spelling '''color''' sometimes also used.}}
 
In [[snooker]], any of the {{cuegloss|object ball}}s that are not {{cuegloss|red ball|reds}}.
 
In [[snooker]], any of the {{cuegloss|object ball}}s that are not {{cuegloss|red ball|reds}}.
Line 59: Line 59:
  
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
−
=== Multiple definitions for one term ===
+
===Multiple definitions for one term===
−
|{{pseudoheading|Multiple definitions for one term|sub=3}} }}
+
|{{fake heading|Multiple definitions for one term|sub=3}} }}
  
 
If a single {{tnull|term}} has multiple definitions, they are simply numbered with the {{para|2|parameter}} explicitly. Think of the parameter as standing for "{{strong|2}}nd or later definition". You can also call it {{para|no}}, if you prefer (from "[[Numero sign|No.]]")  Example:
 
If a single {{tnull|term}} has multiple definitions, they are simply numbered with the {{para|2|parameter}} explicitly. Think of the parameter as standing for "{{strong|2}}nd or later definition". You can also call it {{para|no}}, if you prefer (from "[[Numero sign|No.]]")  Example:
Line 87: Line 87:
  
 
Because of the uneven length of definitions, it is usually more convenient to put the {{para|2|}} before the {{para|1}} description:
 
Because of the uneven length of definitions, it is usually more convenient to put the {{para|2|}} before the {{para|1}} description:
−
{{bq|{{tnull|defn&nbsp;|2{{=}}1&nbsp;|1{{=}}Lorem ipsum dolor sit amet.}} }}
+
{{quote|{{tnull|defn&nbsp;|2{{=}}1&nbsp;|1{{=}}Lorem ipsum dolor sit amet.}} }}
 
or
 
or
−
{{bq|{{tnull|defn&nbsp;|no{{=}}1&nbsp;|1{{=}}Lorem ipsum dolor sit amet.}} }}
+
{{quote|{{tnull|defn&nbsp;|no{{=}}1&nbsp;|1{{=}}Lorem ipsum dolor sit amet.}} }}
  
 
This is a very robust method, because it permits complex content like block quotations, nested lists, {{tlx|main}} cross-reference hatnotes, and other block-level markup inside each definition. The definitions can also be independently linked.
 
This is a very robust method, because it permits complex content like block quotations, nested lists, {{tlx|main}} cross-reference hatnotes, and other block-level markup inside each definition. The definitions can also be independently linked.
Line 104: Line 104:
  
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
−
=== Making the definition independently linkable ===
+
===Making the definition independently linkable===
−
|{{pseudoheading|Making the definition independently linkable|sub=3}} }}
+
|{{fake heading|Making the definition independently linkable|sub=3}} }}
  
 
{{quote box|width=33%|title=HTML5 update:|quote=Most of the restrictions on the content of <code>id</code> have been removed, so <code>id</code> values no longer have to begin with an <code>[a-z][A-Z]</code> 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.}}To enable a link directly to a specific definition, name the definition with its {{tlx|term}} (or it must be the {{para|id|{{var|foo}}}} value, if any, used in {{tnull|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 {{tnull|defn}}'s {{para|term}} parameter. This will produce a <code>#</code>-link target ID in the form <code>{{var|term}}-defn{{var|#}}</code>, where the {{var|#}} is the number of the definition ''(see [[#Multiple definitions for one term]], above)'', defaulting to "1". Example:
 
{{quote box|width=33%|title=HTML5 update:|quote=Most of the restrictions on the content of <code>id</code> have been removed, so <code>id</code> values no longer have to begin with an <code>[a-z][A-Z]</code> 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.}}To enable a link directly to a specific definition, name the definition with its {{tlx|term}} (or it must be the {{para|id|{{var|foo}}}} value, if any, used in {{tnull|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 {{tnull|defn}}'s {{para|term}} parameter. This will produce a <code>#</code>-link target ID in the form <code>{{var|term}}-defn{{var|#}}</code>, where the {{var|#}} is the number of the definition ''(see [[#Multiple definitions for one term]], above)'', defaulting to "1". Example:
Line 156: Line 156:
  
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
−
=== Languages ===
+
===Languages===
−
|{{pseudoheading|Languages|sub=3}} }}
+
|{{fake heading|Languages|sub=3}} }}
  
 
There is no {{para|lang}} parameter, as on English Wikipedia 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:
 
There is no {{para|lang}} parameter, as on English Wikipedia 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:
Line 170: Line 170:
  
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
−
=== Examples ===
+
===Examples===
−
|{{pseudoheading|Examples|sub=3}} }}
+
|{{fake heading|Examples|sub=3}} }}
  
 
This shows both a very simple then a rather complex instance:
 
This shows both a very simple then a rather complex instance:
Line 181: Line 181:
 
{{tnull|glossary}}<br /><br />
 
{{tnull|glossary}}<br /><br />
 
{{tnull|term|1{{=}}applesnorkel}}<br />
 
{{tnull|term|1{{=}}applesnorkel}}<br />
−
{{bxt|{{tlnull|defn|1{{=}}Definition of term 1.}}}}<br /><br />
+
{{bxt|{{tnull|defn|1{{=}}Definition of term 1.}}}}<br /><br />
−
{{tnull|term|term{{=}}arglefarst&nbsp;|content{{=}}<nowiki>''{{lang|</nowiki>{{var|xx}}<nowiki>|arglefarst}}''{{anchors|argle-farst|argle farst}}</nowiki>&nbsp;}}<br />
+
{{tnull|term|term{{=}}arglefarst&nbsp;|content{{=}}<nowiki>''{{lang|</nowiki>{{var|xx}}<nowiki>|arglefarst}}''{{anchor|argle-farst|argle farst}}</nowiki>&nbsp;}}<br />
−
{{bxt|{{tlnull|defn|no{{=}}1&nbsp;|defn{{=}}<br />
+
{{bxt|{{tnull|defn|no{{=}}1&nbsp;|defn{{=}}<br />
 
Beginning of first definition of term 2<br />
 
Beginning of first definition of term 2<br />
 
{{tnull|gbq|1{{=}}Block quotation in first definition of term 2.}}<br />
 
{{tnull|gbq|1{{=}}Block quotation in first definition of term 2.}}<br />
 
Conclusion of first definition of term 2.<br />}}}}<br />
 
Conclusion of first definition of term 2.<br />}}}}<br />
−
{{bxt|{{tlnull|defn|no{{=}}2&nbsp;|defn{{=}}Second definition of term 2.}}}}<br /><br />
+
{{bxt|{{tnull|defn|no{{=}}2&nbsp;|defn{{=}}Second definition of term 2.}}}}<br /><br />
 
{{tnull|glossary end}}
 
{{tnull|glossary end}}
 
</code></blockquote>
 
</code></blockquote>
Line 194: Line 194:
 
<td style="border: 1px solid black; vertical-align: top;">
 
<td style="border: 1px solid black; vertical-align: top;">
 
<blockquote>
 
<blockquote>
−
{{pseudoheading|A&ndash;M}}
+
{{fake heading|A&ndash;M}}
  
 
{{glossary}}
 
{{glossary}}
Line 201: Line 201:
 
{{defn|1=Definition of term 1.}}
 
{{defn|1=Definition of term 1.}}
  
−
{{term|term=arglefarst |content=''{{lang|xx|arglefarst}}''{{anchors|argle-farst|argle farst}} }}
+
{{term|term=arglefarst |content=''{{lang|xx|arglefarst}}''{{anchor|argle-farst|argle farst}} }}
 
{{defn|no=1 |defn=
 
{{defn|no=1 |defn=
 
Beginning of first definition of term 2
 
Beginning of first definition of term 2
Line 214: Line 214:
  
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
−
=== Applying CSS styles to the definition ===
+
===Applying CSS styles to the definition===
−
|{{pseudoheading|Applying CSS styles to the definition|sub=3}} }}
+
|{{fake heading|Applying CSS styles to the definition|sub=3}} }}
  
 
The {{para|style}} parameter will pass CSS styling on to the {{tag|dd|o}} element, e.g. {{para|style|font-family:serif;}} or whatever. I.e., this styles the definition itself, not the term it applies to, other defintiions, or the glossary as a whole. This feature is rarely if ever needed in articles, but can be useful elsewhere for things like matching custom user page style.
 
The {{para|style}} parameter will pass CSS styling on to the {{tag|dd|o}} element, e.g. {{para|style|font-family:serif;}} or whatever. I.e., this styles the definition itself, not the term it applies to, other defintiions, or the glossary as a whole. This feature is rarely if ever needed in articles, but can be useful elsewhere for things like matching custom user page style.
  
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
−
=== Other parameters ===
+
===Other parameters===
−
|{{pseudoheading|Other parameters|sub=3}} }}
+
|{{fake heading|Other parameters|sub=3}} }}
  
 
The {{para|id}} parameter can be used to assign a one-word, case-sensitive ID name to definition. It must be unique on the page. This can be used as a #link target, and could have other metadata uses. ''See the [[#Making the definition independently linkable]] section for how to normally make a definition linkable.'' Probably the {{em|only}} reason to use this feature is if there are two terms with the same name on the page, which would result in conflicting IDs.
 
The {{para|id}} parameter can be used to assign a one-word, case-sensitive ID name to definition. It must be unique on the page. This can be used as a #link target, and could have other metadata uses. ''See the [[#Making the definition independently linkable]] section for how to normally make a definition linkable.'' Probably the {{em|only}} reason to use this feature is if there are two terms with the same name on the page, which would result in conflicting IDs.
Line 231: Line 231:
 
{{Term/doc}}
 
{{Term/doc}}
  
−
== See also ==
+
==See also==
 
{{glossary templates see also}}
 
{{glossary templates see also}}
  
−
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
+
|{{collapse bottom}} }}<!--end ifeq--><includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
[[Category:Glossary templates]]
 
[[Category:Glossary templates]]
 
[[Category:Definition list templates]]
 
[[Category:Definition list templates]]
 
}}</includeonly>
 
}}</includeonly>
−
 
−
|{{collapse bottom}} }}<!--end ifeq-->
 

Revision as of 10:04, 8 April 2015

Usage

The template {{defn}} is used in template-structured glossaries to create definitions of terms. It is a wrapper for <dd>...</dd>, the description list definition HTML element. The template has a mnemonic redirect at {{dd}}.

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 |1= 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 |1= parameter can also be called |defn= for those who don't care for numeric parameters.

  • This will work: {{defn|1=The concept that the mass of a body is a measure of its energy content, expressed by the formula E=MC²}}
  • This will work: {{defn|defn=The concept that the mass of a body is a measure of its energy content, expressed by the formula E=MC²}}
  • This will fail: {{defn|The concept that the mass of a body is a measure of its energy content, expressed by the formula E=MC²}}

More complex usage is typically:

{{defn|defn=Definition. |no=# |term=term_id}}

where |no=# gives a leading number for a definition in a list of definitions, and |term=term_id provides the name of the term used in the {{Term}} template to which this definition pertains.

Images, hatnotes and other content

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.

{{glossary}}
{{term|1=colour ball |content= colour ball {{anchor|coloured ball|coloured balls|colour|colours|color ball}}}}
{{defn|1=
[[File:Set of Snookerballs.png|thumb|right|150px|A complete set of snooker balls, with six '''colour balls''']]
{{ghat|1=Also '''coloured ball(s)''', '''colour(s)'''; American spelling '''color''' sometimes also used.}}
In [[snooker]], any of the {{cuegloss|object ball}}s that are not {{cuegloss|red ball|reds}}.
}}
{{glossary end}}

Template:Term
File:Set of Snookerballs.png
A complete set of snooker balls, with six colour balls

Also coloured ball(s), colour(s); American spelling color sometimes also used.

In snooker, any of the object balls that are not reds.

Multiple definitions for one term

If a single {{term}} has multiple definitions, they are simply numbered with the |2=parameter explicitly. Think of the parameter as standing for "2nd or later definition". You can also call it |no=, if you prefer (from "No.") Example:

{{glossary}}
{{term|1=blubbermonster}}
{{defn|1=Lorem ipsum dolor sit amet. |no=1}}
{{defn|1=Consectetur adipisicing elit. |no=2}}
{{glossary end}}

Template:Term
1.  Lorem ipsum dolor sit amet.
2.  Consectetur adipisicing elit.

Because of the uneven length of definitions, it is usually more convenient to put the |2= before the |1= description:

{{defn |2=1 |1=Lorem ipsum dolor sit amet.}}

or

{{defn |no=1 |1=Lorem ipsum dolor sit amet.}}

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}}
1.&nbsp;&nbsp;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). }}

Making the definition independently linkable

Template:Quote boxTo enable a link directly to a specific definition, name the definition with its {{term}} (or it must be the |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:

{{glossary}}
{{term|1=blubbermonster}}
{{defn|no=1 |1=Lorem ipsum dolor sit amet. |term=blubbermonster}}
{{defn|no=2 |1=Consectetur adipisicing elit. |term=blubbermonster}}
{{term|1=snorkelweasel (noun)}}
{{defn|1=Ut enim ad minim veniam |term=snorkelweasel (noun)}}
{{glossary end}}

Template:Term
1.  Lorem ipsum dolor sit amet.
2.  Consectetur adipisicing elit.
Template:Term
Ut enim ad minim veniam

 HTML output:

<dl class="glossary">
<dt class="glossary" id="blubbermonster" style="font-size: 110%; margin-top: 0.5em;"><dfn>blubbermonster</dfn></dt>
<dd class="glossary" id="blubbermonster-defn1">1.  Lorem ipsum dolor sit amet.</dd>
<dd class="glossary" id="blubbermonster-defn2">2.  Consectetur adipisicing elit.</dd>
<dt class="glossary" id="snorkelweasel_.28noun.29" style="font-size: 110%; margin-top: 0.5em;"><dfn>snorkelweasel (noun)</dfn></dt>
<dd class="glossary" id="snorkelweasel_.28noun.29-defn1">Ut enim ad minim veniam</dd>
</dl>

Note that some characters in snorkelweasel (noun)" have been converted on the fly by MediaWikia by the time it sends the ID to the browser as snorkelweasel_.28noun.29-defn1. You can still link to it on this page as #snorkelweasel (noun)-defn1 (view page source and see for yourself – that link has href=#snorkelweasel_.28noun.29-defn1).

The IDs blubbermonster-defn1, blubbermonster-defn2,  and snorkelweasel_(noun)-defn1 are all individually linkable, e.g. as [[Glossary of weird terms#blubbermonster-defn1]]. This is especially useful for cross-references within the glossary, e.g. See also [[#blubbermonster-defn2|"blubbermonster", sense 2]].

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}}

Languages

There is no |lang= parameter, as on English Wikipedia 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: 

{{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}}

Examples

This shows both a very simple then a rather complex instance:

==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}}

A–M
Template:Term
Definition of term 1.
Template:Term
1.  Beginning of first definition of term 2

Block quotation in first definition of term 2.

Conclusion of first definition of term 2.
2.  Second definition of term 2.

Applying CSS styles to the definition

The |style= parameter will pass CSS styling on to the <dd> element, e.g. |style=font-family:serif; or whatever. I.e., this styles the definition itself, not the term it applies to, other defintiions, or the glossary as a whole. This feature is rarely if ever needed in articles, but can be useful elsewhere for things like matching custom user page style.

Other parameters

The |id= parameter can be used to assign a one-word, case-sensitive ID name to definition. It must be unique on the page. This can be used as a #link target, and could have other metadata uses. See the #Making the definition independently linkable section for how to normally make a definition linkable. Probably the only reason to use this feature is if there are two terms with the same name on the page, which would result in conflicting IDs.

The |class= parameter will pass one or more space-separated CSS classes on to <dd> element, in addition to the automatically included class glossary. There is rarely any reason to do this.

Usage

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}}
{{defn}}
{{glossary end}}

Parameters

  • |id=   can be used to assign a one-word ID name to the glossary. This can be used as a #id 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.
  • |class=   will pass one or more space-separate CSS classes on to <dl> element, in addition to the automatically included class glossary. 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}}): 

==A&ndash;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}}
A–M




Template:Term
Definition of term 1.


Template:Term
1.  Beginning of first definition of term 2

Block quotation in first definition of term 2.


Conclusion of first definition of term 2.

2.  Second definition of term 2.


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:

Template:Term
The new version of this product costs significantly less than the previous one!
Template:Term
We've changed the product so that it's much easier to use!
Template:Term
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.

See also

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


Template:Term/doc

See also

  • {{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
Retrieved from "https://blackwiki.org/index.php?title=Template:Defn/doc&oldid=3936738"