dpinney / omf

The Open Modeling Framework for smart grid cost-benefit analysis.
https://omf.coop
GNU General Public License v2.0
112 stars 60 forks source link

Implement mouse-over comments for model input data. #268

Closed dpinney closed 9 years ago

dpinney commented 10 years ago

Currently our input form looks like this:

image

We need a way to add instructions to the user in a mouse-over. I.e. when a user hovers their mouse over the

Style information to follow. I'm thinking white text on a very dark gray background.

An example of what would go in the box: sources for variables, notes about how they're used in the model, etc.

cshjin commented 10 years ago

Two options: one is direct use title attribute of input field to show the text. image Another is use some css on the label like this: image

I prefer the second one.

Is there any standard explanatory text? For example, in pvWatts model all the input field explantion should stay the same with its SAM APIs: image

dpinney commented 10 years ago

I also prefer the second style. But can we do white text instead of black?

I'll need to come up with the text annotations for each of the fields. That will take some time. For now, just use whatever text you have. And I'll create separate issues to track gathering the real text.

dpinney commented 10 years ago

Oh, one other thought. The underline of the label with a tooltip is great. Some labels will not need tooltips, so it'll be good to indicate which ones have notes on them.

cshjin commented 10 years ago

I searched several examples, and steal the ideal from here

dpinney commented 10 years ago

Good artists copy; great artists steal.

cshjin commented 10 years ago

4ab8ab616a96be2a7bc4588a1d742607b1a7cbe9 is the initial mouse-over feature, I also created another issue to provide more detailed explanation of input filed, as stated in https://github.com/dpinney/omf/issues/277

dpinney commented 9 years ago

Closed since the capability is there.