Template:Abbr/doc: Difference between revisions
(Move description to the top of the page, to enable wiki formatting. Rewrite the description to make it clearer. Move template data down into separate section.) |
m (Mark 'shortform' parameter as required.) |
||
Line 22: | Line 22: | ||
"description": "The abbreviation that will be included directly into the page text.", | "description": "The abbreviation that will be included directly into the page text.", | ||
"example": "DRC", | "example": "DRC", | ||
"type": "string" | "type": "string", | ||
"required": true | |||
}, | }, | ||
"2": { | "2": { |
Latest revision as of 07:10, 30 November 2024
A template for simplifying the marking of abbreviations and providing their unabbreviated forms as hover text.
Note: Despite behaving similarly to the {{hover text}}
template, the order of the parameters differs due to the two templates having different intended uses. The {{hover text}}
template is intended to be used wherever hover text might be stylistically desired, whereas the {{abbr}}
template is specifically for use with abbreviations.
Examples:
{{abbr|n.|noun}}
→ n.{{abbr|v.|verb}}
→ v.{{abbr|adj.|adjective}}
→ adj.{{abbr|adc.|adverb}}
→ adc.{{abbr|DRC|D'ni Restoration Council}}
→ DRC
Template Data[edit source]
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Abbreviation | 1 shortform | The abbreviation that will be included directly into the page text.
| String | required |
Full Text | 2 longform | The full text of which the abbreviation is a shortened form. The text that shall appear when the abbreviation in the page text is hovered over.
| String | required |