Difference between revisions of "Template:Defn/doc"

From blackwiki
Jump to navigation Jump to search
(Undid revision 723878009 by Edokter (talk))
imported>SMcCandlish
m (sorry, not reading closely)
 
(22 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{#ifeq:{{BASEPAGENAME}}|Defn|{{Documentation subpage}}|}}<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
{{Documentation subpage}}
=={{#ifeq:{{BASEPAGENAME}}|Defn|Usage|[[Template:Defn]]}}==
+
==Usage==
{{#ifeq:{{BASEPAGENAME}}|Defn|<!--nothing-->|{{collapse top|heading=Usage|left=y}} }}
 
 
The template {{tlx|defn}} is used in [[Wikipedia:Manual of Style/Glossaries|template-structured glossaries]] to create definitions of terms.
 
The template {{tlx|defn}} is used in [[Wikipedia:Manual of Style/Glossaries|template-structured glossaries]] to create definitions of terms.
 
It is a wrapper for {{tag|dd}}, the ''description list definition'' [[HTML element#Lists|HTML element]]. The template has a mnemonic redirect at {{tlx|dd}}.
 
It is a wrapper for {{tag|dd}}, the ''description list definition'' [[HTML element#Lists|HTML element]]. The template has a mnemonic redirect at {{tlx|dd}}.
Line 7: Line 6:
 
Basic usage:
 
Basic usage:
  
<blockquote>
+
{{gray|1={{tlf|glossary}} }}
{{gray|1={{tnull|glossary}} }}<br />
+
{{gray|1={{tlf|term|1{{=}}<var>term</var>}} }}
{{gray|1={{tnull|term|1{{=}}<var>term</var>}} }}<br />
+
{{bxt|1={{tlf|defn|1{{=}}<var>Definition.</var>}} }}
{{bxt|1={{tnull|defn|1{{=}}<var>Definition.</var>}} }}<br />
+
{{gray|1={{tlf|glossary end}} }}
{{gray|1={{tnull|glossary end}} }}<br />
 
</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={{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={{tlf|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|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={{tlf|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={{tlf|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 might be:
{{quote|{{tnull|defn|defn{{=}}<var>Definition.</var>&nbsp;|no{{=}}<var>#</var>&nbsp;|term{{=}}<var>term_id</var>}} }}
+
{{quote|{{tnull|defn|1{{=}}<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|
 
 
===Images, hatnotes and other content===
 
===Images, hatnotes and other content===
|{{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 {{tlx|more}} can be placed at the ends of but {{em|inside}} the content of {{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.
+
{|
<table><tr>
+
| style="border: 1px solid black; vertical-align: top;" | <syntaxhighlight lang="moin">
<td style="border: 1px solid black; vertical-align: top;">
 
<blockquote><code>
 
{{tnull|glossary}}<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|<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 />
 
In [<nowiki />[snooker]], any of the {{tnull|cuegloss|object ball}}s that are not {{tnull|cuegloss|red ball|reds}}.<br />
 
}<nowiki />}<br />
 
{{tnull|glossary end}}
 
</code></blockquote>
 
</td></tr>
 
<tr>
 
<td style="border: 1px solid black; vertical-align: top;">
 
<blockquote>
 
 
{{glossary}}
 
{{glossary}}
 
{{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''']]
 +
{{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}}.
 +
}}
 +
{{glossary end}}</syntaxhighlight>
 +
|-
 +
| style="border: 1px solid black; vertical-align: top;" | <blockquote>
 +
{{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''']]
 
[[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.}}
Line 53: Line 44:
 
}}
 
}}
 
{{glossary end}}</blockquote>
 
{{glossary end}}</blockquote>
</td></tr></table>
+
|}
 
{{clear}}
 
{{clear}}
  
{{#ifeq:{{BASEPAGENAME}}|Defn|
+
=== Multiple definitions for one term ===
===Multiple definitions for one term===
+
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:
|{{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:
+
{|
 
+
| style="border: 1px solid black; vertical-align: top;" | <syntaxhighlight lang="moin">
<table><tr>
+
{{glossary}}
<td style="border: 1px solid black; vertical-align: top;">
+
{{term|1=blubbermonster}}
<blockquote><code>
+
{{defn|1=Lorem ipsum dolor sit amet. |no=1}}
{{tnull|glossary}}<br />
+
{{defn|1=Consectetur adipisicing elit. |no=2}}
{{tnull|term|1{{=}}blubbermonster}}<br />
+
{{glossary end}}</syntaxhighlight>
{{tnull|defn|1{{=}}Lorem ipsum dolor sit amet.&nbsp;|'''no{{=}}1'''}}<br />
+
|-
{{tnull|defn|1{{=}}Consectetur adipisicing elit.&nbsp;|'''no{{=}}2'''}}<br />
+
| style="border: 1px solid black; vertical-align: top;" | <blockquote>
{{tnull|glossary end}}<br />
 
</code></blockquote>
 
</td></tr>
 
<tr>
 
<td style="border: 1px solid black; vertical-align: top;">
 
<blockquote>
 
 
{{glossary}}
 
{{glossary}}
 
{{term|1=blubbermonster}}
 
{{term|1=blubbermonster}}
Line 81: Line 65:
 
{{glossary end}}
 
{{glossary end}}
 
</blockquote>
 
</blockquote>
</td></tr></table>
+
|}
 +
 
 
{{clear}}
 
{{clear}}
  
Line 89: Line 74:
 
{{quote|{{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, {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:
+
Use of a "standard" hatnote with a numbered definition would require manual numbering or it would look weird. But this method is deprecated anyway. An example of forcing it to kinda work:
  
<blockquote>
+
<syntaxhighlight lang="moin">
{{tnull|term|1{{=}}blackjack |content{{=}}blackjack<nowiki>{{anchor|Blackjack}}</nowiki>&nbsp;}}<br />
+
{{term|1=blackjack|content=blackjack{{anchor|Blackjack}} }}
{{tnull|defn|1{{=}}{{bxt|{{tnull|main|Blackjack}}}}<br />
+
{{defn     |1={{main|Blackjack}}}}
{{bxt|1=1.&amp;nbsp;&amp;nbsp;}}A card game in which players attempt to approach 21 but not exceed it.<br />
+
{{defn|no=1|1=A card game in which players attempt to approach 21 but not exceed it.}}
}}<br />
+
{{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). }}
{{tnull|defn|{{bxt|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).&nbsp;}}
+
</syntaxhighlight>
</blockquote>
 
  
{{#ifeq:{{BASEPAGENAME}}|Defn|
+
It's better to use the {{tlx|ghat}} template, for glossary hatnotes, and put it inside the first (or most applicable) definition. This obviates creating a pseudo-definition to hold the hatnote, as shown above.  {{tnull|Ghat}} (which uses [[Module:Hatnote inline]]) has some CSS adjustments to work better than {{tlx|Hatnote}} and its derivatives, when used inside a definition.
===Making the definition independently linkable===
 
|{{fake heading|Making the definition independently linkable|sub=3}} }}
 
  
 +
=== Making the definition independently linkable ===
 
{{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:
  
<table><tr>
+
{|
<td style="border: 1px solid black; vertical-align: top;">
+
| style="border: 1px solid black; vertical-align: top;" | <syntaxhighlight lang="moin">
<blockquote><code>
 
{{tnull|glossary}}<br />
 
{{tnull|term|1{{=}}blubbermonster}}<br />
 
{{tnull|defn|no{{=}}1&nbsp;|1{{=}}Lorem ipsum dolor sit amet.&nbsp;|'''term{{=}}blubbermonster'''}}<br />
 
{{tnull|defn|no{{=}}2&nbsp;|1{{=}}Consectetur adipisicing elit.&nbsp;|'''term{{=}}blubbermonster'''}}<br />
 
{{tnull|term|1{{=}}snorkelweasel (noun)}}<br />
 
{{tnull|defn|1{{=}}Ut enim ad minim veniam&nbsp;|'''term{{=}}snorkelweasel (noun)'''}}<br />
 
{{tnull|glossary end}}<br />
 
</code></blockquote>
 
</td></tr>
 
<tr>
 
<td style="border: 1px solid black; vertical-align: top;">
 
<blockquote>
 
 
{{glossary}}
 
{{glossary}}
 
{{term|1=blubbermonster}}
 
{{term|1=blubbermonster}}
Line 128: Line 98:
 
{{term|1=snorkelweasel (noun)}}
 
{{term|1=snorkelweasel (noun)}}
 
{{defn|1=Ut enim ad minim veniam |term=snorkelweasel (noun)}}
 
{{defn|1=Ut enim ad minim veniam |term=snorkelweasel (noun)}}
{{glossary end}}
+
{{glossary end}}</syntaxhighlight>
</blockquote>
+
|-
</td></tr>
+
| style="border: 1px solid black; vertical-align: top;" | <blockquote>
<tr>
+
{{glossary}}
<td style="border: 1px solid black; vertical-align: top;">
+
{{term|1=blubbermonster}}
&nbsp;HTML output:
+
{{defn|no=1 |1=Lorem ipsum dolor sit amet. |term=blubbermonster}}
<blockquote><samp><nowiki>
+
{{defn|no=2 |1=Consectetur adipisicing elit. |term=blubbermonster}}
<dl class="glossary"></nowiki><br /><nowiki>
+
{{term|1=snorkelweasel (noun)}}
<dt class="glossary" id="blubbermonster" style="font-size: 110%; margin-top: 0.5em;"><dfn>blubbermonster</dfn></dt></nowiki><br /><nowiki>
+
{{defn|1=Ut enim ad minim veniam |term=snorkelweasel (noun)}}
<dd class="glossary" id="</nowiki>'''blubbermonster-defn1'''<nowiki>">1.&#160;&#160;Lorem ipsum dolor sit amet.</dd></nowiki><br /><nowiki>
+
{{glossary end}}</blockquote>
<dd class="glossary" id="</nowiki>'''blubbermonster-defn2'''<nowiki>">2.&#160;&#160;Consectetur adipisicing elit.</dd></nowiki><br /><nowiki>
+
|-
<dt class="glossary" id="snorkelweasel_.28noun.29" style="font-size: 110%; margin-top: 0.5em;"><dfn>snorkelweasel (noun)</dfn></dt></nowiki><br /><nowiki>
+
| style="border: 1px solid black; vertical-align: top;" | &nbsp;HTML output:
<dd class="glossary" id="</nowiki>'''snorkelweasel_.28noun.29-defn1'''<nowiki>">Ut enim ad minim veniam</dd></nowiki><br /><nowiki>
+
<syntaxhighlight lang="html">
 +
<dl class="glossary">
 +
  <dt class="glossary" id="blubbermonster" style="margin-top: 0.4em;"><dfn class="glossary">blubbermonster</dfn></dt>
 +
  <dd class="glossary" id="blubbermonster-defn1">1.&nbsp;&nbsp;Lorem ipsum dolor sit amet.</dd>
 +
  <dd class="glossary" id="blubbermonster-defn2">2.&nbsp;&nbsp;Consectetur adipisicing elit.</dd>
 +
  <dt class="glossary" id="snorkelweasel_(noun)" style="margin-top: 0.4em;"><dfn class="glossary">snorkelweasel (noun)</dfn></dt>
 +
  <dd class="glossary" id="snorkelweasel_(noun)-defn1">Ut enim ad minim veniam</dd>
 
</dl>
 
</dl>
</nowiki></samp>
+
</syntaxhighlight>
</blockquote></td></tr></table>
+
|}
 +
 
 
{{clear}}
 
{{clear}}
 
Note that some characters in <code>snorkelweasel (noun)</code>" have been converted on the fly by MediaWikia by the time it sends the ID to the browser as <code>snorkelweasel_.28noun.29-defn1</code>. You can still link to it on this page as [[#snorkelweasel (noun)-defn1]] (view page source and see for yourself &ndash; that link has <code>href=#snorkelweasel_.28noun.29-defn1</code>).
 
Note that some characters in <code>snorkelweasel (noun)</code>" have been converted on the fly by MediaWikia by the time it sends the ID to the browser as <code>snorkelweasel_.28noun.29-defn1</code>. You can still link to it on this page as [[#snorkelweasel (noun)-defn1]] (view page source and see for yourself &ndash; that link has <code>href=#snorkelweasel_.28noun.29-defn1</code>).
Line 151: Line 128:
 
To add more than one linkable anchor, use the {{tl|anchor}} template at the beginning of the definition's content:
 
To add more than one linkable anchor, use the {{tl|anchor}} template at the beginning of the definition's content:
  
  {{tnull|defn|no{{=}}2 |1{{=}}{{tlp|anchor|elit|Elit}}Consectetur adipisicing elit. |term{{=}}blubbermonster}}
+
  {{tlf|defn|no{{=}}2 |1{{=}}{{tlp|anchor|elit|Elit}}Consectetur adipisicing elit. |term{{=}}blubbermonster}}
 
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
 
===Languages===
 
|{{fake heading|Languages|sub=3}} }}
 
  
 +
=== Languages ===
 
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:
<pre>
+
<syntaxhighlight lang="moin">
 
{{glossary}}
 
{{glossary}}
 
{{term|1=Titles of La Vie en Rose in various languages&nbsp;|content=Titles of ''[[La Vie en Rose]]'' in various languages}}
 
{{term|1=Titles of La Vie en Rose in various languages&nbsp;|content=Titles of ''[[La Vie en Rose]]'' in various languages}}
Line 165: Line 139:
 
...
 
...
 
{{glossary end}}
 
{{glossary end}}
</pre>
+
</syntaxhighlight>
 
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
 
===Examples===
 
|{{fake heading|Examples|sub=3}} }}
 
  
 +
=== Examples ===
 
This shows both a very simple then a rather complex instance:
 
This shows both a very simple then a rather complex instance:
  
<table><tr>
+
{|
<td style="border: 1px solid black; vertical-align: top;">
+
| style="border: 1px solid black; vertical-align: top;" | <syntaxhighlight lang="moin">
<blockquote><code>
+
{{fake heading|A&ndash;M}}
<nowiki>==A&ndash;M==</nowiki><br /><br />
+
{{glossary}}
{{tnull|glossary}}<br /><br />
+
{{term|1=applesnorkel}}
{{tnull|term|1{{=}}applesnorkel}}<br />
+
{{defn|1=Definition of term 1.}}
{{bxt|{{tnull|defn|1{{=}}Definition of term 1.}}}}<br /><br />
+
{{term|term=arglefarst |content=''{{lang|de|arglefarst}}''{{anchor|argle-farst|argle farst}} }}
{{tnull|term|term{{=}}arglefarst&nbsp;|content{{=}}<nowiki>''{{lang|</nowiki>{{var|xx}}<nowiki>|arglefarst}}''{{anchor|argle-farst|argle farst}}</nowiki>&nbsp;}}<br />
+
{{defn|no=1 |defn=
{{bxt|{{tnull|defn|no{{=}}1&nbsp;|defn{{=}}<br />
+
Beginning of first definition of term 2
Beginning of first definition of term 2<br />
+
{{gbq|1=Block quotation in first definition of term 2.}}
{{tnull|gbq|1{{=}}Block quotation in first definition of term 2.}}<br />
+
Conclusion of first definition of term 2.
Conclusion of first definition of term 2.<br />}}}}<br />
+
}}
{{bxt|{{tnull|defn|no{{=}}2&nbsp;|defn{{=}}Second definition of term 2.}}}}<br /><br />
+
{{defn|no=2 |defn=Second definition of term 2.}}
{{tnull|glossary end}}
+
{{glossary end}}</syntaxhighlight>
</code></blockquote>
+
|-
</td></tr>
+
| style="border: 1px solid black; vertical-align: top;" | <blockquote>
<tr>
 
<td style="border: 1px solid black; vertical-align: top;">
 
<blockquote>
 
 
{{fake heading|A&ndash;M}}
 
{{fake heading|A&ndash;M}}
 
 
{{glossary}}
 
{{glossary}}
 
 
{{term|1=applesnorkel}}
 
{{term|1=applesnorkel}}
 
{{defn|1=Definition of term 1.}}
 
{{defn|1=Definition of term 1.}}
 
+
{{term|term=arglefarst |content=''{{lang|de|arglefarst}}''{{anchor|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 206: Line 171:
 
}}
 
}}
 
{{defn|no=2 |defn=Second definition of term 2.}}
 
{{defn|no=2 |defn=Second definition of term 2.}}
 
 
{{glossary end}}
 
{{glossary end}}
 
</blockquote>
 
</blockquote>
</td></tr></table>
+
|}
  
{{#ifeq:{{BASEPAGENAME}}|Defn|
 
 
===Applying CSS styles to the definition===
 
===Applying CSS styles to the definition===
|{{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 definitions, 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|
 
 
===Other parameters===
 
===Other parameters===
|{{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.
  
 
The {{para|class}} parameter will pass one or more space-separated CSS classes on to {{tag|dd|o}} element, in addition to the automatically included class <code>glossary</code>.  ''There is rarely any reason to do this.''
 
The {{para|class}} parameter will pass one or more space-separated CSS classes on to {{tag|dd|o}} element, in addition to the automatically included class <code>glossary</code>.  ''There is rarely any reason to do this.''
 
{{#ifeq:{{BASEPAGENAME}}|Defn|
 
{{Glossary/doc}}
 
{{Term/doc}}
 
  
 
==See also==
 
==See also==
 
{{glossary templates see also}}
 
{{glossary templates see also}}
  
|{{collapse bottom}} }}<!--end ifeq--><includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
+
<includeonly>{{Sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
<!-- CATEGORIES HERE, THANKS -->
 
[[Category:Glossary templates]]
 
[[Category:Glossary templates]]
 
[[Category:Definition list templates]]
 
[[Category:Definition list templates]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 08:32, 1 December 2020

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 might be:

{{defn|1=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 the content of {{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|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
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, {cross-reference hatnotes, and other block-level markup inside each definition. The definitions can also be independently linked.

Use of a "standard" hatnote with a numbered definition would require manual numbering or it would look weird. But this method is deprecated anyway. An example of forcing it to kinda work:

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

It's better to use the {{ghat}} template, for glossary hatnotes, and put it inside the first (or most applicable) definition. This obviates creating a pseudo-definition to hold the hatnote, as shown above. {{Ghat}} (which uses Module:Hatnote inline) has some CSS adjustments to work better than {{Hatnote}} and its derivatives, when used inside a definition.

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="margin-top: 0.4em;"><dfn class="glossary">blubbermonster</dfn></dt>
  <dd class="glossary" id="blubbermonster-defn1">1.&nbsp;&nbsp;Lorem ipsum dolor sit amet.</dd>
  <dd class="glossary" id="blubbermonster-defn2">2.&nbsp;&nbsp;Consectetur adipisicing elit.</dd>
  <dt class="glossary" id="snorkelweasel_(noun)" style="margin-top: 0.4em;"><dfn class="glossary">snorkelweasel (noun)</dfn></dt>
  <dd class="glossary" id="snorkelweasel_(noun)-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&nbsp;|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:

{{fake heading|A&ndash;M}}
{{glossary}}
{{term|1=applesnorkel}}
{{defn|1=Definition of term 1.}}
{{term|term=arglefarst |content=''{{lang|de|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 definitions, 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.

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