Register Guidelines E-Books Search Today's Posts Mark Forums Read

Go Back   MobileRead Forums > E-Book Software > Calibre > Plugins

Notices

Reply
 
Thread Tools Search this Thread
Old 06-17-2014, 06:08 AM   #1
davidfor
Wizard
davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.
 
Posts: 4,822
Karma: 4772844
Join Date: Jul 2011
Location: Australia
Device: Kobo Touch, Kobo Glo
[GUI Plugin] Annotations


The Annotations plugin is under new management. With GRiker taking a long vacation, he has passed the development and support for the plugin to me. From now on, this thread will be used for any support questions and to host the plugin. All future questions should be posted here, but the older thread is here for reference.

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



Main Features of v1.4.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).
  • 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-.
  • Support for:
    • Kindle
    • Kobo ereaders
    • GoodReader

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 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.



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.

Version History:
Spoiler:

v1.4.0 - 16 June 2014
• Added support for multiple libraries
• Various bug fixes
• Remove support for Marvin as that is in the Marvin XD plugin.
v1.3.0 - 9 December 2013
• Added support for multiple libraries
• Various bug fixes
• Remove support for Marvin as that is in the Marvin XD plugin.
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 (646.6 KB, 633 views)

Last edited by davidfor; 06-18-2014 at 09:51 PM.
davidfor is online now   Reply With Quote
Old 06-20-2014, 11:00 AM   #2
pedrogaza
Junior Member
pedrogaza can tame squirrels without the assistance of a chair or a whip.pedrogaza can tame squirrels without the assistance of a chair or a whip.pedrogaza can tame squirrels without the assistance of a chair or a whip.pedrogaza can tame squirrels without the assistance of a chair or a whip.pedrogaza can tame squirrels without the assistance of a chair or a whip.pedrogaza can tame squirrels without the assistance of a chair or a whip.pedrogaza can tame squirrels without the assistance of a chair or a whip.pedrogaza can tame squirrels without the assistance of a chair or a whip.pedrogaza can tame squirrels without the assistance of a chair or a whip.pedrogaza can tame squirrels without the assistance of a chair or a whip.pedrogaza can tame squirrels without the assistance of a chair or a whip.
 
Posts: 6
Karma: 11000
Join Date: Dec 2013
Device: Kobo Mini
Export annotations to Kobo

Hi,

Would it possible to export annotations to Kobo ? For the ADE annotations it is not a problem, but for annotations stored in Kobo database, it is more difficult to manage it by hand.

I wait for this function since long time... I do not know how to program a plugin, so if I can't find a way to do this before this summer, I will make it in bash script.

Pierre
pedrogaza is offline   Reply With Quote
Old 06-20-2014, 12:28 PM   #3
theducks
Grand Sorcerer
theducks ought to be getting tired of karma fortunes by now.theducks ought to be getting tired of karma fortunes by now.theducks ought to be getting tired of karma fortunes by now.theducks ought to be getting tired of karma fortunes by now.theducks ought to be getting tired of karma fortunes by now.theducks ought to be getting tired of karma fortunes by now.theducks ought to be getting tired of karma fortunes by now.theducks ought to be getting tired of karma fortunes by now.theducks ought to be getting tired of karma fortunes by now.theducks ought to be getting tired of karma fortunes by now.theducks ought to be getting tired of karma fortunes by now.
 
theducks's Avatar
 
Posts: 14,126
Karma: 5468860
Join Date: Aug 2009
Location: The (original) Silicon Valley, USA
Device: Galaxy Tab 2, Astak Pocket Pro, K4NT
Quote:
Originally Posted by pedrogaza View Post
Hi,

Would it possible to export annotations to Kobo ? For the ADE annotations it is not a problem, but for annotations stored in Kobo database, it is more difficult to manage it by hand.

I wait for this function since long time... I do not know how to program a plugin, so if I can't find a way to do this before this summer, I will make it in bash script.

Pierre
Have you looked at what the Kobo utilities PI can do for you?
theducks is offline   Reply With Quote
Old 06-20-2014, 07:59 PM   #4
davidfor
Wizard
davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.
 
Posts: 4,822
Karma: 4772844
Join Date: Jul 2011
Location: Australia
Device: Kobo Touch, Kobo Glo
Quote:
Originally Posted by pedrogaza View Post
Hi,

Would it possible to export annotations to Kobo ? For the ADE annotations it is not a problem, but for annotations stored in Kobo database, it is more difficult to manage it by hand.

