This plugin implements the DataTables jQuery plugin.

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Note for Hogfather users
Hogfather use the JS “defer” attribute for speedup the loading of the JS assets, but some users report issues in some plugin and template. If you encounter problems, you can disable defer_js option via Configuration Manager.

See the plugin in action here. The sample page shows all the styles available with the plugin.

A simple usage:

<datatables>
^ Column A ^ Column B ^ Column C ^
| Row A1   | Row B1   | Row C1   |
| Row A2   | Row B2   | Row C2   |
| Row A2   | Row B2   | Row C3   |
</datatables>

Some more complex samples

<datatables page-length="50"> [...] </datatables>
<datatables paging="false" ordering="false" info="false" searching="false"> [...] </datatables>

<datatables header-rows="true">
| Row A1   | Row B1   | Row C1   |
| Row A2   | Row B2   | Row C2   |
| Row A2   | Row B2   | Row C3   |
</datatables>

<datatables>
^ Name ^^
^ First ^ Last ^
| My | Name |
| Your | Name |
</datatables>

Basic syntax:

<datatables> [...] </datatables>

See https://datatables.net/reference/option/ for complete options.

Notes:

• The option names are actually used as HTML5 data attributes, so they must be formatted with hyphens-and-lower-case instead of CamelCase (see https://datatables.net/manual/options#HTML-5-data-attributes).
• Do not prepend option names with data-. The prefix will be added by the plugin.
• Complex option values must be specified using valid JSON, wrapped with single quotes '. For example: order='[[0, "asc"]]', order='[[0, "desc"]]' or search='{"search":"fred"}'.
• Datatables won't work in complex tables, where cells are merged together (e.g. with “:::”)

The plugin also implements extra features beyond the options from DataTables jQuery library.

The demo and examples is available on http://lotar.altervista.org/dokuwiki/wiki/plugin/datatables.

• Added support for PHP 8.x on legacy DokuWiki by giterlizzi (2023-08-31 15:42)
• Fix typo by giterlizzi (2023-08-30 15:30)
• Updated release by giterlizzi (2023-07-23 17:42)
• Merge branch 'master' of https://github.com/LotarProject/dokuwiki-plu… by giterlizzi (2023-07-23 17:41)
• Merge pull request #70 from cosmocode/master by giterlizzi (2023-07-23 17:39)
• cleanup script.js by splitbrain (2023-07-12 10:17)
• code cleanup for syntax.php by splitbrain (2023-07-12 09:45)
• fix i18n handling by splitbrain (2023-07-12 09:35)

Please report bugs or feature requests at the Bug tracker.

• I cannot get the buttons (csv,xls,pdf) to appear as documented: see: discussion on GitHub
• How to use with the CSV plugin: read the discussion on GitHub¹⁾.
• I would like sorting a column by date. dd/mm/yyyy doesn't work. The way I have found is mm.dd which is not obvious (for french people) and Year doesn't match in this format. I follow this thread about but don't know if the feature is already implemented in Datatables. Thanks. — Digitalin 2016-02-08 13:16
  • Information is sorted as text by default in Datatables. According to this post and documentation, the best format is yyyy/mm/dd and works well. In case, to get at once a new format with bash : sed -E 's,([0-9]{2})/([0-9]{2})/([0-9]{4}),\3\/\2\/\1,g' page.txt > page2.txt (to adapt to your situation) — Digitalin 2016-10-07 14:07
• It seems the tables default to a background color of white. Is there a way to change that? I tried modifying some values in the plugin css files but they are difficult to read and the changes seemed to have no effect.
• It would be nice if it was possible to state which column the sort should be applied to (as a default)

This plugin looks like the answer to my dreams!

Can it use any of the jQuery DataTables data sources? I.e. can I get data into the table from 'outside' rather than having to fill the data in the DokuWiki source page? In particular I would like to use the ajax server side processing to run some PHP to read a database to provide the data.

Also, are the table editing functions of DataTables available?

This is quite a very nice & practical plugin, that you may use in conjunction with sql plugin, eg:

<datatables page-length="20">
<sql>select * from cms ORDER BY type_id;</sql>
</datatables>

Only a little suggestion if you use it with sql plugin: wouldn't if be possible to rewrite cells containing an url to a clickable link (like in dw), eg.

https://forum.dokuwiki.org/forum/28 ->
<a href="https://forum.dokuwiki.org/forum/28">https://forum.dokuwiki.org/forum/28</a>

but maybe the problem is on sql plugin…

One possible answer to the above is to modify the SQL query so it outputs a link.

• To make a URL clickable (where the thing returned from sql is already a URL, in field “url”):

<sql>
SELECT
 CONCAT('<a href="',table.url,'" target=_blank">',table.url,'</a>') AS url,
...
FROM
    table
...
</sql>

To make “id” in table “table” part of a clickable link:

• To put the id at the end of the link, e.g.: https://my.website.here/100

<sql>
SELECT
 CONCAT('<a href="https://my.website.here/',table.id,'" target=_blank">',table.id,'</a>') AS id,
...
FROM
    table
...
</sql>

• To insert the field id somewhere in the link, e.g.: https://my.website.here/100/details

<sql>
SELECT
    CONCAT('<a href="https://my.website.here/',table.id,'/details" target="_blank">',table.id,'</a>') AS id,
...
FROM
    table
...
</sql>

And other variations on this, for example if you needed multiple fields to build the URL, that's possible too with CONCAT.

Obviously this hack is only useful if you're using datatables with the sql plugin. It also means you can't do “SELECT *” because you need to modify the correct field.

I agree that auto-hyperlinks for URLs would be a neat feature. As an aside, the data in the PDF/CSV/Excel export buttons do not contain the URL link but the rendered output, which is probably what you want.

• Any information for Igor support?