Reading List
This plugin is for a number of users who have requested a "Reading List" ability for their library, allowing them to keep track of which books they would like to read next and in which order. You can have multiple lists per library per device.
This plugin has also integrated all the functionality of the now deprecated Book Sync plugin, allowing you to synchronise list(s) to a device either manually or automatically when it is connected.
You also have the ability to generate lists based on the content of your device. In combination with the ability to apply tags or populate a custom column based on membership in a list, this provides an easy way to keep track of books on your device(s) while they are not connected.
- Create one or more independent lists of books, per library
- Lists can be manually populated, auto-populated based on books on a device, or auto-populated based on a tag/custom column value
- Add all books with the same series series name for the selected books to a list
- Order the contents of a list (for manual lists, order is viewable in calibre only, not on the device)
- Optionally specify a tag or custom column value to be added when books are put on the list and/or removed when taken off the list
- Optionally sync each list to one or more devices, a folder or iTunes
- Specify whether list sync should add only new items not on device, add all items every time, remove all items that are on the list, or replace all items on the device with the list
- Optionally force a sync to the device of your list if adding while it is connected
- Optionally populate a custom series column with your reading list order, for constant visibility within calibre or content server
- Optionally force Kindle Collections to be recreated after a sync. Kindle DX 2,3,4 non-touch owners only, requires the Kindle Collections plugin
- Configure devices and the names for individual storage locations
- View the contents of your list in the library view sorted in list sequence.
- Remove books from your list, move books between lists and clear lists.
- Shortcuts customisable in a configuration dialog
Access the configuration dialog via:
- Preferences -> Plugins -> User interface action -> Reading List -> Customize plugin
- Reading List -> Customize...
| Option | Description |
|---|---|
| List type |
Manually add/remove items - list is populated by your manual actions. Auto populated from books on device - When reading device is plugged in, list is overwritten with by whatever books are on that device Auto populated from search - List is dynamically tied to the evaluation of a calibre saved search. |
| Auto populate from search | Only applies when list type is Auto populated from search. Specify the calibre saved search to populate from each time list is used. |
| Option | Description |
|---|---|
| Device to sync this list to | Enables you to send books on your list to the specified reading device. Reading devices are setup on the Devices tab. |
| When syncing this list |
Add new list items to device - Sends only books on the list that are not present on device. Does not remove from device books that are not on list. Add/overwrite all list items to device - Sends new books on list and overwrite existing books on list. Does not remove from device books that are not on list. Remove list items from device - Does not add books to device. Only removes any that match this list. Replace device with list, add new items only - Sends only books on the list that are not present on device. Removes all books from device not on list. Replace device with list, add/overwrite all - Sends all books on the list, overwriting if already present on device. Removes all books from device not on list. |
| Sync if connected | If checked, list will sync every time the is plugged in. If unchecked you must manually choose from menu to sync a list. |
| Clear list after sync | If checked, list will be cleared after a sync has taken place. |
| Option | Description |
|---|---|
| When changing list |
Do not update calibre column - No custom column interaction desired. Update column for add or remove - Apply a value to a custom column when add to list, clear value when removed. Update column for add to list only - Apply a value to a custom column when add to list. No changes when removed. Update column for remove from list only - Apply a value to a custom column when removed from list. No changes when added. |
| Column to update | Your calibre custom column to apply some value to based on above rule. e.g. you might add/remove to the tags column to indicate book is on your device. |
| Value in column | The value in the custom column to apply based on above rule. e.g. the tags column above might have a tag value called Kindle to apply when on the list. |
| Option | Description |
|---|---|
| Store in series column | Only enabled if List type is Manually add/remove items and Clear this list after a sync to this device is unchecked. Specify a series custom column that this list will update. This column will get overwritten by this plugin, do not populate manually! Use this feature if you want your reading list order to be visible on your books view. |
| Series name | If specified will be the name displayed in your series column e.g. 'ToRead' If not specified, will be the name of the reading list itself. |
| Option | Description |
|---|---|
| Move View list | By default your lists appear in a View list submenu. If checked, this list will appear in the top level menu instead. |
| Apply reading list order | If checked changes your calibre view sort columns when viewing this list. Useful if you have ordered your list specifically. |
| Restore sort after viewing | Only enabled if you have checked the above option. Apply whatever sort you had before viewing the list when the list i sno longer displayed. e.g. you apply a search, switch libraries or quit calibre. |
| Column | Description |
|---|---|
| Menu | Whether the specified device should appear in menus/dropdowns for this plugin. |
| Name | Display name for this device. Read from the configuration file on the device. |
| Location | Name of the storage location within the device. Read from device configuration file. |
| Status | Whether this device is currently connected. |
| Kindle Collections | For legacy Kindles only (DX, 2, 3, 4 non-touch), offers integration with the Kindle Collections plugin. Modern kindles cannot be supported by the Kindle Collections plugin unfortunately. |
| Option | Description |
|---|---|
| Keyboard shortcuts | Quick access for modifying keyboard shortcuts for menus in this plugin. |
| Reset confirmation dialogs | Various dialogs in this plugin offer a "do not show me again" option. If you want to reset all of them back to becoming visible again click this button. |
| View library preferences | For advanced/diagnostic purposes only. Allows viewing/editing library specific plugin settings. |
| Show dialog when removing | Relevent when syncing a list means books will get removed from the device. If checked, a dialog will appear asking you to confirm book deletion from device. |
| Menu Item | Description |
|---|---|
| Add to <Default> list | Add the currently selected book(s) to your Default list. |
| Add series to <Default> list | Add all books in the same series as currently selected book(s) to your Default list. |
| Move to list... | Displays a dialog allowing you to choose which list to add eslected books to. |
| Remove from <Default> list | Remove selected book(s) from your Default list if present on it. |
| View <Default> list | Display the books on your Default list in calibre book list view. |
| View <ListName> list | Display books on the named list in calibre book list view. |
| Edit <ListName> list | Edit books on this list allowing you to change reading order. |
| Clear <ListName> list | Remove all books from the specified list. |
| Set default list | Make the specified list in the submenu your Default list. Only impacts the menu options above for ease of access to common list functions. |
| Sync Now | Enabled when a device is connected, to manually sync list with your device. |
| Customize plugin... | Access to more advanced plugin configuration, such as creating lists. |
If you enjoy my calibre plugins or extensions, please feel free to show your appreciation!