I wait for this function since long time... I do not know how to program a plugin, so if I can't find a way to do this before this summer, I will make it in bash script.
Version 1.4.0 of the plugin added support for the Kobo devices. I still need to update the first post completely. And add it to the help.

There are some alternatives:
  • As theducks said, the Kobo Utilities plugin includes a function.
  • Calibre has a a "Fetch annotations" function that gets them and adds them to the comments field.
  • If you add "ExportHighlights=true" to the "FeatureSettings" section of the devices config file, a menu item will be added to the books menu in in the library list on the device to export them as a text file on the device.
  • There have been a few scripts or apps posted in the Kobo forum over the years. A search there should find them.
davidfor is online now   Reply With Quote
Old 06-24-2014, 01:24 PM   #5
Rains
Junior Member
Rains began at the beginning.
 
Posts: 3
Karma: 10
Join Date: Jun 2014
Device: Kindle Paperwhite 2
Hi! Is this plugin usable in Linux? Because I can't get it to work, it installs fine and then I reboot the program but I can't import annotations from the Kindle and when I try to click on "Customize plugin" it shows me this:



These are the details:

Code:
calibre 1.40  isfrozen: False is64bit: True
Linux-3.15.0-1-mainline-x86_64-with-glibc2.2.5 Linux ('64bit', 'ELF')
('Linux', '3.15.0-1-mainline', '#1 SMP PREEMPT Mon May 26 09:43:21 CEST 2014')
Python 2.7.7
Linux: ('', '', '')
Traceback (most recent call last):
  File "/usr/lib/calibre/calibre/gui2/preferences/plugins.py", line 286, in customize_plugin
    self.modify_plugin(op='customize')
  File "/usr/lib/calibre/calibre/gui2/preferences/plugins.py", line 361, in modify_plugin
    if plugin.do_user_config(self.gui):
  File "/usr/lib/calibre/calibre/customize/__init__.py", line 150, in do_user_config
    config_widget = self.config_widget()
  File "calibre_plugins.annotations.__init__", line 28, in config_widget
  File "calibre_plugins.annotations.config", line 60, in __init__
AttributeError: 'AnnotationsAction' object has no attribute 'opts'
As you can see, my Calibre is in Spanish, but I don't think that's the issue, or is it?
Rains is offline   Reply With Quote
Old 06-24-2014, 03:01 PM   #6
eschwartz
Irrational Optimist
eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.
 
Posts: 4,095
Karma: 4846502
Join Date: Nov 2012
Location: The Beaten Path, USA, Roundworld, This Side of Infinity
Device: Kindle Touch (Wifi only)
I do know that according to your error message [isfrozen: False] you do not seem to be running the version that came from Kovid, but are instead using a distro calibre.

It is generally recommended to use the official calibre build. Most distros do not update as frequently as calibre does (weekly) and Kovid prefers to have one self-contained package to support.

The plugin does work on linux -- I use it.
eschwartz is online now   Reply With Quote
Old 06-24-2014, 11:04 PM   #7
Rains
Junior Member
Rains began at the beginning.
 
Posts: 3
Karma: 10
Join Date: Jun 2014
Device: Kindle Paperwhite 2
You're right. I just removed the version I had installed (which wasn't too old, 1.40) and installed the binary package from Calibre's website and now the plugin works.

Thanks.
Rains is offline   Reply With Quote
Old 06-24-2014, 11:10 PM   #8
eschwartz
Irrational Optimist
eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.
 
Posts: 4,095
Karma: 4846502
Join Date: Nov 2012
Location: The Beaten Path, USA, Roundworld, This Side of Infinity
Device: Kindle Touch (Wifi only)
Quote:
Originally Posted by Rains View Post
You're right. I just removed the version I had installed (which wasn't too old, 1.40) and installed the binary package from Calibre's website and now the plugin works.

Thanks.
There are also random ways in which the binaries are not necessarily the same as the distro. For instance, calibre (binary) uses a different version of python (2.7.5) than you seem to have installed (2.7.7).

Perhaps the plugin is written in a way that depends on 2.7.5?
eschwartz is online now   Reply With Quote
Old 06-24-2014, 11:46 PM   #9
davidfor
Wizard
davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.
 
