Skip to content
This repository has been archived by the owner on Jul 24, 2019. It is now read-only.

Hotkeys dependency #53

Closed
chrisharrison opened this issue Apr 20, 2013 · 4 comments
Closed

Hotkeys dependency #53

chrisharrison opened this issue Apr 20, 2013 · 4 comments

Comments

@chrisharrison
Copy link

It is mentioned in the docs that jQuery HotKeys is a dependency. But I interpreted this as "a dependency - if you intend to use the hotkey feature" ... and without it, the core functionality would still work. This is a standard terminology that other libraries use.

It took me a while to realise that the jQuery HotKeys REALLY is a dependency. i.e. the whole thing relies on it. I think this should be made very, very clear in the instructions/documentation.

@gojko
Copy link
Contributor

gojko commented Apr 20, 2013

for me, a dependency means exactly that, a dependency, not an optional dependency

@gojko gojko closed this as completed Apr 20, 2013
@chrisharrison
Copy link
Author

What you say is, of course, 100% true. But I think many people will have difficulty and interpret it wrongly due to the fact that hundreds of other libraries also mention hotkey plugins, scrolling plugins etc. that are "optional". Usually they are NOT dependencies.

Also the reason why I initially ignored that instruction (and I believe many others will do too), is because adding lots of libraries introduces page bloat. So that is why I normally ignore any additional files.

I agree that technically there is no problem with the wording. Dependency means essential. If someone (like me) interprets that wrongly - it is their fault. But in the interests of giving people a helping hand?

@joshorvis
Copy link

I came across the same issue. Took me a while to realize that lack of the hotkeys library was screwing me up - I think the confusion is coming from the part of the documentation that indicates you can change the hotkey assignments. While it did not explicitly state so, I made the assumption that hotkey use was optional and therefore the library it depended on was optional as well.

@joshorvis
Copy link

BTW, on that note, it should be listed that FontAwesome is a dependency for the Strikethrough, Underline, UL and OL buttons. That was another gotcha.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants