Template:Expand acronym/doc

From CAPipedia
Revision as of 03:24, 16 February 2021 by en>DesertPipeline (Minor copyedit: Wording, grammar, punctuation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

[[Category:Template documentation pages{{#translation:}}]]

This inline tag is for placement after an acronym, abbreviation or initialism that is not written in full at first occurrence. The Manual of Style requires all acronyms or abbreviations written in full, followed by the abbreviated form in round brackets. An exception is made for abbreviations that are as well-known or better known than their full name, such as "PhD" and "DNA", for which is it unnecessary to supply the full name on first occurrence.

Usage

This inline template is placed after any acronym, abbreviation or initialism that should be expanded. For example:

A set of rules apply to the various locations of the college, such as the Dining Hall and JCR{{Expand acronym}} to ensure standards of dress and manners are upheld.

results in:

A set of rules apply to the various locations of the college, such as the Dining Hall and JCR[expand acronym] to ensure standards of dress and manners are upheld.

Parameters

Parameter Explanation
|1= The text displayed in the tag and the hover text can be changed with this parameter. If null or invalid, "expand acronym" is displayed. if 1= is set to ab, "expand abbreviation" is displayed. If set to in, "expand initialism" is displayed. The hover text is also changed accordingly. This parameter does not need to be named. {{expand acronym|in|date=November 2024}} will function in the same way as {{expand acronym|1=in|date=November 2024}}
|date= This template allows an optional date parameter that records when the tag was added. One can specify the date manually; for example, to date the tag in the current month, enter {{Expand acronym|date=November 2024}}. If no date is added manually, a bot will automatically fill in the gap.

Categorization

None at present.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Expand acronym in articles based on its TemplateData.

TemplateData for Expand acronym

<templatedata> { "params": { "1": { "description": "Change text. in = initialism | ab = abbreviation | (null or invalid value) = acronym", "autovalue": "", "type": "string", "label": "Tag and hover text type" }, "date": { "label": "Month and year", "type": "string", "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}", "required": true, "description": "The month and year this tag was added." } }, "format": "inline", "description": "This inline template is placed after any acronym, abbreviation or initialism that needs to be expanded." } </templatedata>

Redirects

See also