Template:Infobox character encoding/doc: Difference between revisions

Revision as of 20:38, 10 March 2018

Latest revision as of 15:27, 10 August 2024

(33 intermediate revisions by 12 users not shown)

Line 1:

{{Documentation subpage}}

{{Lua|Module:Infobox|Module:Check for unknown parameters}}

<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

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 "[[Windows-1252|WinLatin-1]]" is a ''de facto'' extension of the "Latin-1" (ISO 8859-1) ''encoding'', whereas so-called "[[Code page 850|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 presently used for both.

== Usage ==

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

<presyntaxhighlight lang="wikitext">{{infobox character encoding

| name =

| image =

| caption =

| mime =

| aliaskermit =

| standardalias =

| lang =

| statusby =

| classificationstandard =

| extendsdefinitions =

| extensionsstatus =

| encodingsclassification =

| encodesextends =

| prevbasedon =

| nextextensions =

| otherrelatedencodings =

| encodes =

}}</pre>

| prev =

| next =

| otherrelated =

| extra =

}}</syntaxhighlight>

==Template Data==

{{TemplateData header}}

{{TemplateDataHeader}}

<templatedata>

{

"description": "An infobox onfor a format comprising a coded character set and/or a character encoding.",

"params": {

"name": {

Line 38 ⟶ 44:

"required": true,

"deprecated": false,

"description": "commonCommon, preferably unique, name of character encoding (displayed as title of infobox). Not necessarily a valid label."

},

"image": {

Line 56 ⟶ 62:

"type": "string",

"deprecated": false,

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

},

"encodeskermit": {

"typelabel": "stringKermit",

"type": "string",

"deprecated": false,

"description": "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."

},

"alias": {

Line 63 ⟶ 75:

"deprecated": false,

"description": "Other names and labels of the character encoding"

},

"lang": {

"label": "Transforms / EncodesLanguage(s)",

"type": "string",

"deprecated": false,

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

},

"by": {

"label": "Created by",

"type": "string",

"deprecated": false,

"description": "Individual or organisation who created the encoding"

},

"standard": {

Line 70 ⟶ 94:

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

},

"langdefinitions": {

"label": "Language(s)Definitions",

"type": "string",

"deprecated": false,

"description": "TheDefining languagedocuments or languagesreference implementations which the character encoding is used for or,don't moreconstitute broadly,a supportsstandard."

},

"status": {

Line 93 ⟶ 117:

"deprecated": false,

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

},

"basedon": {

"label": "Based on",

"type": "string",

"deprecated": false,

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

},

"extensions": {

Line 99 ⟶ 129:

"deprecated": false,

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

},

"encodes": {

"label": "Transforms / Encodes",

"type": "string",

"deprecated": false,

"description": "Repertoire or charset which is a subset (or equal set) 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."

},

"encodings": {

Line 105 ⟶ 141:

"deprecated": false,

"description": "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."

},

"encodes": {

"label": "Transforms / Encodes",

"type": "string",

"deprecated": false,

"description": "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."

},

"prev": {

Line 116 ⟶ 146:

"type": "string",

"deprecated": false,

"description": "Encoding/charset/format which it superseded in some context. This may or may not be a subset."

},

"next": {

Line 122 ⟶ 152:

"type": "string",

"deprecated": false,

"description": "Encoding/charset/format which it was superseded by in some context. This may or may not be a superset."

},

"otherrelated": {

"label": "Other related encodings",

"type": "string",

"deprecated": false,
"description": "Any other encodings which are worth of note as being closely related, but neither a predecessor, nor a successor, nor a subset."

},

"extra": {

"label": "Extra markup",

"type": "string",

"deprecated": false,

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

}

},

Line 135 ⟶ 172:

== See also ==

* {{tl|Infobox symbol}}

* {{tl|Infobox punctuation mark}}

<includeonly>{{Sandbox other||

<includeonly>

<!-- Categories go here, and interwikis go in Wikidata -->

[[Category:Software infobox templates]]

}}</includeonly>