Editing Template:Sic/doc

<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE. -->
{{For |more information on the notation itself|Sic}}
{{For | information on when to use templates related to this one instead |Template:Not a typo}}{{Documentation subpage}}
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}}
{{COinS safe|n}}

You can use this template to easily insert a "[sic]" notation. This notation is placed after a point in a quotation that, in ''both'' the original text and its quotation in an article, contains either an actual textual error or text that ''appears'' to be an error—the problematic text must have been faithfully reproduced as it appears in the original source for using ''sic'' to be correct. This usage clarifies the source of text that might otherwise be taken as an [[Transcription error|error of transcription]].

However, it isn't always the best idea to recreate a quote perfectly. Note that [[MOS:SIC]] says that "'''insignificant spelling and typographic errors should simply be silently corrected.'''"

*By default, this template links to the article ''[[Sic]]'' for the benefit of readers, but this default is disabled if the {{para|nolink|y}} parameter is added. When the template is used within the displayed anchor text (right-hand visible portion) of an internal link (aka a wikilink) or external link, this parameter is essential to prevent incorrect formatting, as the link will be truncated otherwise. Linking to the ''[[Sic]]'' article may be undesirable in certain other cases, for example when the template is used many times close together.
*Additional unnamed parameters can be used to obfuscate spelling errors in quoted material in the wiki-text of a page, to help prevent automated or semi-automated correction by bot or human editors, which (although done in good faith) would be undesirable. In these cases, split the intentionally misspelled word or other character string into two parts and use them as the first two parameters of the template, and ''replace'' the original with the template: {{nowrap|<code><nowiki>He said "{{sic|Irrega|rdless}} …"</nowiki></code>}} will display as:
::He said "{{sic|Irrega|rdless}} …"
*The template can be used with a {{para||?}} question mark parameter to mark situations where whether an apparent error is copied from the source cannot readily be determined. If this feature is used in conjunction with the obfuscation feature above, {{para||?}} '''must''' come first: <code><nowiki>He said "{{sic|?|Irrega|rdless}} …"</nowiki></code> Examples of use cases:
**The quoted source might not be available online, or not without a paid subscription, etc.
**A quoted passage contains a spelling error but is ambiguous as to whether the statement was originally printed this way (in which case [''sic''] may be appropriate), or spoken aloud (in which case the typo should be corrected).

#<code>… his April 1992 interview with the Dolly Llama <nowiki>{{sic}}</nowiki> …</code>
#:yields:
#::… his April 1992 interview with the Dolly Llama {{sic}} …
#<code><nowiki>… spokesperson stated that "rescue efforts have been suspnded {{sic|?}} until further notice" …</nowiki></code>
#:yields:
#::… spokesperson stated that "rescue efforts have been suspnded {{sic|?}} until further notice" …
#:This is used because the context does not make it clear whether the spelling error was made by the spokesperson (in a written statement), or by a reporter (listening to the spokesperson speak).

==Template data==
{{TemplateDataHeader}}

<templatedata>
{
	"description": "This template simplifies insertion of the \"[sic]\" notation, which is used where a textual error, or unexpected but intended text that may appear to be an error, has been faithfully reproduced from the original source. Note that MOS:QUOTE says: \"trivial spelling and typographic errors should simply be corrected without comment […] unless the slip is textually important.\"",
	"params": {
		"1": {
			"description": "May contain a word fragment or a question mark. To display [sic?] and indicate doubt, put a question mark here, and put the word fragment in parameter 2. Otherwise, put the word fragment here.",
			"type": "string"
		},
		"2": {
			"description": "A word fragment goes here.",
			"type": "string"
		},
		"3": {
			"description": "A word fragment goes here.",
			"type": "string"
		},
		"hide": {
			"label": "Remove [sic]?",
			"description": "Set to y to remove the label [sic] altogether; the template may still be used to prevent automated or human editors from correcting the word.",
			"type": "string"
		},
		"nolink": {
			"label": "Remove link?",
			"description": "Set to y to remove the link to the article on \"sic\". The purpose of the link is to explain the template to readers, but it may be awkward if the template is placed in a link.",
			"type": "string"
		},
		"expected": {
			"label": "A comment to editors",
			"description": "Will not display; may contain some explanation for future editors.",
			"type": "string"
		}
	},
	"format": "inline"
}
</templatedata>

==Controlling display ({{para|nolink|y}} and {{para|hide|y}})==
To suppress the link but keep the [''sic'']:
:<code><nowiki>*[http://www.example.org/document_1.htm "{{sic|Conc|encus|nolink=y}} can Change!"]</nowiki></code>
:yields:
::*[http://www.example.org/document_1.htm "{{sic|Conc|encus|nolink=y}} can Change!"]

Use {{tlx|sic|hide&#61;y|<var>word or phrase</var>}} to avoid the display of sic altogether but still get the other benefits of the template. As with obfuscation, above, ''replace'' the original material that is now inside the template with the template itself, and the nolink and obfuscation features can be combined:
:<code><nowiki>He said "{{sic|hide=y|Irrega|rdless}} …"</nowiki></code>
:yields:
::He said "{{sic|hide=y|Irrega|rdless}} …"

Note: It is pointless to specify both <code>nolink</code> and <code>hide</code>, since one is a display feature, but the other disables display.

==Documenting the problem==
If the misspelling is an unusual one, it may be helpful to include an "expected" parameter: {{tlx|sic|<var>incorrect word or phrase</var>|expected&#61;<var>expected word or phrase</var>}}. This has no effect on the rendered page, but may assist later editors.

==Simple examples==

*Normal use: {{Tlx|sic|templte}} yields: {{sic|templte}}
*Obfuscating: {{Tlx|sic|tem|plte}} yields: {{sic|tem|plte}}
*Unlinked: {{Tlx|sic|nolink{{=}}y|templte}} yields: {{sic|nolink=y|templte}}
*Hidden: {{Tlx|sic|hide{{=}}y|templte}} yields: {{sic|hide=y|templte}}
*Query: {{Tlx|sic|?|templte}} yields: {{sic|?|templte}}
*Explained: {{Tlx|sic|templte|expected{{=}}template}} yields: {{sic|templte|expected=template}}

==Compound examples==

*Unlinked and obfuscated: {{Tlx|sic|nolink{{=}}y|temp|lte}} yields: {{sic|nolink=y|temp|lte}}
*Hidden and obfuscated: {{Tlx|sic|hide{{=}}y|temp|lte}} yields: {{sic|hide=y|temp|lte}}
*Query and obfuscated: {{Tlx|sic|?|temp|lte}} yields: {{sic|?|temp|lte}}
*Explained and unlinked: {{Tlx|sic|templte|nolink{{=}}y|expected{{=}}template}} yields: {{sic|templte|nolink=y|expected=template}}
*Query and unlinked: {{Tlx|sic|?|nolink{{=}}y|templte}} yields: {{sic|?|nolink=y|templte}}
*Unlinked and hidden ("unlinked" portion has no effect): {{Tlx|sic|nolink{{=}}y|hide{{=}}y|templte}} yields: {{sic|nolink=y|hide=y|templte}}
*Unlinked, hidden and query ("unlinked" portion has no effect): {{Tlx|sic|?|nolink{{=}}y|hide{{=}}y|templte}} yields: {{sic|?|nolink=y|hide=y|templte}}
*Unlinked, query and obfuscated: {{Tlx|sic|?|nolink{{=}}y|temp|lte}} yields: {{sic|?|nolink=y|temp|lte}}
*Unlinked, hidden and obfuscated ("unlinked" portion has no effect): {{Tlx|sic|nolink{{=}}y|hide{{=}}y|temp|lte}} yields: {{sic|nolink=y|hide=y|temp|lte}}
*Hidden, query and obfuscated: {{Tlx|sic|?|hide{{=}}y|temp|lte}} yields: {{sic|?|hide=y|temp|lte}}
*Unlinked, hidden, query and obfuscated ("unlinked" portion has no effect): {{Tlx|sic|?|nolink{{=}}y|hide{{=}}y|temp|lte}} yields: {{sic|?|nolink=y|hide=y|temp|lte}}

== See also ==
* {{tl|Bracket}}
* {{tl|Quote}}
* {{tl|Lang}}
* {{tl|Not a typo}}

<includeonly>{{Sandbox other|
| <!-- PLEASE ADD CATEGORIES BELOW THIS LINE: -->
[[Category:Inline templates]]
[[Category:Quotation templates]]
[[Category:Typing-aid templates]]
}}</includeonly>