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

Revised hotkey system #1525

Merged
merged 18 commits into from
Aug 10, 2016
Merged

Revised hotkey system #1525

merged 18 commits into from
Aug 10, 2016

Conversation

mairdl
Copy link
Contributor

@mairdl mairdl commented Jun 29, 2016

Revised Hotkey System

In the next release of JabRef we will introduce a revisid hotkey system. The 2 goals of this revision is to improve maneuverability through the keyboard and streamlining hotkeys. Some related hotkeys like for the side panes were scattered across the keyboard, so we grouped them together. You might be wondering what has changed, so have a look at them:

  • Change default key bindings (have a look at the table below)
  • Add a hotkey for creating a new technical report
  • Add a hotkey for opening the OpenOffice/LibreOffice pane
  • Add “Print preview” to the right-click menu
  • Improve group pane maneuverability by making groups selectable by arrow keys
  • Improve main table maneuverability by making “TAB” jump to the next entry instead of the next cell, “SHIFT+TAB” selects the previous entry
  • Resize the “change key bindings” dialog to 500x500
Keys - new Keys - old Function
F7 alt + f Automatically set file links
F8 ctrl + shift + F7 Cleanup entries
alt + 1 ctrl + shift + E Focus entry table
alt + 2 ctrl + F9 Toggle entry/preview editor
alt + 3 ctrl + shift + G Toggle groups
alt + 4 F5 web search
alt + 0 - Open Openoffice/LibreOffice connection
ctrl + shift + F7 ctrl + f4 Synchronize file links
ctrl + shift R - Technical report
- alt + P Print entry preview
- ctrl + alt + T Hide/show toolbar
- ctrl+P Edit preamble

As you can see we moved related functions together. “F7” is now affiliated with file links, hence we changed key bindings if they contained “F7” but weren’t related to file links.
Also we moved all side panes together by changing them to “ALT+(1,2,3,4,0)”. By doing so we hope to improve the accessibility, because now you don’t have to remember all kinds of key combinations for side panes, only which number stands for your desired pane. On a side note: Open OpenOffice/LibreOffice connection was added to this family due to being a side pane.
The hotkey for “Edit preamble” was changed due to normally being the hotkey to print.
The new hotkey for “New technical report” was requested by some users that use it frequently, so we added a key binding.
We removed the hotkey for “Hide/show toolbar” due to being not of any imaginable use for users.
We removed the hotkey for “Print entry preview” due to some conflicts with others and the fact that this function wasn’t really used that often by users. But we didn’t remove it completely, we added it to the right click menu.
We removed the hotkey for "Edit preamble" due to being a seldomly used action that doens't require a hotkey.
We resized the “change key bindings” dialog due to being too small for some descriptions.

For questions about the functioning or suggestions for improvements please use the discussion forum. In case you have trouble, report bugs on GitHub.

@mairdl mairdl changed the title Revised hotkey system [WIP] Revised hotkey system Jun 29, 2016
@boceckts
Copy link
Contributor

I think you should leave a comment in the changelog

@boceckts
Copy link
Contributor

Please fix failing check.

@oscargus
Copy link
Contributor

I think that is currently the only way to print the preview. Unless one enables the preview toolbar, which, if I recall correctly, is only supported by manual editing of the preferences... But I may be wrong here.

@mairdl
Copy link
Contributor Author

mairdl commented Jul 4, 2016

I have disscussed the new bindings with @koppor. As far as I remember he said that print entry preview isn't needed at all.

