Documentation hotkey

Hi,

Many years ago I worked a lot with Borland Delphi, and one of the best features of their IDE was the combination of an excellent help system and the possibility to look up any keyword from the code with a single keystroke (F3).

Is there something similar in the LispWorks IDE? The documentation is pretty good, but having to go to the Help menu, choosing ”On Symbol…”, writing the symbol in a box, and then choosing from a list of search results, is pretty tedious. (Actually switching to a browser and google is usually faster for me). So is there a better way? And even if there isn’t out of the box, there surely must be possible to customize LW in that direction?

How do you folks use the built-in documentation?

Erik



_______________________________________________
Lisp Hug - the mailing list for LispWorks users
lisp-hug@lispworks.com
http://www.lispworks.com/support/lisp-hug.html

Unable to render article 14629 because of ":DEFAULT stream decoding error on #<SB-SYS:FD-STREAM for \"socket 192.168.43.216:64095, peer: 116.202.254.214:119\" {10045F83F3}>: the octet sequence #(246 109 32 119) cannot be decoded." error

Re: Documentation hotkey

For me it is F5 (with http://weitz.de/lw-doc/).

Jens

On 27. Oct 2017, at 16:03, Erik Ronström <erik.ronstrom@doremir.com> wrote:

Hi,

Many years ago I worked a lot with Borland Delphi, and one of the best features of their IDE was the combination of an excellent help system and the possibility to look up any keyword from the code with a single keystroke (F3).

Is there something similar in the LispWorks IDE? The documentation is pretty good, but having to go to the Help menu, choosing ”On Symbol…”, writing the symbol in a box, and then choosing from a list of search results, is pretty tedious. (Actually switching to a browser and google is usually faster for me). So is there a better way? And even if there isn’t out of the box, there surely must be possible to customize LW in that direction?

How do you folks use the built-in documentation?

Erik

_______________________________________________
Lisp Hug - the mailing list for LispWorks users
lisp-hug@lispworks.com
http://www.lispworks.com/support/lisp-hug.html

Re: Documentation hotkey

A good way to get an overview of the keybindings is:

c-h b   -> this gives an overview of the keybindings

I have

Meta-Ctrl-Shift-a   Show Documentation
Ctrl-Shift-d     Function Documentation

Meta-.      Find Source


It helps to go through the keybinds and check what is there already.


Regards,

Rainer Joswig


> Am 27.10.2017 um 16:03 schrieb Erik Ronström <erik.ronstrom@doremir.com>:
> 
> Hi,
> 
> Many years ago I worked a lot with Borland Delphi, and one of the best features of their IDE was the combination of an excellent help system and the possibility to look up any keyword from the code with a single keystroke (F3).
> 
> Is there something similar in the LispWorks IDE? The documentation is pretty good, but having to go to the Help menu, choosing ”On Symbol…”, writing the symbol in a box, and then choosing from a list of search results, is pretty tedious. (Actually switching to a browser and google is usually faster for me). So is there a better way? And even if there isn’t out of the box, there surely must be possible to customize LW in that direction?
> 
> How do you folks use the built-in documentation?
> 
> Erik
> 
> 
> 
> _______________________________________________
> Lisp Hug - the mailing list for LispWorks users
> lisp-hug@lispworks.com
> http://www.lispworks.com/support/lisp-hug.html


_______________________________________________
Lisp Hug - the mailing list for LispWorks users
lisp-hug@lispworks.com
http://www.lispworks.com/support/lisp-hug.html

Re: Documentation hotkey

Hi,

I use external program called Dash for documentation lookup (https://kapeli.com/dash). In Dash there is a CLHS available. I use LW on OSX where I use Dash client and on Windows where I use Velocity (https://velocity.silverlakesoftware.com/) for the same databases. I've also created the LW CAPI documentation database for Dash: https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/CAPI and its now available in the list of user-contributed Dash docsets.

Here is the command to bind to call:

(editor:defcommand "Search In Dash" (p &optional name)

"Search current word in Dash"

(let* ((name (format nil "~a" (editor:get-symbol-from-point (editor:current-point)))))

(open-in-dash name)))

And the open-in-dash code:

(defun open-in-dash (name)

(let ((url (concatenate 'string "dash://" name)))

#+:mswindows

(let ((null-ptr (fli:make-pointer :address 0 :type :void)))

(fli:with-foreign-string (text element-count byte-count

:external-format :unicode)

url

(declare (ignore element-count byte-count))

(shell-execute 0 null-ptr text null-ptr null-ptr 5)))

#+:cocoa

(objc:invoke (objc:invoke "NSWorkspace" "sharedWorkspace") "openURL:" (objc:invoke "NSURL" "URLWithString:" url))))

Finally the bindings:

#+:cocoa (editor:bind-key "Search In Dash" "Hyper-F1" :global)
#-:cocoa (editor:bind-key "Search In Dash" "Ctrl-F1" :global)

/Alexey

On Fri, Oct 27, 2017 at 5:00 PM, Erik Ronström <erik.ronstrom@doremir.com> wrote:

Thanks, all of you, great tips!

I didn’t know about c-h b, that’s a useful one!

Erik

> 27 okt. 2017 kl. 16:39 skrev Rainer Joswig <joswig@lisp.de>:
>
> A good way to get an overview of the keybindings is:
>
> c-h b -> this gives an overview of the keybindings
>
> I have
>
> Meta-Ctrl-Shift-a Show Documentation
> Ctrl-Shift-d Function Documentation
>
> Meta-. Find Source
>
>
> It helps to go through the keybinds and check what is there already.
>
>
> Regards,
>
> Rainer Joswig
>
>
>> Am 27.10.2017 um 16:03 schrieb Erik Ronström <erik.ronstrom@doremir.com>:
>>
>> Hi,
>>
>> Many years ago I worked a lot with Borland Delphi, and one of the best features of their IDE was the combination of an excellent help system and the possibility to look up any keyword from the code with a single keystroke (F3).
>>
>> Is there something similar in the LispWorks IDE? The documentation is pretty good, but having to go to the Help menu, choosing ”On Symbol…”, writing the symbol in a box, and then choosing from a list of search results, is pretty tedious. (Actually switching to a browser and google is usually faster for me). So is there a better way? And even if there isn’t out of the box, there surely must be possible to customize LW in that direction?
>>
>> How do you folks use the built-in documentation?
>>
>> Erik
>>
>>
>>
>> _______________________________________________
>> Lisp Hug - the mailing list for LispWorks users
>> lisp-hug@lispworks.com
>> http://www.lispworks.com/support/lisp-hug.html
>
>
> _______________________________________________
> Lisp Hug - the mailing list for LispWorks users
> lisp-hug@lispworks.com
> http://www.lispworks.com/support/lisp-hug.html

_______________________________________________
Lisp Hug - the mailing list for LispWorks users
lisp-hug@lispworks.com
http://www.lispworks.com/support/lisp-hug.html