Documentation for the vl: search location

This commit is contained in:
Charles Haley 2017-08-19 22:09:12 +02:00
parent 622833eb05
commit da46a3c438
2 changed files with 24 additions and 1 deletions

View File

@ -359,7 +359,7 @@ You can build advanced search queries easily using the :guilabel:`Advanced searc
clicking the button |sbi|.
Available fields for searching are: ``tag, title, author, publisher, series, series_index, rating, cover,
comments, format, identifiers, date, pubdate, search, size`` and custom columns. If a device is plugged in, the ``ondevice`` field becomes available, when searching the calibre library view. To find the search name (actually called the `lookup name`) for a custom column, hover your mouse over the column header in the library view.
comments, format, identifiers, date, pubdate, search, size, vl`` and custom columns. If a device is plugged in, the ``ondevice`` field becomes available, when searching the calibre library view. To find the search name (actually called the `lookup name`) for a custom column, hover your mouse over the column header in the library view.
The syntax for searching for dates is::
@ -400,6 +400,12 @@ The special field ``search`` is used for saved searches. So if you save a search
"My spouse's books" you can enter ``search:"My spouse's books"`` in the Search bar to reuse the saved
search. More about saving searches below.
The special field ``vl`` is used to search for books in a virtual library. For
example, ``vl:Read`` will find all the books in the Read virtual library. The search
``vl:Read and vl:"Science Fiction"`` will find all the books that are in both the Read and
Science Fiction virtual libraries. The value following ``vl:`` must be the name of a
virtual library. If the virtual library name contains spaces then surround it with quotes.
You can search for the absence or presence of a field using the special "true" and "false" values. For example::
cover:false will give you all books without a cover

View File

@ -95,6 +95,23 @@ virtual libraries as tabs`. You can re-arrange the tabs by drag and drop and
close ones you do not want to see. Closed tabs can be restored by
right-clicking on the tab bar.
Using Virtual libraries in searches
-------------------------------------
You can search for books that are in a virtual library using the ``vl:`` prefix. For
example, ``vl:Read`` will find all the books in the Read virtual library. The search
``vl:Read and vl:"Science Fiction"`` will find all the books that are in both the Read and
Science Fiction virtual libraries.
The value following ``vl:`` must be the name of a virtual library. If the virtual library name
contains spaces then surround it with quotes.
One use for a virtual library search is in the content server. In
:guilabel:`Preferences->Sharing over the net->Require username/password` you can limit the
calibre libraries visible to a user. For each visible library you can specify
a search expression to further limit which books are seen. Use ``vl:...`` to limit the books
to those in a virtual library.
Using additional restrictions
-------------------------------