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

New way for plugins to call Dash with keywords #20

Closed
Kapeli opened this issue Jan 7, 2014 · 1 comment
Closed

New way for plugins to call Dash with keywords #20

Kapeli opened this issue Jan 7, 2014 · 1 comment

Comments

@Kapeli
Copy link
Collaborator

Kapeli commented Jan 7, 2014

Dash 1.9.3 comes with a new way for plugins to call Dash and send over a list of keywords which Dash uses to enable/disable docsets.

This is all described at http://kapeli.com/dash_plugins.

This was designed for IDEs and editors, so that they can activate more than one docset at a time based on the type of the file they're currently editing.

Even if you only want one docset at a time, I suggest that you change the workflow to also use the new URL scheme. The only benefit in doing this is that the workflow will still work if the user changes his keyword preferences.

So, for example, if the user sets r: as the keyword for Ruby, calling dash://ruby:{query} will no longer work. However, calling dash-plugin://keys=ruby&query={query} will still work.

One thing to look out for: you need to percent escape the {query}, otherwise things will fail when the user searches for things that cointain a & (and possibly other special chars as well).

As the benefit is not that huge, it's up to you whether or not to change things.

@willfarrell
Copy link
Owner

Thanks for letting me know. I'll add a note to the README mentioning it for future shortcuts added, or the updating of old one where other are having this issue.

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

No branches or pull requests

2 participants