Inline Documentation

[timo-bes]

The goal is to make documentation accessible inside the piwik UI.

There are two parts:

1. General help about current report. 1 or 2 sentences to explain the report.

2. Help about each column separately. On hover on a column name, show a (?) icon, and on hover or click on this icon, show the help in a tooltip.

Documentation for general metrics will be implemented in API/API.php, more information comes from the getReportMetadata method in plugin controllers.

[robocoder]

(In [4639]) refs #2373 - minor edits; btw I don't think singleReport() should be in core/View.php

[robocoder]

EZdesign: don't worry about my comment about singleReport. p.s. use "refs" or "fixes" in your commit messages, so the messages are automatically logged in the ticket.

[robocoder]

(In [4634] by EZdesign) refs #2373 inline documentation for reports and metrics

(In [4635] by EZdesign) refs #2373 added missing files

[mattab]

vipsoft, you have to remove assets to make the new code work

[mattab]

(In [4646]) Refs #2373
Maybe it looks a bit better if help icon is more grey/brown than blue, when showing next to title? (less contrast, more discreet)

[timo-bes]

(In [4649]) refs #2373 removed forgotten debug code

[robocoder]

re: comment:4 lol @ the newbie advice. I think it was a problem with FF4. After some twiddling with settings and restarting the browser, it looks normal again... but where's the help icon?

[mattab]

Help displays on all reports pages next to the Title (on hover) and on the column names (on hover). It does not display in the dashboard (maybe it could but I'm fine with it..)

Great work EZDesign!

[timo-bes]

I think displaying help in the dashboard would make it a bit cluttered. Further, the popup for enlarged reports would cut off the column documentation. That's why I disabled the help in the dashboard.

In general, I think the dashboard is for users who know the reports already. If someone uses Piwik for the first time, he will probably click through all the menus and get the help texts there.

[mattab]

Small bug spotted: in the Widgets screen, widgets have the ? icon, but there is no title. In the case of Widgets, the inline help for the report should not be displayed.

[mattab]

(In [4793]) Fixes #2373 - hiding the help icon on widgetize view
REfs #898 Ecommerce orders log now refreshes properly on pagination rather than refreshing over the whole screen