lemonmade / bigfoot

A jQuery plugin for creating exceptional footnotes.
http://www.bigfootjs.com
MIT License
935 stars 77 forks source link

Bottom style functionality using 'positionContent' option is unclear in documentation #8

Closed ericdodds closed 10 years ago

ericdodds commented 10 years ago

First, amazing plugin.

When using the Bottom style, it's clear that you need to use the CSS, but unclear that you need to change the 'positionContent' option to 'false' in order for the popup to behave correctly—it took a good bit of trouble shooting and re-reading the docs a few times to realize the two were directly related.

I'd be happy to update the site if you point me to the repo.

Again, great work.

lemonmade commented 10 years ago

I haven't put the site itself on Github yet (code's a bit of a mess). How would you adjust the site to represent this? I agree with your point but I wasn't sure where to put such information. My only idea is to make some sort of comment about using bottom-fixed styles in the text for the positionContent option.

ericdodds commented 10 years ago

Gotcha. I think part of the issue is that there isn't documentation about the styles. That might be unnecessary if the Bottom style is the only one with this type of particular behavioral setting. Either way, it might be helpful to add the point both to the main page under the 'positionContent' section, as well as on the demo page when the Bottom style is selected (see screenshot). That's where I poked around initially to find some sort of documentation.

Also, I'd be happy to convert the content from the site to Markdown and update the README file on this repo if that would be helpful.

Thanks again for your awesome work.

positioncontent-note

lemonmade commented 10 years ago

OK, added an indicator of what value positionContent should be for the styles. I just left it there for every style and changed the value from true to false or vice versa depending on the button selected. (Trying to animate it in was fairly ugly as the only easy way was to animate the comment's height, which has terrible performance.)