Difference between revisions of "Template:Errata/doc"
(Created page with "{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE AND INTERWIKIS IN WIKIDATA --> Annote published corrections to text. Some publications contain...") |
m (expand examples) |
||
| Line 23: | Line 23: | ||
"type": "string", | "type": "string", | ||
"required": true, | "required": true, | ||
| − | "aliases": [ " | + | "aliases": [ "" ] |
}, | }, | ||
"2": { | "2": { | ||
| Line 30: | Line 30: | ||
"type": "string", | "type": "string", | ||
"required": true, | "required": true, | ||
| − | "aliases": [ " | + | "aliases": [ "" ] |
}, | }, | ||
"3": { | "3": { | ||
| Line 37: | Line 37: | ||
"type": "string", | "type": "string", | ||
"required": false, | "required": false, | ||
| − | "aliases": [ " | + | "aliases": [ "" ] |
}, | }, | ||
"4": { | "4": { | ||
| Line 44: | Line 44: | ||
"type": "string", | "type": "string", | ||
"required": false, | "required": false, | ||
| − | "aliases": [ " | + | "aliases": [ "" ] |
| + | }, | ||
| + | "5": { | ||
| + | "label": "mark", | ||
| + | "description": "Optional colour control for highlighting changes (default is 'palegreen' in Page: 'transparent' elsewhere; suggest use of muted 'fluorescent' colours.) If specified will apply equally to all name space views.", | ||
| + | "type": "string", | ||
| + | "required": false, | ||
| + | "aliases": [ "" ] | ||
} | } | ||
} | } | ||
| Line 50: | Line 57: | ||
</templatedata> | </templatedata> | ||
| − | === | + | === Examples === |
| + | <nowiki>{{errata|old|new}}</nowiki> | ||
| + | |||
| + | <nowiki>{{smallrefs|group="errata"}}</nowiki> | ||
| + | |||
| + | renders as: | ||
| + | |||
| + | default: {{errata|old|new}} | ||
| + | |||
| + | in Page: {{errata|old|new|view=Page}} | ||
| + | |||
| + | {{smallrefs|group="errata"}} | ||
| + | {{rule}} | ||
<nowiki>{{errata|old|new|template:errata/doc}}</nowiki> | <nowiki>{{errata|old|new|template:errata/doc}}</nowiki> | ||
| + | |||
| + | <nowiki>{{smallrefs|group="errata"}}</nowiki> | ||
renders as: | renders as: | ||
| Line 60: | Line 81: | ||
{{smallrefs|group="errata"}} | {{smallrefs|group="errata"}} | ||
| + | {{rule}} | ||
| + | <nowiki>{{errata|old|new|template:errata/doc|mark=yellow}}</nowiki> | ||
| + | |||
| + | <nowiki>{{smallrefs|group="errata"}}</nowiki> | ||
| + | |||
| + | renders as: | ||
| + | |||
| + | default: {{errata|old|new|template:errata/doc|mark=yellow}} | ||
| + | |||
| + | in Page: {{errata|old|new|template:errata/doc|Page|yellow}} | ||
| + | |||
| + | {{smallrefs|group="errata"}} | ||
| + | {{rule}} | ||
<!-- uncomment as necessary | <!-- uncomment as necessary | ||
=== See also === | === See also === | ||
Revision as of 00:56, 20 October 2014
Template:Mbox Annote published corrections to text.
Some publications contain an errata page which can result in a conflict for proofreaders: how to represent text "true-to-scan" (in the Page: view) yet still "accurate-to-intention" when presented in its final form. This template represents an attempt to address this issue in a uniform fashion.
Usage
{{errata|original content|corrected content|discussion link|viewing name space}}
The following (or equivalent) is always required by this template in order to provide a display area for alternate content (and optional linkage) display:
{{smallrefs|group="errata"}}
Parameters
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| original | 1 | Original page content prior to correction. | String | required |
| modified | 2 | Final page content after correction has been applied. | String | required |
| link | 3 | Optional link to published errata or other explanation of alteration. | String | optional |
| view | 4 | Optional name space specification for testing or demonstration purposes to force apparent name space to be used for interpretation of display. If unspecified current display context will be used. Currently, only 'page' is treated specially. | String | optional |
| mark | 5 | Optional colour control for highlighting changes (default is 'palegreen' in Page: 'transparent' elsewhere; suggest use of muted 'fluorescent' colours.) If specified will apply equally to all name space views. | String | optional |
Examples
{{errata|old|new}}
{{smallrefs|group="errata"}}
renders as:
default: new[errata 1]
in Page: old[errata 2]
{{errata|old|new|template:errata/doc}}
{{smallrefs|group="errata"}}
renders as:
default: new[errata 1]
in Page: old[errata 2]
{{errata|old|new|template:errata/doc|mark=yellow}}
{{smallrefs|group="errata"}}
renders as:
default: new[errata 1]
in Page: old[errata 2]