search

Dyalog / ride

Cross-platform IDE for Dyalog APL
https://dyalog.github.io/ride
MIT License
202 stars 31 forks source link

RIDE help should offer quick reference for keyboard shortcuts #389

Closed romilly closed 6 years ago

romilly commented 6 years ago

Describe the issue you are having

If I want to explore/find RIDE's keyboard shortcuts I have to

  1. Open RIDE help,
  2. go the documentation centre,
  3. open the RIDE doc,
  4. navigate to Appendix A
  5. work though until I find the shortcut I'm interested in.

Life's too short for this, (especially at my age).

Did you connect to an already running interpreter or start the interpreter from RIDE?

Either

How do you reproduce the issue?

See above

Paste the contents of Help → About (Shift+F1)

(Paste here)
jayfoad commented 6 years ago

How about going to Preferences->Shortcuts. Isn't that a more useful reference? It's always up-to-date!

jayfoad commented 6 years ago

Perhaps you'd like a new menu item Help->Keyboard Shortcuts to take you straight to that pane of the preferences window?

e9gille commented 6 years ago

I guess the preference window doesn't actually describe the commands, only lists their names. if we add another column with descriptions perhaps? It would make descriptions searchable, but the table busier.

jayfoad commented 6 years ago

There is already a column of descriptions! ABT About AC Align comments AO Comment out lines etc.

JohnScholes commented 6 years ago

There is already a column of descriptions!

Agreed. A couple of them could be improved: ABT About Dyalog EMD Edit current trace window (?) TC Trace line

jayfoad commented 6 years ago

A couple of them could be improved

Done. NB the ODE still calls TC "Trace". I'm not sure we need EMD any more. It was put in to appease some ODE users (@dyaandys ?) who found that in RIDE, they couldn't easily put their cursor onto some whitespace in order to hit \ to edit the current function. But I think these problems may have been fixed.

JohnScholes commented 6 years ago

NB the ODE still calls TC "Trace".

cf ER Execute line

I'm all for removing EMD.

On 9 May 2018, at 14:54, jayfoad notifications@github.com wrote:

A couple of them could be improved

Done. NB the ODE still calls TC "Trace". I'm not sure we need EMD any more. It was put in to appease some ODE users (@dyaandys https://github.com/dyaandys ?) who found that in RIDE, they couldn't easily put their cursor onto some whitespace in order to hit to edit the current function. But I think these problems may have been fixed.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/Dyalog/ride/issues/389#issuecomment-387746515, or mute the thread https://github.com/notifications/unsubscribe-auth/AH_E556sX5X2rf83GZNKLCIFZ2dWjFO5ks5twvUqgaJpZM4T38gL.

e9gille commented 6 years ago

There is already a column of descriptions!

Well, we have a code and a short description. I've never seen the appendix in the RIDE doc @romilly referred to before today, but there you'll find a long description of each command. That is the one I was talking about. I'd rather not put the long one in though.

jayfoad commented 6 years ago

Perhaps we should have Help->RIDE User Guide to take you straight to the pdf in your browser.

romilly commented 6 years ago

My mistake (though others may make it) - I'd never visited preferences until now, so I had no idea that's where the shortcuts were listed.

Some sort of link from help to the shortcuts (in preferences) would be fine.

FionaDyalog commented 6 years ago

In RIDE 4.0 there was a little keyboard icon to the right of the language bar: • Positioning the cursor over the icon displayed a tooltip showing selected keyboard shortcuts for command codes. • Clicking on the icon displayed the Preferences dialog box (the same as selecting the Edit > Preferences menu option)

In RIDE 4.1 this is no longer there. Maybe reinstating this (or having something similar to the mousing over option described above) would provide a convenient way of checking what you have configured your shortcuts to be?

jayfoad commented 6 years ago

@FionaDyalog see #341: the change was deliberate. The tooltip only showed an arbitrary subset of shortcuts, which didn't seem very useful, and the icon changed to a gear wheel and then migrated to the left of the status bar.

FionaDyalog commented 6 years ago

@jayfoad It might have been deliberate, and I agree the arbitrary nature of its population was not helpful, but could there not be a dynamic replacement that you mouse over to see all your configured shortcuts without having to go into the correct tab of the dialog box? I might be biased here though as I found it useful!

e9gille commented 6 years ago

I have re-instated the keyboard icon in the language bar. Hovering over it shows all defined shortcuts. Clicking it opens the preferences on the Shortcuts tab. Once there you can filter to show only defined shortcuts. Top right you will find a print button to print the (optionally filtered) list.

Hope that helps.