Marvin XD

Table of Contents

  1. Overview
  2. Configuring Marvin XD
  3. Match status
  4. FAQs
  5. Actions reference
  6. Support

1. Overview

Marvin XD is an extended driver, offering advanced management features for your Marvin library. Think of Marvin XD as a remote control for Marvin.

Features:


2. Configuration

Open the context menu for the Marvin XD icon (right-click the icon or click the down arrow), then click Customize plugin to display the Customize Marvin XD dialog.

The Custom column assignments section connects Marvin details to custom columns in calibre. For example, by selecting a custom column in calibre for Collections, you can synchronize collection assignments between calibre and Marvin. You may specify custom columns for Annotations, Collections, Last read, Locked, Progress, Read, Reading list and Word count.

Clicking the combo box presents a list of existing custom columns eligible for use with the associated Marvin details.

Clicking the Wizard button leads you through the steps to create a new custom column, or renames an existing custom column.

CSS: Click the Annotations button to customize the CSS applied to Annotations. Click the Articles, Vocabulary button to customize the CSS applied to Articles and Vocabulary.

General options: Apply temporary markers to duplicate books: When checked, books in Marvin determined to be duplicates of books in calibre will be marked.
Apply temporary markers to books with updated content: When checked, books with matching metadata but differing content will be marked.
Automatically refresh custom column content: When checked, enabled custom column content will be synchronized upon opening Marvin XD for all books installed in Marvin that are also in your calibre library.
Show reading progress as percentage: When checked, displays reading progress as a numeric percentage. When unchecked, reading progress is shown as a series of dots.

Debug options: Enable debug logging for Marvin XD, Enable debug logging for libiMobileDevice: If you are having a problem with the plugin, you may be asked to enable one or both of these checkboxes, then restart calibre in debug mode from a terminal window to generate a debug log.

To start calibre in debug mode, type calibre-debug -g in a terminal window.

 

3. Match status

Click to list books installed in Marvin with a background color representing their status.

Color in calibre library Match status
Green Installed in calibre and Marvin, all metadata matches.
Yellow Installed in calibre and Marvin, some metadata differences.
Magenta multiple Installed in calibre and Marvin, more than one copy in calibre.
Orange Installed in calibre and Marvin, more than one copy in Marvin.
Light Gray Installed in calibre and Marvin, book contents updated in calibre.
Dark Gray Installed in calibre and Marvin, book contents updated in Marvin.
White   Installed in Marvin only.
Red   Multiple copies installed in Marvin.

Click to return to the regular display listing.

4. FAQs

How does the Marvin XD plugin relate to the iOS reader applications driver? Do I need both plugins?

Yes, you need the iOS reader applications driver (iOSRA) configured with Marvin as your preferred iOS reader application. Marvin XD communicates with the iOSRA driver to accomplish its tasks. Marvin XD offers many more features than a conventional device driver. You should be able to accomplish all Marvin tasks through Marvin XD.


I see lots of books with yellow backgrounds when showing match status. Is that bad?

No, that's good! Yellow means that the book content is the same between calibre and Marvin, but there are some metadata differences. The differences could be as minor as a difference in the title, or perhaps an updated cover.

To compare the metadata, double-click the title to open the Metadata window. To make the books match exactly, choose which metadata you want to use, and apply it. Changes are applied immediately.


I have books in Marvin that I'd like to add to calibre. How do I do that?

Select the books to add, then open the context menu by right-clicking in the Titles or Authors column, then click 'Add to calibre library'.


Why can't I see all of my calibre books in Marvin XD?

Books listed in Marvin XD are only those installed in your Marvin library. Books which also happen to be in your calibre library are shown with green, yellow or orange backgrounds when match quality is enabled.


How do I control which columns are shown or hidden? How do I resize the column widths?

To manage visible columns, open Marvin XD, then right-click on any column header. Enable or disable the columns by toggling the checkbox next to the column name.

When Marvin XD is installed, Date added, Last read and Subjects are hidden by default.

