Template:Version/doc

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 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 WikiProject Accessibility.)

When 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.

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 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.

Sortable tables
The template can be used in sortable tables. If the column version is sortable, the sort key defaults to the value of the version parameter. If you need differing sorting, add the sortKey parameter as follows:

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" }

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.