Help:Sortable tables: Difference between revisions

Content deleted Content added
Sorting tables by default: clarify further, I hope
note about mobile app problem
 
Line 1:
{{short description|Help with sorting of rows in tables}}
[[Help:Table|Tables]] can be made {{mlw|sorting||sortable}} via [[w:client-side JavaScript|client-side JavaScript]] with <code>class="sortable"</code>. This works in MediaWiki 1.9 and above, which is installed in all Wikimedia projects.
{{About||other uses|Help:Sorting}}
{{Table help}}
{{Wikipedia how to|WP:TABLESORT|WP:SORT}}
{{Wiki markup}}
{{TOC limit|3}}
 
{{hatnote|'''Note:''' Tables are sortable in mobile browsers, but not in the [[wikipedia mobile app|mobile app]]. See [[phab:T181452]].}}
A sortable table is identified by the arrows in each of its header cells. Clicking them will cause the table rows to sort based on the selected column, in ascending order first, and subsequently toggling between ascending and descending order. Links and other wiki-markup are not possible in headers.
 
== Creating sortable tables ==
Note that all of the below is subject to change due to improvements in the script.
[[File:Wikipedia VisualEditor Table Properties.png|thumb|The properties panel of a table in VisualEditor allows you to mark a table as sortable.]]
Tables can be made sortable via [[client-side JavaScript]] by adding <code>class="wikitable sortable"</code> to their top line. These tables need to be properly formatted, with the correct number of cells. Additionally, you need to make sure that the headers of your column are properly indicated in the [[Help:Wiki markup|wikitext]]. For this, the <code>!</code> character is used in the table syntax.
 
If you are using the [[Wikipedia:VisualEditor|Visual Editor]], you can open the properties dialog of a table and select the sortable option.
==JavaScript==
The JavaScript code [http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/skins/common/wikibits.js?view=log wikibits.js] has on each site a copy at
<nowiki>{{SERVER}}/skins-1.5/common/wikibits.js</nowiki>, on this site {{SERVER}}/skins-1.5/common/wikibits.js. In addition a site may have a page [[MediaWiki:Common.js]] which adds and overrides some code.
 