Title is always shown; all other columns may be shown or hidden.

You can resize individual column widths by positioning your cursor at the right edge of a column header, then clicking and dragging.

The layout of visible columns and columns widths is preserved when closing the Marvin XD window.

 


Does Marvin XD synchronize or merge annotations?

No. Marvin XD enables transferring annotations and highlights from the connected iDevice to a custom column in calibre, with the option of custom formatting. It is not possible to transfer annotations from calibre to Marvin.


Why does it take so long to generate Deep View content?

Marvin scans the entire text of your book to index all names, dates, events and locations. Older iDevices take longer than newer iDevices. But once Deep View has been created for a book, you'll never have to do it again. Go get a cup of coffee.


I have a large calibre library. How can I used calibre's virtual libraries feature to speed things up?

Before launching Marvin XD, create a virtual library in calibre. For example, you can limit a virtual library to books by a certain author. Type author:Lewis Carroll in calibre's search box, then click the Virtual Library button to open the Virtual Library menu, then select *current search. When you launch Marvin XD, only the books in the virtual library will be scanned.


What's going on under the hood?

When Marvin XD is initially launched on your computer, it creates caches to speed up subsequent sessions. First, your calibre library is scanned, generating 'hash' values for every book. Next, Marvin's library is scanned, generating hash values for every book. These hash values allow Marvin XD to identify books as being the same when the content matches, even when the metadata differs. After Marvin XD has identified your books, it compares metadata to see which books match completely or partially. This match quality is shown as background colors when show match quality is enabled.


The guy who writes the Marvin blog entries is always more entertaining when it comes to these technical documents. Do you know when he will post something better than this dry crap?

Keep an eye on the Marvin for iOS blog, I'm sure he'll come up with something brilliant soon.


5. Actions reference

Actions in Marvin XD are initiated by double-clicking a cell, selecting an action from a cell's context menu, or clicking a button in the main window. Hover the cursor over a cell in the Marvin XD window to see the available actions for that cell.

Action Description Where it lives
Add annotations to a custom column Fetch notes and annotations from Marvin, apply to custom column specified for Annotations (in configuration dialog). Applies to selected books.
  • Annotations context menu
Add collection assignments Add collection assignments. Applies to selected books.
  • Collections context menu
  • Collections dialog
Add to calibre library Add selected books to calibre library.
  • Title/Author context menu
Apply last read date to a calibre column Apply last read date to custom column specified for Last read (in configuration dialog). Applies to selected books.
  • Last read double-click
  • Last read content menu
Apply rating Apply rating (0-5 stars) to selected books. If book is matched in calibre, rating will also be applied to calibre metadata.
  • Rating context menu
Apply reading progress to a custom column Apply reading progress to custom column specified for Progress (in configuration dialog). Applies to selected books. Books flagged as New will have no reading progress; books flagged as Read will have 100% reading progress.
  • Progress double-click
  • Progress context menu
Calculate word count Calculate word count for selected books.
  • Word count double-click
  • Word count context menu
Clear all flags Clear New, Reading list and Read flags for selected books in Marvin and calibre (if custom columns enabled).
  • Flags context menu
Clear New flag Clear New flag for selected books in Marvin and calibre (if custom column enabled).
  • Flags context menu
Clear Read flag Clear Read flag for selected books in Marvin and calibre (if custom column enabled).
  • Flags context menu
Clear Reading list flag Clear Reading list flag for selected books in Marvin and calibre (if custom column enabled).
  • Flags context menu
Deep View articles Display Deep View articles associated with selected book.
  • Deep View context menu
Deep View items, sorted alphabetically Display Deep View items (names, dates, events and locations) sorted alphabetically. Applies to selected book.
  • Deep View context menu
Deep View items, sorted by importance Display Deep View items (names, dates, events and locations) sorted by frequency of appearance. Applies to selected books.
  • Deep View context menu
Deep View items, sorted by order of appearance Display Deep View items (names, dates, events and locations) sorted by order of appearance in book. Applies to selected book.
  • Deep View context menu