@tobiasdiez
Copy link
Member

  • Printing preview: just add it to the right-click menu
  • I would put the websearch on Alt + 4 (more important then OpenOffice)
  • for the same reason, OO -> Alt + 0
  • Remove default Toggle Toolbar shortcut (can't imagine that this is useful for somebody, I would leave alt + num for toggling real panes)
  • What is the difference between F7 and Alt + F7, both are mapped to the same command according to your table.

@mairdl
Copy link
Contributor Author

mairdl commented Jul 4, 2016

I fixed my table regarding Automatically set file links (F7 was the right one)

@boceckts boceckts added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Jul 4, 2016
@koppor
Copy link
Member

koppor commented Jul 11, 2016

Please also test how this works in conjunction with the emacs mode.

@mairdl
Copy link
Contributor Author

mairdl commented Jul 12, 2016

Ok I'll look into it.

@koppor koppor removed the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Jul 13, 2016
@koppor
Copy link
Member

koppor commented Jul 13, 2016

  • tab in the main table: When I click on an entry and select tab, the next entry should be selected. Current behavior: next cell in the entry table is selected.

@koppor
Copy link
Member

koppor commented Jul 13, 2016

Better support of groups:

  1. Open a bib file with groups and 10 entries.
  2. Click on entry 10
  3. Click on a group
  4. Press cursor down

Effect: Cursor moves to the first entry in the entry table

Desired effect:

  • Next group is selected

Side comment:

  • When the group window has the focus, tab should jump to the first entry in the entry table.

@tobiasdiez
Copy link
Member

Maybe one should consider that Tab always cycles to the next frame if there is nothing to select in the current subwindow. For example, tab in entry list goes to entry preview / edit. Tab in some field in entry edit goes to next field, but tab in last field goes to group window. Tab in group window goes to next sidepane component and from there back to the entry list.

@mairdl mairdl force-pushed the HotkeyReworkConsistency branch 2 times, most recently from 07d10f0 to 23aa955 Compare July 21, 2016 12:46
@Braunch
Copy link
Contributor

Braunch commented Jul 21, 2016

@koppor I don't think tab for the next entry is a convenient interaction. As I encountered when working with the customize entry type dialog, lists and tables are all navigated with the arrow keys, so the next enry is reached by pressing arrow-down. I think we should keep that consistent as it is right now. Do you agree?

@mairdl
Copy link
Contributor Author

mairdl commented Jul 21, 2016

I have to agree with @Braunch

@mairdl
Copy link
Contributor Author

mairdl commented Jul 21, 2016

  • Printing preview: just add it to the right-click menu
  • I would put the websearch on Alt + 4 (more important then OpenOffice)
  • for the same reason, OO -> Alt + 0
  • Remove default Toggle Toolbar shortcut (can't imagine that this is useful for somebody, I would leave alt + num for toggling real panes)
  • What is the difference between F7 and Alt + F7, both are mapped to the same command according to your table.

@Braunch Braunch mentioned this pull request Jul 21, 2016
4 tasks
@koppor
Copy link
Member

koppor commented Jul 23, 2016

@Braunch Currently, when pressing tab, the next cell in the entry table is selected. One cannot do anything at a cell, can I? For instance, when pressing space on the url/doi file column, I would expect that the same behavior as when left-clicking is done. This currently doesn't happen. So, either jump to the next line via tab or do something meaningful when a single field in the table is focused.

@@ -19,6 +19,7 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
- [#1249](https://github.com/JabRef/jabref/issues/1249) Date layout formatter added
- Added ISBN integrity checker
- Added filter to not show selected integrity checks
- [#1225](https://github.com/JabRef/jabref/issues/1225): Hotkey-system should be consistent
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"is now consistent"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where does one find information (help page / blog post / ...) about what was changed and how the hotkeys are configured now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to add the Information when everything was finalized, do you think i should add it beforehand?

@koppor koppor removed the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Aug 10, 2016
@koppor koppor merged commit adc9de6 into JabRef:master Aug 10, 2016
ayanai1 pushed a commit to ayanai1/jabref that referenced this pull request Sep 5, 2016
@mairdl mairdl deleted the HotkeyReworkConsistency branch September 5, 2016 14:28
@koppor
Copy link
Member

koppor commented Oct 16, 2016

Blog article at http://blog.jabref.org/2016/08/15/HotkeyRevision/
Currently, no help page on the hot keys.

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

Successfully merging this pull request may close these issues.

10 participants