From f2b17dbeca08bba7f07f815a47911cd0cbd3aebf Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Wed, 10 Feb 2021 19:05:41 +0100 Subject: [PATCH] doc: shortcuts --- src/doc/user/usermanual.html | 297 ++++++++++++++++++++++++++--------- src/doc/user/usermanual.xml | 250 ++++++++++++++++++++--------- 2 files changed, 401 insertions(+), 146 deletions(-) diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 5ad15a6f..2f25492a 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -225,12 +225,14 @@ alink="#0000FF"> "#RCL.SEARCH.GUI.SORT">Sorting search results and collapsing duplicates
3.2.13. Search tips, + "#RCL.SEARCH.GUI.SHORTCUTS">Keyboard shortcuts
3.2.14. Search tips
+
3.2.15. Saving and restoring queries (1.21 and later)
-
3.2.15. 3.2.16. Customizing the search interface
@@ -418,6 +420,12 @@ alink="#0000FF"> +
+

List of Tables

+
+
3.1. Keyboard shortcuts
+
+
@@ -2778,7 +2786,7 @@ fs.inotify.max_user_watches=32768 re-use them later, perhaps with some tweaking. Recoll can save and restore searches. See + "3.2.15. Saving and restoring queries (1.21 and later)"> Saving and restoring queries.

@@ -3973,12 +3981,212 @@ fs.inotify.max_user_watches=32768
-

3.2.13. Search tips, +

3.2.13. Keyboard shortcuts

+

A number of common actions within the graphical + interface can be triggered through keyboard shortcuts. As + of Recoll 1.29, many of + the shortcut values can be customised from a screen in + the GUI preferences. Most shortcuts are specific to a + given context (e.g. within a preview window, within the + result table).

+
+ +

Table 3.1. Keyboard + shortcuts

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DescriptionDefault value
Context: almost + everywhere
Program exitCtrl+Q
Context: advanced + search
Load next stored searchUp
Load previous stored + searchDown
Context: main + window
Clear searchCtrl+S
Move keyboard focus to the + search entry areaCtrl+L
Move keyboard focus to the + search entry areaCtrl+Shift+S
Toggle displaying results as + table or listCtrl+T
Context: main window, when + showing the results as a + table
Move the keyboard focus to the + result tableCtrl+R
Jump to row 0-9 or a-zCtrl+[0-9] or [a-z]
Cancel current selectionEsc
Context: preview + window
Close the preview windowEsc
Close the current tabCtrl+W
Print current tab + contentsCtrl+P
Load the next result in the + current tabShift+Down
Load the previous result in + the current tabShift+Up
Context: result + table
Copy the current result + document text contents to the clipboardCtrl+G
Open the current result + document and quitCtrl+Shift+O
Open the current result + documentCtrl+O
Preview the current + resultCtrl+D
Toggle showing the table + headerCtrl+H
Open snippets window for the + current resultCtrl+E
Toggle showing row + numbersCtrl+V
Context: snippets + window
Close the snippets windowEsc
Find in snippetsCtrl+F
Find (alt)/
Find nextF3
Find previousShift+F3
+
+

+
+
+
+
+
+

3.2.14. Search + tips

+
+
+
@@ -3990,13 +4198,12 @@ fs.inotify.max_user_watches=32768
-

Term completion. Typing Esc Space in the simple - search entry field while entering a word will either - complete the current word if its beginning matches a - unique term in the index, or open a window to propose a - list of completions.

+

Term completion. While typing into the + simple search entry, a popup menu will appear and show + completions for the current string. Values preceded by + a clock icon come from the history, those preceded by a + magnifier icon come from the index terms. This can be + disabled in the preferences.

Picking up new terms from result or preview text. Double-clicking on a word in the result list or in a preview window will copy it to the simple @@ -4145,70 +4352,16 @@ fs.inotify.max_user_watches=32768 description of what the query looked for, including stem expansion, and Boolean operators used, by clicking on the result list header.

-

Advanced search history. As of - Recoll 1.18, you can - display any of the last 100 complex searches performed - by using the up and down arrow keys while the advanced - search panel is active.

-

Browsing the result list inside a preview - window. Entering Shift-Down or - Shift-Up - (Shift + - an arrow key) in a preview window will display the next - or the previous document from the result list. Any - secondary search currently active will be executed on - the new document.

-

Scrolling the result list from the - keyboard. You can use PageUp and - PageDown - to scroll the result list, Shift+Home to go back - to the first page. These work even while the focus is - in the search entry.

-

Result table: moving the focus to the - table. You can use Ctrl-r to move the - focus from the search entry to the table, and then use - the arrow keys to change the current row. Ctrl-Shift-s returns - to the search.

-

Result table: open / preview. With the - focus in the result table, you can use Ctrl-o to open the - document from the current row, Ctrl-Shift-o to open - the document and close recoll, Ctrl-d to preview the - document, and Ctrl-e to open the - document snippets window.

-

Editing a new search while the focus is not in - the search entry. You can use the Ctrl-Shift-S shortcut - to return the cursor to the search entry (and select - the current search text), while the focus is anywhere - in the main window.

+

Advanced search history. You can display + any of the last 100 complex searches performed by using + the up and down arrow keys while the advanced search + panel is active.

Forced opening of a preview window. You can use Shift+Click on a result list Preview link to force the creation of a preview window instead of a new tab in the existing one.

-

Closing previews. Entering Ctrl-W in a tab will - close it (and, for the last tab, close the preview - window). Entering Esc will close the - preview window and all its tabs.

