View source for Template:Version/doc

{{Documentation subpage}}
{{Accessibility dispute |reason=version information conveyed by background color has no text alternative |talk=Color coding accessibility |date=November 2016}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

== Usage ==
This template presents version history tables in a standardized format.

Many articles on Wikipedia use color-coded tables to illustrate the version or release history of software. The template has been imported from German Wikipedia, where it is used as the current standard for color-coding history tables.

This template is used within [[Help:Wikitable|Wikitables]], making use of the [[Help:Table#Pipe syntax tutorial|pipe syntax]]. Legends can be added as tables, as floating or non-floating containers. As colors are not visible to blind or visually-impaired readers, this template uses replacement information when necessary to improve accessibility, e.g. using the "title" attribute. (See [[Wikipedia:WikiProject Accessibility]].)

When creating a version history, please note that less is more: [[WP:NOTCHANGELOG|Wikipedia is not a directory or changelog]]. Only important or major releases should be documented in Wikipedia. See the [[Wikipedia:Manual of Style/Computing|Manual of Style for Computing topics]] for further guidelines.

=== General look ===
{| class="wikitable"
|-
! Version
! Year
! Description
|-
| {{Version |o |1.0}}
| {{#expr: {{CURRENTYEAR}}-3}}
| [[end-of-life (product)|EOL]] versions
|-
| {{Version |co |2.0}}
| {{#expr: {{CURRENTYEAR}}-2}}
| [[long-term support|LTS]] versions
|-
| {{Version |c |3.0}}
| {{#expr: {{CURRENTYEAR}}-1}}
| Current stable version
|-
| {{Version |cp |4.0beta2}}
| {{#expr: {{CURRENTYEAR}}}}
| Latest beta version
|-
| {{Version |p |4.0}}
| {{#expr: {{CURRENTYEAR}}+1}}
| Future release
|-
| colspan=3 | {{Version|l|show=111111}}
|}

=== When to avoid ===
;Discontinued products: For a product that is neither supported nor developed, each version would have the "EOL versions" description. Since no distinction would exist between version stages, the use of this template would lack any basis. A simple sentence or a {{para|discontinued|yes}} in the infobox would do admirably well.

;When there is always one stable supported version: When there are no supported previous versions, preview versions, or announced future versions, the entire table would consist of red versions with a single green one at the very end. In such cases, the use of this template is discouraged.

== Parameters ==
=== Legend box ===
{| class="wikitable"
|-
! Parameter
! Description
! Notes
|-
| <code>1</code>
| Legend type
| Either of the following generates a legend box. Acceptable values include:
:'''l''': Horizontal legend
:'''lv''': Vertical legend
:'''t''': Horizontal legend, as a table
:'''tv''': Vertical legend, as a table
|-
| <code>show</code>
| Legend contents
| This parameter is optional. By default the legend box contains the following six items:
# '''Legend:''' (appears bold when the legend type is either "l", "lv", or "t")
# EOL versions
# LTS versions
# '''Current version''' (appears bold)
# Latest preview version
# Future release

This parameter allows each item to be displayed or hidden with digits. Each digit controls the state of its associated item in the above list.<br />
Acceptable digits are "1" (displays the associated legend item) and "0" (hides the associated legend item).<br />
The parameter is "show=XXX" where "XXX" is:
* a six-digit number when the legend type is either "l" or "lv"
* a five-digit number when the legend type is either "t" or "tv" because the first item ("Legend:") cannot be hidden.
Additional digits on the '''left''' are ignored.
|-
| <code>style</code>
| [[Cascading Style Sheets|CSS]] styles
| This parameter is optional. Use it to change the template's formatting, style and layout via CSS syntax.
In combination with the legend the specified CSS applies to the entire block.
|}

=== Table cells ===
{| class="wikitable"
|-
! Parameter
! Description
! Notes
|-
| <code>1</code>
| Data type
| Either of the following change the background color of the cell in which it is inserted:
:'''o''': Denotes EOL versions
:'''co''': Denotes LTS versions
:'''c''': Denotes latest stable version
:'''cp''': Denotes preview version
:'''p''': Denotes planned future version
|-
| <code>2</code>
| Text
| Specifies the text to display on screen, usually a version number or name of a specific version.
|-
| <code>style</code>
| [[Cascading Style Sheets|CSS]] styles
| This parameter is optional. Use it to change the template's formatting, style and layout via CSS syntax.
This parameter can be inserted into a table cell to enforce CSS definitions in that cell.
|-
| <code>sortKey</code>{{anchor|sortKey}}
| Sorting key
| This parameter is optional. A sortkey is an invisible string used to change the way a certain table cell is sorted. For instance, normally, the phrase "ACME's Bow" is sorted with phrases that start with A. Affixing a sortkey of "Bow" to the phrase causes the phrase to be sorted with other phrases that start with "B" (or, to be more accurate, with "Bow").

For general information on sorting tables, see [[Help:Tables#Sorting|Help:Tables]].
|}

== Examples ==
{{See|Template:Version/Examples|Template:Version/doc/Examples from german Wikipedia}}

=== Legend box ===
{| class="wikitable" style="width:100%;"
|-
! Description
! What you type
! What it looks like
|-
| Horizontal legend
| <pre>{{Version |l |show=110111}}</pre>
| {{Version |l |show=110111}}
|-
| Vertical legend
| <pre>{{Version |lv |show=011101}}</pre>
| {{Version |lv |show=011101}}{{Lorem ipsum|1}}
|-
| Horizontal legend table
| <pre>{{Version |t |show=11110}}</pre>
| {{Version |t |show=11110}}
|-
| Vertical legend table
| <pre>{{Version |tv |show=01111}}</pre>
| {{Version |tv |show=01111}}{{Lorem ipsum|1}}
|}

=== Table cells ===
{| class="wikitable"
|-
! Description
! What you type
! What it looks like
|-
| [[end-of-life (product)|EOL]] versions
| <pre>{{Version |o |1.0}}</pre>
| {{Version |o |1.0}}
|-
| [[long-term support|LTS]] versions
| <pre>{{Version |co |2.0}}</pre>
| {{Version |co |2.0}}
|-
| Latest stable version
| <pre>{{Version |c |3.0}}</pre>
| {{Version |c |3.0}}
|-
| Preview version
| <pre>{{Version |cp |4.0}}</pre>
| {{Version |cp |4.0}}
|-
| Planned future version
| <pre>{{Version |p |5.0}}</pre>
| {{Version |p |5.0}}
|}

=== Sortable tables ===
The template can be used in sortable tables. If the column ''version'' is sortable, the [[#sortKey|sort key]] defaults to the value of the version parameter. If you need differing sorting, add the ''sortKey'' parameter as follows:
{| class="wikitable"
|-
! What you type!!What it looks like
|-
| <pre>{| class="wikitable sortable"
|-
! Version !! Date !! Description
|-
| {{Version  |o  |1.0    |sortKey=1.0}}
| 2010-07-23 || [[end-of-life (product)|EOL]] versions
|-
| {{Version  |co |2.0    |sortKey=2.0}}
| 2011-06-27 || [[long-term support|LTS]] versions
|-
| {{Version  |cp |3.0 DP |sortKey=3.0 A}}
| 2012-03-02 || Developer's preview
|-
| {{Version  |cp |3.0 CP |sortKey=3.0 B}}
| 2012-04-01 || Consumers Preview
|-
| {{Version  |cp |3.0 RC |sortKey=3.0 C}}
| 2012-05-25 || Release candidate
|-
| {{Version  |c  |3.0    |sortKey=3.0 Z}}
| 2012-06-23 || Release to web
|-
| {{Version  |p  |4.0    |sortKey=4.0}}
| 2017-09-06 || Future version
|}</pre>||
{| class="wikitable sortable"
|-
! Version !! Date !! Description
|-
| {{Version  |o  |1.0    |sortKey=1.0}}
| 2010-07-23 || [[end-of-life (product)|EOL]] versions
|-
| {{Version  |co |2.0    |sortKey=2.0}}
| 2011-06-27 || [[long-term support|LTS]] versions
|-
| {{Version  |cp |3.0 DP |sortKey=3.0 A}}
| 2012-03-02 || Developer's preview
|-
| {{Version  |cp |3.0 CP |sortKey=3.0 B}}
| 2012-04-01 || Consumers Preview
|-
| {{Version  |cp |3.0 RC |sortKey=3.0 C}}
| 2012-05-25 || Release candidate
|-
| {{Version  |c  |3.0    |sortKey=3.0 Z}}
| 2012-06-23 || Release to web
|-
| {{Version  |p  |4.0    |sortKey=4.0}}
| 2017-09-06 || Future version
|}
|}

== TemplateData ==
{{TemplateDataHeader}}

<templatedata>
{
	"params": {
		"1": {
			"label": "Type",
			"description": "For a table cell, this is \"o\", \"co\", \"c\", \"cp\", or \"p\", meaning EOL, LTS, current, preview, and future releases respectively. To create a table legend instead, use \"l\", \"lv\", \"t\", or \"tv\", meaning horizontal or vertical legend, or horizontal or vertical legend as a table, respectively.",
			"example": "c",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "Text (for cells)",
			"description": "If this is a cell (see parameter 1), this is required. It is the text to display.",
			"example": "1.0-alpha",
			"type": "content",
			"autovalue": "",
			"suggested": true
		},
		"style": {
			"label": "Custom CSS",
			"description": "Custom CSS to apply to the template",
			"example": "text-align: center;"
		},
		"show": {
			"label": "Legend components shown",
			"description": " If this is a legend, a series of ones (on) and zeros (off) denoting the components of the legend in the order: Legend; EOL versions; LTS versions; Current version; Latest preview version; Future release. If displaying as a table, the text \"Legend\" must be shown and so the first digit should be omitted.",
			"example": "110110",
			"type": "string",
			"default": "All parts displayed. (111111)",
			"suggested": true
		},
		"sortKey": {
			"label": "Sort key (for cells)",
			"description": "When the cells of a table are sorted, this cell would normally be positioned by the visible cell content. If you set this parameter, this cell will be positioned when sorted as if this was its content.",
			"type": "string",
			"default": "Normally the cell is sorted by its visible content."
		}
	},
	"description": "This template presents version history tables in a standardized format. Note that you may have to insert it in source mode, not visual mode.\n\nMany articles on Wikipedia use color-coded tables to illustrate the version or release history of software. The template has been imported from German Wikipedia, where it is used as the current standard for color-coding history tables.\n\nThis template is used within Wikitables, making use of the pipe syntax. Legends can be added as tables, as floating or non-floating containers. As colors are not visible to blind or visually-impaired readers, this template uses replacement information when necessary to improve accessibility, e.g. using the \"title\" attribute. (See Wikipedia:WikiProject Accessibility.)\n\nWhen creating a version history, please note that less is more: Wikipedia is not a directory or changelog. Only important or major releases should be documented in Wikipedia. See the Manual of Style for Computing topics for further guidelines.",
	"format": "inline"
}
</templatedata>

== Limitations ==
* The current version of the template is known to fail creating correct cell contents when combined with the "colspan" keyword for table cell joining - except for the legend item.

== See also ==
* [[Template:Table cell templates]] – a family of related templates
* [[Template:Dts]] – used to correctly sort and display dates in a sortable table
* {{tl|Oldid}}

<includeonly>{{Sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Legend templates]]
[[Category:Table templates|{{PAGENAME}}]]
[[Category:Software templates]]
}}</includeonly>