Difference between revisions of "Template:SIC/doc"

From Nynorn
Jump to navigation Jump to search
m (in line with code change)
(Templatedata)
Line 46: Line 46:
  
 
</includeonly>
 
</includeonly>
 +
 +
====
 +
 +
<templatedata>
 +
{
 +
"params": {
 +
"texttip": {
 +
"aliases": [
 +
"2"
 +
],
 +
"description": "presumed text",
 +
"example": "texttip",
 +
"type": "string"
 +
},
 +
"target": {
 +
"aliases": [
 +
"1"
 +
],
 +
"label": "target",
 +
"description": "targetted word in text",
 +
"type": "string",
 +
"required": true
 +
},
 +
"nodash": {
 +
"aliases": [
 +
"3"
 +
],
 +
"label": "nodash",
 +
"description": "used to suppress dashed underline",
 +
"type": "boolean"
 +
}
 +
},
 +
"description": "To display a visual representation that a presumed error in the published work is indeed what was produced in that work",
 +
"format": "inline"
 +
}
 +
</templatedata>

Revision as of 06:02, 4 August 2020

Template:Mbox

Purpose

{{SIC}} is used to indicate that the spelling of word matches the original text. This should minimise the amount of modification by those who like to correct spelling. Use of this template is queried and may be untested. Compare the earlier practice of using {{Sic}} (a different template with a similar name) or of doing nothing.

The word should actually be a typo. The purpose of the template is not for indicating a different or obsolete spelling, nor for attaching definitions, synonyms, commentary etc. to a word

Effect

To underline the word of interest, and to produce a pop-up to show the presumed intended word.

Usage

Use of two parameters
  • first parameter ($1 or target) is the word in text being transcribed [mandatory]
  • second parameter ($2 or texttip) is the word that is presumed to have been the intended word [optional]

The intention is to encapsulate the word in question

{{SIC|typed word|presumed word}}
RESULT: typed word    ← hover cursor to see full effect


If the dashed line (default) is problematic for the work, this can be overridden

  • third parameter ($3 or nodash) = nodash
{{SIC|typed word|presumed word|nodash}}
RESULT: typed word    ← hover cursor to see full effect

Incorrect usage

no parameters
{{SIC}}
RESULT: {{{1}}}    ← hover cursor to see full effect

See also

  • {{sic}} — which undertakes a similar function though as a hidden placemarker in the text.
  • {{tooltip}} — {{SIC}} is based upon this template


==

To display a visual representation that a presumed error in the published work is indeed what was produced in that work

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Texttiptexttip 2

presumed text

Example
texttip
Stringoptional
targettarget 1

targetted word in text

Stringrequired
nodashnodash 3

used to suppress dashed underline

Booleanoptional