-

Printing previews. Entering Ctrl-P in a preview - window will print the currently displayed text.

-

Quitting. Entering Ctrl-Q almost anywhere - will close the application.

@@ -4216,7 +4369,7 @@ fs.inotify.max_user_watches=32768

3.2.14. Saving and + "RCL.SEARCH.SAVING">3.2.15. Saving and restoring queries (1.21 and later)

@@ -4247,7 +4400,7 @@ fs.inotify.max_user_watches=32768

3.2.15. Customizing + "RCL.SEARCH.GUI.CUSTOM">3.2.16. Customizing the search interface

diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index 73020d23..384fcbe3 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -2907,18 +2907,177 @@ fs.inotify.max_user_watches=32768 + + Keyboard shortcuts + + A number of common actions within the graphical interface can + be triggered through keyboard shortcuts. As of &RCL; 1.29, many + of the shortcut values can be customised from a screen in the GUI + preferences. Most shortcuts are specific to a given context + (e.g. within a preview window, within the result table). + + + Keyboard shortcuts + + + + + DescriptionDefault value + + + + + + Context: almost everywhere + + Program exit + Ctrl+Q + + + + Context: advanced search + + Load next stored search + Up + + + Load previous stored search + Down + + + + Context: main window + + + Clear search + Ctrl+S + + + Move keyboard focus to the search entry area + Ctrl+L + + + Move keyboard focus to the search entry area + Ctrl+Shift+S + + + Toggle displaying results as table or list + Ctrl+T + + + + Context: main window, when showing the results + as a table + + + Move the keyboard focus to the result table + Ctrl+R + + + Jump to row 0-9 or a-z + Ctrl+[0-9] or [a-z] + + + Cancel current selectionEsc + + + + + Context: preview window + + + Close the preview window + Esc + + + Close the current tab + Ctrl+W + + + Print current tab contents + Ctrl+P + + + Load the next result in the current tab + Shift+Down + + + Load the previous result in the current tab + Shift+Up + + + + Context: result table + + Copy the current result document text contents to + the clipboard Ctrl+G + + + Open the current result document and quit + Ctrl+Shift+O + + + Open the current result document + Ctrl+O + + + Preview the current result + Ctrl+D + + + Toggle showing the table header + Ctrl+H + + + Open snippets window for the current result + Ctrl+E + + + Toggle showing row numbers + Ctrl+V + + + + Context: snippets window + + Close the snippets window + Esc + + + Find in snippets + Ctrl+F + + + Find (alt) + / + + + Find next + F3 + + + Find previous + Shift+F3 + + + +
+ + + - Search tips, shortcuts + Search tips Terms and search expansion Term completion - Typing Esc Space in - the simple search entry field while entering a word will - either complete the current word if its beginning matches a - unique term in the index, or open a window to propose a list - of completions. + While typing into the + simple search entry, a popup menu will appear and show + completions for the current string. Values preceded by a clock + icon come from the history, those preceded by a magnifier icon + come from the index terms. This can be disabled in the + preferences. Picking up new terms from result or preview @@ -3037,14 +3196,13 @@ fs.inotify.max_user_watches=32768 <title>Others Using fields - You can use the query language - and field specifications - to only search certain parts of documents. This can be - especially helpful with email, for example only searching - emails from a specific originator: - search tips from:helpfulgui - - + You can use the query + language and field specifications + to only search certain parts of documents. This can be + especially helpful with email, for example only searching + emails from a specific originator: + search tips from:helpfulgui + Adjusting the result table columns When displaying results in table mode, you can use a @@ -3074,50 +3232,10 @@ fs.inotify.max_user_watches=32768 used, by clicking on the result list header. - Advanced search history - As of &RCL; 1.18, you can display any of the last 100 complex - searches performed by using the up and down arrow keys while the - advanced search panel is active. - - - Browsing the result list inside a preview - window - Entering Shift-Down or Shift-Up - (Shift + an arrow key) in a preview window will - display the next or the previous document from the result - list. Any secondary search currently active will be executed on - the new document. - - - Scrolling the result list from the keyboard - You can use PageUp and PageDown - to scroll the result list, Shift+Home to go back - to the first page. These work even while the focus is in the - search entry. - - - Result table: moving the focus to the table - You can use Ctrl-r to move the focus - from the search entry to the table, and then use the arrow keys - to change the current row. Ctrl-Shift-s returns to - the search. - - - Result table: open / preview - With the focus in the result table, you can use - Ctrl-o to open the document from the current - row, Ctrl-Shift-o to open the document and close - recoll, Ctrl-d to preview - the document, and Ctrl-e to open the document - snippets window. - - - Editing a new search while the focus is not - in the search entry - You can use the Ctrl-Shift-S shortcut to - return the cursor to the search entry (and select the current - search text), while the focus is anywhere in the main - window. + Advanced search history You can + display any of the last 100 complex searches performed by + using the up and down arrow keys while the advanced search + panel is active. Forced opening of a preview window @@ -3126,22 +3244,6 @@ fs.inotify.max_user_watches=32768 preview window instead of a new tab in the existing one. - Closing previews - Entering Ctrl-W in a tab will - close it (and, for the last tab, close the preview - window). Entering Esc will close the preview - window and all its tabs. - - - Printing previews - Entering Ctrl-P in a preview window will print - the currently displayed text. - - - Quitting - Entering Ctrl-Q almost anywhere will - close the application. -