Deep View items (notes and flags first) Display Deep View items (names, dates, events and locations) with notes and flagged items first. Applies to selected book.
  • Deep View context menu
Delete from Marvin library Delete selected books from Marvin library.
  • Title/Author context menu
Export calibre collections to Marvin Apply collection assignments from calibre custom column (assigned in configuration dialog) to Marvin for selected books.
  • Collections context menu
  • Collections dialog
Export metadata from calibre to Marvin Apply all calibre metadata to Marvin for selected books.
  • Title/Author context menu
  • Metadata dialog
Generate Deep View content Generate Deep View content (names, dates, events and locations) for selected books. Depending on the iDevice, this may take several minutes for larger books.
  • Deep View double-click
  • Deep View context menu
Help Display this help file.
  • Main window button
Hide status match Toggle display to hide match status (colored rows) in main window.
  • Main window button
Import Marvin collections to calibre Apply collection assignments from Marvin to calibre custom column (assigned in configuration dialog) for selected books.
  • Collections context menu
  • Collections dialog
Import metadata from Marvin to calibre Apply Marvin metadata to calibre for selected books.
  • Title/Author context menu
  • Metadata dialog
Lock books Set locked status of selected books to locked. Locked column is only visible when password is set in the 'More' tab of Marvin's main settings (the gear icon on the Home screen).
  • Locked context menu
Manage collections Display the Collection management dialog to globally rename or delete collection names in both calibre and Marvin. Changes to collection names apply to all books with collection assignments in calibre and Marvin.
  • Main window button
  • Collections content menu
Merge collections Merge collection assignments from calibre custom column (assigned in configuration dialog) and Marvin to selected books.
  • Collections context menu
  • Collections dialog
Refresh custom columns Apply contents of Progress, Last read, Locked and Annotations columns to custom columns (assigned in configuration dialog) for selected books. You may also enable automatic refresh of custom column content in the plugin's configuration dialog.
  • Main window button
  • Configuration dialog
Remove from all collections Clear all collection assignments for selected books.
  • Collections context menu
  • Collections dialog
Set New flag Set New flag for selected books in Marvin and calibre (if custom column enabled).
  • Flags context menu
Set Read flag Set Read flag for selected books in Marvin and calibre (if custom column enabled).
  • Flags context menu
Set Reading list flag Set Reading list flag for selected books in Marvin and calibre (if custom column enabled).
  • Flags context menu
Show match status Toggle display to show match status (colored rows) in main window.
  • Main window button
Synchronize flags Sync Read and Reading list flags between calibre and Marvin, using most-recently updated metadata as master.
  • Flags context menu
Unlock books Set locked status of selected books to unlocked. Locked column is only visible when password is set in the 'More' tab of Marvin's main settings (the gear icon on the Home screen).
  • Locked context menu
View all vocabulary words Display a list of vocabulary words for all books installed in Marvin.
  • Main window button
  • Vocabulary context menu
View annotations Display a list of annotations for selected book.
  • Annotations double-click
  • Annotations context menu
View articles Display a list of pinned and Wiki articles for selected book.
  • Articles double-click
  • Articles context menu
  • Deep View context menu
View collection assignments Display the Collections dialog with collections assignments for calibre and Marvin. Applies to selected book.
  • Collections double-click
  • Collections context menu
View metadata Display calibre and Marvin metadata side-by-side, with differences highlighted, for currently selected book. If metadata differs, you may export metadata from calibre to Marvin, or import metadata from Marvin to calibre.
  • Title/Author double-click
  • Title/Author context menu
View vocabulary Display vocabulary words for currently selected book.
  • Vocabulary double-click
  • Vocabulary context menu

 

6. Support

For more information on Marvin XD, visit calibre's Plugins forum at MobileRead Forums.

To report an error or suggest an enhancement, visit Marvin XD's GitHub issue tracker.

To support the ongoing development of Marvin XD: