Template:Infobox character encoding

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search
Infobox character encoding
Template documentation[view] [edit] [history] [purge]

Infobox template for character encodings, character sets, code pages et cetera.

While the difference between a coded character set and a character encoding is clear in a Unicode context (UTF-8 and UTF-16 are different encodings for the same set), the difference is often blurred immensely by legacy encodings. For example, so-called "WinLatin-1" is a de facto extension of the "Latin-1" (ISO 8859-1) encoding, whereas so-called "DOS Latin-1" is an alternative, incompatible encoding (or transformation format) of the ISO 8859-1 charset. Both add their own extensions, meaning that their own charsets, taken as wholes, have their own unique identities as well. For this reason, the same infobox template is used for both.

Usage[edit]

See below for documentation of individual parameters. It is usually neither appropriate nor necessary to specify all of them.

{{infobox character encoding
| name = 
| image =
| caption =
| mime = 
| kermit =
| alias = 
| lang = 
| by =
| standard = 
| definitions = 
| status =
| classification =
| extends =
| basedon = 
| extensions =
| encodings =
| encodes =
| prev = 
| next = 
| otherrelated =
| extra =
}}

Template Data[edit]

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Infobox character encoding

An infobox for a format comprising a coded character set and/or a character encoding.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Name name

Common, preferably unique, name of character encoding (displayed as title of infobox). Not necessarily a valid label.

Default
empty
Example
empty
Auto value
empty
Stringrequired
Imageimage

Image (such as a single byte character grid, multiple byte layout chart or a logo of the set)

Default
empty
Example
empty
Auto value
empty
Fileoptional
Image Captioncaption

Caption for the image

Default
empty
Example
empty
Auto value
empty
Stringoptional
MIME / IANAmime

A label of the encoding to be used in MIME types. Should be an IANA-approved label for the specific encoding in question; favour the Preferred MIME Name if one is available. Set |_nomimecode= to disable the default <code>...</code> formatting.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Kermitkermit

A label of the encoding used in Kermit. As MIME names are currently accepted by Kermit, this is not necessarily useful to note, but may be if the label is in extensive use or if there is no MIME name for the encoding. Set |_nokermitcode= to disable the default <code>...</code> formatting.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Alias(es)alias

Other names and labels of the character encoding

Default
empty
Example
empty
Auto value
empty
Stringoptional
Language(s)lang

The language or languages which the character encoding is used for or, more broadly, supports.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Created byby

Individual or organisation who created the encoding

Default
empty
Example
empty
Auto value
empty
Stringoptional
Standardstandard

If the format is part of a standard or standards, list it/them here.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Definitionsdefinitions

Defining documents or reference implementations which don't constitute a standard.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Current statusstatus

Usage status of the character encoding

Default
empty
Example
empty
Auto value
empty
Stringoptional
Classificationclassification

Classification of the charset or encoding, e.g. series it may be part of (e.g. ISO 8859), general categories (e.g. Extended ASCII), higher level encoding it might be built for (ISO 2022), et cetera.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Extendsextends

Encodings which it is an extended version or superset of (but which it may or may not be a clear successor of).

Default
empty
Example
empty
Auto value
empty
Stringoptional
Based onbasedon

Encodings which it is a modification of but NOT (either in theory or practice) a superset of.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Extensionsextensions

Noteworthy extended versions of the charset or encoding (but which may or may not be regarded as clear successors).

Default
empty
Example
empty
Auto value
empty
Stringoptional
Transforms / Encodesencodes

Repertoire or charset which is a subset of this encoding's repertoire. Whilst this may be something which is both a charset and an encoding, it should not be an encoding solely encoding a charset with its own clear identity (e.g. 'ISO 8859-1' and 'Unicode' are both appropriate values but 'UTF-8' is not). If it is an encoding which is a subset of the encoding itself, it goes in the Extends field.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Encoding formatsencodings

Encoding or transformation formats for the charset. These are usually listed if the charset either doesn't define an encoding format itself, or defines more than one (e.g. Unicode), or one which is not consistently used.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Preceded byprev

Encoding/charset/format which it superseded in some context.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Succeeded bynext

Encoding/charset/format which it was superseded by in some context.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Other related encodingsotherrelated

Any encodings which are worth of note as being closely related, but neither a predecessor, nor a successor, nor a subset.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Extra markupextra

Something to leave at the bottom of the infobox, below the information. For example, a {{notelist}} invocation.

Default
empty
Example
empty
Auto value
empty
Stringoptional

See also[edit]