View Single Post
Old 02-06-2013, 12:42 PM   #1
GRiker
Comparer of the Ephemeris
GRiker ought to be getting tired of karma fortunes by now.GRiker ought to be getting tired of karma fortunes by now.GRiker ought to be getting tired of karma fortunes by now.GRiker ought to be getting tired of karma fortunes by now.GRiker ought to be getting tired of karma fortunes by now.GRiker ought to be getting tired of karma fortunes by now.GRiker ought to be getting tired of karma fortunes by now.GRiker ought to be getting tired of karma fortunes by now.GRiker ought to be getting tired of karma fortunes by now.GRiker ought to be getting tired of karma fortunes by now.GRiker ought to be getting tired of karma fortunes by now.
 
Posts: 1,497
Karma: 424627
Join Date: Mar 2009
Device: iPad
[GUI Plugin] Annotations (closed)

This thread is closed.

You can find the new thread for Annotations support
here.




The Annotations plugin imports annotations from supported ebook readers and applications described in the following table:



Main Features of v1.3.0:
  • Imports annotations from supported eBook reader applications.
  • Annotations may be added to Comments or a custom column.
  • Annotation appearance is fully configurable via CSS.
  • Collect News clippings from periodicals downloaded by Calibre (Kindle, Marvin).
  • Extensible architecture allows adding support for other eBook reader applications.
  • Enables fetching annotations directly from a connected iDevice without additional 3rd party software.
  • Adds improved support for international Kindle timestamps contributed by @-axel-.

Installation Steps:
  • Open Preferences|Plugins|Get new plugins to install the 'Annotations' plugin. Or, download the attached zip file and install the plugin manually, then restart calibre as described in the Introduction to plugins thread.

Plugin configuration:
  • By default, imported annotations will be added to calibre's Comments column.
  • If you'd prefer to add imported annotations to a custom column (recommended), open the Customize Annotations dialog by selecting Customize plugin… from the plugin's context menu. Use the custom column wizard in the Annotation options section to create a custom column.
  • If you choose to use a pre-existing custom column to receive annotations, click on the Annotations plugin icon to open the Configuration dialog, then select the custom column in the Annotation options dropdown list.
  • See Help in the plugin menu for additional information.

Typical Marvin workflow:
As of Marvin 2.0, Marvin users can use the Marvin XD plugin to transfer annotations directly from Marvin to calibre. The Annotations plugin still supports Marvin, but for most users Marvin XD will be the preferred approach. If you install the Marvin XD plugin, uninstall the Annotations plugin.
  • Calibre: Transfer books from calibre to Marvin, either via iTunes, email, OPDS or Marvin's web browser.
  • Marvin: Create some highlights/notes.
    Spoiler:
  • Marvin: Export the annotations (see Marvin export options below).
    Spoiler:
  • Calibre: Open the Annotations plugin context menu, select Import annotations from…Marvin
  • Drag the exported file to the plugin window, then click OK to import the annotations.
  • Select a book, click Preview to preview the annotations to be added to calibre.
    Spoiler:
  • Click Import Annotations to add the imported annotations to the selected book in calibre's database.
  • Open calibre's Metadata editor to view the imported annotations.
    Spoiler:

Typical Kindle workflow:
The Kindle UI must be set to English for the plugin to be able to retrieve locations and timestamps from your 'My Clippings.txt' file.
  • Calibre: Transfer books from calibre to Kindle, either via email, Kindle's experimental web browser, or while directly connected to calibre.
  • Kindle: Create some highlights/notes.
  • Calibre: Open the Annotations plugin context menu, select Fetch annotations from Amazon Kindle.

Typical GoodReader workflow:
  • Computer: Transfer books from calibre to GoodReader via iTunes. See this GoodReader explanation of how to transfer books from your computer to GoodReader via USB.
  • GoodReader: Create some highlights/notes.
  • GoodReader: While reading a book, tap the center of the screen so that the overlay controls are shown. Tap the Share icon (bottom right). Tap E-mail Summary, then email the annotations to yourself.
  • Computer: After receiving the emailed annotations summary, select and copy the contents of the annotations summary email.
  • Calibre: Select the book in your calibre library to receive the imported GoodReader annotations.
  • Calibre: Open the Annotations plugin context menu, select Import annotations from…GoodReader, then paste the annotations summary into the dialog window.

