doc: shortcuts

This commit is contained in:
Jean-Francois Dockes 2021-02-10 19:05:41 +01:00
parent caedda75ad
commit f2b17dbeca
2 changed files with 401 additions and 146 deletions

View File

@ -225,12 +225,14 @@ alink="#0000FF">
"#RCL.SEARCH.GUI.SORT">Sorting search results and "#RCL.SEARCH.GUI.SORT">Sorting search results and
collapsing duplicates</a></span></dt> collapsing duplicates</a></span></dt>
<dt><span class="sect2">3.2.13. <a href= <dt><span class="sect2">3.2.13. <a href=
"#RCL.SEARCH.GUI.TIPS">Search tips, "#RCL.SEARCH.GUI.SHORTCUTS">Keyboard
shortcuts</a></span></dt> shortcuts</a></span></dt>
<dt><span class="sect2">3.2.14. <a href= <dt><span class="sect2">3.2.14. <a href=
"#RCL.SEARCH.GUI.TIPS">Search tips</a></span></dt>
<dt><span class="sect2">3.2.15. <a href=
"#RCL.SEARCH.SAVING">Saving and restoring queries "#RCL.SEARCH.SAVING">Saving and restoring queries
(1.21 and later)</a></span></dt> (1.21 and later)</a></span></dt>
<dt><span class="sect2">3.2.15. <a href= <dt><span class="sect2">3.2.16. <a href=
"#RCL.SEARCH.GUI.CUSTOM">Customizing the search "#RCL.SEARCH.GUI.CUSTOM">Customizing the search
interface</a></span></dt> interface</a></span></dt>
</dl> </dl>
@ -418,6 +420,12 @@ alink="#0000FF">
</dd> </dd>
</dl> </dl>
</div> </div>
<div class="list-of-tables">
<p><b>List of Tables</b></p>
<dl>
<dt>3.1. <a href="#idm1437">Keyboard shortcuts</a></dt>
</dl>
</div>
<div class="chapter"> <div class="chapter">
<div class="titlepage"> <div class="titlepage">
<div> <div>
@ -2778,7 +2786,7 @@ fs.inotify.max_user_watches=32768
re-use them later, perhaps with some tweaking. <span class= re-use them later, perhaps with some tweaking. <span class=
"application">Recoll</span> can save and restore searches. "application">Recoll</span> can save and restore searches.
See <a class="link" href="#RCL.SEARCH.SAVING" title= See <a class="link" href="#RCL.SEARCH.SAVING" title=
"3.2.14.&nbsp;Saving and restoring queries (1.21 and later)"> "3.2.15.&nbsp;Saving and restoring queries (1.21 and later)">
Saving and restoring queries</a>.</p> Saving and restoring queries</a>.</p>
<div class="sect2"> <div class="sect2">
<div class="titlepage"> <div class="titlepage">
@ -3973,12 +3981,212 @@ fs.inotify.max_user_watches=32768
<div class="titlepage"> <div class="titlepage">
<div> <div>
<div> <div>
<h3 class="title"><a name="RCL.SEARCH.GUI.TIPS" id= <h3 class="title"><a name=
"RCL.SEARCH.GUI.TIPS"></a>3.2.13.&nbsp;Search tips, "RCL.SEARCH.GUI.SHORTCUTS" id=
"RCL.SEARCH.GUI.SHORTCUTS"></a>3.2.13.&nbsp;Keyboard
shortcuts</h3> shortcuts</h3>
</div> </div>
</div> </div>
</div> </div>
<p>A number of common actions within the graphical
interface can be triggered through keyboard shortcuts. As
of <span class="application">Recoll</span> 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).</p>
<div class="table">
<a name="idm1437" id="idm1437"></a>
<p class="title"><b>Table&nbsp;3.1.&nbsp;Keyboard
shortcuts</b></p>
<div class="table-contents">
<table class="table" summary="Keyboard shortcuts"
border="1">
<colgroup>
<col align="left" class="c1">
<col align="left" class="c2">
</colgroup>
<thead>
<tr>
<th align="left">Description</th>
<th align="left">Default value</th>
</tr>
</thead>
<tbody>
<tr>
<td colspan="2" align="left"><span class=
"command"><strong>Context: almost
everywhere</strong></span></td>
</tr>
<tr>
<td align="left">Program exit</td>
<td align="left">Ctrl+Q</td>
</tr>
<tr>
<td colspan="2" align="left"><span class=
"command"><strong>Context: advanced
search</strong></span></td>
</tr>
<tr>
<td align="left">Load next stored search</td>
<td align="left">Up</td>
</tr>
<tr>
<td align="left">Load previous stored
search</td>
<td align="left">Down</td>
</tr>
<tr>
<td colspan="2" align="left"><span class=
"command"><strong>Context: main
window</strong></span></td>
</tr>
<tr>
<td align="left">Clear search</td>
<td align="left">Ctrl+S</td>
</tr>
<tr>
<td align="left">Move keyboard focus to the
search entry area</td>
<td align="left">Ctrl+L</td>
</tr>
<tr>
<td align="left">Move keyboard focus to the
search entry area</td>
<td align="left">Ctrl+Shift+S</td>
</tr>
<tr>
<td align="left">Toggle displaying results as
table or list</td>
<td align="left">Ctrl+T</td>
</tr>
<tr>
<td colspan="2" align="left"><span class=
"command"><strong>Context: main window, when
showing the results as a
table</strong></span></td>
</tr>
<tr>
<td align="left">Move the keyboard focus to the
result table</td>
<td align="left">Ctrl+R</td>
</tr>
<tr>
<td align="left">Jump to row 0-9 or a-z</td>
<td align="left">Ctrl+[0-9] or [a-z]</td>
</tr>
<tr>
<td align="left">Cancel current selection</td>
<td align="left">Esc</td>
</tr>
<tr>
<td colspan="2" align="left"><span class=
"command"><strong>Context: preview
window</strong></span></td>
</tr>
<tr>
<td align="left">Close the preview window</td>
<td align="left">Esc</td>
</tr>
<tr>
<td align="left">Close the current tab</td>
<td align="left">Ctrl+W</td>
</tr>
<tr>
<td align="left">Print current tab
contents</td>
<td align="left">Ctrl+P</td>
</tr>
<tr>
<td align="left">Load the next result in the
current tab</td>
<td align="left">Shift+Down</td>
</tr>
<tr>
<td align="left">Load the previous result in
the current tab</td>
<td align="left">Shift+Up</td>
</tr>
<tr>
<td colspan="2" align="left"><span class=
"command"><strong>Context: result
table</strong></span></td>
</tr>
<tr>
<td align="left">Copy the current result
document text contents to the clipboard</td>
<td align="left">Ctrl+G</td>
</tr>
<tr>
<td align="left">Open the current result
document and quit</td>
<td align="left">Ctrl+Shift+O</td>
</tr>
<tr>
<td align="left">Open the current result
document</td>
<td align="left">Ctrl+O</td>
</tr>
<tr>
<td align="left">Preview the current
result</td>
<td align="left">Ctrl+D</td>
</tr>
<tr>
<td align="left">Toggle showing the table
header</td>
<td align="left">Ctrl+H</td>
</tr>
<tr>
<td align="left">Open snippets window for the
current result</td>
<td align="left">Ctrl+E</td>
</tr>
<tr>
<td align="left">Toggle showing row
numbers</td>
<td align="left">Ctrl+V</td>
</tr>
<tr>
<td colspan="2" align="left"><span class=
"command"><strong>Context: snippets
window</strong></span></td>
</tr>
<tr>
<td align="left">Close the snippets window</td>
<td align="left">Esc</td>
</tr>
<tr>
<td align="left">Find in snippets</td>
<td align="left">Ctrl+F</td>
</tr>
<tr>
<td align="left">Find (alt)</td>
<td align="left">/</td>
</tr>
<tr>
<td align="left">Find next</td>
<td align="left">F3</td>
</tr>
<tr>
<td align="left">Find previous</td>
<td align="left">Shift+F3</td>
</tr>
</tbody>
</table>
</div>
</div><br class="table-break">
</div>
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.GUI.TIPS" id=
"RCL.SEARCH.GUI.TIPS"></a>3.2.14.&nbsp;Search
tips</h3>
</div>
</div>
</div>
<div class="sect3"> <div class="sect3">
<div class="titlepage"> <div class="titlepage">
<div> <div>
@ -3990,13 +4198,12 @@ fs.inotify.max_user_watches=32768
</div> </div>
</div> </div>
</div> </div>
<p><b>Term completion.&nbsp;</b>Typing <span class= <p><b>Term completion.&nbsp;</b>While typing into the
"keycap"><strong>Esc</strong></span> <span class= simple search entry, a popup menu will appear and show
"keycap"><strong>Space</strong></span> in the simple completions for the current string. Values preceded by
search entry field while entering a word will either a clock icon come from the history, those preceded by a
complete the current word if its beginning matches a magnifier icon come from the index terms. This can be
unique term in the index, or open a window to propose a disabled in the preferences.</p>
list of completions.</p>
<p><b>Picking up new terms from result or preview <p><b>Picking up new terms from result or preview
text.&nbsp;</b>Double-clicking on a word in the result text.&nbsp;</b>Double-clicking on a word in the result
list or in a preview window will copy it to the simple 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 description of what the query looked for, including
stem expansion, and Boolean operators used, by clicking stem expansion, and Boolean operators used, by clicking
on the result list header.</p> on the result list header.</p>
<p><b>Advanced search history.&nbsp;</b>As of <p><b>Advanced search history.&nbsp;</b>You can display
<span class="application">Recoll</span> 1.18, you can any of the last 100 complex searches performed by using
display any of the last 100 complex searches performed the up and down arrow keys while the advanced search
by using the up and down arrow keys while the advanced panel is active.</p>
search panel is active.</p>
<p><b>Browsing the result list inside a preview
window.&nbsp;</b>Entering <span class=
"keycap"><strong>Shift-Down</strong></span> or
<span class="keycap"><strong>Shift-Up</strong></span>
(<span class="keycap"><strong>Shift</strong></span> +
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.</p>
<p><b>Scrolling the result list from the
keyboard.&nbsp;</b>You can use <span class=
"keycap"><strong>PageUp</strong></span> and
<span class="keycap"><strong>PageDown</strong></span>
to scroll the result list, <span class=
"keycap"><strong>Shift+Home</strong></span> to go back
to the first page. These work even while the focus is
in the search entry.</p>
<p><b>Result table: moving the focus to the
table.&nbsp;</b>You can use <span class=
"keycap"><strong>Ctrl-r</strong></span> to move the
focus from the search entry to the table, and then use
the arrow keys to change the current row. <span class=
"keycap"><strong>Ctrl-Shift-s</strong></span> returns
to the search.</p>
<p><b>Result table: open / preview.&nbsp;</b>With the
focus in the result table, you can use <span class=
"keycap"><strong>Ctrl-o</strong></span> to open the
document from the current row, <span class=
"keycap"><strong>Ctrl-Shift-o</strong></span> to open
the document and close <span class=
"command"><strong>recoll</strong></span>, <span class=
"keycap"><strong>Ctrl-d</strong></span> to preview the
document, and <span class=
"keycap"><strong>Ctrl-e</strong></span> to open the
document snippets window.</p>
<p><b>Editing a new search while the focus is not in
the search entry.&nbsp;</b>You can use the <span class=
"keycap"><strong>Ctrl-Shift-S</strong></span> shortcut
to return the cursor to the search entry (and select
the current search text), while the focus is anywhere
in the main window.</p>
<p><b>Forced opening of a preview window.&nbsp;</b>You <p><b>Forced opening of a preview window.&nbsp;</b>You
can use <span class= can use <span class=
"keycap"><strong>Shift</strong></span>+Click on a "keycap"><strong>Shift</strong></span>+Click on a
result list <code class="literal">Preview</code> link result list <code class="literal">Preview</code> link
to force the creation of a preview window instead of a to force the creation of a preview window instead of a
new tab in the existing one.</p> new tab in the existing one.</p>
<p><b>Closing previews.&nbsp;</b>Entering <span class=
"keycap"><strong>Ctrl-W</strong></span> in a tab will
close it (and, for the last tab, close the preview
window). Entering <span class=
"keycap"><strong>Esc</strong></span> will close the
preview window and all its tabs.</p>
<p><b>Printing previews.&nbsp;</b>Entering <span class=
"keycap"><strong>Ctrl-P</strong></span> in a preview
window will print the currently displayed text.</p>
<p><b>Quitting.&nbsp;</b>Entering <span class=
"keycap"><strong>Ctrl-Q</strong></span> almost anywhere
will close the application.</p>
</div> </div>
</div> </div>
<div class="sect2"> <div class="sect2">
@ -4216,7 +4369,7 @@ fs.inotify.max_user_watches=32768
<div> <div>
<div> <div>
<h3 class="title"><a name="RCL.SEARCH.SAVING" id= <h3 class="title"><a name="RCL.SEARCH.SAVING" id=
"RCL.SEARCH.SAVING"></a>3.2.14.&nbsp;Saving and "RCL.SEARCH.SAVING"></a>3.2.15.&nbsp;Saving and
restoring queries (1.21 and later)</h3> restoring queries (1.21 and later)</h3>
</div> </div>
</div> </div>
@ -4247,7 +4400,7 @@ fs.inotify.max_user_watches=32768
<div> <div>
<h3 class="title"><a name="RCL.SEARCH.GUI.CUSTOM" <h3 class="title"><a name="RCL.SEARCH.GUI.CUSTOM"
id= id=
"RCL.SEARCH.GUI.CUSTOM"></a>3.2.15.&nbsp;Customizing "RCL.SEARCH.GUI.CUSTOM"></a>3.2.16.&nbsp;Customizing
the search interface</h3> the search interface</h3>
</div> </div>
</div> </div>

View File

@ -2907,18 +2907,177 @@ fs.inotify.max_user_watches=32768
</sect2> </sect2>
<sect2 id="RCL.SEARCH.GUI.SHORTCUTS">
<title>Keyboard shortcuts</title>
<para>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).</para>
<table frame='all'>
<title>Keyboard shortcuts</title>
<tgroup cols='2' align='left' colsep='1' rowsep='1'>
<colspec colname='c1'/>
<colspec colname='c2'/>
<thead>
<row><entry>Description</entry><entry>Default value</entry></row>
</thead>
<tbody>
<row><entry namest="c1" nameend="c2">
<command>Context: almost everywhere</command></entry></row>
<row>
<entry>Program exit</entry>
<entry>Ctrl+Q</entry>
</row>
<row><entry namest="c1" nameend="c2">
<command>Context: advanced search</command></entry></row>
<row>
<entry>Load next stored search</entry>
<entry>Up</entry>
</row>
<row>
<entry>Load previous stored search</entry>
<entry>Down</entry>
</row>
<row><entry namest="c1" nameend="c2">
<command>Context: main window</command></entry>
</row>
<row>
<entry>Clear search</entry>
<entry>Ctrl+S</entry>
</row>
<row>
<entry>Move keyboard focus to the search entry area</entry>
<entry>Ctrl+L</entry>
</row>
<row>
<entry>Move keyboard focus to the search entry area</entry>
<entry>Ctrl+Shift+S</entry>
</row>
<row>
<entry>Toggle displaying results as table or list</entry>
<entry>Ctrl+T</entry>
</row>
<row><entry namest="c1" nameend="c2">
<command>Context: main window, when showing the results
as a table</command></entry>
</row>
<row>
<entry>Move the keyboard focus to the result table</entry>
<entry>Ctrl+R</entry>
</row>
<row>
<entry>Jump to row 0-9 or a-z</entry>
<entry>Ctrl+[0-9] or [a-z]</entry>
</row>
<row>
<entry>Cancel current selection</entry><entry>Esc</entry>
</row>
<row><entry namest="c1" nameend="c2">
<command>Context: preview window</command></entry>
</row>
<row>
<entry>Close the preview window</entry>
<entry>Esc</entry>
</row>
<row>
<entry>Close the current tab</entry>
<entry>Ctrl+W</entry>
</row>
<row>
<entry>Print current tab contents</entry>
<entry>Ctrl+P</entry>
</row>
<row>
<entry>Load the next result in the current tab</entry>
<entry>Shift+Down</entry>
</row>
<row>
<entry>Load the previous result in the current tab</entry>
<entry>Shift+Up</entry>
</row>
<row><entry namest="c1" nameend="c2">
<command>Context: result table</command></entry></row>
<row>
<entry>Copy the current result document text contents to
the clipboard</entry> <entry>Ctrl+G</entry>
</row>
<row>
<entry>Open the current result document and quit</entry>
<entry>Ctrl+Shift+O</entry>
</row>
<row>
<entry>Open the current result document</entry>
<entry>Ctrl+O</entry>
</row>
<row>
<entry>Preview the current result</entry>
<entry>Ctrl+D</entry>
</row>
<row>
<entry>Toggle showing the table header</entry>
<entry>Ctrl+H</entry>
</row>
<row>
<entry>Open snippets window for the current result</entry>
<entry>Ctrl+E</entry>
</row>
<row>
<entry>Toggle showing row numbers</entry>
<entry>Ctrl+V</entry>
</row>
<row><entry namest="c1" nameend="c2">
<command>Context: snippets window</command></entry></row>
<row>
<entry>Close the snippets window</entry>
<entry>Esc</entry>
</row>
<row>
<entry>Find in snippets</entry>
<entry>Ctrl+F</entry>
</row>
<row>
<entry>Find (alt)</entry>
<entry>/</entry>
</row>
<row>
<entry>Find next</entry>
<entry>F3</entry>
</row>
<row>
<entry>Find previous</entry>
<entry>Shift+F3</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
<sect2 id="RCL.SEARCH.GUI.TIPS"> <sect2 id="RCL.SEARCH.GUI.TIPS">
<title>Search tips, shortcuts</title> <title>Search tips</title>
<sect3 id="RCL.SEARCH.GUI.TIPS.TERMS"> <sect3 id="RCL.SEARCH.GUI.TIPS.TERMS">
<title>Terms and search expansion</title> <title>Terms and search expansion</title>
<formalpara><title>Term completion</title> <formalpara><title>Term completion</title>
<para>Typing <keycap>Esc</keycap> <keycap>Space</keycap> in <para>While typing into the
the simple search entry field while entering a word will simple search entry, a popup menu will appear and show
either complete the current word if its beginning matches a completions for the current string. Values preceded by a clock
unique term in the index, or open a window to propose a list icon come from the history, those preceded by a magnifier icon
of completions.</para> come from the index terms. This can be disabled in the
preferences.</para>
</formalpara> </formalpara>
<formalpara><title>Picking up new terms from result or preview <formalpara><title>Picking up new terms from result or preview
@ -3037,14 +3196,13 @@ fs.inotify.max_user_watches=32768
<title>Others</title> <title>Others</title>
<formalpara><title>Using fields</title> <formalpara><title>Using fields</title>
<para>You can use the <link linkend="RCL.SEARCH.LANG">query language </link> <para>You can use the <link linkend="RCL.SEARCH.LANG">query
and field specifications language </link> and field specifications
to only search certain parts of documents. This can be to only search certain parts of documents. This can be
especially helpful with email, for example only searching especially helpful with email, for example only searching
emails from a specific originator: emails from a specific originator:
<literal>search tips from:helpfulgui</literal> <literal>search tips from:helpfulgui</literal>
</para> </para></formalpara>
</formalpara>
<formalpara><title>Adjusting the result table columns</title> <formalpara><title>Adjusting the result table columns</title>
<para>When displaying results in table mode, you can use a <para>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.</para> used, by clicking on the result list header.</para>
</formalpara> </formalpara>
<formalpara><title>Advanced search history</title> <formalpara><title>Advanced search history</title> <para>You can
<para>As of &RCL; 1.18, you can display any of the last 100 complex display any of the last 100 complex searches performed by
searches performed by using the up and down arrow keys while the using the up and down arrow keys while the advanced search
advanced search panel is active.</para> panel is active.</para>
</formalpara>
<formalpara><title>Browsing the result list inside a preview
window</title>
<para>Entering <keycap>Shift-Down</keycap> or <keycap>Shift-Up</keycap>
(<keycap>Shift</keycap> + 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.</para>
</formalpara>
<formalpara><title>Scrolling the result list from the keyboard</title>
<para>You can use <keycap>PageUp</keycap> and <keycap>PageDown</keycap>
to scroll the result list, <keycap>Shift+Home</keycap> to go back
to the first page. These work even while the focus is in the
search entry.</para>
</formalpara>
<formalpara><title>Result table: moving the focus to the table</title>
<para>You can use <keycap>Ctrl-r</keycap> to move the focus
from the search entry to the table, and then use the arrow keys
to change the current row. <keycap>Ctrl-Shift-s</keycap> returns to
the search.</para>
</formalpara>
<formalpara><title>Result table: open / preview</title>
<para>With the focus in the result table, you can use
<keycap>Ctrl-o</keycap> to open the document from the current
row, <keycap>Ctrl-Shift-o</keycap> to open the document and close
<command>recoll</command>, <keycap>Ctrl-d</keycap> to preview
the document, and <keycap>Ctrl-e</keycap> to open the document
snippets window.</para>
</formalpara>
<formalpara><title>Editing a new search while the focus is not
in the search entry</title>
<para>You can use the <keycap>Ctrl-Shift-S</keycap> shortcut to
return the cursor to the search entry (and select the current
search text), while the focus is anywhere in the main
window.</para>
</formalpara> </formalpara>
<formalpara><title>Forced opening of a preview window</title> <formalpara><title>Forced opening of a preview window</title>
@ -3126,22 +3244,6 @@ fs.inotify.max_user_watches=32768
preview window instead of a new tab in the existing one.</para> preview window instead of a new tab in the existing one.</para>
</formalpara> </formalpara>
<formalpara><title>Closing previews</title>
<para>Entering <keycap>Ctrl-W</keycap> in a tab will
close it (and, for the last tab, close the preview
window). Entering <keycap>Esc</keycap> will close the preview
window and all its tabs.</para>
</formalpara>
<formalpara><title>Printing previews</title>
<para>Entering <keycap>Ctrl-P</keycap> in a preview window will print
the currently displayed text.</para>
</formalpara>
<formalpara><title>Quitting</title>
<para>Entering <keycap>Ctrl-Q</keycap> almost anywhere will
close the application.</para>
</formalpara>
</sect3> </sect3>
</sect2> </sect2>