Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Inline Documentation #2373

Closed
BeezyT opened this Issue · 11 comments

3 participants

Timo B. Anthon Pang Matthieu Aubry
Timo B.
Collaborator

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.

Anthon Pang
Collaborator

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

Anthon Pang
Collaborator

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.

Anthon Pang
Collaborator

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

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

Matthieu Aubry
Owner

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

Matthieu Aubry
Owner

(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 B.
Collaborator

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

Anthon Pang
Collaborator

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?

Matthieu Aubry
Owner

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 B.
Collaborator

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.

Matthieu Aubry
Owner

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.

Matthieu Aubry
Owner

(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

Timo B. BeezyT added this to the 1.5 - Piwik 1.5 milestone
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.