Template:Sort/doc
This is a documentation subpage for Template:Sort. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
This template is deprecated. Table sort keys should now be defined using the data-sort-value attribute, like so: | data-sort-value="Doe, John" | John Doe . Please see WP:SORT § Specifying a sort key for a cell for details. |
This template is for manually adjusting sorting order in sortable tables by specified sortkeys.
- Usage
{{sort | 1 = {{{sort value}}} | 2 = {{{displayed value}}} }}
→ {{{displayed value}}}
The first parameter is the sortkey; the second parameter is the wikitext of what has to be displayed. By default, this is the sortkey with link brackets:
{{sort | 1 = {{{displayed value}}} }}
→ [[{{{displayed value}}}]]
A table using this template should use it in all rows.
This template works by placing a hidden sortkey before the visible text. The hiding of the sortkey is achieved through CSS: <span style="display:none" class="sortkey">hidden text</span>. The CSS class allows custom sort scripts to parse and get the sort key, and remove it from the DOM if needed (for some accessibility tools).
Example
|{{sort|Brothers Karamazov|[[The Brothers Karamazov]]}}
- Sorting by numerical value, date, etc.
See Help:Sorting#Numerical sorting problems and meta:Help:Sorting#Sort modes
- Equal rank
If you simply code as the second parameter an indicator that two items are equally ranked, e.g. "4=", the template interpreter will treat this as an additional parameter (i.e. parameter 4, which it will then not use). You must explicitly code this as parameter 2:
{{sort|4|2=4=}}
See also
- Template:Sortname (backlinks edit)—for using names in sortable tables (using "last name, first name" as default sort key)
- Template:dts (backlinks edit)—for using dates in sortable tables
- Template:nts (backlinks edit)—for using alphabetic sort mode for numbers in sortable tables
- Template:hs (backlinks edit)—for providing a hidden sort value for cells in a table
- Help:Sorting
- meta:Help:Sorting