Add basic docs for the new FTS feature

This commit is contained in:
Kovid Goyal 2022-06-14 11:18:16 +05:30
parent 6c755112b4
commit 2ea40e6cef
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
2 changed files with 17 additions and 2 deletions

View File

@ -546,6 +546,19 @@ calibre allows you to save a frequently used search under a special name and the
Now you can access your saved search in the Tag browser under :guilabel:`Saved searches`. A single click will allow you to reuse any arbitrarily complex search easily, without needing to re-create it. Now you can access your saved search in the Tag browser under :guilabel:`Saved searches`. A single click will allow you to reuse any arbitrarily complex search easily, without needing to re-create it.
Searching the full text of all books
---------------------------------------
calibre can *optionally* index the full text of books in the library to allow
for instant searching of words inside any book. To enable this functionality
go to :guilabel:`Preferences->Toolbars & menus->The main toolbar` and add the
:guilabel:`Search full text` button to the toolbar.
Click the newly added button to show the full text search window. Enable
indexing for the current library. Once indexing is complete you can search all
the text in the full library. When you add new books to the library, they will
be automatically indexed in the background.
Virtual libraries Virtual libraries
------------------- -------------------
@ -849,6 +862,8 @@ calibre has several keyboard shortcuts to save you time and mouse movement. Thes
- Add empty books to calibre - Add empty books to calibre
* - :kbd:`Ctrl+M` * - :kbd:`Ctrl+M`
- Toggle mark/unmarked status on selected books - Toggle mark/unmarked status on selected books
* - :kbd:`Ctrl+/` or :kbd:`Ctrl+Alt+F`
- Open the popup to search the full text of all books in the library
* - :kbd:`Q` * - :kbd:`Q`
- Open the Quick View popup for viewing books in related series/tags/etc. - Open the Quick View popup for viewing books in related series/tags/etc.
* - :kbd:`Shift+Q` * - :kbd:`Shift+Q`

View File

@ -8,8 +8,8 @@ from calibre.gui2.actions import InterfaceAction
class FullTextSearchAction(InterfaceAction): class FullTextSearchAction(InterfaceAction):
name = 'Full Text Search' name = 'Full Text Search'
action_spec = (_('Search full text of books'), 'search.png', action_spec = (_('Search full text'), 'search.png',
_('Search the full text of all books in the calibre library'), _('Z')) _('Search the full text of all books in the calibre library'), ('Ctrl+/', 'Ctrl+Alt+F'))
dont_add_to = frozenset(('context-menu-device',)) dont_add_to = frozenset(('context-menu-device',))
action_type = 'current' action_type = 'current'