From da46a3c438aa3293ef0c3a9409aaabd7a8746519 Mon Sep 17 00:00:00 2001 From: Charles Haley Date: Sat, 19 Aug 2017 22:09:12 +0200 Subject: [PATCH] Documentation for the vl: search location --- manual/gui.rst | 8 +++++++- manual/virtual_libraries.rst | 17 +++++++++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/manual/gui.rst b/manual/gui.rst index bcce1e4d37..8a28734a2c 100644 --- a/manual/gui.rst +++ b/manual/gui.rst @@ -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 diff --git a/manual/virtual_libraries.rst b/manual/virtual_libraries.rst index 51f378bdb7..39d296abcd 100644 --- a/manual/virtual_libraries.rst +++ b/manual/virtual_libraries.rst @@ -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 -------------------------------