Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inline Documentation #2373

Closed
timo-bes opened this issue Apr 29, 2011 · 11 comments
Closed

Inline Documentation #2373

timo-bes opened this issue Apr 29, 2011 · 11 comments
Labels
Critical Indicates the severity of an issue is very critical and the issue has a very high priority. Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc.
Milestone

Comments

@timo-bes
Copy link
Member

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
Copy link
Contributor

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

@robocoder
Copy link
Contributor

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
Copy link
Contributor

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

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

@mattab
Copy link
Member

mattab commented May 6, 2011

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

@mattab
Copy link
Member

mattab commented May 6, 2011

(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
Copy link
Member Author

timo-bes commented May 6, 2011

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

@robocoder
Copy link
Contributor

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
Copy link
Member

mattab commented May 9, 2011

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
Copy link
Member Author

timo-bes commented May 9, 2011

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
Copy link
Member

mattab commented May 20, 2011

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
Copy link
Member

mattab commented May 23, 2011

(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-bes timo-bes added this to the 1.5 - Piwik 1.5 milestone Jul 8, 2014
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Critical Indicates the severity of an issue is very critical and the issue has a very high priority. Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc.
Projects
None yet
Development

No branches or pull requests

3 participants