Posts: 4,822
Karma: 4772844
Join Date: Jul 2011
Location: Australia
Device: Kobo Touch, Kobo Glo
Quote:
Originally Posted by eschwartz View Post
There are also random ways in which the binaries are not necessarily the same as the distro. For instance, calibre (binary) uses a different version of python (2.7.5) than you seem to have installed (2.7.7).

Perhaps the plugin is written in a way that depends on 2.7.5?
To the best of my knowledge it doesn't. Or at least not directly. The plugin is dependent on calibre. And it is packaged with a version of Python, so anything else could cause a problem.

Rain: Where did you try to configure the plugin from? The toolbar button or the plugin list?
davidfor is online now   Reply With Quote
Old 06-24-2014, 11:55 PM   #10
eschwartz
Irrational Optimist
eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.eschwartz ought to be getting tired of karma fortunes by now.
 
Posts: 4,095
Karma: 4846502
Join Date: Nov 2012
Location: The Beaten Path, USA, Roundworld, This Side of Infinity
Device: Kindle Touch (Wifi only)
Quote:
Originally Posted by davidfor View Post
To the best of my knowledge it doesn't. Or at least not directly. The plugin is dependent on calibre. And it is packaged with a version of Python, so anything else could cause a problem.
You mean python is installed in the plugin itself??

Doesn't it use calibre's python? Which in this case is updated distro python.
eschwartz is online now   Reply With Quote
Old 06-25-2014, 12:43 AM   #11
davidfor
Wizard
davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.
 
Posts: 4,822
Karma: 4772844
Join Date: Jul 2011
Location: Australia
Device: Kobo Touch, Kobo Glo
Yes, that was badly phrased. The plugin doesn't have its own version of Python. It is dependent on the version of Python included with calibre.
davidfor is online now   Reply With Quote
Old 06-25-2014, 07:55 PM   #12
Rains
Junior Member
Rains began at the beginning.
 
Posts: 3
Karma: 10
Join Date: Jun 2014
Device: Kindle Paperwhite 2
Quote:
Originally Posted by davidfor View Post
Rain: Where did you try to configure the plugin from? The toolbar button or the plugin list?
I'd tried both from the plugin list and the toolbar button and the result was the same.
Rains is offline   Reply With Quote
Old 06-29-2014, 12:11 AM   #13
Digital_Restrict
Junior Member
Digital_Restrict began at the beginning.
 
Digital_Restrict's Avatar
 
Posts: 6
Karma: 10
Join Date: Apr 2014
Location: Sherbrooke, QC
Device: Kindle3/Keyboard
I am trying to use this plugin but I'm encountering an error message. I wonder if someone is still providing support for this apparently glorious plugin? If I get a reply, I will post the exact error message and jobs log, and all the relevant details. I would love to be able to use this plugin ! Thanks !
Digital_Restrict is offline   Reply With Quote
Old 06-29-2014, 12:16 AM   #14
PeterT
Taking a break; Fed up
PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.
 
PeterT's Avatar
 
Posts: 6,457
Karma: 42483084
Join Date: Nov 2007
Location: Toronto
Device: Wife: Touch, Arc, Vox Me: Nexus 7, Glo
Davidfor is supporting it....
PeterT is offline   Reply With Quote
Old 06-29-2014, 01:24 AM   #15
davidfor
Wizard
davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.
 
Posts: 4,822
Karma: 4772844
Join Date: Jul 2011
Location: Australia
Device: Kobo Touch, Kobo Glo
Quote:
Originally Posted by Digital_Restrict View Post
I am trying to use this plugin but I'm encountering an error message. I wonder if someone is still providing support for this apparently glorious plugin? If I get a reply, I will post the exact error message and jobs log, and all the relevant details. I would love to be able to use this plugin ! Thanks !
Yes, post the error and any information that you think could help.
davidfor is online now   Reply With Quote
Reply

Thread Tools Search this Thread
Search this Thread:

Advanced Search

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
[GUI Plugin] KindleUnpack - The Plugin DiapDealer Plugins 228 Yesterday 11:59 AM
[GUI Plugin] Open With kiwidude Plugins 223 07-09-2014 02:42 AM
[GUI Plugin] Annotations (closed) GRiker Plugins 68 06-17-2014 06:11 AM
[GUI Plugin] KiNotes -axel- Plugins 0 07-14-2013 06:39 PM
[GUI Plugin] Plugin Updater **Deprecated** kiwidude Plugins 159 06-19-2011 12:27 PM


All times are GMT -4. The time now is 10:43 PM.


MobileRead.com is a privately owned, operated and funded community.