Template:Ref sic

From Guild of Archivists
Template documentation[view] [edit] [history] [purge]

Summary[edit source]

An alternative form of the {{sic}} template that provides a means of describing what the mistake in the text is believed to be, as well as a helpful admonition to editors, reminding them not to attempt to correct the mistake as it was copied verbatim.

Template Data[edit source]

An alternative form of the 'sic' template that provides a means of describing what the mistake in the text is believed to be, as well as a helpful admonition to editors, reminding them not to attempt to correct the mistake as it was copied verbatim.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Source Text1 source

The word or phrase found in the source text, verbatim, including whatever mistake might be present.

Stringrequired
Correction2 correction

The corrected form of the word or phrase that has been singled out as being incorrect.

Stringsuggested
Descriptiondescription

An optional decription that replaces the terminal "contains the same error." part of the hover text. Such a description is intended to provide more detail or direction to the reader.

Stringoptional
No Sicnosic

If present, the trailing '[sic]' is omitted from the output. The value is unimportant, as it is merely the presence of this parameter that affects the output.

Unknownoptional

Examples[edit source]

Code Result Explanation
{{ref sic|discreet|discrete}} discreet [sic] If both the incorrect text and the correct text are provided as parameters, the hover text indicating that the text should not be edited will include the correct spelling of the word.
{{ref sic|fire-marbles|firemarbles|description=contains the same stylistic quirk.}} fire-marbles [sic] Providing the description parameter changes the tail end of the hover text to allow the problem to be described more in depth. The section of the text that is replaced is "contains the same error.".
{{ref sic|discreet}} discreet [sic] (Avoid if possible) If only the first parameter is provided, a default hover text is used. This should be avoided in favour of specifying a correction so that readers can understand what the mistake is.