Difference between revisions of "Template:SIC/doc"
Jump to navigation
Jump to search
(removed one variable example from Usage section, since it appears under Incorrect usage) |
Griceylipper (talk | contribs) m (22 revisions imported: Import templates for formatting Jakobsen snippets) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
==Purpose== | ==Purpose== | ||
| − | {{tl|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 {{tl|Sic}} (a different template with | + | {{tl|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 {{tl|Sic}} (a different template with a similar name) or of doing nothing. |
| − | The word should actually be a typo. The purpose of the template | + | 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== | ==Effect== | ||
| Line 10: | Line 10: | ||
==Usage== | ==Usage== | ||
| − | ;Use of two | + | ;Use of two parameters |
| − | * first | + | * first parameter (<code>$1</code> or <code>target</code>) is the word in text being transcribed ['''mandatory'''] |
| − | * second | + | * second parameter (<code>$2</code> or <code>texttip</code>) is the word that is presumed to have been the intended word [optional] |
| + | |||
The intention is to encapsulate the word in question | The intention is to encapsulate the word in question | ||
<pre>{{SIC|typed word|presumed word}}</pre> | <pre>{{SIC|typed word|presumed word}}</pre> | ||
: RESULT: {{SIC|typed word|presumed word}} ← hover cursor to see full effect | : RESULT: {{SIC|typed word|presumed word}} ← hover cursor to see full effect | ||
| + | |||
| + | If the dashed line (default) is problematic for the work, this can be overridden | ||
| + | * third parameter (<code>$3</code> or <code>nodash</code>) = nodash | ||
| + | |||
| + | <pre>{{SIC|typed word|presumed word|nodash}}</pre> | ||
| + | : RESULT: {{SIC|typed word|presumed word|nodash}} ← hover cursor to see full effect | ||
===Incorrect usage=== | ===Incorrect usage=== | ||
| − | ; no | + | ; no parameters |
<pre>{{SIC}}</pre> | <pre>{{SIC}}</pre> | ||
: RESULT: {{SIC}} ← hover cursor to see full effect | : RESULT: {{SIC}} ← hover cursor to see full effect | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==See also== | ==See also== | ||
* {{tl|sic}} — which undertakes a similar function though as a hidden placemarker in the text. | * {{tl|sic}} — which undertakes a similar function though as a hidden placemarker in the text. | ||
| − | * {{tl| | + | * {{tl|tooltip}} — <nowiki>{{SIC}}</nowiki> is based upon this template |
<includeonly> | <includeonly> | ||
| Line 44: | Line 46: | ||
</includeonly> | </includeonly> | ||
| + | |||
| + | ==Templatedata== | ||
| + | |||
| + | <templatedata> | ||
| + | { | ||
| + | "params": { | ||
| + | "target": { | ||
| + | "aliases": [ | ||
| + | "1" | ||
| + | ], | ||
| + | "label": "target", | ||
| + | "description": "targetted word in text", | ||
| + | "type": "string", | ||
| + | "required": true | ||
| + | }, | ||
| + | "texttip": { | ||
| + | "aliases": [ | ||
| + | "2" | ||
| + | ], | ||
| + | "description": "presumed text", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "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> | ||
Latest revision as of 22:58, 10 March 2021
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 (
$1ortarget) is the word in text being transcribed [mandatory] - second parameter (
$2ortexttip) 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 (
$3ornodash) = 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
Templatedata
To display a visual representation that a presumed error in the published work is indeed what was produced in that work
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| target | target 1 | targetted word in text | String | required |
| Texttip | texttip 2 | presumed text | String | optional |
| nodash | nodash 3 | used to suppress dashed underline | Boolean | optional |