Changes to 'Basic HTML' format

[vipsoft]

Drop styling. Developers will apply their own theme anyways.

• Drop <style>...</style> from output
• Remove <b></b> tags
• Drop border and width attributes from <table> definition

Recommended changes:

• Enclose attribute values in double quotes.
• Separate header and body using <thead></thead> and <tbody></tbody>
• Set table id, e.g., id="Actions_getActions"
• Instead of "Sub DataTable not loaded", add a pseudo-column that contains an integer (idSubtable)

Improvements:

• Add example using the  jQuery DataTables plugin

[vipsoft]

• Add unit tests to tests/core/DataTable/Renderer.test.php
• Fix missing </tr> on header row.

[vipsoft]

Depends on #772

[vipsoft]

(In [1222]) fixes #760 - changes to Basic HTML format

[vipsoft]

(In [1223]) refs #760 - use <th> for header

[vipsoft]

Screenshot of data table

[vipsoft]

screenshot of graph table

[vipsoft]

Sample code

[vipsoft]

The attached example uses the following jquery plugins:

•  graphTable
•  flot (for plotting)
•  dataTables

[matt]

Reopening:

• before the html output was a simple debug output; now it seems it will be part of the feature as your examples suggest: it makes it very easy to reuse the data in external apps. As such, we need to add unit test to the output of this table, just like other format are tested in tests/core/DataTable/Renderer.test.php

• how could we best showcase this new feature? It looks like something that could be very useful to many people integrating Piwik in their project.. I would suggest a short and sweet blog post tutorial explaining how to do so - just an idea :-) but would definitely advertise this to the community

• could we also include it in misc/?

• you mention "flot", is it in the screenshots attached to the ticket?

good work!

[matt]

* why do you do the following?

$value = html_entity_decode($value, ENT_COMPAT, 'UTF-8');
$value = htmlspecialchars($value);

I would instead suggest to use Piwik_DataTable_Filter_SafeDecodeLabel to keep this logic in one place only.

[vipsoft]

• I can't include a test case/tutorial until #772 is fixed because the variance in column order means the tests would pass on one machine and fail on another; similarly, dataTables and graphTable use row/column position/index to select data, not by row/column name
• flot is used by graphTable, so there isn't a separate screenshot
• the samples are just a proof-of-concept; Let's create a separate ticket to spec out what a flashy non-flash demo would be
• why do I... hang on, I copied that snippet of code from another Renderer ;)

[vipsoft]

Closing in favor of #804; test case will be included in #772

[vipsoft]

Note: dataTable.html is a proof-of-concept; in practice, the data would be embedded in the page from the server-side so that token_auth is not exposed in the page source