Template:Defn/doc - Revision history

RogueScholar: Fix redlink

2022-09-11T02:50:24Z

Fix redlink

← Older revision		Revision as of 02:50, 11 September 2022
Line 22:		Line 22:

	=== Images, hatnotes and other content ===		=== Images, hatnotes and other content ===
	Images, hatnotes and other "add-in" content intended to immediately follow the {{Tlx\|Term}} <em>must be used at the top of (inside) the first {{Tlx\|Defn}} of the {{Tlx\|Term}}.</em> They ~~<strong>~~cannot~~</strong>~~ be placed between the {{Tlx\|Term}} and {{Tlx\|Defn}} or it will break the glossary markup. Images can, of course, be placed elsewhere within the {{Tlx\|Defn}}, and bottom-notes like {{Tlx\|~~More~~}} can be placed at the ends of, but <em>inside</em> the content of {{Tlx\|Defn}}s.		Images, hatnotes and other "add-in" content intended to immediately follow the {{Tlx\|Term}} <em>must be used at the top of (inside) the first {{Tlx\|Defn}} of the {{Tlx\|Term}}.</em> They '''cannot''' be placed between the {{Tlx\|Term}} and {{Tlx\|Defn}} or it will break the glossary markup. Images can, of course, be placed elsewhere within the {{Tlx\|Defn}}, and bottom-notes like {{Tlx\|See also}} can be placed at the ends of, but <em>inside</em> the content of {{Tlx\|Defn}}s.

	{\| style="border: 2px groove darkslategray; border-collapse: collapse;"		{\| style="border: 2px groove darkslategray; border-collapse: collapse;"

RogueScholar: Correct image transclusion from Commons

2022-08-27T18:35:32Z

Correct image transclusion from Commons

Show changes

RogueScholar: Add TemplateData

2021-11-02T13:08:36Z

Add TemplateData

@@ Line 165: / Line 165: @@
 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</em> 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.''<includeonly>
+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.''
 <!-- CATEGORIES HERE, THANKS -->
-[[Category:Glossary templates]]
+[[Category:Definition list templates]]
-[[Category:Definition list templates]]</includeonly>
+[[Category:Glossary templates]]</includeonly>

RogueScholar: Remove unneeded Sandbox other template

2021-09-10T03:00:43Z

Remove unneeded Sandbox other template

← Older revision		Revision as of 03:00, 10 September 2021
Line 165:		Line 165:
	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</em> 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</em> 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.''<includeonly>


	~~<includeonly>{{Sandbox other\|\|~~
	<!-- CATEGORIES HERE, THANKS -->		<!-- CATEGORIES HERE, THANKS -->
	[[Category:Glossary templates]]		[[Category:Glossary templates]]
	[[Category:Definition list templates]]		[[Category:Definition list templates]]</includeonly>
	}}</includeonly>

RogueScholar: Import documentation for Defn template from English Wikipedia, with significant rewrites to adapt to the Kodi Wiki Manual of Style

2021-09-10T02:58:30Z

Import documentation for Defn template from English Wikipedia, with significant rewrites to adapt to the Kodi Wiki Manual of Style

New page

{{Documentation subpage}}

== Usage ==
The template {{Tlx|Defn}} is used in template-structured glossaries and other lists which express correlated properties in pairs to show how something is defined. It is a wrapper for {{Tag|dd}}, the ''description list definition'' HTML element.

Pro forma usage is thus:

{{Tnull|Glossary}}
{{Tnull|Term|1{{=}}<var>term</var>}}
<span class="example example-bold" style="font-weight: bold; color: #006400;">{{Tnull|Defn|1{{=}}<var>Definition.</var>}}</span>
{{Tnull|Glossary end}}

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 unnamed or numeric parameters.
* This will work: <span class="example example-bold" style="font-weight: bold; color: #006400;">{{Tnull|Defn|1{{=}}The concept that the mass of a body is a measure of its energy content, expressed by the formula E{{=}}MC²}}</span>
* This will work: <span class="example example-bold" style="font-weight: bold; color: #006400;">{{Tnull|Defn|defn{{=}}The concept that the mass of a body is a measure of its energy content, expressed by the formula E{{=}}MC²}}</span>
* This will <strong style="color: red;">fail</strong>: <span class="example deprecated-content example-bad example-bold" style="font-weight: bold; color: #8B0000;">{{Tnull|Defn|The concept that the mass of a body is a measure of its energy content, expressed by the formula E{{=}}MC²}}</span>

More complex usage might be:
<blockquote>{{Tnull|Defn|1{{=}}<var>Definition.</var> |num{{=}}<var>#</var> |term{{=}}<var>term_id</var>}}</blockquote>

where {{Para|num|<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 {{Tnull|Term}} template to which this definition pertains.

=== Images, hatnotes and other content ===
Images, 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}}.</em> They <strong>cannot</strong> 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 {{Tnull|More}} can be placed at the ends of, but <em>inside</em> the content of {{Tnull|Defn}}s.

{| style="border: 2px groove darkslategray; border-collapse: collapse;"
| style="border: 1px solid black; padding: 1.5em; vertical-align: top;" | <syntaxhighlight lang="moin">
{{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''']]
<p class="glossary-hatnote"><span>Also '''coloured ball(s)''', '''colour(s)'''; American spelling '''color''' sometimes also used.</span></p>
In snooker, any of the object balls that are not reds.
}}
{{Glossary end}}</syntaxhighlight>
|-
| style="border: 1px solid black; padding: 1.5em; 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''']]
<p class="glossary-hatnote"><span>Also '''coloured ball(s)''', '''colour(s)'''; American spelling '''color''' sometimes also used.</span></p>
In snooker, any of the object balls that are not reds.
}}
{{Glossary end}}</blockquote>
|}
{{Clear}}

=== 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</strong>nd or later definition". You can also call it {{Para|num}}, if you prefer.

Example:

{|
| style="border: 1px solid black; vertical-align: top;" | <syntaxhighlight lang="moin">
{{Glossary}}
{{Term|1=blubbermonster}}
{{Defn|1=Lorem ipsum dolor sit amet. |num=1}}
{{Defn|1=Consectetur adipisicing elit. |num=2}}
{{Glossary end}}</syntaxhighlight>
|-
| style="border: 1px solid black; vertical-align: top;" | <blockquote>
{{Glossary}}
{{Term|1=blubbermonster}}
{{Defn|1=Lorem ipsum dolor sit amet. |num=1}}
{{Defn|1=Consectetur adipisicing elit. |num=2}}
{{Glossary end}}
</blockquote>
|}

{{Clear}}

Because of the uneven length of definitions, it is usually more convenient to put the {{Para|2|}} before the {{Para|1}} description:
<blockquote>{{Tnull|Defn |2{{=}}1 |1{{=}}Lorem ipsum dolor sit amet.}}</blockquote>
or
<blockquote>{{Tnull|Defn |num{{=}}1 |1{{=}}Lorem ipsum dolor sit amet.}}</blockquote>

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.

=== Making the definition independently linkable ===
<div class="floatright" style="background-color: #f9f9f9; border: 1px solid #aaa; box-sizing: border-box; margin: 0.5em 0 0.8em 1.4em; padding: 10px; font-size: 88%; max-width: 100%; width: 30%;"><div style="background-color: #f9f9f9; text-align: center; font-size: larger; font-weight: bold;">HTML5 update:</div>
<blockquote style="margin: 0; padding: 0;">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. The MediaWiki engine is smart enough to auto-escape any problematic characters, on the fly.</blockquote></div>

To enable a link directly to a specific definition, name the definition with its {{Tnull|Term}} (or it must be the {{Para|id|<var>foo</var>}} 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</var>-defn<var>#</var></code>, where the <var>#</var> is the number of the definition ''(see [[#Multiple definitions for one term]], above)'', defaulting to "1".

Example:
{|
| style="border: 1px solid black; vertical-align: top;" | <syntaxhighlight lang="moin">
{{Glossary}}
{{Term|1=blubbermonster}}
{{Defn|num=1 |1=Lorem ipsum dolor sit amet. |term=blubbermonster}}
{{Defn|num=2 |1=Consectetur adipisicing elit. |term=blubbermonster}}
{{Term|1=snorkelweasel (noun)}}
{{Defn|1=Ut enim ad minim veniam |term=snorkelweasel (noun)}}
{{Glossary end}}</syntaxhighlight>
|-
| style="border: 1px solid black; vertical-align: top;" | <blockquote>
{{Glossary}}
{{Term|1=blubbermonster}}
{{Defn|num=1 |1=Lorem ipsum dolor sit amet. |term=blubbermonster}}
{{defn|num=2 |1=Consectetur adipisicing elit. |term=blubbermonster}}
{{Term|1=snorkelweasel (noun)}}
{{Defn|1=Ut enim ad minim veniam |term=snorkelweasel (noun)}}
{{Glossary end}}</blockquote>
|-
| style="border: 1px solid black; vertical-align: top;" |  HTML output:
<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.  Lorem ipsum dolor sit amet.</dd>
<dd class="glossary" id="blubbermonster-defn2">2.  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>
</syntaxhighlight>
|}

{{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 – that link has <code>href=#snorkelweasel_.28noun.29-defn1</code>).

The IDs <samp style="padding-left: 0.4em; padding-right: 0.4em; color: #666666;">blubbermonster-defn1</samp>, <samp style="padding-left: 0.4em; padding-right: 0.4em; color: #666666;">blubbermonster-defn2</samp>,  and <samp style="padding-left: 0.4em; padding-right: 0.4em; color: #666666;">snorkelweasel_(noun)-defn1</samp> are all individually linkable, e.g. as <code><nowiki>[[Glossary of weird terms#blubbermonster-defn1]]</nowiki></code>. This is especially useful for cross-references within the glossary, e.g. <code><nowiki>See also [[#blubbermonster-defn2|"blubbermonster", sense 2]].</nowiki></code>

To add more than one linkable anchor, use the {{Tl|Anchor}} template at the beginning of the definition's content:

{{Tnull|Defn|num{{=}}2 |1{{=}}{{Tnull|Anchor|elit|Elit}}Consectetur adipisicing elit. |term{{=}}blubbermonster}}

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

{|
| style="border: 1px solid black; vertical-align: top;" | <syntaxhighlight lang="moin">
<div style="color: #000000; background: none; overflow: hidden; page-break-after: avoid; font-size: 1.5em; font-family: Georgia,Times,serif; margin-top: 1em; margin-bottom: 0.25em; line-height: 1.3; padding: 0; border-bottom: 1px solid #AAAAAA;">A–M</div>
{{Glossary}}
{{Term|1=applesnorkel}}
{{Defn|1=Definition of term 1.}}
{{Term|term=arglefarst |content=''arglefarst''{{Anchor|argle-farst|argle farst}} }}
{{Defn|num=1 |defn=
Beginning of first definition of term 2
<blockquote style="margin-top: 0; margin-bottom: -0.5em;">Block quotation in first definition of term 2.</blockquote>
Conclusion of first definition of term 2.
}}
{{Defn|num=2 |defn=Second definition of term 2.}}
{{Glossary end}}</syntaxhighlight>
|-
| style="border: 1px solid black; vertical-align: top;" | <blockquote>
<div style="color: #000000; background: none; overflow: hidden; page-break-after: avoid; font-size: 1.5em; font-family: Georgia,Times,serif; margin-top: 1em; margin-bottom: 0.25em; line-height: 1.3; padding: 0; border-bottom: 1px solid #AAAAAA;">A–M</div>
{{Glossary}}
{{Term|1=applesnorkel}}
{{Defn|1=Definition of term 1.}}
{{Term|term=arglefarst |content=''arglefarst''{{Anchor|argle-farst|argle farst}} }}
{{Defn|num=1 |defn=
Beginning of first definition of term 2
<blockquote style="margin-top: 0; margin-bottom: -0.5em;">Block quotation in first definition of term 2.</blockquote>
Conclusion of first definition of term 2.
}}
{{Defn|num=2 |defn=Second definition of term 2.}}
{{Glossary end}}
</blockquote>
|}

=== Applying CSS styles to the definition ===
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.

=== Other parameters ===
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</em> 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.''

<includeonly>{{Sandbox other||

[[Category:Glossary templates]]
[[Category:Definition list templates]]
}}</includeonly>