This is an old revision of the document!
Table of Contents
sortablejs Plugin
Compatible with DokuWiki
anteater, angua, Rincewind, adora belle, Weatherwax, Binky, 2014-05-05 "Ponder Stibbons", 2014-09-29 "Hrun"
Similar to datatables, tablelayout
Needed for linkmanager
Description
A JavaScript-based (client-side) plugin, which can be used to create sortable tables. It is optional for linkmanager plugin.
For server-side sorting or more robust sort facilities use Sam Wilson's sorter, based on https://github.com/Mottie/tablesorter (supports server-side sorting): https://github.com/samwilson/dokuwiki_sortablejs
Previously maintained by oiv (Otto Vainio at otto@valjakko.net)
Usage
After installing the plugin you should make sure that your DokuWiki cache is updated. This can easily be done by changing any parameter value in settings (or by doing a touch conf/local.php
).
You need to set <sortable>
and </sortable>
tags around your table.
<sortable> ^Col1^Col3^Col3^ |1|one|25/12/2008| |2|two|10/12/2008| </sortable>
Table initially sorted by column 1
<sortable 1> ^Col1^Col3^Col3^ |1|one|25/12/2008| |2|two|10/12/2008| </sortable>
Table initially reverse sorted by column 1
<sortable r1> ^Col1^Col3^Col3^ |1|one|25/12/2008| |2|two|10/12/2008| </sortable>
To sort the columns you (the page viewer) just needs to click on the correct column on the first row. A second click on the same column reverses sort.
Options
<sortable [[r]column] [sumrow[=2]] [column=alpha|numeric|ddmm|mmdd|nosort] [3phase]> <sortable r1 sumrow=2 3phase 1=numeric 2=alpha 3=nosort> ││ │ │ │ │ │ ││ │ │ │ │ └ No sort option for column 3 ││ │ │ │ └ Sort column 2 as text always ││ │ │ └ Sort column 1 as numeric always ││ │ └ Add a 3 phase sort option. Normal, Reverse and Back to original order. ││ └ Prevent last 2 rows from sort. The number can be omitted. Default is last row (=1) │└ Initially sort by column 1 on page load └ Reverse initial sort
Misc links
historical versions: https://github.com/FyiurAmron/sortablejs/wiki/older-versions
GitHub revision history: https://github.com/FyiurAmron/sortablejs/commits/master
historical bugs/ehnancements: https://github.com/FyiurAmron/sortablejs/wiki/old-issues-and-enhancement-requests
current issue tracker: https://github.com/FyiurAmron/sortablejs/issues