Difference between revisions of "Template:Errata/doc"
m (expand examples) |
(→Parameters: utilise parameter names, and put positional as aliases) |
||
| Line 18: | Line 18: | ||
"description": "", | "description": "", | ||
"params": { | "params": { | ||
| − | " | + | "original": { |
"label": "original", | "label": "original", | ||
"description": "Original page content prior to correction.", | "description": "Original page content prior to correction.", | ||
"type": "string", | "type": "string", | ||
"required": true, | "required": true, | ||
| − | "aliases": [ "" ] | + | "aliases": [ "1" ] |
}, | }, | ||
| − | " | + | "modified": { |
"label": "modified", | "label": "modified", | ||
"description": "Final page content after correction has been applied.", | "description": "Final page content after correction has been applied.", | ||
"type": "string", | "type": "string", | ||
"required": true, | "required": true, | ||
| − | "aliases": [ "" ] | + | "aliases": [ "2" ] |
}, | }, | ||
| − | " | + | "link": { |
"label": "link", | "label": "link", | ||
"description": "Optional link to published errata or other explanation of alteration.", | "description": "Optional link to published errata or other explanation of alteration.", | ||
"type": "string", | "type": "string", | ||
"required": false, | "required": false, | ||
| − | "aliases": [ "" ] | + | "aliases": [ "3" ] |
}, | }, | ||
| − | " | + | "view": { |
"label": "view", | "label": "view", | ||
"description": "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.", | "description": "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.", | ||
"type": "string", | "type": "string", | ||
"required": false, | "required": false, | ||
| − | "aliases": [ "" ] | + | "aliases": [ "4" ] |
}, | }, | ||
| − | " | + | "mark": { |
"label": "mark", | "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.", | "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", | "type": "string", | ||
"required": false, | "required": false, | ||
| − | "aliases": [ "" ] | + | "aliases": [ "5" ] |
} | } | ||
} | } | ||
Revision as of 02:23, 3 November 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 | original 1 | Original page content prior to correction. | String | required |
| modified | modified 2 | Final page content after correction has been applied. | String | required |
| link | link 3 | Optional link to published errata or other explanation of alteration. | String | optional |
| view | 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 | 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]