quanteek/dash-at-point

a emacs lisp for searching the word at point with Dash

Overview

dash-at-point.el --- Search the word at point with Dash

Dash is an API Documentation Browser and Code Snippet Manager. dash-at-point make it easy to search the word at point with Dash.

Usage

If you choose not to use one of the convenient packages in Melpa, you will need to add the directory containing dash-at-point.el to your load-path, and then add the following to your .emacs:

(add-to-list 'load-path "/path/to/dash-at-point")
(autoload 'dash-at-point "dash-at-point"
          "Search the word at point with Dash." t nil)
(global-set-key "\C-cd" 'dash-at-point)
(global-set-key "\C-ce" 'dash-at-point-with-docset)

Run dash-at-point to search the word at point, then Dash is launched and search the word. Use prefix argument C-u to edit the search string first.

Dash queries can be narrowed down with a docset prefix. You can customize the relations between docsets and major modes.

(add-to-list 'dash-at-point-mode-alist '(perl-mode . "perl"))

To choose docsets before call Dash, run dash-at-point-with-docset. The docset options are suggested from the variable

Additionally, the buffer-local variable dash-at-point-docset can be set in a specific mode hook (or file/directory local variables) to programmatically override the guessed docset. For example:

(add-hook 'rinari-minor-mode-hook
          (lambda () (setq dash-at-point-docset "rails")))

Dash 1.9.3 introduces a new way to call Dash with keywords (dash-plugin://), but if you want to use the legacy way (dash://), set non-nil to dash-at-point-legacy-mode.

(custom-set-variables '(dash-at-point-legacy-mode t))

Copyright

Copyright (C) 2013 Shinji Tanaka

Licence

This file is NOT part of GNU Emacs.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.