Help:Sorting: Difference between revisions
Line 491: | Line 491: | ||
<nowiki>{|class="wikitable sortable" |
<nowiki>{|class="wikitable sortable" |
||
!Name and Surname!!Height |
!Name and Surname!!Height |
||
|- |
|||
|-</nowiki> |
|||
|<b style="color:red">data-sort-value="Smith, John"</b>|John Smith||1.85 |
|<b style="color:red">data-sort-value="Smith, John"</b>|John Smith||1.85 |
||
|- |
|- |
||
Line 499: | Line 499: | ||
|- |
|- |
||
!Average:||1.82 |
!Average:||1.82 |
||
|} |
|}</nowiki> |
||
This gives: |
This gives: |
Revision as of 16:07, 27 March 2014
Tables can be made sortable via client-side JavaScript with class="sortable"
(in combination with the usual formatting: class="wikitable sortable"
). This works in MediaWiki 1.9 and above, which is installed in all Wikimedia projects.
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.
JavaScript
The JavaScript code jquery.tablesorter.js (source) of the tablesorter is loaded by the ResourceLoader. Some sites may have a page MediaWiki:Common.js which adds and overrides some code. Browsers need to support JavaScript and it needs to be enabled for sorting to work.
Sort modes
As of version 1.16.5, the way items are sorted depends on the data type of the item currently in the first row. This is true for the top cell of the column in both ascending and descending order. To determine the data type, multiple cells are tested and the most appropriate format is chosen. Mismatches are possible. The sort order of a column can be forced. See the relevant section farther down.
Tags such as span or sup are ignored when determining data type.
Dates
Various date formats are supported, including those with localized month names. On the German Wikipedia, "16. März 2010" is correctly sorted as 2010-03-16
Most other numerical formats are supported as well, including those with different separators (such as . , ' or / ); On English Wikipedias dates are treated as US-Dates (eg. month-day-year) per default.
Numbers
The script can recognize numbers with different decimal separators (. and ,) as well as e/E numbers. However, numbers will be sorted alphanumerically (with 9 sorted after 10) unless this default behaviour is overridden. (See below.)
Text
Text is sorted in ASCII order (Any accented/special characters follow after the basic latin alphabet). This can be changed site wide by posting code like the following inside the common.js:
mw.config.set('tableSorterCollation', {'ä':'ae', 'ö' : 'oe', 'ß': 'ss', 'ü':'ue'});
Afterwards, all 'ä' will be sorted as if they were an ae etc.
Partial list showing the default order: !"#$%&'()*+,-./09:;<=>?@[\]^_'az{|}~é—
Forcing the sort mode for a column
The sort mode can be manually specified by putting data-sort-type
inside the header of the respective row. This functionality is based on tablesorter.com. The following (case-insensitive) values are valid for data-sort-type:
- text
- number
- IPAddress
- currency
- url
- isoDate
- usLongDate
- date
- time
Example:
{|class="wikitable sortable" ! data-sort-type="date" | Date!!Name!!Height |- |01.10.1977||Smith||1.85 |- |11.6.1972||Ray||1.89 |- |1.9.1992||Bianchi||1.72 |}
Date | Name | Height |
---|---|---|
01.10.1977 | Smith | 1.85 |
11.6.1972 | Ray | 1.89 |
1.9.1992 | Bianchi | 1.72 |
Examples
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 "−" (a minus sign).
The second example shows that expressions are not sorted according to their evaluated value, but according to the first number.
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.
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.
|
|
The example with "a" gives alphabetic sorting; that with "e" ditto, the data are not mistaken for numbers in scientific format.
Additional featuresExcluding the last row from sortingSometimes it is helpful to exclude the last row of a table from the sorting process. This can be achieved by declaring the last row as a footer Wiki markup {|class="wikitable sortable" !Name!!Surname!!Height |- |John||Smith||1.85 |- |Ron||Ray||1.89 |- |Mario||Bianchi||1.72 |- ! !!Average:||1.82 |} What it looks like in your browser
Excluding the first row from sortingThe same can be applied for first rows as well, by declaring them as header using the same exclamation mark notation.
Making a column unsortableIf you want a specific column not to be sortable, specify Wiki markup {|class="wikitable sortable" !Numbers!!Alphabet!!Dates!!Currency!!class="unsortable"|Unsortable |- |1||Z||02-02-2004||5.00||This |- |2||y||13-apr-2005||||Column |- |3||X||17.aug.2006||6.50||Is |- |4||w||01.Jan.2005||4.20||Unsortable |- |5||V||05/12/2006||7.15||See? |- !Total: 15!!!!!!Total: 29.55!! |- |} What it looks like in your browser
Specifying a sort keySometimes 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 setting the Note, however, that this makes use of a new feature in HTML5, which is enabled by default in MediaWiki (including WMF wikis since September 2012 cfr. bugzilla:27478). Wiki markup {|class="wikitable sortable" !Name and Surname!!Height |- |<b style="color:red">data-sort-value="Smith, John"</b>|John Smith||1.85 |- |<b style="color:red">data-sort-value="Ray, Ian"</b>|Ian Ray||1.89 |- |<b style="color:red">data-sort-value="Bianchi, Zachary"</b>|Zachary Bianchi||1.72 |- !Average:||1.82 |} This gives:
See also mediawiki.org. Keeping some rows togetherdata-sort-value can be used to keep certain rows together. The original mutual order of these rows is preserved. Example where this is the case for the rows about the Netherlands:
Special datesFor years BC we can use, for example, 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. Use of #timeUsing parser function #time we can put Dates and times can be entered in any php date/time format. Note that when we have just a year, a month (typically Jan) must be added in the hidden part. Example using Help:Sorting/date:
To use dates before the year 111, add a multiple of 400, e.g. 6000, to all years, this effectively shifts the range to 1 Jan -5889, 00:00:00 through 31 Dec 3999, 23:59:59, without changing the calendar. See also: Secondary sortkeyIt is possible to sort by column A (primary sortkey), while for equal values in column A, sort by column B (secondary sortkey): first sort by A by clicking the sort button of column A once or twice, then, while holding the shift-key, click the sort button of column B once or twice. Example: First click on column Text and then, while holding the shift-key, on Numbers, you'll see that the ordering is on Text (1), Numbers (2).
Cell spanning multiple rows/cellsCells which are spanning more than one row are treated as if it were multiple cells with the same value. Example:
Colspan workaroundTo 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. Example:
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. Example:
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. Controlling sorting and displayText undesired for sorting but needed for display:
Static columnA 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:
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. Default orderIt 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. Sorting the wikitext of a tableSorting the wikitext itself, thus creating a new default sort order, can be done semi-automatically as follows. Take the wikitext of the table without top and bottom lines. Use "find and replace" to replace the cell separators with special code not containing "|". If there are pipes in the table cells, replace all pipes by some code, and replace that code with a newline in front of it (originating from the code for the start of a new row) back. Apply mw:Module:Sort (see mw:Module talk:Sort) at mw:Special:ExpandTemplates by putting:
This method sorts by the wikitext of the rows, so in principal by the first column (and the second as secondary key), although wikitext codes in the cells of the first column before the content can affect the order. Basic alphabetic sorting order
The two-character entries such as A1 demonstrate that A and a are at the same position. This is not a fully alphabetic sort order: letter case is first folded to lowercase using a basic 1-to-1 conversion table (limited to the Basic Multilingual Plane of Unicode, and whose coverage and completeness still depends on browser versions and on their current implementation of the versioned Unicode Character Database), but letters with diacritics (and all other digits, symbols or special whitespaces or format control characters) will still sort according to the binary encoding of the casefolded letter, using the binary order of the UTF-16 code units (exposed and seen in Javascript through the parsed HTML DOM), but not the binary order of UTF-8 code units in the HTML page, and not of codepoints as one could also expect for encoded characters in supplementary planes). In addition, no normalization of the Unicode text is being performed (so canonically equivalent strings, that should compare equal or with only very minor binary difference, may sometimes compare very far away, with completely different strings interleaved between them). For this reason, MediaWiki pages should always be encoded with their text in the Normalized Form C (preComposed), as recommended in the HTML standards. As of today, an UCA-based sort is still not implemented in the client-side Javascript code, but some wikis are implementing a limited form of multilevel collation using custom basic replacement rules tuned for specific languages. Server issueIt has been observed that the MediaWiki code on the server replaces a regular space before "!" by a non-breaking space Persistent sort states using cookiesAdding this snippet to your MediaWiki:Common.js page will make the sortable tables remember their columns sort states in a cookie so they look the same next time the page is visited. Each sortable table must have a unique id attribute for its state to be stored in the cookie. addOnloadHook( function() {
jQuery('.sortable').each( function() {
var id = jQuery(this).attr('id');
document.shCookie = getCookie('sortheader-'+id);
document.sortheaderId = 0;
jQuery('#'+id+' a.sortheader').each( function() {
var id = jQuery(this).parent().parent().parent().parent().attr('id');
var sh = document.sortheaderId++;
if( sh+100 == document.shCookie ) { ts_resortTable(this); ts_resortTable(this); }
if( sh == document.shCookie ) { ts_resortTable(this); sh += 100; }
jQuery(this).bind('click', {id: id, sh: sh}, function(e) {
setCookie('sortheader-'+e.data.id, e.data.sh, 1);
e.data.sh += e.data.sh < 100 ? 100 : -100;
});
});
});
});
function setCookie(c_name,value,exdays) {
var exdate=new Date();
exdate.setDate(exdate.getDate() + exdays);
var c_value=escape(value) + ((exdays==null) ? "" : "; expires="+exdate.toUTCString());
document.cookie=c_name + "=" + c_value;
}
function getCookie(c_name) {
var i,x,y,ARRcookies=document.cookie.split(";");
for (i=0;i<ARRcookies.length;i++) {
x=ARRcookies[i].substr(0,ARRcookies[i].indexOf("="));
y=ARRcookies[i].substr(ARRcookies[i].indexOf("=")+1);
x=x.replace(/^\s+|\s+$/g,"");
if (x==c_name) return unescape(y);
}
}
See also
Examples elsewhere:
Links to other help pages
|