=== Simple example ===
==Sort modes==
This is the wikitext of the table [[Help:Sortable tables#Example|shown]] in the first section and shows the typical way to enable table sorting:
The sort modes (the [[w:data type|data type]]s, which, in addition to the choice "ascending" or "descending", determine the sorting order) are as follows; in the given order (as soon as there is a match, subsequent criteria are not applicable, e.g., 24-12-2007 is a date, not a number. For the criteria, tags (e.g. span, sup, sub) are ignored.
<syntaxhighlight lang="wikitext">
*date (see also below)
{| class="wikitable sortable"
**criterion: the first non-blank element is of the form "dd-dd-dddd", "dd-dd-dd", or "dd aaa dddd"
|-
**order: the string abcdefghij of length 10 is positioned as ghijdeab, the string abcdefghijk of length 8 as 19ghdeab if gh>=50 (string comparison) and 20ghdeab otherwise (i.e., the assumed format is DD-MM-YYYY or DD-MM-YY), and the string "dd aaa dddd" with aaa an abbreviated month name: chronologically
! name
*"currency" (this mode can be useful for other data also)
! data
**criterion: the first non-blank element starts with $, £, €, or ¥
! more data
**order: numeric, ignoring these symbols and all ordinary letters and commas, but not spaces; note that scientific notation cannot be used, as e and E are removed
|-
*numeric
| cats
**criterion: the first non-blank element consists of just digits, points, commas, spaces, "+", "-", possibly followed by "e" or "E" and a string consisting of "+", "-", digits
| 273
**order: if the string starts with a number (where spaces and nbsp's at the start are ignored) the order is numeric according to the first number in the string ([http://www.devguru.com/technologies/ecmascript/QuickRef/parsefloat.html parseFloat] is applied) after removing the commas, if any; if it does not (parseFloat returns [[w:NaN|NaN]]), the element is positioned like 0
| 53
:::''proposed internationalisation: in German etc., treat comma as a decimal point''
|-
*string
| dogs
**criterion: all other cases; to avoid one of the other modes, start e.g. with a hidden "&"; this can be done conveniently with {{tim|sms}}, which also allows more hidden text, as sortkey; while the similar templates above are called at the end of a table element, call this one at the start
| 65
**order: after conversion of capitals to lowercase the order is [[w:ASCII|ASCII]] - partial list showing the order: !"#$%&'()*+,-./09:;<=>?@[\]^_'az{|}~é&mdash; (see also below; a blank space comes before every other character; an [[w:Non-breaking space|nbsp]] code counts as a space; two adjacent ordinary blank spaces count as one; for multiple blank spaces one can use nbsps or alternate nbsps and ordinary blank spaces)
| 8,492
|-
| mice
| 1,649
| 548
|}
</syntaxhighlight>
The <code>!</code> indicates cells that are header cells. In order for a table to be sortable, the first row(s) of a table need to be entirely made up out of these header cells. You can learn more about the basic table syntax by taking the [[Help:Table/Introduction to tables|Introduction to tables]] for source editing.
 
=== Initial sort order of rows ===
The sort mode is determined by the table element that is ''currently'' in the first non-blank row below the header. In the case of different data types within one column (according to the criteria mentioned above) the sort mode may change after sorting, which can give a cycle of four or even more instead of two. This is confusing and gives undesired sorting orders, so that can better be avoided. However, it can be complicated to assess whether an element can ever be at the top after any sorting operations on the same and other columns, and this can also change after deleting a row, or adding a column. Therefore it is wise to make sure that every element matches the criterion for the required data type. Using a {{ml|Help:Table|Row_template|row template}} this can be done very conveniently.
 
When users are first presented with a table, the rows will always appear in the same order as in the wikitext. If you want a table to appear sorted by a certain column, you must sort the wikitext itself in that order. This is usually done for the first column. The VisualEditor makes it easy to move individual table columns and rows around. For info about that, and also about putting a table in initial alphabetical order see [[#initial alphabetical order|§ Initial alphabetical order]].
An alternative method of making sure the sort mode of each column is as desired, is creating a first row that determines the sort modes, but in such a way that this row is not displayed and is excluded from sorting, see below.
 
== Using sortable tables ==
==Examples==
When browsing Wikipedia you may encounter [[Help:Table|tables]] that have been made ''[[Help:Table#Sorting|sortable]]''. A sortable table is a type of table used to allow readers to sort its data by clicking on the header cells of columns. It is identifiable by the arrows in one or more of its header cells. Typically, readers can sort data in ascending or descending order based on the values in the selected column. The first click on the header cell will sort the column’s data in ascending order, a second click of the same arrow descending order, and a third click will restore the original order of the entire table. For example; a third click causes [[List of countries by intentional homicide rate]] to reset to its original order by subregion.
Text after a number (e.g. a footnote) does not affect the sorting order, if the sorting ''mode'' is numeric. However, if the number at the top has text after it, this makes the sorting mode alphabetic.
 
Sortable tables are particularly useful for organizing and navigating large sets of data. For example, you might have a table displaying names, dates, or numerical data. By making the table sortable, you allow readers to click on the column header to sort by, for example, alphabetical order (A–Z or Z–A) for names, chronological order for dates, or numerical order for numbers (low to high or high to low).
{|
 
|- style="vertical-align:top;"
The actual sorting process will happen on the computer-side using [[client-side JavaScript]]. For this reason, it is ''only'' possible to use this functionality if you have JavaScript enabled in your web browser. The sorting process is also dependent on your computer and the amount of data. Sorting a very large table on a low-performance computer may take a long time.
|
 
{|class="wikitable sortable"
=== Example ===
!numbers
This is an example of a small sortable table:
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Rendered result'''
{| class="wikitable sortable"
|-
! name
|123,456,789
! data
! more data
|-
| cats
|2,500,000,000
| 273
| 53
|-
| dogs
|300,000,000
| 65
| 8,492
|-
| mice
|3,000,000 abc
| 1,649
| 548
|}
</div>
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Wiki source'''
<syntaxhighlight lang="wikitext">
{| class="wikitable sortable"
|-
! name
|5,000,000
! data
! more data
|-
| cats
|2,000 def
| 273
| 53
|-
| -4,000dogs
| 65
| 8,492
|-
| aaamice
| 1,649
| 548
|}
</syntaxhighlight></div>
 
=== Tables with complex headers ===
 
Tables with more complex headers than before now sort correctly. For example:
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Rendered result'''
{| class="wikitable sortable"
|-
! rowspan=2 | name
| -9,999
! colspan=2 | data columns
|-
! data
|4,000
! more data
|-
| cats
|9,999
| 273
| 53
|-
| dogs
|800,000
| 65
| 8,492
|-
| mice
|900,000
| 1,649
| 548
|}
</div>
|
 
{|class="wikitable sortable"
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
!numbers
'''Wiki source'''
<syntaxhighlight lang="wikitext" highlight="3-4">
{| class="wikitable sortable"
|-
! rowspan=2 | name
|123 564,589.7e12
! colspan=2 | data columns
|-
! data
|9
! more data
|-
| -80cats
| 273
| 53
|-
|80 abc 5dogs
| 65
| 8,492
|-
|abc 80mice
| 1,649
| 548
|}
</syntaxhighlight></div>
 
Using two or more header rows, the sort arrows are placed on the bottom or lowest header row by default. They can be placed a maximum of one row higher than the lowest header row by setting <code>class="sorttop"</code> at the top of the bottom header row. For example:
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
{|
|-
|'''Default'''
{| class="wikitable sortable"
|-
! column 1
|70
! column 2
|-
! style="text-align:left;" | 3
|600
! style="text-align:left;" | 7
|-
| 1
| 3
|-
| 2
| 4
|}
<syntaxhighlight lang="wikitext" highlight="6-7">
|
{| class="wikitable sortable"
!first alphabetic, later also numeric mode
|-
! column 1
|123.4 ghi
! column 2
|-
! style="text-align:left;" | 3
|2,500,000,000
! style="text-align:left;" | 7
|-
| 1
|300,000,000
| 3
|-
| 2
|3,000,000 abc
| 4
|}
</syntaxhighlight>
|}
</div>
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
{|
|-
|'''Using <code>class="sorttop"</code>'''
{| class="wikitable sortable"
|-
! column 1
|5,000,000
! column 2
|- class="sorttop"
! style="text-align:left;" | 3
! style="text-align:left;" | 7
|-
| 1
|2,000 def
| 3
|-
| 2
|4,000
| 4
|}
<syntaxhighlight lang="wikitext" highlight="5-7">
{| class="wikitable sortable"
|-
! column 1
|9,999
! column 2
|- class="sorttop"
! style="text-align:left;" | 3
! style="text-align:left;" | 7
|-
| 1
|800,000
| 3
|-
| 2
|900,000
| 4
|}
</syntaxhighlight>
|}
</div>
 
=== Tables with merged data rows ===
{|
{{Anchor|Tables with complex data rows}}
|- style="vertical-align:top;"
{{Further|Help:Tables#Colspan and rowspan|Wikipedia:Manual of Style/Accessibility/Data tables tutorial#Complex tables}}
|
:
{|class="wikitable sortable"
It is possible to create tables with cells that stretch over two or more columns or rows (also known as merged cells). For columns, one uses <code>|colspan=<var>n</var> | <var>content</var></code>, whereas for rows, one uses <code>|rowspan=<var>m</var> | <var>content</var></code>. In the table code, one must ''leave out the cells that are covered by such a span''. The resulting column- and row-counting must fit. Tables can have cells spanning multiple rows, using <code>|rowspan=''n''</code>.
!currencies
 
The number of rows must be indicated with each use of rowspan. Before any sorting can be done, the rowspan setup must be correct. The wikitext must be correct. An incorrect rowspan organization can break sorting, cause weird table formatting, move data to the wrong column, etc.
 
See examples below.
 
When sorted all the rows are filled. Tables without rowspan are much easier to maintain by less experienced editors, and by editors who are stopping by only once to edit the table.
 
Correct rowspan numbers and wikitext, with sorting in working order:
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Rendered result'''
{| class="wikitable sortable"
|-
! name
|$ 9
! data
! year
|-
|$ 80cats
| 273
| 2013
|-
|$ 70dogs
| 65
| rowspan=2 | 2014
|-
|$ 600mice
| 1,649
<!--column 3 spanned by cell "2014"-->
|}
</div>
|
 
{|class="wikitable sortable"
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
!currencies
'''Wiki source'''
<syntaxhighlight lang="wikitext" line highlight="13,17">
{| class="wikitable sortable"
|-
! name
|€ 9
! data
! year
|-
| 80cats
| 273
| 2013
|-
| 70dogs
| 65
| rowspan=2 | 2014
|-
| 600mice
| 1,649
<!--column 3 spanned by cell "2014"-->
|}
</syntaxhighlight></div>
|
 
{|class="wikitable sortable"
Note that, after sorting, the rowspanning cells are cut into rows and their content is repeated (the year "2014" in the example). If the original order of a table is restored by clicking a third time on the same arrow, then the cells will remain repeated and not revert to the original rowspan.
!currencies
 
See example below. The wikitext is incorrect. Line 17 should not exist. Compare to correct table above. Result in this case is an added empty column.
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Rendered result'''
{| class="wikitable sortable"
|-
! name
|£ 9
! data
! year
|-
|£ 80cats
| 273
| 2013
|-
|£ 70dogs
| 65
| rowspan=2 | 2014
|-
|£ 600mice
| 1,649
|
|}
</div>
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Wiki source'''
<syntaxhighlight lang="wikitext" line highlight="17">
{| class="wikitable sortable"
|-
! name
! data
! year
|-
| cats
| 273
| 2013
|-
| dogs
| 65
| rowspan=2 | 2014
|-
| mice
| 1,649
|
|}
</syntaxhighlight></div>
 
==== Online table editors and rowspan ====
 
There is an easy online wiki table editor here:
* [http://wikitable.eu5.org wikitable.eu5.org]
 
It makes it easy to edit the text and links in individual cells of a table. It is especially easy when there are no rowspans in the body of a table. See the [[Help:Sortable tables#Previous section|previous section]]. Without rowspans it is easier to change the underlying framework of a table, and move stuff around. Once the wikitext framework is simpler, the online table editor is simpler too, because you do not have to edit the wikitext as much in order to edit the table.
 
=== Secondary key and multi-key sorting ===
When a column contains repeated values, sorting the column should maintain the original order of rows within each subset that shares the same value. This is known as [[Stable sorting|''stable sorting'']]. As a result, multi-key sorting (sorting by primary, secondary, tertiary keys, etc.) can be achieved by sorting the least significant key first and the most significant key last. For example, to sort the table by the "Text" column and then by the "Numbers" column, you would first click on and sort by the "Numbers" column, the ''secondary key'', and then click on and sort by the "Text" column, ''primary key''.
 
Another method for multi-key sorting is to hold down the {{Key press|shift}} key while clicking on column headings. For instance, to sort by the "Text" column followed by the “Numbers" column, you would first click on the “Text” column heading (primary key), then hold down the {{Key press|shift}} key and click on the “Numbers" column heading (secondary key).
 
There can be a problem with sorting if the [[User:Endo999/GoogleTrans|Google translation gadget]] (see [[User talk:Endo999/GoogleTrans#Interference with secondary sorting in tables|discussion]]) is enabled in {{Myprefs|Gadgets|uncheck=GoogleTrans}}. It may seem like shift-click secondary sorting is not working because of the delay due to the translation popup for the name in the column head. The gadget can be turned on and off quickly, once enabled in preferences, from the "Tools" menu at the upper right of any page. There are many browser translation addons (such as Simple Translate for [https://addons.mozilla.org/en-US/firefox/addon/simple-translate Firefox], [https://microsoftedge.microsoft.com/addons/detail/simple-translate/cllnohpbfenopiakdcjmjcbaeapmkcdl Chrome], and [https://chrome.google.com/webstore/detail/simple-translate/ibplnjkanclpjokhdolnendpplpjiace Edge]) that work as well or better than the gadget.
{|class="wikitable sortable"
!Numbers!!Text!!More text
!currencies
|-
|4||a||row 1
|¥ 9
|-
|5||a||row 2
|¥ 80
|-
|1||b||row 3
|¥ 70
|-
|1||a||row 4
|-
|2||x||row 5
|-
|2||a||row 6
|-
|3||a||row 7
|-
|3||z||row 8
|-
|3||z||row 9
|-
|3||z||row 10
|-
|3||z||row 11
|-
|25||z||row 12
|-class=sortbottom
!Bottom!!!!
|-
|¥ 600
|}
 
|
== Optimising tables for a narrow display ==
{|class="wikitable sortable"
 
!comparison
=== Vertical headers ===
 
{{See|Template:Vert header}}
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Rendered result'''
{| class="wikitable sortable"
|-
! {{vert header|stp=1|name}}
|a 9
! {{vert header|stp=1|data}}
! {{vert header|stp=1|more data}}
! {{vert header|stp=1|another column}}
|-
|a 80cats
| 273
| 53
| 1
|-
|a 70dogs
| 65
| 8,492
| 2
|-
|a 600mice
| 1,649
| 548
| 3
|}
</div>
|
 
{|class="wikitable sortable"
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
!comparison
'''Wiki source'''
<syntaxhighlight lang="wikitext" highlight="3-6">
{| class="wikitable sortable"
|-
! {{vert header|stp=1|name}}
|e 9
! {{vert header|stp=1|data}}
! {{vert header|stp=1|more data}}
! {{vert header|stp=1|another column}}
|-
|e 80cats
| 273
| 53
| 1
|-
|e 70dogs
| 65
| 8,492
| 2
|-
|e 600mice
| 1,649
|}
| 548
| 3
|}
</syntaxhighlight></div>
 
{{Tl|vertical header}} also works with headers that span rows or columns (using <code>rowspan</code> and col<code>span</code>). '''Note''' that there is no vertical bar <code>|</code> between <code>rowspan=2</code> and <code><nowiki>{{vertical header}}</nowiki></code>
The example with "a" gives alphabetic sorting; that with "e" ditto, the data are not mistaken for numbers in scientific format.
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
{|
'''Rendered result'''
|- style="vertical-align:top;"
{| class="wikitable sortable"
|
{|class="wikitable sortable"
!mixed notations
|-
! rowspan=2 {{vert header|stp=1|name}}
| {{#expr:1000000000000000000/7}}
! colspan=2 {{vert header|data columns}}
! rowspan=2 {{vert header|stp=1|another column}}
|-
! {{vert header|stp=1|data}}
| 1000000000000000000
! {{vert header|stp=1|more data}}
|-
| cats
| -1000000000000000000
| 273
| 53
| 1
|-
| dogs
| .0000000000000000001
| 65
| 8,492
| 2
|-
| mice
| -.0000000000000000001
| 1,649
| 548
| 3
|}
</div>
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Wiki source'''
<syntaxhighlight lang="wikitext" highlight="3-5,7-8">
{| class="wikitable sortable"
|-
! rowspan=2 {{vert header|stp=1|name}}
| {{#expr:-1000000000000000000/7}}
! colspan=2 {{vert header|data columns}}
! rowspan=2 {{vert header|stp=1|another column}}
|-
! {{vert header|stp=1|data}}
| {{#expr:.000000000001/7}}
! {{vert header|stp=1|more data}}
|-
| cats
| {{#expr:-.000000000001/7}}
| 273
| 53
| 1
|-
| dogs
|89 123 456 788
| 65
| 8,492
| 2
|-
| mice
|89,123,456,789
| 1,649
| 548
| 3
|}
</syntaxhighlight>
</div>
 
== Sort under template ==
{{Tracked|T35249}}
{{t|sort under}} can be used to make the sorting arrows appear underneath the header text, which may be desirable to narrow the width of a column.
 
{{sort under}}
{| class="wikitable sortable sort-under"
|-
! rowspan=2 | name
|333
! colspan=2 | data columns
|-
! data
|1e10
! more data
|-
|e 9
|-
|e 80cats
| 273
| 53
|-
|e 70dogs
| 65
| 8,492
|-
|e 600mice
| 1,649
| 548
|}
 
== Restrictions and exclusions ==
 
Tables can only be sorted vertically by clicking on the column headers (topmost cells). When a column header is clicked, the rows of the table reorder themselves in an up-and-down manner, based on the values in that column. However, there is no functionality to sort columns horizontally by clicking on a cell in the leftmost row. Thus, the table columns will not rearrange themselves left-to-right based on their data, as sorting horizontally is not supported in typical sortable table implementations.
 
=== Making selected columns unsortable ===
 
If you want a specific column not to be sortable, specify <code>class=unsortable</code> in the attributes of its header cell. If you have a sorting row then <code>class=unsortable</code> must be in the header cell with the sorting icon.
 
(When using {{tl|vert header}}, disable column sorting by omitting <code>|stp=1</code> in that template, which overrides anything placed before it.)
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Wiki source'''
<syntaxhighlight lang="wikitext" highlight="2">
{|class="wikitable sortable"
!Numbers!! class="unsortable" |Unsortable
|-
|1||This
|999e9
|-
|2||Column
|88e80
|-
|3||Is
|7e270
|-
|4||Unsortable
|999e-9
|-
|5||See?
|88e-80
|-
!Total: 15!!
|7e-270
|}
</syntaxhighlight>
</div>
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Rendered result''' {{anchor|Sortable looks}}
{|class="wikitable sortable"
!Numbers!! class="unsortable" |Unsortable
|-
|1||This
| -999e9
|-
|2||Column
| −999e9
|-
|3||Is
| -88e80
|-
|4||Unsortable
| -7e270
|-
|5||See?
| -999e-9
|-
!Total: 15!!
| -88e-80
|}
</div>
 
=== Excluding final rows from sorting ===
 
Sometimes it is helpful to exclude the last row of a table from the sorting process. There are two methods to achieve this.
 
==== Header as a footer ====
You want a repeat of the header at the bottom. You do this by using the <code>!</code> (exclamation mark) syntax for all cells in the last row of the table. This will be recognized as a footer and the row will not be part of the sorting. This footer makes it a complex table, and so scopes help accessibility via [[screen readers]].
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Wiki source'''
<syntaxhighlight lang="wikitext" highlight="20-22">
{|class="wikitable sortable"
|+ Header as footer example
|-
!scope=col| Name
| -7e-270
!scope=col| Surname
!scope=col| Height
|-
!scope=row| John
|e3
| Smith
| 1.85
|-
!scope=row| Ron
| -e3
| Ray
| 1.89
|-
!scope=row| Mario
|1e3
| Bianchi
| 1.72
|-
!scope=col| Name
|e9
!scope=col| Surname
!scope=col| Height
|}
</syntaxhighlight>
</div>
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Rendered result'''
{|class="wikitable sortable"
|+ Header as footer example
|-
!scope=col| Name
|e80
!scope=col| Surname
!scope=col| Height
|-
!scope=row| John
|e270
| Smith
| 1.85
|-
!scope=row| Ron
|6e11
| Ray
| 1.89
|-
!scope=row| Mario
|8e11
| Bianchi
| 1.72
|-
!scope=col| Name
!scope=col| Surname
!scope=col| Height
|}
</div>
|
 
This applies to all rows at the end of the table that are consecutive and fully made up out of header cells. Those rows will not sort.
 
==== Summation footer ====
This can be achieved using <code>class=sortbottom</code> on the desired table row (line starting with <code>|-</code>).
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Wiki source'''
<syntaxhighlight lang="wikitext" highlight="19-20">
{|class="wikitable sortable"
|+ Summation footer example
!first number in each element counts
|-
!scope=col| Name
|7-4
!scope=col| Surname
!scope=col| Height
|-
!scope=row| John
|2
| Smith
| 1.85
|-
!scope=row| Ron
|4
| Ray
| 1.89
|-
!scope=row| Mario
|22/7
| Bianchi
|-
| 1.72
|111
|- class=sortbottom
!scope=row colspan=2 | Average:||1.82
|}
</syntaxhighlight>
|
</div>
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Rendered result'''
{|class="wikitable sortable"
|+ Summation footer example
!percentage
|-
!scope=col| Name
|7%
!scope=col| Surname
!scope=col| Height
|-
!scope=row| John
|2
| Smith
| 1.85
|-
!scope=row| Ron
|4
| Ray
| 1.89
|-
!scope=row| Mario
|22
| Bianchi
| 1.72
|- class=sortbottom
!scope=row colspan=2 | Average:
| 1.82
|}
</div>
This is a complex table due to the "Average" cell spanning 2 columns. "Average" is also the row heading for the last row. Using the <code>!</code> (exclamation mark) syntax with <code>scope=row</code> causes the correct header HTML to be generated, which aids in [[WP:ACCESS|accessibility]], e.g., for those using screen readers.
 
It is possible to keep multiple lines fixed at the bottom, as long as the lines are consecutive.
 
If the "sortbottom" rows are not consecutive, then when the original order of a table is restored by clicking a third time on the same arrow then rows with <code>class=sortbottom</code> will remain at the bottom even if they were not originally at the bottom.
 
=== Excluding top rows from sorting ===
 
This can be achieved using <code>class="sorttop"</code> on the desired table row (line starting with <code>|-</code>). It is possible to keep multiple lines fixed at the top, as long as the lines are consecutive.
 
Table below is an adapted excerpt from [[List of U.S. states and territories by poverty rate]]. '''Sorttop''' is used on the US data row. And the US row is excluded from having a static row number. Note that the "Area" flag links can't be made bold the normal way. But the whole row can be made bold like this:
 
<syntaxhighlight lang=wikitext highlight=1>
|- class="sorttop static-row-numbers-norank" style="font-weight:bold;"
| {{flagg|uspeft|pref=Economy of|United States}}
| 12.5 || 0.1 || 40,763,043 || 277,214
</syntaxhighlight>
 
{{mw-datatable}}{{table alignment}}{{static row numbers}}{{sticky header}}
{| class="wikitable sortable sticky-header mw-datatable col1left static-row-numbers" style=text-align:right;
|+ Number and percentage of people in poverty by state, D.C., and Puerto Rico. Plus margin of error. 2023.
! Area !! Percent !! Error (±) !! Number !! Error (±)
|- class="sorttop static-row-numbers-norank" style="font-weight:bold;"
| {{flagg|uspeft|pref=Economy of|United States}}
| 12.5 || 0.1 || 40,763,043 || 277,214
|-
| {{flagg|uspeft|pref=Economy of|Puerto Rico}}
|111
| 39.6 || 0.8 || 1,257,607 || 26,856
|-
| {{flagg|uspeft|pref=Economy of|Louisiana}}
| 18.9 || 0.6 || 840,146 || 27,162
|-
| {{flagg|uspeft|pref=Economy of|Mississippi}}
| 18.0 || 0.8 || 512,184 || 21,949
|}
 
|
Note that sorttop can't be used with multi-header rows in tables using {{tl|sticky table start}}. Single-row headers are not a problem.
{|class="wikitable sortable"
 
!mixed notations
== Configuring the sorting ==
By default, the system tries to guess the data type in each column. It does this by looking at the first five rows and evaluating their contents. This process works most of the time but can also easily get confused if you have inconsistent values or additional specifiers that the system doesn't know about. To avoid this ambiguity you can force a particular data type or override the value of a cell. For numeric values, consider using template {{Tl|Val}}, see examples at {{Section link|Template:Val|Sorting}}.
 
== Forcing a column to have a particular data type ==
{{See|mediawikiwiki:Help:Sortable tables#Forcing the sort mode of a column}}
 
The <code>data-sort-type="..."</code> attribute can be added inside the header of a column to ensure that the cells underneath are ''all'' treated as a specified type of data. {{A note|It must go in the header cell with the sorting icon}}. It will not work in a header cell without a sorting icon. For example; when there are two rows of headers, the bottom row will always have the sorting icons, as explained previously. If there are problems sorting a column, forcing a particular data type often helps. Be specific. If the column is currency, force that data type, not number.
 
The following (case-insensitive) values are valid for <code>data-sort-type</code>:
* <code>text</code>
* <code>number</code>
* <code>currency</code>
* <code>url</code> for website addresses
* <code>IPAddress</code> for numeric [[IP address|internet protocol addresses]]
* <code>date</code> for language specific standard date format
* <code>isoDate</code> for dates in [[ISO 8601]] format (i.e. YYYY-MM-DD)
* <code>usLongDate</code> for dates in the US format of month day, year. Must have all 3 to work.
* <code>time</code>
 
=== data-sort-type=text ===
 
<code>data-sort-type=text</code> uses alphabetical sorting of text, but numbers are sorted numerically within that alphabetical sorting. See [[natural sort order]].
 
For example:
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
{| class="wikitable"
|-
! Without any <code>data-sort-type</code>
| 14
|-
| <syntaxhighlight lang="wikitext">
| -14
{| class="wikitable sortable"
|-
! Album
| 11
|-
... etc ...
| -12 (retrograde)
|}
</syntaxhighlight>
{| class="wikitable sortable"
|-
! Album
| 12 or 13
|-
| ''[[21 (Adele album)|21]]''
| 12 (?)
|-
| ''[[19 (Adele album)|193]]''
| ca. 12
|-
| ''[[21 (Adele album)|215]]''
| 12 (approx.)
|-
| ''[[21 (Adele album)|21]]''
| ?
|-
| ''[[19 (Adele album)|19]]''
|-
| ''[[21 (Adele album)|21]]''
|-
| ''[[Matinée (album)|Matinée]]''
|-
| ''[[21 (Adele album)|21]]''
|-
| ''[[19 (Adele album)|19]]''
|-
| ''[[Everything Is New]]''
|-
| ''[[Love & War (Daniel Merriweather album)|Love & War]]''
|}
|}
</div>
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
The first example demonstrates that text is positioned at zero, and that e.g. e3 for 1000 is not allowed; use 1e3 instead. It also shows that "-" should be used, not "−".
{| class="wikitable"
|-
!With <code>data-sort-type=text</code>
|-
| <syntaxhighlight lang="wikitext" highlight="3">
{| class="wikitable sortable"
|-
! data-sort-type=text | Album
|-
... etc ...
|}
</syntaxhighlight>
{| class="wikitable sortable"
|-
! data-sort-type=text | Album
|-
| ''[[21 (Adele album)|21]]''
|-
| ''[[19 (Adele album)|193]]''
|-
| ''[[21 (Adele album)|215]]''
|-
| ''[[21 (Adele album)|21]]''
|-
| ''[[19 (Adele album)|19]]''
|-
| ''[[21 (Adele album)|21]]''
|-
| ''[[Matinée (album)|Matinée]]''
|-
| ''[[21 (Adele album)|21]]''
|-
| ''[[19 (Adele album)|19]]''
|-
| ''[[Everything Is New]]''
|-
| ''[[Love & War (Daniel Merriweather album)|Love & War]]''
|}
|}
</div>
 
Without <code>data-sort-type=text</code> in the header, the tablesorter gets confused by the numeric titles in the first few rows into treating the entire column as numeric. This results in it wrongly sorting the non-numeric titles as zero regardless of the alphabetical ordering of their text.
The second example shows that expressions are not sorted according to their evaluated value, but according to the first number.
 
Note that if a column without declared sort-type contains only numeric values within the first top five cells, ''but with a reference'' <code><nowiki><ref>...</ref></nowiki></code> immediately after the last digit of at least one number in those first five cells, this may cause the column to be sorted as text. This can be avoided by declaring a different sort type such as: <code>data-sort-type=number</code>
The third example shows that a percentage is accepted for numeric sorting mode, but ignored in the actual sorting, so if a column contains percentages, ''all'' numbers have to be written as a percentage.
 
=== Default data type of a column ===
The fourth example shows again that "ca. 12" sorts at 0, as opposed to 12 with some text after it, which sorts at 12. In case such an element arrives at the top of a column, it causes alphabetic sorting mode.
If you do not specify a <code>data-sort-type</code>, the sort modes (the [[data type]]s, which, in addition to the choice "ascending" or "descending", determine the sorting order) are as follows:
; date (see also below)
:* criterion: the first non-blank element is of the form "DD-MM-YYYY", "DD-MM-YY", or "DD mmm YYYY"
:* order: numeric value of YYYYMMDD; The string DDsMMsYYYY of length 10 (if characters positioned at s are equal together and are either '/' or '-' separator) is positioned as YYYYMMDD, the string DDsMMsYY of length 8 (if characters positioned at s are equal together and are either '/' or '-' separator) as 19YYMMDD if YY >= 50 and 20YYMMDD otherwise, and the string "DD mmm YYYY" with mmm an (abbreviated) month name.
; isoDate (ISO 8601)
:* criterion: format "±YYYY-MM-DD", with 1-4 digits for year "YYYY" from -9999 to 9999, month only with digits, format "±YYYY-MM-DDThh:mm:ss.sss±TH:TM" with time hour "hh", minutes "mm", seconds "ss.sss", and time zone offset "TH:TM, right values are optional.
:* order: numeric, with time in milliseconds after 01 January, 1970 UTC.
; currency (this mode can be useful for other data also)
:* criterion: the first non-blank element starts with $, £, €, or ¥
:* order: numeric, ignoring these symbols and all ordinary letters and commas, but not spaces; note that scientific notation cannot be used, as e and E are removed
:* Note: Force this if column is currency. Otherwise, no sorting at all may occur.
; number
:* criterion: the first non-blank element consists of just digits, points, commas, spaces, "+", "-", possibly followed by "e" or "E" and a string consisting of "+", "-", digits
:* order: after removing the commas and spaces, if any, if the string starts with a number the order is numeric according to the first number in the string ([https://web.archive.org/20121226161834/www.devguru.com/technologies/ecmascript/QuickRef/parsefloat.html parseFloat] is applied); it is regarded as zero if it is empty; in other cases (parseFloat returns [[w:NaN|NaN]]), the element is positioned like -∞.
; string
:* criterion: all other cases;
:* order: uses locale specific (so in this case English) ordering if your browser supports it. Alternatively after conversion of capitals to lowercase the order is [[w:ASCII|ASCII]] – partial list showing the order: !"#$%&'()*+,-./09:;<=>?@[\]^_'az{|}~é— (see also below; a blank space comes before every other character; a [[non-breaking space]] code <code>&amp;nbsp;</code> counts as a space; two adjacent ordinary blank spaces count as one; for multiple blank spaces one can use <code>&amp;nbsp;</code> or alternate <code>&amp;nbsp;</code> and ordinary blank spaces)
 
If more than one possible type matches, the first type in the above order is chosen. For example, "24-12-2007" matches as a date, so is not treated as a number. Formatting and markup tags are ignored when determining the matching type.
== Additional features ==
 
The sort mode is determined by the first 5 non-blank rows below the header after loading the page. This can also change after deleting a row, or adding a column. Therefore, it is wise to make sure that every element matches the criterion for the required data type. Using a [[Help:Table#Row template|row template]] this can be done very conveniently.
=== Excluding the last row from sorting ===
 
The method of making sure the sort mode of each column is as desired, is specify a <code>data-sort-type</code>, see [[#Forcing a column to have a particular data type|above]].
Sometimes it is helpful to exclude the last row of a table from the sorting process.
 
== Specifying a sort key for a cell ==
Sometimes the value of a cell is not correctly parsed or one wants to sort the row in a special way. (e.g. a cell containing 'John Doe' should actually be sorted as 'Doe' and not as 'John'). This can be easily achieved by using {{tlx|sortname}}, like this:
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Wiki source'''
{|
|-
|
<nowiki />{|class="wikitable sortable"
<nowiki />!Name and surname!!Height
<nowiki />|-
<nowiki />|<nowiki>{{sortname|John|Smith|nolink=1}}</nowiki>||1.85
<nowiki />|-
<nowiki />|<nowiki>{{sortname|Ian|Ray|nolink=1}}</nowiki>||1.89
<nowiki />|-
<nowiki />|<nowiki>{{sortname|Zachary|Bianchi|nolink=1}}</nowiki>||1.72
<nowiki />|-
<nowiki />!Average:||1.82
<nowiki />|}
|}
</div>
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Rendered result'''
{|class="wikitable sortable"
!Name and surname!!Height
|-
|{{sortname|John|Smith|nolink=1}}||1.85
|-
|{{sortname|Ian|Ray|nolink=1}}||1.89
|-
|{{sortname|Zachary|Bianchi|nolink=1}}||1.72
|-
!Average:||1.82
|}
</div>
 
Alternatively, you can set the <code>data-sort-value</code> attribute:
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Wiki source'''
{|
|-
|
<nowiki />{|class="wikitable sortable"
<nowiki />!Name and surname!!Height
<nowiki />|-
<nowiki />|<b style="color:red">data-sort-value="Smith, John"</b>|John Smith||1.85
<nowiki />|-
<nowiki />|<b style="color:red">data-sort-value="Ray, Ian"</b>|Ian Ray||1.89
<nowiki />|-
<nowiki />|<b style="color:red">data-sort-value="Bianchi, Zachary"</b>|Zachary Bianchi||1.72
<nowiki />|-
<nowiki />!Average:||1.82
<nowiki />|}
|}
</div>
 
For example, this is handy to sort military ranks in rank-seniority order:
This can be achieved using <code>class="sortbottom"</code> on the desired table row (line starting with <code>|-</code>).
 
'''Wiki markup'''
 
<nowiki>{|</nowiki>class="wikitable sortable"</nowiki>
!Name and surname!!Rank
<nowiki>!</nowiki>Name!!Surname!!Height
|-
<nowiki>|-</nowiki>
|<b style="color:red">data-sort-value="Smith, John"</b>|John Smith||<b style="color:blue">data-sort-value="16"</b>|<nowiki>[[Corporal|Cpl]]</nowiki>
<nowiki>|</nowiki>John||Smith||1.85
|-
<nowiki>|-</nowiki>
|<b style="color:red">data-sort-value="Ray, Ian"</b>|Ian Ray||<b style="color:blue">data-sort-value="8"</b>|<nowiki>[[Captain (OF-2)|Capt]]</nowiki>
<nowiki>|</nowiki>Ron||Ray||1.89
|-
<nowiki>|-</nowiki>
|<b style="color:red">data-sort-value="Bianchi, Zachary"</b>|Zachary Bianchi||<b style="color:blue">data-sort-value="10"</b>|<nowiki>[[2nd Lieutenant|2 Lt]]</nowiki>
<nowiki>|</nowiki>Mario||Bianchi||1.72
|}
<nowiki>|-</nowiki><b style="color:red">class="sortbottom"</b>
<nowiki>|</nowiki>||Average:||1.82
<nowiki>|}</nowiki>
 
This gives:
'''What it looks like in your browser'''
 
{|class="wikitable sortable"
!Name and surname!!Surname!!HeightRank
|-
|data-sort-value="Smith, John"|John Smith||data-sort-value="16"|[[Corporal|Cpl]]
|John||Smith||1.85
|-
|data-sort-value="Ray, Ian"|Ian Ray||data-sort-value="8"|[[Captain (OF-2)|Capt]]
|Ron||Ray||1.89
|-
|data-sort-value="Bianchi, Zachary"|Zachary Bianchi||data-sort-value="10"|[[2nd Lieutenant|2 Lt]]
|-
|Mario||Bianchi||1.72
|-class="sortbottom"
|||Average:||1.82
|}
 
See also [[mw:Help:Sorting#Specifying a sort key]].
More generally, one or more lines at the bottom marked with <code>class="sortbottom"</code> are sorted among themselves, but stay at the bottom. Thus it is not possible to keep multiple lines fixed at the bottom:
 
'''If you have a list where all the entries start with quotes ("),''' and you want to set a sort key for one of the entries, then you will need to use the [http://www.ascii.cl/htmlcodes.htm HTML name or number] for quotes at the beginning of that sort key (see also {{section link|List of XML and HTML character entity references|Character entity references in HTML}}). Lists of song titles for example sometimes have each song title in quotes. So to sort by a particular word in a song title use one of these:
 
<code style="font-weight:bold;">data-sort-value="&amp;quot;WORD"</code>
 
<code style="font-weight:bold;">data-sort-value="&amp;#34;WORD"</code>
 
=== Keeping some rows together ===
<code>data-sort-value</code> can be used to keep certain rows together. The specified order of these rows is preserved. An example is to keep "South Holland" immediately after "Netherlands", whatever the sort order or column:
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Rendered result'''
{|class="wikitable sortable"
!Country/province !!Capital
|+''Using more than one "sortbottom", failing to keep these lines fixed''
!Name!!Surname!!Height
|-
|France ||Paris
|John||Smith||1.85
|-
|Netherlands ||Amsterdam
|Ron||Ray||1.89
|-
|-class="sortbottom"
|data-sort-value=Netherlands |South Holland ||data-sort-value=Amsterdam |The Hague
|||Average:||1.82
|-
|-class="sortbottom"
|Poland ||Warsaw
!Name!!Surname!!Height
|-
|UK||London
|}
</div>
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
==== Excluding the first row from sorting ====
'''Wiki source'''
{{unclear}}
<syntaxhighlight lang="wikitext" highlight="8">
As follows from what was mentioned above, the first row of a table can be made non-sortable (the code <code><s>class="sorttop"</s></code> not being valid) by marking every other row except the first with <code>class="sortbottom"</code>. This first row can either be a normal visible row (to provide annotation for the headers) or a hidden row (with each element marked with <code><nowiki><span style="display:none">...</span></nowiki></code>) to ensure that each column has the desired sort mode.
{|class="wikitable sortable"
!Country/province !!Capital
|-
|France ||Paris
|-
|Netherlands ||Amsterdam
|-
|data-sort-value=Netherlands |South Holland ||data-sort-value=Amsterdam |The Hague
|-
|UK||London
|}
</syntaxhighlight></div>
 
If you have rows that contain colspans, this might become a little difficult. You can also use the <code>class="expand-child"</code> on a row; it will then always be below the row just above it in the table source, wherever that row may be sorted in the table.
=== Making a column unsortable ===
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
If you want a specific column not to be sortable, specify <code>class="unsortable"</code> in the attributes of its header cell.
'''Rendered result'''
{| class="wikitable sortable"
!style="width:9.3em" |Country !!Capital
|-
|'''France'''
|Paris
|- class="expand-child"
| colspan="2" | In Paris is the Eiffel Tower.
|-
|'''UK'''
|London
|- class="expand-child"
| colspan="2" | In the U.K. you cannot pay with euros,
|- class="expand-child"
| colspan="2" | and you drive on the left.
|-
|'''Germany'''
|Berlin
|- class="expand-child"
|colspan="2" | Germany includes the former DDR.
|}
</div>
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Wiki markup'''
'''Wiki source'''
<syntaxhighlight lang="wikitext" highlight="6,11,13,18">
{| class="wikitable sortable"
!style="width:9.3em" |Country !!Capital
|-
|'''France'''
|Paris
|- class="expand-child"
| colspan="2" | In Paris is the Eiffel Tower.
|-
|'''UK'''
|London
|- class="expand-child"
| colspan="2" | In the U.K. you cannot pay with euros,
|- class="expand-child"
| colspan="2" | and you drive on the left.
|-
|'''Germany'''
|Berlin
|- class="expand-child"
|colspan="2" | Germany includes the former DDR.
|}
</syntaxhighlight></div>
 
== Examples of datatype auto detection. First 5 cells in a column ==
<nowiki>{|</nowiki>class="wikitable sortable"
The script sees what the first 5 cells in a column contain. The sorting mode becomes '''numeric''' if the first 5 cells contain <u>a number only</u> (comma and period used in number formatting are accepted as number). The numeric sorting order is maintained even when text is found in the cells that follow the 5th cell. 123,564,589.7e12 is in [[scientific notation]] and is treated as a number. An empty cell is treated as a non-number when sorting numerically. There is an empty cell initially at the bottom of each of the 2 tables just below.
<nowiki>!</nowiki>Numbers!!Alphabet!!Dates!!Currency!!<b style="color:red">class="unsortable"|</b>Unsortable
<nowiki>|-</nowiki>
<nowiki>|</nowiki>1||Z||02-02-2004||5.00||This
<nowiki>|-</nowiki>
<nowiki>|</nowiki>2||y||13-apr-2005||||Column
<nowiki>|-</nowiki>
<nowiki>|</nowiki>3||X||17.aug.2006||6.50||Is
<nowiki>|-</nowiki>
<nowiki>|</nowiki>4||w||01.Jan.2005||4.20||Unsortable
<nowiki>|-</nowiki>
<nowiki>|</nowiki>5||V||05/12/2006||7.15||See?
<nowiki>|-</nowiki>class="sortbottom"
<nowiki>!</nowiki>Total: 15!!!!!!Total: 29.55!!
<nowiki>|-</nowiki>
<nowiki>|}</nowiki>
 
'''Datatype auto detection is inconsistent.''' It is '''always better to add''' a '''<code>data-sort-type</code>''' to the '''column header.'''
'''What it looks like in your browser'''
 
<div style="display:inline-table; vertical-align:top;">
{|class="wikitable sortable"
{| class="wikitable sortable"
!Numbers!!Alphabet!!Dates!!Currency!!class="unsortable"|Unsortable
! Sort order<br>auto-detected<br>as text
|-
| 123,564,589.7e12
|1||Z||02-02-2004||5.00||This
|-
| 9
|2||y||13-apr-2005||||Column
|-
| 70
|3||X||17.aug.2006||6.50||Is
|-
| 80 <span style="color:red">approx</span>
|-
| -80
|-
| abc 80
|-
| aaa
|-
| 600
|4||w||01.Jan.2005||4.20||Unsortable
|-
| 300,000,000
|5||V||05/12/2006||7.15||See?
|-class="sortbottom"
!Total: 15!!!!!!Total: 29.55!![http://www.joostdevalk.nl/code/sortable-table/ Original example]
|-
| 3,000,000
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
=== Striping ===
{| class="wikitable sortable"
The JavaScript that makes tables sortable adds <code>.odd</code> and <code>.even</code> classes to the rows of the resulting table. If a [[w:Wikipedia:Catalogue of CSS classes|cascading style sheet]] specifies that text be displayed differently in these two classes, alternating rows in the resulting table will appear differently. For example, including the following code in a style sheet causes ''every'' sortable table to have silver and gold background stripes:
! Sort order<br>auto-detected<br>as number
<pre>
|-
tr.odd {
| 123,564,589.7e12
background-color: silver;
|-
}
| 9
tr.even {
|-
background-color: gold;
| 70
}
|-
</pre>
| -80
|-
| 600
|-
| 80 <span style="color:red">approx</span>
|-
| abc 80
|-
| aaa
|-
| 300,000,000
|-
| 3,000,000
|}
</div>
 
Single currency character, or single alphabetic character, does not currently change what the script determines via the first 5 cells in a column: '''Numerical order.'''
It is also possible to define an <code>id</code> in a CSS that causes only tables with that <code>id</code> to be striped, for example:
<pre>
#stripe tr.odd {
background-color: silver;
}
#stripe tr.even {
background-color: gold;
}
</pre>
In this case, only tables with <code>class="sortable"</code> ''and'' <code>id="stripe"</code> would display with alternating row colors.
 
<div style="display:inline-table; vertical-align:top;">
If a user sorts the table according to a different column, the stripes still alternate. I.e., the stripes are specific to the positions of the rows in the sorted table, not to the positions of the rows in the wikitext.
{| class="wikitable sortable"
! currencies
|-
| $ 9
|-
| $ 80
|-
| $ 70
|-
| $ 600
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
==Sorting with hidden sortkey==
{| class="wikitable sortable"
If necessary one can apply sorting using a sortkey which [[Help:Cascading_style_sheets#Non-display|due to CSS is not displayed]]:
! currencies
:<nowiki><span style="display:none">...</span></nowiki>
|-
| € 9
|-
| € 80
|-
| € 70
|-
| € 600
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
Example:
{| class="wikitable sortable"
:<nowiki>p<span style="display:none">q</span>r</nowiki> gives p<span style="display:none">q</span>r
! currencies
|-
| £ 9
|-
| £ 80
|-
| £ 70
|-
| £ 600
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
(However, on some projects, notably Ontoworld, a page with this wikitext cannot be saved, as spam protection.)
{| class="wikitable sortable"
! currencies
|-
| ¥ 9
|-
| ¥ 80
|-
| ¥ 70
|-
| ¥ 600
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
Javascript sorting is based on the text inside and outside the tags, without the tags themselves. A hidden sortkey can be put at the start. Both in the case of alphabetic and that of numeric sorting the first parts determine the order. Both parts together are used to determine the sort mode, so for numeric sorting the whole should be a valid number.
{| class="wikitable sortable"
! a
|-
| a 9
|-
| a 80
|-
| a 70
|-
| a 600
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
==Alphabetic sorting with hidden sortkey==
{| class="wikitable sortable"
The sortkey comes at the start and is separated from the displayed text in such a way that the latter does not affect the sorting order. For example, if a sortkey system is used where there are no blank spaces in any sortkey, then a blank space can be used for separation. If a single blank space ''is'' possible in a sortkey, two nbsps can be used. For table elements for which the text to be displayed is equal to the sortkey, no duplication is needed, of course.
! e
|-
| e 9
|-
| e 80
|-
| e 70
|-
| e 600
|}
</div>
 
Percentage sign does not change from determination as '''numerical order.''' Number combinations with minus or divide signs within them are still detected as numbers. Their numerical ordering though is determined by the number before the minus or divide sign.
If the text inside and outside the tags together is of a form that would cause a sorting mode other than alphabetic (if and when the element is at the top), a character can be appended at the end of the sortkey to avoid this, again making sure it does not affect the sorting order by putting a space or two nbsps. This can be dispensed with if the element can never be at the top, but this can be complicated to assess as that can be caused by sorting other columns, with varying sorting modes, and it can change when deleting a row, adding a column, etc.
 
{|
Instead of "display=none" another way is using a font color equal to the background, e.g. <nowiki><font color="#f9f9f9">999</font></nowiki> gives "<font color="#f9f9f9">999</font>". With this method the hidden code can be seen in selected text (e.g. with the mouse). Also the hidden text is included when copying the rendered text. The first may be an advantage or a disadvantage, the second seems only a disadvantage. A complication is also that if a user uses a background color different from the default, the specified text color may not match it; to make sure they are the same the background color can be specified also.
|
{| class="wikitable sortable"
! Percentage
|-
| 7%
|-
| 2
|-
| 4
|-
| 22
|-
| 111
|}
|
{| class="wikitable sortable"
! Number combinations
|-
| 7-4
|-
| 2
|-
| 4
|-
| 22/7
|-
| 111
|}
|}
 
A '''plus sign''' in an '''empty cell''' among the first 5 cells breaks default numerical sorting. As does a '''plus sign after a number''' if it is in one of the first 5 cells in a column.
===Unsuitability of padding with no-break spaces===
The effect of left-padding with [[w:Non-breaking space|"&amp;nbsp;" codes]], which render as blank spaces, depends on the browser: in IE they are (unlike actual blank spaces) counted for sorting as leading blank spaces, so in a list of numbers with text (for which the alphabetic sorting mode applies) they could be used to equalize the number of characters before the explicit or implicit decimal separator. However, in Firefox they are ignored for the purpose of sorting.
 
{|
{|class="wikitable sortable"
|- style="vertical-align:top;"
!Sorting using nbsps, works on IE but not on Firefox
|
!Name
{| class="wikitable sortable"
! Sort order<br>auto-detected<br>as text
|-
| 400
|100.3 FM
|Third
|-
| 40,000
|&nbsp;89.5 FM
|First
|-
|107.3 FM+
|Fourth
|-
| 60,000
|&nbsp;95.3 FM
|-
|Second
| 20,000
|-
| 6,000
|-
| 5,000
|}
|
{| class="wikitable sortable"
! Sort order<br>auto-detected<br>as text
|-
| 400
|-
| 40,000
|-
| 300+
|-
| 60,000
|-
| 20,000
|-
| 6,000
|-
| 5,000
|}
|}
 
== Numerical sorting problems ==
See also [[w:Talk:List_of_U.S._states_by_population#Sortable_Table]].
:'''''Note:''' See the section above about datatype auto detection via the first 5 cells in a column.''
 
Most of these problems can now be fixed by manually specifying the sort mode of a column by putting <code>data-sort-type=number</code> in the column header. See the example tables above and below. See also [[meta:Help:Sorting#Sort modes]] and the section about forcing the sort mode of a column.
===Padding with zeros===
Example:
*{{padleft:{{#expr:12*13}}|6|0}}
 
To work '''<code>data-sort-type=number</code>''' needs to be in the '''header cell''' that '''contains the sorting icon.''' In tables with multi-row headers, the sorting icon will be in the lowest header cells.
Formatnum can be combined with padleft:
 
When '''<code>data-sort-type=number</code>''' is '''not in the header''' the following is true:
Integer:
*References <code><nowiki><ref>...</ref></nowiki></code> after a number in any cell (including the first five cells) no longer break numerical sorting.
*The same is true for the percent symbol (%) after a number.
*Text breaks numerical sorting if it is before or after a number in one of the first 5 cells in a column.
*Asterisks (*) in the first 5 cells break numerical sorting.
*A colon by itself (to signify no data, for example) in one of the first 5 cells in a column breaks numerical sorting.
*A dash, of any kind, ''in a blank cell'' in one of the first 5 cells in a column breaks default numerical sorting of a column.
*A dash ''in front of a number'' does not break numerical sorting.
 
Dashes are allowed anywhere in cells if <code>data-sort-type=number</code> is used in the column header.
<nowiki>{{formatnum:{{padleft:299792458|16|0}}}}</nowiki> gives:
 
Even when using <code>data-sort-type=number</code> in the column header, text in front of a number in any cell breaks numerical sorting of that cell.
*{{formatnum:{{padleft:299792458|16|0}}}}
 
Text after a number is not a problem if the sort order of a column is specified by using <code>data-sort-type=number</code>.
Real:
 
Leading zeroes are not necessary for numerical sorting of a column. If it seems that way, then that means the column is being sorted alphabetically. Look in the first 5 cells for anything other than numbers, and correct those cells according to these rules. Better yet, add <code>data-sort-type=number</code> to the column header. Later editing by other editors will not break numerical sorting.
<nowiki>{{formatnum:{{padleft:{{#expr:((299792458.056 - .5) round 0)}}|16|0}}}}.{{padleft:{{#expr:(1000000*(299792458.056 - ((299792458.056 - .5) round 0))) round 0}}|6|0}}</nowiki> gives:
 
The {{tl|N/A}} template in the first five cells of a column is inconsistent in its effect on automatic datatype detection. It is always better to specify a <code>data-sort-type</code> in the column header.
*{{formatnum:{{padleft:{{#expr:((299792458.056 - .5) round 0)}}|16|0}}}}.{{padleft:{{#expr:(1000000*(299792458.056 - ((299792458.056 - .5) round 0))) round 0}}|6|0}}
 
===Alphabetic sortkeyc. for numericcirca sorting===
{{See also|#Year, month, day. Using numbers. ISO date YYYY-MM-DD}}
If one needs to use alphabetic sort mode for numbers, one can construct a hidden alphabetic sortkey for this purpose. This can be done for all numbers between -1e100 and 1e100 in arbitrary precision as follows:
"'''c.'''" ([[Wiktionary:circa|circa]], indicates "approximately") is often found in columns of numbers and dates. It often breaks sorting. The addition of <code>data-sort-type="..."</code> to the column header does not allow c. to be put in front of the number.
*where scientific notation is used, it is normalized such that the absolute value of the mantissa is between 1 and 10; the exponent is put first
*scientific notation is used for all negative numbers, and all positive numbers outside some interval (below: 1e-9 to 1e9), and not inside that interval
*where the absolute value of the exponent and/or the mantissa is a decreasing function of the number, the notation uses its complement with respect to 99 for exponents and 10 for mantissas; the code "c" is added in these cases
*numbers 0 &le; ''x'' < 1000 get a "+" in front
*positive numbers in scientific notation with a negative exponent get "+0" in front
*spaces inside the code and &-signs in front are added where needed:
**for numbers not in scientific notation the positions of all explicit and implicit decimal points are aligned
**for the starting position, i.e. the position of the first "-", "+", or "e", of other numbers, see the example table
**no code should satisfy the criterion for numeric sorting mode (below we have always either an ampersand or two letters e): although this matters only for the element at the top, any element might arrive at the top due to sorting another column
In the following the left column shows the code for alphabetic sorting, where cryptic followed by the regular notation. The second column contains the same (hence sorting the same), but with code hidden with CSS. The third column does not contain hidden parts and uses numeric sort mode. When sorting the first or second column "more than 1e9" is positioned suitably, while when sorting the third column it is positioned like 0. Moreover, if this cell would be at the top alphabetic sort mode would be used.
 
Using the '''{{tl|circa}}''' template fixes sorting when c. is in front of the number, but only if the '''''<code>sortable=yes</code>''''' parameter is added to the template. See: [[Template:Circa/doc/sortable]].
{|class="wikitable sortable"
:<code><nowiki>{{circa|NUMBER|sortable=yes}}</nowiki></code>
:{{circa|NUMBER|sortable=yes}}
 
Alternatively, c. can be put after the number. Or it can be moved to a different column.
 
=== Numerical ranges ===
:'''''Note:''' Most problems are fixed by adding '''<code>data-sort-type=number</code>''' to the column header. It also prevents problems caused by later editing.''
 
A dash after a number no longer breaks default numerical sorting of a column. Therefore, a range (30–40) now works.
 
A plus sign after a number breaks default numerical sorting if it is in one of the first 5 cells in a column.
 
A plus sign in an otherwise empty cell breaks default numerical sorting of a column. That is if the cell is one of the first 5 cells in the column.
 
You can also use 2 columns for a range if you want to sort by either the lower or upper range. If you want the upper range to sort best all cells need to be filled in with numbers. For example, you can use the same number in both the lower and upper range. You can also add a plus sign after the number in the upper range.
 
'''The first set of tables below do not sort correctly,''' except for the lower range which has no complicating factors. Note that '''"400+"''' and '''"400 +"''' do not sort correctly in their columns. These tables do not have <code>data-sort-type=number</code> in their column headers.
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|+ One column
! Estimated<br>attendance
|-
| 400 +
!full code for alphabetic sorting!! display form !!plain number
|-
| 40,000+
|<tt>{{lsc11amp|6|}} </tt>||{{lsc11amp|6}} || 6
|-
| 200,000–400,000
|<tt>{{lsc11amp|7|}} </tt>||{{lsc11amp|7}} || 7
|-
| 400,000+
|<tt>{{lsc11amp|{{#expr: 4^10}}|}} </tt>||{{lsc11amp|{{#expr: 4^10}}}} || {{formatnum:{{#expr: 4^10}}}}
|-
| 60,000–350,000
|<tt>{{lsc11amp|1234|}} </tt>|||{{lsc11amp|1234}} || 1,234
|-
| 40,000
|<tt>{{lsc11amp|123|}} </tt>||{{lsc11amp|123}} || 123
|-
| 40,000–50,000
|<tt>{{lsc11amp|{{#expr: 4^12}}|}} </tt>||{{lsc11amp|{{#expr: 4^12}}}} || {{formatnum:{{#expr: 4^12}}}}
|-
| 20,000–100,000
|<tt>{{lsc11amp|{{#expr: 4^8}}|}} </tt>||{{lsc11amp|{{#expr: 4^8}}}} || {{formatnum:{{#expr: 4^8}}}}
|-
| 10,000–100,000
|<tt>{{lsc11amp|{{#expr: 4^13}}|}} </tt>||{{lsc11amp|{{#expr: 4^13}}}} || {{formatnum:{{#expr: 4^13}}}}
|-
| 6,000–7,000
|<tt><span>e23 6</span> 6e23 </tt>||<span style="display:none">e23 6</span> 6e23 || 6e23
|-
| 5,000–10,000
|<tt><span>e09 1.01</span> more than 1e9 </tt>||<span style="display:none">e09 1.01</span> more than 1e9 || more than 1e9
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|+ One column
! Estimated<br>attendance
|-
| 400+
|<tt><span>e09 1</span> 1e9 </tt>||<span style="display:none">e09 1</span> 1e9 || 1e9
|-
| 40,000+
|<tt><span>&&&&&&&&&+0 ec89 9.999,99 </span> 9.999,99e-10</tt>||{{sms|&&&&&&&&+0 ec89 9.999,99 }} 9.999,99e-10|| 9.999,99e-10
|-
| 200,000–400,000
|<tt><span>&&&&&&&&&+</span>0.000,000,001 </tt>||<span style="display:none">&&&&&&&&&+</span>0.000,000,001 || 0.000,000,001
|-
| 400,000+
|<tt><span>&&&&&&&&&+0 ec87 6 </span>6e-12</tt>||<span style="display:none">&&&&&&&&&+0 ec87 6 </span>6e-12|| 6e-12
|-
| 60,000–350,000
|<tt><span>&&&&&&&&&+0 ec86 7 </span>7e-13</tt>||<span style="display:none">&&&&&&&&&+0 ec86 7 </span>7e-13|| 7e-13
|-
| 40,000
|<tt><span>&&&&&&&&&+0 ec87 5 </span> 5e-12</tt>||<span style="display:none">&&&&&&&&&+0 ec87 5 </span> 5e-12|| 5e-12
|-1
| 40,000–50,000
|<tt><span>&&&&&&&&&&-e-10 c0.000,01</span> -9.999,99e-10 </tt>||<span style="display:none">&&&&&&&&&&-e-10 c0.000,01</span> -9.999,99e-10 || -9.999,99e-10
|-
| 20,000–100,000
|-
| 10,000–100,000
|-
| 6,000–7,000
|-
| 5,000–10,000
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|+ Two columns
! colspan=2| Estimated<br>attendance
|-
! (lower) !! (upper)
|<tt><span>&&&&&&&&&&-e-08 c6.8 </span> -3.2e-8</tt>||<span style="display:none">&&&&&&&&&&-e-08 c6.8 </span> -3.2e-8|| -3.2e-8
|-
| 400 || 400+
|<tt><span>&&&&&&&&&&&-ec86 c0.3 </span> -9.7e13</tt>||<span style="display:none">&&&&&&&&&&&-ec86 c0.3 </span> -9.7e13|| -9.7e13
|-
| 40,000 || 40,000+
|<tt><span>&&&&&&&&&&&-ec99 c7.7 </span> -2.3</tt>||<span style="display:none">&&&&&&&&&&&-ec99 c7.7 </span> -2.3|| -2.3
|-
| 200,000 || 400,000
|<tt>{{lsc11amp|0|}} </tt>||{{lsc11amp|0}} || 0
|-
| 400,000 || +
|<tt>{{lsc11amp|0|}}.3 </tt>||{{lsc11amp|0}}.3 || 0.3
|-
| 60,000 || 350,000
|-
| 40,000 ||
|-
| 40,000 || 50,000
|-
| 20,000 || 100,000
|-
| 10,000 || 100,000
|-
| 6,000 || 7,000
|-
| 5,000 || 10,000
|}
</div>
 
'''<code>data-sort-type=number</code>''' has '''fixed the sorting in the tables below.''' Note the sorting of '''400+''' and '''400 +'''.
==Dates==
 
<div style="display:inline-table; vertical-align:top;">
{|
{| class="wikitable sortable"
|+ One column
! data-sort-type=number |Estimated<br>attendance
|-
| 400 +
|-
| 40,000+
|-
| 200,000–400,000
|-
| 400,000+
|-
| 60,000–350,000
|-
| 40,000
|-
| 40,000–50,000
|-
| 20,000–100,000
|-
| 10,000–100,000
|-
| 6,000–7,000
|-
| 5,000–10,000
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|+ One column
! data-sort-type=number |Estimated<br>attendance
|-
| 400+
|-
| 40,000+
|-
| 200,000–400,000
|-
| 400,000+
|-
| 60,000–350,000
|-
| 40,000
|-
| 40,000–50,000
|-
| 20,000–100,000
|-
| 10,000–100,000
|-
| 6,000–7,000
|-
| 5,000–10,000
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|+ Two columns
! colspan=2| Estimated<br>attendance
|-
! data-sort-type=number |(lower) !! data-sort-type=number |(upper)
|-
| 400 || 400+
|-
| 40,000 || 40,000+
|-
| 200,000 || 400,000
|-
| 400,000 || +
|-
| 60,000 || 350,000
|-
| 40,000 ||
|-
| 40,000 || 50,000
|-
| 20,000 || 100,000
|-
| 10,000 || 100,000
|-
| 6,000 || 7,000
|-
| 5,000 || 10,000
|}
</div>
 
== Date sorting problems ==
 
The '''{{Tl|Date table sorting}}''' or '''{{tl|dts}}''' template will work with any combination of years, months, days ([[List of PC games (A)|example]]). See template documentation and section farther down for more info.
 
=== Month names ===
All sorting involving month names may fail for registered users who have changed the default language setting "en - English" at [[Special:Preferences]] (reported at [[phab:T126744]]). It affects relatively few users on the English Wikipedia and can be ignored.
 
=== Year only ===
 
Year sorting of a column works as long as the year is the first text in each cell in the column. Adding <code>data-sort-type=date</code> to the column header does not change this.
 
Text is OK ''after'' a year in a cell. "FY" ([[fiscal year]]), for example, should go after the year. References after the year are OK. Put "c." after the year, or use "est." after the year instead.
 
A dash, of any kind, in a blank cell breaks year sorting of a column. Dashes after the year are OK.
 
Unlike for numerical sorting the {{tl|N/A}} template in any cell in a year column does ''not'' break year sorting of that column.
 
If there are problems with year sorting check for any cells in the column with text or a dash (of any kind) as the first thing in a cell. Remove that text or dash, and the column should sort correctly.
 
=== Year and month ===
 
Date sorting '''does not work''' for columns with only the year before the month (no day).
 
Adding <code>data-sort-type=date</code> or <code>data-sort-type=isoDate</code> to the column header '''does not help.''' Click each column header a couple times in the tables below to see. Note the column headed <code>data-sort-type=isoDate</code> may sort correctly in some browsers, but it is not reliable.
<br>'''Year and month in numerical form (YYYY-MM) works with <code>data-sort-type=isoDate</code>''' (see relevant section farther down).
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|-
!style=max-width:5em |Year and month
|-
| 1999 Dec
|-
| 1999 Jan
|-
| 2004 May
|-
| 2004 Aug
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|-
!style=max-width:5em |Year and month
|-
| 1999 December
|-
| 1999 January
|-
| 2004 May
|-
| 2004 August
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|-
! data-sort-type=date | Year and month<br><small><code>data-sort-type=date</code></small>
|-
| 1999 Dec
|-
| 1999 Jan
|-
| 2004 May
|-
| 2004 Aug
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|-
! data-sort-type=date | Year and month<br><small><code>data-sort-type=date</code></small>
|-
| 1999 December
|-
| 1999 January
|-
| 2004 May
|-
| 2004 August
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|-
! data-sort-type=isoDate | Year and month<br><small><code>data-sort-type=isodate</code></small>
|-
| 1999 December
|-
| 1999 January
|-
| 2004 May
|-
| 2004 August
|}
</div>
 
=== Month and year ===
 
Date sorting '''does not work''' for columns with only the month before the year (no day). Adding '''<code>data-sort-type=date</code>''' to the column header '''does not help.'''
 
{|
|- style=vertical-align:text-top;
|
{| class="wikitable sortable"
|-
! Month and year
!Date sort mode
|-
|07 AprDec 20071999
|-
|16 AprJan 20071999
|-
|16 MarMay 20072004
|-
| Aug 2004
|05-04-2007
|}
|
{| class="wikitable sortable"
|-
! Month and year
|04-05-2007
|-
| December 1999
|18 Mar 2007
|-
| January 1999
|27 Mar 2007
|-
|20 AugMay 20062004
|-
| August 2004
|22 Jul 2006
|}
|}
 
{|
|- style=vertical-align:text-top;
|
{| class="wikitable sortable"
|-
! data-sort-type=date | Month and year<br><code>data-sort-type=date</code>
|-
| Dec 1999
|-
| Jan 1999
|-
| May 2004
|-
| Aug 2004
|}
|
{| class="wikitable sortable"
|-
! data-sort-type=date | Month and year<br><code>data-sort-type=date</code>
!Date sort mode, sorting works for no preference and preference dmy
|-
| December 1999
|07 Apr 2007
|-
| January 1999
|<span style="display:none">00 Jan </span>2007
|-
| May 2004
|<span style="display:none">00</span> Mar 2007
|-
| August 2004
|16 Apr 2007
|}
|}
 
=== Full dates work. Year must be on the end ===
This shows that any full date works ''without'' '''data-sort-type=date''' in the table. Month-day-year or day-month-year. If a number for a day is missing, date sorting is broken. Abbreviated months work too. The year must be on the end, and a number can not be used for the month. Either will break date sorting.
 
Date sorting works correctly in the first 2 tables below. Years before 100 (for example, year 99) break sorting.
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|-
! Full dates
|28 Feb 2007
|-
| Dec 5, 1999
|[[28 Feb]] [[2007]]
|-
|28 Jan 20077, 1999
|-
| May 14, 2004
|[[28 Jan]] [[2007]]
|-
| Aug 4, 2004
|[[07 Apr]] [[2007]]
|-
| 5 Dec 1999
|[[16 Apr]] [[2007]]
|-
| 7 Jan 1999
|[[1 Mar]] [[2007]]
|-
| 14 May 2004
|[[01 Mar]] [[2007]]
|-
| 4 Aug 2004
|[[27 Mar]] [[2007]]
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|-
! Full dates
|[[20 Aug]] [[2006]]
|-
| December 5, 1999
|[[22 Jul]] [[2006]]
|-
| January 7, 1999
|1 Mar 2007
|-
| May 14, 2004
|01 Mar 2007
|-
| August 4, 2004
|27 Mar 2007
|-
| 5 December 1999
|20 Aug 2006
|-
| 7 January 1999
|22 Jul 2006
|-
| 14 May 2004
|-
| 4 August 2004
|}
</div>
 
'''data-sort-type=date''' in the header for the date column allows date sorting to work for all entries not missing a day number. So it is good to add it in case editors forget day numbers for some entries. That can be fixed later. The rest of the dates will sort correctly by date. Test date sorting below. '''Some entries below are missing the day number.''' They end up at the top or bottom of the ''data-sort-type=date'' list upon sorting. The list below without ''data-sort-type=date'' does not sort by date.
 
The 2 tables below are identical except for the addition of '''data-sort-type=date''' to the second table.
<syntaxhighlight lang=wikitext>
{| class="wikitable sortable"
|-
! data-sort-type=date | Full dates.<br><code>data-sort-type=date</code>
</syntaxhighlight>
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|-
! Full dates.<br>A mix of formats
|-
| Dec 5, 1999
|-
| Jan 7, 1999
|-
| May 2004
|-
| Aug 4, 2004
|-
| 5 Dec 1999
|-
| 7 Jan 1999
|-
| 14 May 2004
|-
| 4 Aug 2004
|-
| December 1999
|-
| January 7, 1999
|-
| May 14, 2004
|-
| August 4, 2004
|-
| 5 December 1999
|-
| January 1999
|-
| 14 May 2004
|-
| 4 August 2004
|}
</div>
{|
 
|'''String sort mode''' ''([{{fullurl:{{FULLPAGENAME}}|action=edit&section=14}} edit] to view source)''
<div style="display:inline-table; vertical-align:top;">
{|class="wikitable sortable"
{| class="wikitable sortable"
!date
|-
! data-sort-type=date | Full dates.<br><code>data-sort-type=date</code>
| [[2006]] <span style="display:none">a</span>
|-
| Dec 5, 1999
| {{dts1|2006-12-03}}
|-
| Jan 7, 1999
| {{dts1|-0000-03-27}}
|-
| May 2004
| <span style="display:none">2006-12 </span>[[December]] [[2006]]
|-
| Aug 4, 2004
| <span style="display:none">!9936-04 </span>[[April]] [[64 BC]]
|-
| 5 Dec 1999
| <span style="display:none">!9900-07-13</span>[[-0099-07-13]]
|-
| 7 Jan 1999
| <span style="display:none">!9937-09-23</span>[[-0062-09-23]]
|-
| 14 May 2004
| <span style="display:none">!9937-10-08</span>[[-0062-10-08]]
|-
| 4 Aug 2004
| <span style="display:none">!9998-12-21</span>[[-0001-12-21]]
|-
| December 1999
| {{dts1|2006-11-08}}
|-
| January 7, 1999
| {{dts1|0304-12-31}}
|-
| May 14, 2004
| {{dts1|2005-05-15}}
|-
| August 4, 2004
|-
| 5 December 1999
|-
| January 1999
|-
| 14 May 2004
|-
| 4 August 2004
|}
</div>
 
=== Year, month, day. Using words for months ===
 
Sorting does not work for this date order.
:'''''data-sort-type=date'''''
:'''''data-sort-type=isoDate'''''
The addition of any '''data-sort-type''' to the column header does not help. See examples below.
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|-
! Date
<small>no data-sort-type</small>
|-
|2007 January 5
|-
|2007 February 12
|-
|2007 March 9
|-
|2007 April 1
|-
|2007 May 23
|-
|2007 June 29
|}
</div>
The sort mode is based on the ''rendered'' format; in the case of links: the labels, not the targets (though including any content hidden by "display:none").
 
<div style="display:inline-table; vertical-align:top;">
'''Date sort mode''':
{| class="wikitable sortable"
|-
! data-sort-type="date" |Date
<small>data-sort-type=date</small>
|-
|2007 January 5
|-
|2007 February 12
|-
|2007 March 9
|-
|2007 April 1
|-
|2007 May 23
|-
|2007 June 29
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
One of the formats allowed for the date sort mode is produced by the [[Help:Date formatting and linking|Mediawiki's date-formatting feature]] in the right combination of preference and wikitext format: we need to use in the wikitext the format <nowiki>[[dd mmm]] [[yyyy]]</nowiki> (done in the example) and either no preference or preference dmy, or use with preference dmy one of the formats <nowiki>[[mmm dd]][[yyyy]], [[yyyy]][[mmm dd]], or [[yyyy]][[dd mmm]]</nowiki>.
{| class="wikitable sortable"
|-
! data-sort-type="isoDate" |Date
<small>data-sort-type=isoDate</small>
|-
|2007 January 5
|-
|2007 February 12
|-
|2007 March 9
|-
|2007 April 1
|-
|2007 May 23
|-
|2007 June 29
|}
</div>
 
=== Year, month, day. Using numbers. ISO date YYYY-MM-DD ===
Incomplete dates:
*<nowiki><span style="display:none">00 Jan </span>2007</nowiki>
*<nowiki><span style="display:none">00</span> Mar 2007</nowiki>
 
See: '''[[ISO date]].''' "±YYYY-MM-DD", with 1 to 4 digits for year "YYYY" from -9999 to 9999. Year by itself is fine. As is the year followed by just the month. Some stuff after the date is allowed. Such as references after the date. To save header space you can add a tooltip to the "Date" column header instead of "year, month, day" below it. See: [[Template:Tooltip]]. Tooltips have been added to the tables in this section.
'''String sort mode''':
 
See section higher up: [[#Examples of datatype auto detection. First 5 cells in a column]]. Datatype auto detection is inconsistent. That is why ISO date sorting works best with '''''<code>data-sort-type=isoDate</code>''''' added to the column header. It also avoids problems when only one digit is used for the month or day. [[Leading zeros]] are no longer needed. All tables below have '''''<code>data-sort-type=isoDate</code>''''' added to the column headers.
String sort mode provides chronological sorting for dates formated as <nowiki><span style="display:none">&</span></nowiki>YYYY-MM-DD; the hidden "&" avoids numeric sort mode.
 
Remember to leave a space in the wikitext before years that are a negative number. Otherwise, '''<code>|-</code>''' will be used as table formatting instead of '''<code>|</code>'''.
Also we can hide the YYYY-MM-DD and put after that any choice of displayable text, including Mediawiki date formatting. The Wikipedia template {{tiw|dts}} provides a convenient way of applying this method while using the date-formatting feature for display.
 
"'''c.'''" stands for '''[[Wiktionary:circa|circa]]''' (approximately). "'''c.'''" before the date breaks sorting in the first table. Using the '''{{tl|circa}}''' template fixes sorting, but only if the '''''<code>sortable=yes</code>''''' parameter is added to the template. See: [[Template:Circa/doc/sortable]]. See: [[#c. for circa]].
For years BC we can use, for example, <code>!9937-09-23</code> for [[-0062-09-23]] (subtract the year number BC from 10000, or the absolute value of the astronomical year from 9999).
 
<div style="display:inline-table; vertical-align:top;">
If a table column contains any or all incomplete dates, this will not cause sorting problems. If only a year and month are given, that incomplete date is positioned alphabetically before the first day of the month in question. Likewise, if only a year is given, the date is positioned before the first month or day given for that year.
{| class="wikitable sortable"
|-
! data-sort-type=isoDate |{{Tooltip|Date|Year, month, day}}<br><small>With "'''c.'''"<br>Sorting broken.</small>
|-
| -90
|-
| c. 90
|-
| 90-7-13
|-
| 90-12-5
|-
| 1011-08-01<sup style="color:gray">[2]</sup>
|-
| c. 207-11<sup style="color:gray">[1]</sup>
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
If at some point (i.e., after possible previous sorting) the form <code><nowiki>[[YYYY]]</nowiki></code> is at the top with a non-negative year, sorting would be numerical; in this case, after toggling between ascending and descending there would be no proper sorting ''within'' each year (because [http://www.devguru.com/technologies/ecmascript/QuickRef/parsefloat.html parsefloat] is applied, finding the first number in the string, and basing sorting on only that number). Also, years BC would not be sorted properly. Therefore, alphabetic sorting has to be enforced. This can be done by putting a non-displayed character after the year, separated by a space.
{| class="wikitable sortable"
|-
! data-sort-type=isoDate |{{Tooltip|Date|Year, month, day}}<br><small>"c." removed.<br>Sorting works.</small>
|-
| -90
|-
| 90
|-
| 90-7-13
|-
| 90-12-5
|-
| 1011-08-1<sup style="color:gray">[2]</sup>
|-
| 207-11<sup style="color:gray">[1]</sup>
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
See also:
{| class="wikitable sortable"
*{{tiw|dts}}
|-
*[[bugzilla:8226]].
! data-sort-type=isoDate |{{Tooltip|Date|Year, month, day}}<br><small>{{tl|circa}} used.<br>Sorting works.</small>
|-
| -90
|-
| {{circa|sortable=yes|90}}
|-
| 90-7-13
|-
| 90-12-5
|-
| 1011-08-01<sup style="color:gray">[2]</sup>
|-
| {{circa|sortable=yes|207-11}}<sup style="color:gray">[1]</sup>
|}
</div>
 
<div style="display:inline-table; vertical-align:top; max-width:650px;">
==Secondary sortkey==
<syntaxhighlight lang=wikitext>
If a column contains a value multiple times then sorting the column preserves the order of the rows within each subset that has the same value in that column ({{mlw|Sorting_algorithm|Stability|stable sorting}}). Thus sorting based on a primary, secondary, tertiary, etc. sortkey can be done by sorting the least-significant sortkey first, etc.
{| class="wikitable sortable"
|-
! data-sort-type=isoDate |{{Tooltip|Date|Year, month, day}}<br><small>{{tl|circa}} used.<br>Sorting works.</small>
|-
| -90
|-
| {{circa|sortable=yes|90}}
|-
| 90-7-13
|-
| 90-12-5
|-
| 1011-08-01<sup style="color:gray">[2]</sup>
|-
| {{circa|sortable=yes|207-11}}<sup style="color:gray">[1]</sup>
|}
</syntaxhighlight>
</div>
 
Adding BCE, CE, BC, etc. after the date does not break sorting. But [https://www.grammar-monster.com/lessons/abbreviations_AD_BC_BCE_CE.htm adding AD before the date] breaks sorting. Test additions before and after dates. Additions before the date are almost always a problem.
'''First click on column Alphabet and then on Numbers, you'll see that the ordering is on Numbers (1), Alphabet (2).'''
 
{|
{|class="wikitable sortable"
|- style=vertical-align:text-top;
!Numbers!!Alphabet!!Dates!!Currency!!Text
|
{| class="wikitable sortable"
|-
! data-sort-type=isoDate |{{Tooltip|Date|Year, month, day}}<br><small>BCE added after.<br>Sorting works.</small>
|4||a||01.Jan.2005||4.20||row 1
|-
| -90 BCE
|5||a||05/12/2006||7.15||row 2
|-
| {{circa|sortable=yes|90}}
|1||b||02-02-2004||5.00||row 3
|-
| 90-7-13
|1||a||02-02-2004||5.00||row 4
|-
| 90-12-5
|2||x||13-apr-2005||||row 5
|-
| 1011-08-1<sup style="color:gray">[2]</sup>
|2||a||13-apr-2005||||row 6
|-
| {{circa|sortable=yes|207-11}}<sup style="color:gray">[1]</sup>
|3||a||17.aug.2006||6.50||row 7
|}
|
{| class="wikitable sortable"
|-
! data-sort-type=isoDate |{{Tooltip|Date|Year, month, day}}<br><small>AD added before.<br>Sorting broken.</small>
|3||z||25.aug.2006||2.30||row 8
|-
| -90 BCE
|3||z||28.aug.2006||5.50||row 9
|-
| AD {{circa|sortable=yes|90}}
|3||z||31.aug.2006||3.77||row 10
|-
| 90-7-13
|3||z||01.sep.2006||1.50||row 11
|-class="sortbottom"
!Bottom!!!!!!!!
|-
| 90-12-5
|-
| 1011-08-1<sup style="color:gray">[2]</sup>
|-
| {{circa|sortable=yes|207-11}}<sup style="color:gray">[1]</sup>
|}
|}
 
== Years BC are a problem ==
==Keeping some rows together==
Partly hidden sortkeys can be used to keep certain rows together. The original mutual order of these rows is preserved.
 
:'''''Note.''' See also the section farther down about the date table sorting template. It has additional info about dealing with negative years (BC, BCE).''
Example where this is the case for the rows about the Netherlands:
 
From [https://en.wikipedia.org/w/index.php?title=List_of_reported_UFO_sightings&oldid=1141129035 this version] of [[List of reported UFO sightings]]. The "Antiquity" section has a table with some hidden notes. Adapted here:
{|class="wikitable sortable"
 
!Country/province!!Capital
To sort the dates before AD 1000 you will need one of the following:
*<code>|data-sort-value="XXXX"</code> - Year. Use [[leading zeros]], and negative for BC.
*<code><nowiki>{{Date table sorting|X}}</nowiki></code> - Use negative for BC. See: {{tl|Date table sorting}}.
*<code><nowiki>{{circa|sortable=yes|lk=no|X}}</nowiki></code> - {{tl|circa}} is AD only.
 
The date column it is referring to was pulled out of the larger table, simplified, and placed below. It is sorting correctly. Look at the wikitext to see the methods discussed in the hidden notes.
 
<div style="display:inline-table; vertical-align:top;">
<syntaxhighlight lang=wikitext>
{|class="wikitable sortable"
|-
!Date
|France||Paris
|-
|data-sort-value=-1440|c. 1440 BC
|Netherlands<span style="display:none">South Holland</span>||Amsterdam<span style="display:none">The Hague</span>
|-
|{{Date table sorting|-218}}
|<span style="display:none">Netherlands</span>South Holland||<span style="display:none">Amsterdam</span>The Hague
|-
|{{Date table sorting|-76}}
|U.K.||London
|-
|{{Date table sorting|-7}}
|-
|data-sort-value=0065|AD 65
|-
|data-sort-value=0196|AD 196
|-
|data-sort-value=0740|AD c. 740
|}
</syntaxhighlight></div>
<div style="display:inline-table; vertical-align:top;">
{|class="wikitable sortable"
|-
!Date
|-
|data-sort-value=-1440|c. 1440 BC
|-
|{{Date table sorting|-218}}
|-
|{{Date table sorting|-76}}
|-
|{{Date table sorting|-7}}
|-
|data-sort-value=0065|AD 65
|-
|data-sort-value=0196|AD 196
|-
|data-sort-value=0740|AD c. 740
|}
</div>
 
== Date table sorting template. Many date formats ==
==Limitations==
{{anchor|Date table sorting template}}
Javascript sorting may not work properly on tables with cells extending over multiple rows and/or columns (however, sorting of columns up to and including the first with ''colspan'' does not seem to be affected). Also, while cells can be empty, they should not be ''missing'' at the end of a row. In these cases sometimes the table gets messed up when attempting to sort, while other times some of the sorting buttons work while others don't.
The simplest way to format sortable dates in a table is to use the '''{{tl|Date table sorting}}''' template. A redirect: '''{{tl|dts}}'''
 
It can be used with many date formats mixed together ([[List of PC games (A)|example]]). See [[Template:Date table sorting]] for more info. In the tables below, all columns sort correctly. The wikitext for the first entry in each table in the first row is shown in the table header.
=== Colspan workaround ===
To allow sorting, the formal number of cells in each row should be equal (if not all columns are made sortable this should apply at least for the number of cells up to and including the last sortable column). However, with a CSS hack the number of cells ''shown'' in a row can differ from the formal number of cells. For example, two formal cells can be shown as one by specifying a width for the first column, shifting the contents of the second cell to the left, increasing its width by the same amount, and hiding the cell border that would normally be visible. Hidden sortkeys can be used to control, for sorting with respect to each column, how this row should be sorted.
 
''Note:'' None of the table columns use the <code>data-sort-type=</code> modifier. Using <code>data-sort-type=</code> can sometimes break sorting when used with the template. If you want the column to be narrower, you can use month abbreviations (''abbr=on'' parameter). You can also allow the text to wrap (''nowrap=off'' parameter). Use ''format=dmy'' or ''format=mdy'', etc. to control output format, if desired.
Example:
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
!style="width:9.3em"|Country!!Capital
|-
! Date<br>(Day and month only)<br><small><code><nowiki>{{dts|4 Jan}}</nowiki></code></small>
|France
|Paris
|-
| {{dts|4 Jan}}
|<span style="display:none">Z</span>
|style="border-left:2px solid #fff;border-left-style:hidden;background:#fff;padding:0.4em 0em"|<span style="display:none">M</span><div style="position:relative;left:-9em;margin-right:-9em;overflow:auto">Sorting with respect to the first column this row sorts like Z, with respect to the second column like M</div>
|-
| {{dts|28 Aug}}
|U.K.
|-
|London
| {{dts|3 Jan}}
|-
| {{dts|29 Aug}}
|-
| {{dts|14 Dec}}
|-
| {{dts|1 Jan}}
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
This can be combined with the method of "keeping some rows together" demonstrated above. For an example of an application of this, consider a table of three columns where the third column would make the table too wide, such as a column of miscellaneous details. These details can be put in separate rows, each staying below the corresponding row when the table is sorted.
{| class="wikitable sortable"
|-
! Date<br>(Month and day only)<br><small><code><nowiki>{{dts|January 4}}</nowiki></code></small>
|-
| {{dts|January 4}}
|-
| {{dts|August 28}}
|-
| {{dts|January 3}}
|-
| {{dts|August 29}}
|-
| {{dts|December 14}}
|-
| {{dts|January 1}}
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|-
! Date<br>(Month, day, year)<br><small><code><nowiki>{{dts|1990|4|27}}</nowiki></code></small>
|-
| {{dts|1990|4|27}}
|-
| {{dts|1989|8|8}}
|-
| {{dts|2006|2|3}}
|-
| {{dts|2006|10|4}}
|-
| {{dts|2004|11|1}}
|-
| {{dts|2004|1|11}}
|}
</div>
 
Example:
 
<div style="display:inline-table; vertical-align:top;">
<syntaxhighlight lang=wikitext>
{| class="wikitable sortable"
!style="width:9.3em"|Country!!Capital
|-
! Dates.<br>Various formats
|France
|Paris <span style="display:none"><div style="position:relative;left:-9em;margin-right:-9em;overflow:auto">In Paris is the Eiffel Tower.</div></span>
|-
| {{dts|Jan 1980}}
|<span style="display:none">France</span>
|style="border-left:2px solid #fff;border-left-style:hidden;background:#fff;padding:0.4em 0em"|<span style="display:none">Paris </span><div style="position:relative;left:-9em;margin-right:-9em;overflow:auto">In Paris is the Eiffel Tower.</div>
|-
| {{dts|Aug 1981}}
|U.K.
|London <span style="display:none"><div style="position:relative;left:-9em;margin-right:-9em;overflow:auto">In the U.K. you cannot pay with euros.</div></span>
|-
| {{dts|1992}}
|<span style="display:none">U.K.</span>
|style="border-left:2px solid #fff;border-left-style:hidden;background:#fff;padding:0.4em 0em"|<span style="display:none">London </span><div style="position:relative;left:-9em;margin-right:-9em;overflow:auto">In the U.K. you cannot pay with euros.</div>
|-
| {{dts|August 28 1993}}
|Germany
|Berlin <span style="display:none"><div style="position:relative;left:-9em;margin-right:-9em;overflow:auto">Germany includes the former DDR.</div></span>
|-
| {{dts|1990|4|27}}
|<span style="display:none">Germany</span>
|-
|style="border-left:2px solid #fff;border-left-style:hidden;background:#fff;padding:0.4em 0em"|<span style="display:none">Berlin </span><div style="position:relative;left:-9em;margin-right:-9em;overflow:auto">Germany includes the former DDR.</div>
| {{dts|1989|8|8}}
|}
</syntaxhighlight>
</div>
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|-
! Dates.<br>Various formats
|-
| {{dts|Jan 1980}}
|-
| {{dts|Aug 1981}}
|-
| {{dts|1992}}
|-
| {{dts|August 28 1993}}
|-
| {{dts|1990|4|27}}
|-
| {{dts|1989|8|8}}
|}
</div>
 
=== Issues. Years BC, etc ===
A table row template makes this technique less cumbersome to apply, see e.g. [[w:List of furry conventions]], [[w:Template:Furry-con-list-start]] and [[w:Template:Furry-con-list-entry]].
For years BC, <code>!9937-09-23</code> can be used for -0062-09-23 (62 BC): Simply subtract the year BC from 10,000.
* See also: [[bugzilla:8226]]{{-}}
 
Date sorting works by formatting dates so they can be sorted numerically. For example:
==Controlling sorting and display==
* <code>'''yyyy mm dd'''</code>
Text undesired for sorting but needed for display:
*In numeric sorting mode, this text (e.g. footnotes) needs to be put after the number; if at the top it causes string sort mode. See e.g. [[Help:Sorting/countries]].
*In date sorting mode, this text needs to be put in a separate column; in the case of a cell containing a range of dates or numbers (e.g. from .. to ..), text in surplus of what is required for sorting is put in the extra column. If the first part of the text is used for sorting, then the extra column needs to be the following one; conversely, if the last part of the text is used for sorting, then the extra column needs to be the previous one; depending on the table format, this dividing of an item over two cells may look ugly.
*In alphabetic sorting, any footnotes etc. do not require a separate column; they can simply be put at the end of the element.
 
or
Text undesired for display but needed for sorting:
* <code>'''2001 07 21'''</code>
*can be put as hidden text in the column to be sorted
 
...for 21 July 2001. The <code>display:none</code> style can be used to hide a sortable numeric date before the displayed date. See wikitext of table just below. Alternatively, {{tl|Date table sorting}} does this automatically, and is recommended in most cases.
Combining the two, we can have displayed text independent of text used for sorting, by fully hiding the latter, and fully putting the former in a separate column (in date sorting mode and numeric sorting mode) or in the same column after the hidden text (in alphabetic sorting). Fully putting the displayed text in a separate column may look ugly if it is not done consistently for a whole column, but only for elements that require this (e.g. if most entries in a column are single numbers, but some are ranges).
 
{|class="wikitable sortable"
==Static column==
!Displayed
A static column, e.g. with row numbers, can be obtained with two side-by-side tables with for each row the same height set in both tables:
!What is being sorted
|-
| <span style="display:none">2006-12-03</span>2006-12-03
|2006-12-03
|-
| <span style="display:none">0000-03-27</span>0000-03-27
|0000-03-27
|-
| <span style="display:none">2006-12</span>December 2006
|2006-12
|-
| <span style="display:none">!9936-04</span>April 64 BC
|!9936-04
|-
| <span style="display:none">!9900-07-13</span>-0099-07-13
|!9900-07-13
|-
| <span style="display:none">!9937-09-23</span>-0062-09-23
|!9937-09-23
|-
| <span style="display:none">!9937-10-08</span>-0062-10-08
|!9937-10-08
|-
| <span style="display:none">!9998-12-21</span>-0001-12-21
|!9998-12-21
|-
| <span style="display:none">2006-11-08</span>2006-11-08
|2006-11-08
|-
| <span style="display:none">0304-12-31</span>0304-12-31
|0304-12-31
|-
| <span style="display:none">2005-05-15</span>2005-05-15
|2005-05-15
|}
 
You can use {{dts|2012-07-07}} etc. to get sortable dates. Example, including one date with a different display format:
{|
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Rendered result'''
{| class="wikitable sortable"
|-
! Date
|
|-
{| class="wikitable"
| {{dts|2012-01-07}}
!Number
|-
|- style="height:100px"
| {{dts|2012-05-07}}
|1
|-
|- style="height:100px"
| {{dts|4 July 2012}} <!-- Ensure alternate display date format works -->
| 2
|-
| {{dts|2012-07-07}}
|}
</div>
|
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
'''Wiki source'''
<syntaxhighlight lang="wikitext" highlight="9">
{| class="wikitable sortable"
|-
!Country
! Date
!Capital
|-
|- style="height:100px"
| {{dts|2012-01-07}}
|The Netherlands || Amsterdam (although The Hague is the seat of government)
|-
|- style="height:100px"
| {{dts|2012-05-07}}
|France || Paris
|-
| {{dts|4 July 2012}} <!-- Ensure alternate display date format works -->
|-
| {{dts|2012-07-07}}
|}
</syntaxhighlight>
</div>
 
== Before year 100. Any date format ==
{{collapse top|Note: This no longer seems to be working.}}
 
Sorting can be done via the hidden '''<code>data-sort-value</code>''' using the [[ISO date]]. Combined with '''<code>data-sort-type=isoDate</code>'''
 
'''Note:''' The sorting wikitext is the same for the 2 tables below. '''Any date format can be shown to the readers.'''
 
<div style="display:inline-table; vertical-align:top;">
{| class="wikitable sortable"
|-
! data-sort-type=isoDate | Date
|-
| data-sort-value="111-12-05" | 5 Dec 111
|-
| data-sort-value="35-01-07" | 7 Jan 35
|-
| data-sort-value="207-12-05" | 5 Dec 207
|-
| data-sort-value="-111" | 111 BC
|-
| data-sort-value="-35-01-07" | 7 Jan 35 BC
|-
| data-sort-value="-207-12" | Dec 207 BC
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
The style can be adjusted to make it appear as a single table. If for some row the height of that row is too small for the text in a cell on one of the sides, the browser increases it, and there is no longer a match.
<syntaxhighlight lang="wikitext">
{| class="wikitable sortable"
|-
! data-sort-type=isoDate | Date
|-
| data-sort-value="111-12-05" | 5 Dec 111
|-
| data-sort-value="35-01-07" | 7 Jan 35
|-
| data-sort-value="207-12-05" | 5 Dec 207
|-
| data-sort-value="-111" | 111 BC
|-
| data-sort-value="-35-01-07" | 7 Jan 35 BC
|-
| data-sort-value="-207-12" | Dec 207 BC
|}
</syntaxhighlight>
</div>
 
The table below uses the same isoDate values for '''<code>data-sort-value</code>''' as the above table. But '''multiple formats are used for showing the dates to the reader.'''
==Sorting tables by default==
It is not possible to make a table appear sorted by a certain column without the user clicking on it. By default, the rows of a table always appear in the same order as in the wikitext. If you want a table to appear sorted by a certain column, you must sort the wikitext itself in that order; see the next section for one way to do this.
 
<div style="display:inline-table; vertical-align:top;">
==Sorting the wikitext of a table==
{| class="wikitable sortable"
One way to sort the ''wikitext'' itself by a certain column is to use the following trick. You can make an auxiliary sortable table containing the wikitext for the original table, and sort it. You can then replace the original wikitext by this sorted wikitext.
|-
! data-sort-type=isoDate | Date
|-
| data-sort-value="111-12-05" | 5 Dec 111
|-
| data-sort-value="35-01-07" | 7 January 35
|-
| data-sort-value="207-12-05" | Dec 5, 207
|-
| data-sort-value="-111" | about 111 BC
|-
| data-sort-value="-35-01-07" | Jan 7, 35 BC
|-
| data-sort-value="-207-12" | December 207 BC
|}
</div>
 
<div style="display:inline-table; vertical-align:top;">
Example:
<syntaxhighlight lang="wikitext">
{| class="wikitable sortable"
|-
! data-sort-type=isoDate | Date
|-
| data-sort-value="111-12-05" | 5 Dec 111
|-
| data-sort-value="35-01-07" | 7 January 35
|-
| data-sort-value="207-12-05" | Dec 5, 207
|-
| data-sort-value="-111" | about 111 BC
|-
| data-sort-value="-35-01-07" | Jan 7, 35 BC
|-
| data-sort-value="-207-12" | December 207 BC
|}
</syntaxhighlight>
</div>
{{collapse bottom}}
 
== Background colors in sortable headers ==
 
Adding color with the shorthand{{efn|Shorthand [[CSS]] properties allow several sub-properties to be set by a single property and "when values are omitted from a shorthand form, unless otherwise defined, each 'missing' sub-property is assigned its [default] value. This means that a shorthand property declaration always sets all of its sub-properties, even those that are not explicitly set. Carelessly used, this might result in inadvertently resetting some sub-properties." Certain required CSS background properties set on sortable table headers could be overruled by background rules stated on a per-table basis.<ref>{{cite web|url=https://drafts.csswg.org/css-cascade-4/#shorthand-property|title=CSS Cascading and Inheritance Level 4: Shorthand Properties|publisher=[[W3C]]|date=October 10, 2022|archive-url=https://web.archive.org/web/20221211101455/https://drafts.csswg.org/css-cascade-4/#shorthand-property|archive-date=December 11, 2022|access-date=December 19, 2022}}</ref>}} '''<code>"background:...;"</code>''' property in a header may cause that column to lose its sorting button – see [[phab:T33755]]. Example with the "Name" header:
Original table:
 
{|class="wikitable sortable"
!demo
|-
! style="background:navajowhite" |Name!![[Surname]]!!Height
|9
|-
|John||Smith||1.85
|12
|-
|Ron||Ray||1.89
|11
|-
|Mario||Bianchi||1.72
|- class="sortbottom"
|colspan="2" |Average: ||1.82
|}
 
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
Auxiliary table:
Use the more specific '''<code>style="background-color:...;"</code>'''<br>
 
to make things work correctly. Example:
<nowiki>{|class="wikitable sortable"</nowiki><br>
<syntaxhighlight lang="wikitext" highlight="3-5">
<nowiki>!demo</nowiki>
{|class="wikitable sortable"
!header
|-
!style="background-color:navajowhite" | Name
|<nowiki>|-</nowiki><br><nowiki>| 9</nowiki>
!style="background-color:navajowhite" | [[Surname]]
!style="background-color:navajowhite" | Height
|-
|John
|<nowiki>|-</nowiki><br><nowiki>|12</nowiki>
|Smith
|1.85
|-
|Ron
|<nowiki>|-</nowiki><br><nowiki>|11</nowiki>
|Ray
|1.89
|-
|Mario
|Bianchi
|1.72
|- class="sortbottom"
|colspan="2" |Average:
|1.82
|}
</syntaxhighlight>
</div>
<div style="display:inline-table; border: 2px solid lime; padding: 0.5em;">
Produces this sortable table:
{|class="wikitable sortable"
|-
!style="background-color:navajowhite" | Name
!style="background-color:navajowhite" | [[Surname]]
!style="background-color:navajowhite" | Height
|-
|John||Smith||1.85
|-
|Ron||Ray||1.89
|-
|Mario||Bianchi||1.72
|- class="sortbottom"
|colspan="2" |Average: ||1.82
|}
</div>
<nowiki>|}</nowiki>
 
== Tips and tricks ==
Now you can sort the above table, and copy the rendered text to the edit box. After deleting the "header" line, this renders as a new defaultly sorted table:
 
=== Padding ===
Sometimes entries are padded on the left for alignment purposes. This can adversely affect how they are sorted.
 
==== Non-breaking spaces ====
The effect of left-padding with [[non-breaking space]] codes <code>&amp;nbsp;</code> which render as blank spaces, depends on the browser: in IE they are (unlike actual blank spaces) counted for sorting as leading blank spaces, so in a list of numbers with text (for which the alphabetic sorting mode applies) they could be used to equalize the number of characters before the explicit or implicit decimal separator. However, in Firefox they are ignored for the purpose of sorting.
 
{|class="wikitable sortable"
!Sorting using <code>&amp;nbsp;</code> works on IE but not on Firefox
!demo
!Name
|-
|100.3 9 FM
|Third
|-
|&nbsp;89.5 FM
|11
|First
|-
|12107.3 FM
|Fourth
|-
|&nbsp;95.3 FM
|Second
|}
 
See also [[Talk:List of U.S. states and territories by population/Archive 1#Sortable Table]].
==Alphabetic sorting order==
 
Sort the following table to see an example of the alphabetic sort order. Note that sorting is case-insensitive: the two-character entries such as A1 demonstrate that A and a are at the same position.
==== Padding with zeros ====
Example:
* {{padleft:{{#expr:12*13}}|6|0}}
 
{{mono|Formatnum}} can be combined with {{mono|padleft}}:
 
{{markup2
|t=Integer
|m=<syntaxhighlight lang="wikitext" inline>{{formatnum:{{padleft:299792458|16|0}}}}</syntaxhighlight> gives:
|r={{formatnum:{{padleft:299792458|16|0}}}}
}}
{{markup2
|t=Real
|m=<syntaxhighlight lang="wikitext" inline>{{formatnum:{{padleft:{{#expr:((299792458.056 - .5) round 0)}}|16|0}}}}.{{padleft:{{#expr:(1000000*(299792458.056 - ((299792458.056 - .5) round 0))) round 0}}|6|0}}</syntaxhighlight> gives:
|r={{formatnum:{{padleft:{{#expr:((299792458.056 - .5) round 0)}}|16|0}}}}.{{padleft:{{#expr:(1000000*(299792458.056 - ((299792458.056 - .5) round 0))) round 0}}|6|0}}
}}
 
=== Controlling sorting and display ===
Text undesired for sorting but needed for display:
* In '''numeric''' sorting mode, text breaks numerical sorting whether the text is before or after the number. Sorting then becomes alphanumeric. Empty cell is treated as "zero" when sorting numerically.
* In '''date''' sorting mode, this text needs to be put in a separate column; in the case of a cell containing a range of dates or numbers (e.g. from .. to ..), text in surplus of what is required for sorting is put in the extra column. If the first part of the text is used for sorting, then the extra column needs to be the following one; conversely, if the last part of the text is used for sorting, then the extra column needs to be the previous one; depending on the table format, this dividing of an item over two cells may look ugly.
* In '''alphabetic''' sorting, any footnotes etc. do not require a separate column; they can simply be put at the end of the element.
 
Text undesired for display but needed for sorting:
* can be put as hidden text in the column to be sorted
 
Combining the two, we can have displayed text independent of text used for sorting, by fully hiding the latter, and fully putting the former in a separate column (in date sorting mode and numeric sorting mode) or in the same column after the hidden text (in alphabetic sorting). Fully putting the displayed text in a separate column may look ugly if it is not done consistently for a whole column, but only for elements that require this (e.g. if most entries in a column are single numbers, but some are ranges).
 
=== Sorting with increase/decrease/steady templates ===
{| class="wikitable sortable floatright"
!Example!!Without key!!With key
|-
|Apple||{{increase}}10||{{increase|10}}10
|-
|Banana||{{increase}}2||{{increase|2}}2
|-
|Cherry||{{decrease}}1||{{decrease|-1}}1
|-
|Durian||{{steady}}||{{steady|0}}
|}
To enable sorting of cells with [[Template:Increase]], [[Template:Decrease]] or [[Template:Steady]], add a sort key, e.g. {{tlx|increase|2}}2, {{tlx|decrease|-1}}1 or {{tlx|steady|0}}. To fix an existing table, use ''Search and replace'' (right icon in the Advanced toolbar) with ''Treat search string as a regular expression'' selected to do the following replacements:
:{| class="wikitable"
!Search for!!Replace with
|-
|<code>(\{\{increase)(\}\})([0-9]*)</code>||<syntaxhighlight lang="text" inline>$1|$3$2$3</syntaxhighlight>
|-
|<code>(\{\{decrease)(\}\})([0-9]*)</code>||<syntaxhighlight lang="text" inline>$1|-$3$2$3</syntaxhighlight>
|-
|<code>(\{\{steady)(\}\})</code>||<syntaxhighlight lang="text" inline>$1|0$2</syntaxhighlight>
|}
 
== Maintaining tables sorted alphabetically or by rank ==
 
It used to be difficult to maintain tables in rank order, and to keep the numbering correct. That is no longer true. '''[[Template:Static row numbers]]''' renumbers the row numbers after every change in row order. And after every addition or deletion of rows.
 
=== Putting a table in initial alphabetical order ===
<span id="initial alphabetical order"></span>
{{See|Help:Creating tables#Tables and visual editor}}
{{See also|Phab:T240114}}
 
There are fast and slow ways to do this. Unfortunately, the [[WP:VE|Visual Editor]] does not have a fast way to quickly alphabetize a table. You can manually move rows around one at a time. Click on a cell in a row. Then click on the arrow that shows up at the left of the row. Then click on "move above" or "move below" as needed. If this is buggy or is not working, the rows can be moved around in the wikitext by cutting and pasting rows in the wikitext.
 
'''A fast way''' is to launch free '''[[w:LibreOffice Calc|LibreOffice Calc]],''' or [[List of spreadsheet software|another spreadsheet program]]. To see how go to '''[[Help:Creating tables#Sort. Spreadsheet & VE]].''' For more info see [[commons:Commons:Convert tables and charts to wiki code or image files|Commons:Convert tables and charts to wiki code or image files]].
 
'''There is another way''' to alphabetize a table, and it keeps all the styling and flag links that a spreadsheet may remove. One can use '''NoteTab Light''' (freeware version of NoteTab). But for this to work, all the wikitext for a row must be on one line. That means the cells in that row are separated by double bars {{big|'''<code><nowiki>||</nowiki></code>'''}}.
 
To alphabetize the list by the first column paste the table wikitext into a new NoteTab Light page. Select the rows you want to alphabetize. Then click on the "modify" menu, then "lines", then "sort", and then "ascending". That will put "A" at the top and "Z" at the bottom.
 
Then put back {{big|'''<code><nowiki>|-</nowiki></code>'''}} (wikitext for row) between each line. Do that via find-and-replace by replacing {{big|'''<code>^p</code>'''}} with {{big|'''<code>^p<nowiki>|</nowiki>-^p</code>'''}}
 
:{{big|'''<code>^p</code>'''}} is the underlying text editor code for line breaks in NoteTab.
:{{big|'''<code><nowiki>|</nowiki>-</code>'''}} is the wikitext for a table row.
 
If there are blank lines between the entries replace {{big|'''<code>^p^p</code>'''}} with {{big|'''<code>^p<nowiki>|</nowiki>-^p</code>'''}}
 
Copy the wikitext and paste it back into the article. Save the page.
 
=== Initial alphabetical sort versus initial sort by rank order ===
 
It is a good idea to keep lists and tables in some kind of initial non-random sort order. It no longer matters what method you choose. '''[[Template:Static row numbers]]''' will maintain row numbering automatically no matter what changes you make to the row order.
 
==== Removing an old rank column (1,2,3) from a table ====
 
You can remove the rank column cells quickly. It is much easier now with the table editor in the [[VisualEditor]]. Click on the header in the column you want to delete. An arrow will show up at the top of the column. Click the arrow, and then "delete column".
 
Then let '''[[Template:Static row numbers]]''' create the row number column.
 
=== Auto-ranking or adding a row numbering column (1,2,3) ===
 
There are [[WP:Phabricator |Phabricator]] threads asking for a way to easily add static row numbers to tables. See '''[[phab:T42618]].''' It supersedes '''[[phab:T42634]].'''
 
In the meantime there is '''[[Template:Static row numbers]].''' It is easy to use now. It is a template to automatically add row numbers to sortable tables. The row numbers will not be sorted when columns of data are sorted. A possible note to add above a table: '''''Row numbers''' are static. Other columns are sortable. This allows ranking of any column.''
 
See [https://en.wikipedia.org/wiki/Special:WhatLinksHere?target=Template%3AStatic+row+numbers&namespace=&hidelinks=1 list of articles] transcluding {{tlx|static row numbers}}. See [https://templatecount.toolforge.org/index.php?lang=en&namespace=10&name=static+row+numbers#bottom transclusion count].
 
It has some subtemplates that work with it. Go to {{tl|static row numbers}} for more details.
 
To see the template in use: [[List of U.S. states and territories by incarceration and correctional supervision rate]].
 
Note that '''<code>style=max-width:Xem</code>''' is selectively used to narrow columns with wordy header text without using breaks <nowiki><br></nowiki>. Header breaks annoy people using [[screen readers]] due to the pauses.
 
The selective use of '''''[https://developer.mozilla.org/en-US/docs/Web/CSS/max-width max-width]''''' allows the state names to spread out, and stay on one row each if the screen is wide enough. This allows easier scanning down or across the rows. Yet when the screen becomes narrower and narrower, the state names will eventually wrap. This is good for cell phones. Use '''[[em unit]]''' settings instead of ''px''. ''Em'' units expand in width as the font size is increased.
 
Be sure to check both mobile and desktop views (links at bottom of page). Check to see that header rows aren't being given a row number. Also check that the ''max-width'' settings aren't too tight. Mobile view may need a slightly larger ''max-width'' setting for some columns. And different desktop browsers, and different settings for them, can make some max-width settings cause some column header text to overlap into the adjacent column. So it is usually good to add some extra ''em'' units to the max-width settings.
 
== Alphabetic sorting order ==
'''<nowiki>data-sort-type:text</nowiki>''' - Sort the following table to see an example of the alphabetic sort order.
 
Note that sorting is case-insensitive: the two-character entries such as A1 demonstrate that A and a are at the same position.
 
{|class="wikitable sortable"
! data-sort-type:text | Test
!demo
|-
| !
|-
| "
Line 922 ⟶ 2,567:
| 9
|-
| :
|-
| ;
|-
| <
Line 932 ⟶ 2,577:
| >
|-
| ?
|-
| @
Line 972 ⟶ 2,617:
| ~
|-
| &mdash;
|-
| É
|-
| é
|-
| É1
|-
| é1
|-
| †
|}
 
== Numerical sorting order examples ==
==Browser issues==
 
With older versions of [[w:Safari (web browser)|Safari]] a table can only be sorted by the first column: all sort buttons have the effect that only the leftmost one is supposed to have.
'''<nowiki>data-sort-type:number</nowiki>''' - Sort the following table to see an example of the numerical sort order.
 
{|class="wikitable sortable"
|+ mixed notations
! data-sort-type:number | Test
|-
| {{#expr:1000000000000000000/7}}
|-
| 1000000000000000000
|-
| -1000000000000000000
|-
| .0000000000000000001
|-
| -.0000000000000000001
|-
| {{#expr:-1000000000000000000/7}}
|-
| {{#expr:.000000000001/7}}
|-
| {{#expr:-.000000000001/7}}
|-
| 89 123 456 788
|-
| 89,123,456,789
|-
| 14
|-
| -14
|-
| 11
|-
| -12 (retrograde)
|-
| 12 or 13
|-
| 12 (?)
|-
| c. 12
|-
| 12 (approx.)
|-
| ?
|-
| 333
|-
| 1e10
|-
| e 9
|-
| e 80
|-
| e 70
|-
| e 600
|-
| 999e9
|-
| 88e80
|-
| 7e270
|-
| 999e-9
|-
| 88e-80
|-
| 7e-270
|-
| -999e9
|-
| −999e9
|-
| -88e80
|-
| -7e270
|-
| -999e-9
|-
| -88e-80
|-
| -7e-270
|-
| e3
|-
| -e3
|-
| 1e3
|-
| e9
|-
| e80
|-
| e270
|-
| 6e11
|-
| 8e11
|}
 
== See also ==
* {{tl|Sortname}} – sorting by surname without placing first name and surname in two separate columns
*{{ml|Help:Collapsing|Sortable_collapsible_table|Sortable collapsible table}}
* [[m:Help:Sorting]] – general help page of this functionality (Not Wikipedia specific)
*{{tiw|dts}} - sorting a table by a date column, while following [[w:Wikipedia:Manual_of_Style_%28dates_and_numbers%29#Dates_containing_a_month_and_a_day]] for display
* [[Help:Collapsing#Sortable tables|Sortable collapsible table]]
*[[:w:Category:Sorting templates]]
* {{tiw|dts}} – sorting a table by a date column, while following [[Wikipedia:Manual of Style (dates and numbers)#Dates containing a month and a day]] for display
*{{tim|sd}} - shows buggy date sorting when some or all dates are linked
* [[:w:Category:Sorting templates|Category:Sorting templates]] – all templates that provide functionality related to sorting.
*[[Help:Table]]
* [[OrganicDesign:How to put zebra stripes on sortable wiki tables|How to put zebra stripes on sortable wiki tables]]
*[http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/skins/common/wikibits.js wikibits.js] - contains, among other things, the sorting code
* [[Commons: Category:Table sort icons]] – useful in sorting notes (for example: [[File:sort both small.svg|10px]])
**changes regarding sorting:
***Sep 2008: allow negative numbers and scientific notation in determining numeric sort mode
***Nov 2007 [http://svn.wikimedia.org/viewvc/mediawiki?view=rev&revision=27138 allow multiple commas in numbers] - from [http://en.wikipedia.org/w/index.php?title=MediaWiki:Common.js&oldid=122738297]
***Feb 2007 [http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/skins/common/wikibits.js?r1=19987&r2=19989 allow pound and euro in currency sort mode]
***Jan 2007 [http://svn.wikimedia.org/viewvc/mediawiki?view=rev&revision=19699 sorttable.js merged into wikibits.js]
***for older revisions see the revision history of [http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/skins/common/sorttable.js?view=log&pathrev=19698 sorttable.js]
**[[meta:MediaWiki:Common.js]] page overriding function ts_parseFloat(num) and function ts_resortTable(lnk) on Meta with improved versions
**page overriding function ts_parseFloat(num); adaptation to decimal comma
**: [https://bugzilla.wikimedia.org/show_bug.cgi?id=15398] [https://bugzilla.wikimedia.org/show_bug.cgi?id=15399] [https://bugzilla.wikimedia.org/show_bug.cgi?id=15400] [https://bugzilla.wikimedia.org/show_bug.cgi?id=15401] [https://bugzilla.wikimedia.org/show_bug.cgi?id=15402] [https://bugzilla.wikimedia.org/show_bug.cgi?id=15403] [https://bugzilla.wikimedia.org/show_bug.cgi?id=15404] [https://bugzilla.wikimedia.org/show_bug.cgi?id=15405] [https://bugzilla.wikimedia.org/show_bug.cgi?id=15406 force sortorder of a column] [https://bugzilla.wikimedia.org/show_bug.cgi?id=15422 more numbers] [https://bugzilla.wikimedia.org/show_bug.cgi?id=15436]
*[[bugzilla:2001]] - resolved feature request
*[[bugzilla:8063]] - request to enable sorting of numbers with a point as thousands separator
*[[bugzilla:8115]]
*http://www.kryogenix.org/code/browser/sorttable/ - explanation of the original version of the code by Stuart Langridge; an improvement in the MediaWiki version is that tables no longer need to have an id.
*http://blog.webkist.com/archives/000043.html
*http://www.joostdevalk.nl/code/sortable-table/
*[[w:Wikipedia:Wikipedia Signpost/2007-01-02/Technology report]]
*{{tiw|sort}}
*[[mw:Extension:Sort2]]
*[[mw:Extension:Sort]]
*[[w:User:TimR/Tables]]
 
== Notes ==
Examples elsewhere:
{{noteslist}}
 
== References ==
*[[w:Ranked list of Dutch provinces]]
{{reflist}}
*[[w:List of countries by GDP estimates for 2006 (nominal)]]
*[[w:List of countries by GDP (PPP), 2006]]
*[[w:List of longest reigning current monarchs]] - date columns are sortable for people with "no preference" for date formatting, and for people with preference <nowiki>[[YYYY-MM-DD]]</nowiki>.
*[[w:User:Smurrayinchester/Template|Pokémon table]] - prefixes numbers with "#" to have them before "-".
*[[w:Nuclear_power_by_country|Nuclear power by country]] (Featured List)
*[[w:Desert Island Discs: castaways' choices]]
*[[:zh:秘鲁行政区划#大区人口|zh:秘鲁行政区划]] (Subdivisions of Peru) for sorting of Chinese (CJK)
*[[w:Standard electrode potential (data page)‎]]
 
{{Wikipedia technical help|collapsed}}
[[sv:MediaWiki:Common.js]]
[[Category:Wikipedia tables]]