Template:Dfn/doc: Difference between revisions
| [checked revision] | [checked revision] |
Content deleted Content added
Caleb Cooper (talk | contribs) Created page with "{{Documentation subpage}} {{Commons Import}} <!-- Categories and interwikis go at the bottom of this page. --> ==Usage== This template applies the HTML element#Phrase elem..." |
Caleb Cooper (talk | contribs) m Text replacement - "[[WP:" to "[[Wikipedia:WP:" |
||
Line 9:
Without the second parameter, it does not do anything user-facing, and is just a form of meta-data that can be detected and acted upon by internal and external software (statistics-gathering bots, rich Web 2.0 applications, etc.), and can provide valuable contextual information to editors.
It is used as a meta-template by some other templates. When used by itself, its most common purpose would be around a term '''boldfaced''' in an article and immediately defined there such as a key piece of terminology introduced after the lead section. [[Wikipedia:WP:NOT#DICT|Wikipedia is not a dictionary]], so this template should not be used to draw metadata attention to everyday words, and is best suited in spots where there is a short definition or clarification of jargon that is important in the context.
(Tech detail: By using an internal {{tag|span}} with its own independent <code>title</code> attribute for tool tip fun, it sets this up in a way that does not violate the HTML 5 specification on the handing of the <code>title</code> attribute of {{tag|dfn|o}}, which is the exact term defined, not its definition.)
Line 16:
This markup indicates that the text is the ''defining instance'' of that term (word, phrase, name, etc.) on the page in which it appears. Thus it should be used only once per term per page.
[[Wikipedia:WP:NOT#DICT|Wikipedia is not a dictionary]], so this template should not be used to provide definitions for everyday words at all, and is best suited for short definition or clarification of jargon that is important in the context but unlikely to be fully understood by all of our general readership. The template can be adapted to most directly editable cases in which the <code><dfn></code> element would be useful.
Because the <var>definition</var> parameter's content is [[Wikipedia:WP:ACCESSIBILITY|not readily accessible]] to users of most if not all [[screen reader]] software, text-only browsers, mobile phone browsers, etc., the second parameter should never be used to provide information vital to understanding the article subject, only convenient or augmenting for those who can access it; vital information belongs in the main article prose.
This template should not be used for marking up [[MOS:GLOSSARIES|glossary]] entries or links to them; see {{tl|term}} and {{tl|glossary link}} instead, respectively. Likewise, this template should not be used to mark up the bold-faced article subject in the lead; [it is anticipated that] another template, [name forthcoming, probably Template:Subject], is [to be created to be] used for this purpose, including the needed bold-facing and [perhaps] other markup and metadata features.
| |||