Template:Errata/doc - Revision history

Griceylipper: 4 revisions imported: Import templates for formatting Jakobsen snippets

2021-03-11T21:43:30Z

4 revisions imported: Import templates for formatting Jakobsen snippets

ws>Billinghurst: Reverted edits by Billinghurst (talk) to last revision by AuFCL

2014-11-03T01:25:35Z

Reverted edits by Billinghurst (talk) to last revision by AuFCL

ws>Billinghurst: /* Parameters */ utilise parameter names, and put positional as aliases

2014-11-03T01:23:56Z

Parameters: utilise parameter names, and put positional as aliases

ws>AuFCL: expand examples

2014-10-19T23:56:15Z

expand examples

ws>AuFCL: Created page with "{{Documentation subpage}} Annote published corrections to text. Some publications contain..."

2014-10-19T11:26:27Z

Created page with "{{Documentation subpage}}  Annote published corrections to text. Some publications contain..."

New page

{{Documentation subpage}}

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 ===
<nowiki>{{errata|original content|corrected content|discussion link|viewing name space}}</nowiki>

The following (or equivalent) is always required by this template in order to provide a display area for alternate content (and optional linkage) display:

<nowiki>{{smallrefs|group="errata"}}</nowiki>

=== Parameters ===
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "original",
"description": "Original page content prior to correction.",
"type": "string",
"required": true,
"aliases": [ "original" ]
},
"2": {
"label": "modified",
"description": "Final page content after correction has been applied.",
"type": "string",
"required": true,
"aliases": [ "modified" ]
},
"3": {
"label": "link",
"description": "Optional link to published errata or other explanation of alteration.",
"type": "string",
"required": false,
"aliases": [ "link" ]
},
"4": {
"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.",
"type": "string",
"required": false,
"aliases": [ "view" ]
}
}
}
</templatedata>

=== Example ===
<nowiki>{{errata|old|new|template:errata/doc}}</nowiki>

renders as:

default: {{errata|old|new|template:errata/doc}}

in Page: {{errata|old|new|template:errata/doc|Page}}

{{smallrefs|group="errata"}}


<includeonly>


</includeonly>

← Older revision	Revision as of 21:43, 11 March 2021
(No difference)

@@ Line 18: / Line 18: @@
 	"description": "",
 	"params": {
-		"original": {
+		"1": {
 			"label": "original",
 			"description": "Original page content prior to correction.",
 			"type": "string",
 			"required": true,
-			"aliases": [ "1" ]
+			"aliases": [ "" ]
 		},
-		"modified": {
+		"2": {
 			"label": "modified",
 			"description": "Final page content after correction has been applied.",
 			"type": "string",
 			"required": true,
-			"aliases": [ "2" ]
+			"aliases": [ "" ]
 		},
-		"link": {
+		"3": {
 			"label": "link",
 			"description": "Optional link to published errata or other explanation of alteration.",
 			"type": "string",
 			"required": false,
-			"aliases": [ "3" ]
+			"aliases": [ "" ]
 		},
-		"view": {
+		"4": {
 			"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.",
 			"type": "string",
 			"required": false,
-			"aliases": [ "4" ]
+			"aliases": [ "" ]
 		},
-		"mark": {
+		"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": [ "5" ]
+			"aliases": [ "" ]
+		}
+	}

@@ Line 23: / Line 23: @@
 			"type": "string",
 			"required": true,
-			"aliases": [ "original" ]
+			"aliases": [ "" ]
 		},
 		"2": {
@@ Line 30: / Line 30: @@
 			"type": "string",
 			"required": true,
-			"aliases": [ "modified" ]
+			"aliases": [ "" ]
 		},
 		"3": {
@@ Line 37: / Line 37: @@
 			"type": "string",
 			"required": false,
-			"aliases": [ "link" ]
+			"aliases": [ "" ]
 		},
 		"4": {
@@ Line 44: / Line 44: @@
 			"type": "string",
 			"required": false,
-			"aliases": [ "view" ]
+			"aliases": [ "" ]
+		}
+	}
@@ Line 50: / Line 57: @@
 </templatedata>
-=== Example ===
+=== Examples ===
 <nowiki>{{errata|old|new|template:errata/doc}}</nowiki>
 renders as:
@@ Line 60: / Line 81: @@
 {{smallrefs|group="errata"}}
 <!-- uncomment as necessary
 === See also ===