Template:Errata

From Wikisource
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

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[edit]

{{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[edit]

Template parameters

ParameterDescriptionTypeStatus
original1

Original page content prior to correction.

Stringrequired
modified2

Final page content after correction has been applied.

Stringrequired
link3

Optional link to published errata or other explanation of alteration.

Stringoptional
view4

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.

Stringoptional
mark5

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.

Stringoptional

Examples[edit]

{{errata|old|new}}

{{smallrefs|group="errata"}}

renders as:

default: new[errata 1]

in Page: old[errata 2]

  1. Original: old was amended to new
  2. Correction: old should be amended to new

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

{{smallrefs|group="errata"}}

renders as:

default: new[errata 1]

in Page: old[errata 2]

  1. Original: old was amended to new: detail
  2. Correction: old should be amended to new: detail

{{errata|old|new|template:errata/doc|mark=yellow}}

{{smallrefs|group="errata"}}

renders as:

default: new[errata 1]

in Page: old[errata 2]

  1. Original: old was amended to new: detail
  2. Correction: old should be amended to new: detail