| Both sides previous revision Previous revision Next revision | Previous revision |
| wiki:plugin:datatables [2015/07/29 19:22] – [Options] Giuseppe Di Terlizzi | wiki:plugin:datatables [2020/06/14 23:46] (current) – Giuseppe Di Terlizzi |
|---|
| | <jumbotron> |
| ====== DataTables Plugin ====== | ====== DataTables Plugin ====== |
| |
| This plugin add DataTables (https://datatables.net) support to DokuWiki. | {{fa>table}} This plugin add DataTables jQuery plug-in (https://datatables.net) support to DokuWiki. |
| |
| For more information see [[doku>plugin:datatables|Datatables Plugin]] page on [[https://www.dokuwiki.org|DokuWiki.org]]! | For more information see [[doku>plugin:datatables|Datatables Plugin]] page on [[https://www.dokuwiki.org|DokuWiki.org]]! |
| | |
| | \\ |
| | \\ |
| | |
| | <btn type="success" icon="fa fa-download">[[https://github.com/LotarProject/dokuwiki-plugin-datatables/zipball/master|Download]]</btn> <btn type="default" icon="fa fa-bug">[[https://github.com/LotarProject/dokuwiki-plugin-datatables/issues|Bug tracker]]</btn> <btn type="default" icon="fa fa-paypal">[[https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9LJDLVSNGYSA2|Donate]]</btn> |
| | </jumbotron> |
| | |
| | ===== Installation ===== |
| | |
| | Install the plugin using the [[doku>plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[doku>plugins|Plugins]] on how to install plugins manually. |
| |
| ===== Syntax ===== | ===== Syntax ===== |
| \\ | \\ |
| |
| ~~NOCACHE~~ | ==== Complex Headers ==== |
| | |
| | <code><datatables> |
| | ^ Name ^^ |
| | ^ First ^ Last ^ |
| | | My | Name | |
| | | Your | Name | |
| | </datatables></code> |
| | |
| | \\ |
| | \\ |
| | |
| | <datatables> |
| | ^ Name ^^ |
| | ^ First ^ Last ^ |
| | | My | Name | |
| | | Your | Name | |
| | </datatables> |
| | |
| | \\ |
| | \\ |
| | |
| | ===== Other Examples ===== |
| | |
| | {{namespace>wiki:plugin:datatables:examples&linkonly&inline}} |
| ===== Options ===== | ===== Options ===== |
| |
| | ''dom'' | Define the table control elements to appear on the page and in what order | ''string'' | ''lfrtip'' | | | ''dom'' | Define the table control elements to appear on the page and in what order | ''string'' | ''lfrtip'' | |
| </datatables> | </datatables> |
| | |
| | <callout type="info" icon="true"> |
| | === 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"]]'%%'' or ''%%search='{"search":"fred"}'%%''. |
| | </callout> |
| | |
| | ==== Extra Options ==== |
| | |
| | The plugin also implements extra features beyond the options from DataTables jQuery library. |
| | |
| | ^ Option ^ Description ^ Allowed values ^ Default value ^ |
| | | ''header-rows'' | Makes sure the table header contains at least the specified number of rows, so that it can be formatted by DataTables. It transfers the first rows of the table body into the table header if necessary. Particularly useful when formatting tables generated by other plugins, which may not have created a proper table header. | ''integer'' | ''0'' (no effect) | |
| | |
| | ===== Extensions ===== |
| | |
| | ^ ^ Attribute ^ Example ^ |
| | ^ Fixed Header | ''fixed-header'' | ''fixed-header="true"'' or ''fixed-header='{ "header": true, "headerOffset": 50 }' '' | |
| | ^ Fixed Columns | ''fixed-columns'' | ''fixed-columns="true"'' | |
| | ^ Responsive | ''responsive'' | ''responsive="true"'' | |
| | ^ Buttons | ''buttons'' | ''buttons='[ "copy", "csv", "print" ]' '' | |
| | |
| | |
| | ===== Development ===== |
| | |
| | [[https://travis-ci.org/LotarProject/dokuwiki-plugin-bootswrapper|{{ https://travis-ci.org/LotarProject/dokuwiki-plugin-datatables.png?nocache|Build Status}}]] |
| | |
| | === ChangeLog === |
| | |
| | {{rss>http://lotar.altervista.org/feed-wrapper.php?feed=https%3A%2F%2Fgithub.com%2FLotarProject%2Fdokuwiki-plugin-datatables%2Fcommits%2Fmaster.atom 5 author date 1h }} |
| | |
| | === Known Bugs and Issues === |
| | |
| | Please report bugs or feature requests at the [[https://github.com/LotarProject/dokuwiki-plugin-datatables/issues|Bug tracker]]. |
| | |
| | {{tag>dokuwiki plugin}} |
Giuseppe Di Terlizzi