Modifying the appearance of imported annotations:
  • Click the Annotations plugin icon, or select Customize plugin from the context menu.
  • Click Modify appearance…
    Spoiler:
  • The Preview window shows a live preview of the formatting options.
  • Edit the CSS in the Annotation elements window
  • To move an element up or down, click the name of the element (Text, Note or Timestamp), then click the up or down arrow to move that element.
  • To restore an element's CSS to its last saved values, select the element, then click the restore button.
  • To reset an element's CSS to default values, select the element, then click the recycle button.
  • To change the format of the timestamp, edit the Timestamp format. Click the Help icon to see formatting values for the timestamp. Click the recycle button to reset the timestamp to its default value.

How the plugin decides where to add imported annotations
Spoiler:
When the plugin imports annotations, it calculates a confidence index for the book receiving the annotations based upon three metadata items: Title, Author, and the calibre uuid. If all three are matched with a book in your calibre library, the annotations are added without any user intervention. With a partial metadata match, the plugin guesses which book should receive the annotations and asks for user confirmation. With no metadata matching, the user is offered the option to add the annotations to the currently selected book in the library.


Marvin export options:
Spoiler:
To export annotations from a single book:

From within an open book:
  • Tap Table of Contents (book icon at top left)
  • Tap Share (arrow icon at top right)
  • Tap Export Annotations, then email the annotations file to yourself
From the Library screen:
  • Slide the book to the left, then tap Share
  • Tap Export Annotations, then email the annotations file to yourself
After receiving the emailed annotations file:
  • Open the context menu for the Annotations plugin
  • Select Import annotations from…Marvin
  • Drag the exported annotations file to the Import Marvin annotations window
  • Click OK
To export all annotations:
  • In Marvin's Home screen tap Settings (gear icon at top left)
  • Choose the Services tab, then swipe left to the Calibre icon
Via Email:
  • Tap the Export File button, then choose Email
  • Email the annotations to yourself
  • Open the context menu for the Annotations plugin
  • Select Import annotations from…Marvin
  • Drag the exported annotations file to the Import Marvin annotations window
  • Click OK
Via iTunes:
  • Tap the Export File button, then choose Documents directory
  • In iTunes, select your connected iDevice in the DEVICES menu
  • Click the Apps tab
  • Scroll down to File Sharing, then select Marvin in the Apps list
  • Drag library.mrvi from Marvin Documents to your desktop
  • Open the context menu for the Annotations plugin
  • Select Import annotations from…Marvin
  • Drag library.mrvi from your desktop to the Import Marvin annotations window
  • Click OK


Special Notes:
  • Requires calibre 1.0.0 or later.

Developer Notes:
The Annotations plugin can be extended to support devices whose annotations can be fetched while connected via USB, or exported via email. If you are a developer interested in adding support for a particular device or reader app meeting these requirements, contact me for more information.

Paypal Donations:

If you find my contributions to calibre useful, say thanks with PayPal!

Version History:
Spoiler:

v1.3.0 - 9 December 2013
• Added support for multiple libraries
• Various bug fixes
v1.2.0 - 13 September 2013
• Removed dependency on iExplorer for iOS reader applications.
• Added custom column wizard
• Various bug fixes
• Added improved international support for Kindle 'My Clippings.txt' contributed by MobileRead member -axel-.
v1.1.2 - 18 April 2013
• Handle non-English locations in Kindle 'My Clippings.txt'
v1.1.1 - 18 April 2013
• Handle non-English timestamps in Kindle 'My Clippings.txt'
v1.1.0 - 15 March 2013
• Add News clipping feature
• Add support for GoodReader
• Add support for hardware Kindle
v1.0.1 - 11 March2013
• Fixed rare crash condition after opening Preview dialog.
v1.0.0 - 11 March 2013
• Initial release for Linux, OS X and Windows.
• Support for Marvin, an iOS reader application.

Attached Files
File Type: zip Annotations.zip (661.5 KB, 7610 views)

Last edited by GRiker; 06-17-2014 at 07:14 AM. Reason: Closed thread
GRiker is offline