Tungstenchan: Text replacement - "BattleTechWiki" to "BattleIntelligence"

2025-05-01T05:14:53Z

Text replacement - "BattleTechWiki" to "BattleIntelligence"

← Older revision		Revision as of 01:14, 1 May 2025
Line 1:		Line 1:
	{{Documentation subpage}}		{{Documentation subpage}}
	==Usage==		==Usage==
	The template {{tlx\|term}} is used in [[~~BattleTechWiki~~:Glossaries\|template-structured glossaries]] to create terms to be defined, that are properly structured, have [[w:Separation of presentation and content\|semantic value]], and can be linked to as if independent sections. It is a wrapper for {{tag\|dt}}, the ''description list term'' [[w:HTML element#Lists\|HTML element]]. The template has a mnemonic redirect at {{tlx\|dt}}.		The template {{tlx\|term}} is used in [[BattleIntelligence:Glossaries\|template-structured glossaries]] to create terms to be defined, that are properly structured, have [[w:Separation of presentation and content\|semantic value]], and can be linked to as if independent sections. It is a wrapper for {{tag\|dt}}, the ''description list term'' [[w:HTML element#Lists\|HTML element]]. The template has a mnemonic redirect at {{tlx\|dt}}.

	Basic usage:		Basic usage:

imported>Deadfire: Template Doc Creation

2023-05-19T22:26:50Z

Template Doc Creation

New page

{{Documentation subpage}}
==Usage==
The template {{tlx|term}} is used in [[BattleTechWiki:Glossaries|template-structured glossaries]] to create terms to be defined, that are properly structured, have [[w:Separation of presentation and content|semantic value]], and can be linked to as if independent sections. It is a wrapper for {{tag|dt}}, the ''description list term'' [[w:HTML element#Lists|HTML element]]. The template has a mnemonic redirect at {{tlx|dt}}.

Basic usage:

{{pre|1=
{{gray|1={{tl|glossary}} }}
{{bxt|1={{tlf|term|1{{=}}<var>term</var>}} }}
{{gray|1={{tl|defn|1{{=}}<var>Definition.</var>}} }}
{{gray|1={{tl|glossary end}} }}
}}

Inline templates, reference citations, wikimarkup styles, etc., can be applied to the term in the second parameter ({{para|content}} or {{para|2}}) as long as it remains without markup in the first parameter ({{para|term}} or {{para|1}}). Technically, the explicit parameter names are optional if the term or content does not contain the "=" character, but as any editors can add material, including templates or URLs with this character in them, {{em|it is always safest to explicitly name or number the parameters}}.
* This will work: {{bxt|1={{tnull|term|term{{=}}E{{=}}MC²}} }}
* This will work: {{bxt|1={{tnull|term|1{{=}}E{{=}}MC²}} }}
* This will {{strongbad|fail}}: {{!bxt|1={{tnull|term|E{{=}}MC²}} }}

More complex usage is typically:

{{block indent|1={{tnull|term|term{{=}}<var>term with no markup</var> |content{{=}}<var>term with markup</var>}} }}
or
{{block indent|1={{tnull|term|1{{=}}<var>term with no markup</var> |2{{=}}<var>term with markup</var>}} }}
or
{{block indent|1={{tnull|term|1{{=}}<var>term with no markup</var> |content{{=}}<var>term with markup</var>}} }}

==Wiki-styling and linking of the term==

If the second or {{para|content}} parameter is styled with wikimarkup, linked, or otherwise altered inside the template, the term must also be retained in unstyled form as the first or {{para|term}} parameter. Failing to do so will cause the template to malfunction, since it must have a "clean" term name to use as the <code>id</code> of the element, for linking purposes, among other reasons. The order intentionally mirrors that of [[w:WP:PIPE|piped wikilinking]] (<code><nowiki>[[</nowiki><var>title</var>|<var>styled</var><nowiki>]]</nowiki></code>).
*{{xt|Correct}}: {{tlc|term|1{{=}}esprit de corps |2{{=}}{{'}}{{'}}esprit de corps{{'}}{{'}}}}
*{{!xt|Wrong}}: {{tlc|term|1{{=}}{{'}}{{'}}esprit de corps{{'}}{{'}}}}
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):
*{{!xt|Wrong}}: <code>{{'}}{{'}}</code>{{tnull|term|1{{=}}esprit de corps}}<code>{{'}}{{'}}</code>

For the same reasons that links to other pages are discouraged in headings, {{strong|links are discouraged in glossary terms}}:

===Parameter name or number===
Again, as with the first parameter (the term) itself, if the "<code>=</code>" character (equals sign) is used in the content of this second parameter, the syntax {{em|requires}} that the parameter be explicitly specified (and because many URLs, e.g. in reference citations, can contain this character, it is always safest to number or name the parameters):

numbered:
{{block indent|1={{tnull|term|{{bxt|1{{=}}}}E=MC²|{{bxt|2{{=}}}}E=MC<nowiki>2</nowiki>}} }}
or named:
{{block indent|1={{tnull|term|{{bxt|term{{=}}}}E=MC²|{{bxt|content{{=}}}}E=MC<nowiki>2</nowiki>}} }}

==Linking to the term==
{{tlx|term}} automatically creates a link anchor point (an HTML <code>id</code>) from an {{em|all-lowercase}} conversion of the original term ({{para|term}} or {{para|1}}) or {{para|id}}. About 90% of the links to glossary entries are going to be mid-sentence, and thus will start with a lower-case letter, except for proper names.

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 <code>id</code>), then the upper-case one must be given a unique {{para|id}} value, {{em|and}} prevented from conflicting with the lower-case one's HTML <code>id</code>. This can be done by changing its {{para|id}} to a variant (e.g. with a number), then manually injecting a second HTML <samp>id</samp> (with upper-case) by using the {{para|content|=}} parameter and an anchor template:

<pre>
{{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 ...
</pre>

You can then link to them as <code>#foo</code> and <code>#Foo</code>, respectively. (Technically the second can also be addressed as <code>#foo_2</code>, which will have been lower-cased by the template code, but this would not be very intuitive and is just an artifact of the work-around.)

The template {{tlx|anchor}} can also be used in the {{para|content}} a.k.a. {{para|2}} parameter, e.g. to provide the plural of the term (the most common usage), an alternative spelling, the old name of an entry that was linked to but has since changed, or a shortcut link anchor name.

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 {{tnull|anchor}} template when using {{tnull|term}}:
{{block indent|1={{tnull|term|1{{=}}shortstop |content{{=}}shortstop{{bxt|1={{tnull|anchor|shortstops|short-stop|short stop}}}}}} }}

<div style="font-size: 90%;">
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):

{{block indent|1=<code><nowiki>;</nowiki>shortstop</code>{{tnull|anchor|{{bxt|<code>shortstop</code>}}|shortstops|short-stop|short stop}} }}
or use {{tlx|vanchor}}
{{block indent|1=<code><nowiki>;</nowiki></code>{{tlx|vanchor|{{bxt|<code>shortstop</code>}}|shortstops|short-stop|short stop}} }}

(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.)
</div>

==Multiple terms sharing a definition==
Two or more {{tnull|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 {{para|multi|y}} is used on second and subsequent terms to visually group the terms close together so it is clear that they share a definition:

Example:

<nowiki>{{term|1=aspirin}}</nowiki>
<nowiki>{{defn|1=A mild analgesic of the non-steroidal anti-inflammatory drug (NSAID) family...}}</nowiki>
{{bxt|<nowiki>{{term|1=heroin}}</nowiki>}}
{{bxt|<nowiki>{{term|1=diacetylmorphine |multi=y}}</nowiki>}}
{{bxt|<nowiki>{{term|1=diamorpine |multi=y}}</nowiki>}}
<nowiki>{{defn|1=A synthetic narcotic drug of the opiate family...}}</nowiki>
<nowiki>{{term|1=ranitidine}}</nowiki>
<nowiki>{{defn|1=An antacid of the proton pump inhibitor family...}}</nowiki>

{| class="wikitable"
|-
!Result:
!versus no {{para|multi|y}}
|-
|style=vertical-align:top;|{{glossary}}
{{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...}}
{{glossary end}}
|style=vertical-align:top;|{{glossary}}
{{term|1=aspirin}}
{{defn|1=A mild analgesic of the non-steroidal anti-inflammatory drug (NSAID) family...}}
{{term|1=heroin}}
{{term|1=diacetylmorphine}}
{{term|1=diamorpine}}
{{defn|1=A synthetic narcotic drug of the opiate family...}}
{{term|1=ranitidine}}
{{defn|1=An antacid of the proton pump inhibitor family...}}
{{glossary end}}
|}

==Applying CSS styles to the term==
The {{para|style}} parameter will pass CSS styling on to the {{tag|dt|o}} element, e.g. {{para|style|font-family:serif;}}. I.e., this styles the term itself, not the definitions of it, other term entries, or the glossary as a whole. This feature is uncommonly but sometimes importantly needed in articles (usually for formatting the appearance of an specific entry for some reason, e.g. certain mathematical constants and the like that are always given in a serif font). It can also be useful outside of articles, for things like matching custom projectpage or userpage style.

==Other parameters==
{{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.}}The {{para|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. {{em|1=By default, the {{para|term}} a.k.a. {{para|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 {{tlx|anchor}} template is used to add more link targets to an entry {{crossref|(see {{section link||Linking to the term}} for details)}}. Note that providing an empty <code>id</code> (such as with HTML {{tag|!--|content=comments}}) will emit an empty <code>id</code> parameter to the tag, which is invalid HTML.

The {{para|noid}} parameter, if given as {{kbd|true}} / {{kbd|y}} / {{kbd|yes}}, will suppress generation of the <code>id</code> field entirely. This is usually undesirable, except in the case where the anchor {{para|text}} of the generated {{para|term}} is to another {{tl2|Term}} defined in the article.

The {{para|class}} parameter will pass one or more space-separated CSS classes on to the {{tag|dt|o}} element, in addition to the automatically included class <code>glossary</code>. {{em|There is rarely any reason to do this, especially in mainspace.}}

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

{|
| style="border: 1px solid black; vertical-align: top;" |
<nowiki>==A–M==</nowiki> 
<nowiki>{{glossary}}</nowiki> 
{{bxt|<nowiki>{{term|1=applesnorkel}}</nowiki>}} 
<nowiki>{{defn|1=Definition of term 1.}}</nowiki> 
{{bxt|<nowiki>{{term|term=arglefarst |content={{anchor|argle-farst|argle farst}} }} }}</nowiki>}} 
<nowiki>{{defn|no=1 |defn=</nowiki> 
Beginning of first definition of term 2 
<nowiki>{{</nowiki>[[Template:Gbq|gbq]]<nowiki>|1=Block quotation in first definition of term 2.}}</nowiki> 
Conclusion of first definition of term 2. 
<nowiki>}}</nowiki> 
<nowiki>{{defn|no=2 |defn=Second definition of term 2.}}</nowiki> 
<nowiki>{{glossary end}}</nowiki>
|-
| style="border: 1px solid black; vertical-align: top;" |
{{block indent|1=
{{fake heading|A–M}}
{{glossary}}

{{term|1=applesnorkel}}
{{defn|1=Definition of term 1.}}

{{term|term=arglefarst |content={{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}}
}}
|}

==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}}.}} 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 end of, but {{em|inside}}, a {{tnull|defn}}. When used with a multi-definition term, the definition in which the {{tnull|ghat}} appears must be manually numbered (usually <code>1&nbsp; ...</code>, as shown in the example below).

{|
| style="border: 1px solid black; vertical-align: top;" |
<nowiki>{{term|1=colour ball |content=colour ball {{anchor|coloured ball|coloured balls|colour|colours|color ball}} }}</nowiki> 
<nowiki>{{defn|1=</nowiki> 
{{bxt|<nowiki>[[File:Example.png|thumb|right|150px|A complete set of snooker balls, with six '''colour balls''']]</nowiki>}} 
{{bxt|<nowiki>{{ghat|Also '''coloured ball(s)''', '''colour(s)'''; American spelling '''color''' sometimes also used.}}</nowiki>}} 
{{bxt|1.&nbsp; }}<nowiki>In snooker, any of the object ball or object balls that are not red ball or reds}}.</nowiki> 
<nowiki>}}</nowiki> 
<nowiki>{{defn|no=2 |1=</nowiki> 
<nowiki>In Blackball (pool), a generic, collective term for the red and yellow group or groups of object balls.</nowiki> 
<nowiki>}}</nowiki> 
|-
| style="border: 1px solid black; vertical-align: top;" |
{{block indent|1=
{{glossary}}
{{term|1=colour ball |content=colour ball {{anchor|coloured ball|coloured balls|colour|colours|color ball}} }}
{{defn|1= {{ghat|Also '''coloured ball(s)''', '''colour(s)'''; American spelling '''color''' sometimes also used.}} [[File:Example.png|thumb|right|150px|A complete set of snooker balls, with six '''colour balls''']]
1.  In snooker, any of the object ball or object balls that are not red ball or reds.
}}
{{defn|no=2 |1=
In Blackball (pool), a generic, collective term for the red and yellow group or groups of object balls.
}}
{{glossary end}} }}
|}
{{clear}}

==Technical details==
What this template does on the technical level is wrap the {{var|term}} in the {{tag|dfn}} [[w:HTML element|HTML element]] to semantically mark the term as the {{em|defining instance}} on the page of the defined term, and puts this marked-up content inside a {{tag|dt}} ''term'' element of a {{tag|dl}} description list (a.k.a. definition list, association list; the list is generated by the {{tlx|glossary}} and {{tlx|glossary end}} templates), and gives CSS <code>class="glossary"</code> to the {{tag|dt|o}} element. That class isn't doing anything yet, but it could later, like a slight font size increase.

Do not specify a null ID (such as <code><nowiki>id=</nowiki></code>). Empty or null {{mono|id}} HTML parameters produce invalid HTML5 output.

=See also=
{{glossary templates see also}}

<includeonly>{{Sandbox other||

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

Template:Term/doc - Revision history

Tungstenchan: Text replacement - "BattleTechWiki" to "BattleIntelligence"

imported>Deadfire: Template Doc Creation