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 04-18-2016, 06:21 PM   #1
szarroug3
Connoisseur
szarroug3 began at the beginning.
 
Posts: 50
Karma: 12
Join Date: Apr 2016
Device: Kindle PW2
[GUI Plugin] X-Ray Creator

Shelfari has officially started redirecting their pages to Goodreads. We've updated the plugin to support Goodreads but since they don't have a lot of data (a lot of characters and locations have no description at all), your generated x-rays will probably have a lot less data. Unfortunately, there's nothing we can do about this. I'm investigating getting character data from other places. Thanks.

I've created a Calibre plugin that creates and sends x-ray files to kindle.

Some background information on X-Ray:
X-Ray files allow you to get information on key characters and terms from shelfari. You can do this in one of a few ways.
1. You can highlight the word in question and if the x-ray file has information on it, a popup with a brief description will show. It will also show you where this character has been mentioned in the past (will show page number and excerpt where mention occurred).
2. You can click X-Ray and search for the word either by looking through the list or using the search bar. Clicking on the word will show you the same popup from #1.

Note: X-Ray files work only work on Amazon products such as the Kindle PW. For more information on X-Ray files, see here: http://www.amazon.com/gp/help/custom...7-239A35EB4119
It also has a notable clips section which show quotes from shelfari. If there are not enough shelfari quotes found, the plugin will add more random excerpts so there are least 20 notable clips.
Github Page: https://github.com/szarroug3/X-Ray_Calibre_Plugin

This plugin will allow you to:
1. Set book specific preferences (This screen may take a while to open if doesn't have the ASIN and shelfari url set in the settings already as it will be searching for them; Use "," or ", " as a separator for words in aliases list)
Auto associate split aliases, when enabled, will split aliases up. For example, if a character on goodreads named "Vin" has a Goodreads alias of "Valette Renoux", this option will add "Valette" and "Renoux" as aliases. You may not want this in cases such as "Timothy Cratchit" who has a Goodreads alias of "Tiny Tim". Having this feature on would add "Tiny", and "Tim" as aliases which is not valid.
2. Create/Update x-ray files for selected books
3. Send previously generated x-ray files to device
Note: Creating an x-ray file using this plugin will automatically search for and use the correct ASIN so you don't need to search for it.
Note: Highlighting words should work but I have not tested with a book that has DRM so I don't know if it will work for them.
Preferences:
1. Send x-ray to device if connected
- After creating x-ray file, file will automatically be sent to device
2. Create x-ray for files that don't already have them when sending to device
- When sending previously generated x-ray files, x-ray files will be generated for selected books that don't already have a file created
3. Auto associate split aliases, when enabled, will split aliases retrieved from Goodreads up
- i.e If a character on goodreads named "Vin" has a Goodreads alias of "Valette Renoux", this option will add
"Valette" and "Renoux" as aliases. You may not want this in cases such as "Timothy Cratchit" who has a
Goodreads alias of "Tiny Tim". Having this feature on would add "Tiny", and "Tim" as
aliases which is not valid.
4. Overwrite files that already exist when creating files
- When using the Create/Update Files function, this will decide whether or not to delete local files that already exist
5. Files to create/send
- This will let you choose what type of files to create and/or send
- You must choose at least one.
6. Book types to create x-ray files for
- Selection of formats to consider when creating and sending x-ray files.
- You must choose at least one.
7. If device has both (mobi and azw3) formats, prefer
- This will choose which format to send x-ray files for if your device has both file formats
- This matters because there are offsets in the x-ray file that determine whether something that is highlighted is
part of the x-ray
- If you are sure you only have one format of the book type on the device, this does not matter.
Testing:
This plugin has been tested using a Kindle PW2 on Windows 10 and Linux.
I am still working on testing some portions of it so if you do find a bug or want to request a feature, please let me know via Github or Mobileread.

Here are some screenshots of the plugin in action:
Plugin will show up on your toolbar (if you enable it - remember: when device is connected, there is a separate toolbar)

Click image for larger version

Name:	toolbar.PNG
Views:	110
Size:	14.4 KB
ID:	152646

You can set general preferences

Click image for larger version

Name:	preferences.PNG
Views:	110
Size:	17.4 KB
ID:	152645


You can set book specific preferences

Click image for larger version

Name:	book_preferences.PNG
Views:	100
Size:	15.6 KB
ID:	152642


Plugin will add job to job manager

Click image for larger version

Name:	job_manager.PNG
Views:	96
Size:	25.9 KB
ID:	152644


Plugin will list execution, success, and failure information in job details

Click image for larger version

Name:	job_details.PNG
Views:	109
Size:	21.7 KB
ID:	152643
Attached Files
File Type: zip xray_creator_calibre_plugin_3_0_1.zip (92.4 KB, 2054 views)

Last edited by szarroug3; 10-29-2016 at 02:04 PM.
szarroug3 is offline   Reply With Quote
Old 04-18-2016, 07:01 PM   #2
eschwartz
Ex-Helpdesk Junkie
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.
 
eschwartz's Avatar
 
Posts: 19,148
Karma: 82980001
Join Date: Nov 2012
Location: The Beaten Path, USA, Roundworld, This Side of Infinity
Device: Kindle Touch fw5.3.7 (Wifi only)
Is this an update to mjwilson's plugin from this thread?

Also, I think you forgot to attach it.
eschwartz is offline   Reply With Quote
 
Advertisement
Old 04-18-2016, 07:06 PM   #3
BetterRed
null operator
BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.
 
Posts: 7,497
Karma: 6867503
Join Date: Mar 2012
Location: NSW Australia
Device: none
I think it, the link to the zip, was there before
BetterRed is offline   Reply With Quote
Old 04-18-2016, 08:03 PM   #4
szarroug3
Connoisseur
szarroug3 began at the beginning.
 
Posts: 50
Karma: 12
Join Date: Apr 2016
Device: Kindle PW2
Sorry forgot to make a few changes. no this is not an update to anything.
szarroug3 is offline   Reply With Quote
Old 04-18-2016, 08:26 PM   #5
BetterRed
null operator
BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.
 
Posts: 7,497
Karma: 6867503
Join Date: Mar 2012
Location: NSW Australia
Device: none
Quote:
Originally Posted by szarroug3 View Post
Sorry forgot to make a few changes. no this is not an update to anything.
@szarroug3 - If you tell me what sort of plugin it is - i.e. Gui, Metadata, Output etc - then I'll put a 'prefix' on the threads Title.

And if you PM me, or another calibre mod, something like you see below he/she will put it in the plugin-index. Please try to retain the formatting.

Thanks for your efforts - without its optional plugins calibre wouldn't be anywhere near as useful to so many.

BR

Code:
[*][URL="http://www.mobileread.com/forums/showthread.php?t=218666"]allrecipes.com Recipe Reader[/URL]
[I]Create an ebook of recipes from allrecipes.com by entering the urls of interest.
Version: 1.0.0; Released: 07-24-2013; Calibre: 0.8.58; Author: Krittika Goyal; History: Yes; 
Platforms: Windows, OSX, Linux[/I]

Last edited by BetterRed; 04-18-2016 at 08:34 PM.
BetterRed is offline   Reply With Quote
Old 04-18-2016, 08:27 PM   #6
eschwartz
Ex-Helpdesk Junkie
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.
 
eschwartz's Avatar
 
Posts: 19,148
Karma: 82980001
Join Date: Nov 2012
Location: The Beaten Path, USA, Roundworld, This Side of Infinity
Device: Kindle Touch fw5.3.7 (Wifi only)
Ah, I see the link to your GitHub repo: https://github.com/szarroug3/X-Ray_Calibre_Plugin

And the related repos:
https://github.com/szarroug3/X-Ray-Creator
https://github.com/szarroug3/X-Ray-Creator-2

So you've ported Ephemerality's more advanced work? Nice!
Will have to take this out for a spin...

@BR: GUI plugin

Code:
[*][URL="http://www.mobileread.com/forums/showthread.php?t=273189"]X-Ray Creator[/URL]
[I]A plugin to create X-Ray files for MOBI books
Version: 1.0.0; Released: 04-18-2016; Calibre: 0.9.29; Author: szarroug3; History:  No;
Platforms: Windows, OSX, Linux[/I]

Last edited by eschwartz; 04-18-2016 at 08:34 PM.
eschwartz is offline   Reply With Quote
Old 04-18-2016, 08:34 PM   #7
BetterRed
null operator
BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.
 
Posts: 7,497
Karma: 6867503
Join Date: Mar 2012
Location: NSW Australia
Device: none
What's JimmXinu got to do with it
BetterRed is offline   Reply With Quote
Old 04-18-2016, 09:38 PM   #8
szarroug3
Connoisseur
szarroug3 began at the beginning.
 
Posts: 50
Karma: 12
Join Date: Apr 2016
Device: Kindle PW2
@eschwartz - yeah the first 2 were attempts at a desktop version but yes i was going for a way to get Ephemerality's functionality but in a mass processing way.

@BetterRed - Thanks, programmatically (if that's what you're asking), it's an "Interface Plugin"; it updates the ASIN for a book if necessary, creates the x-ray file for the books and puts them in the correct location on the device so it could also be considered a metadata plugin or device plugin.. not really sure which one you'd consider it as
szarroug3 is offline   Reply With Quote
Old 04-18-2016, 09:56 PM   #9
eschwartz
Ex-Helpdesk Junkie
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.
 
eschwartz's Avatar
 
Posts: 19,148
Karma: 82980001
Join Date: Nov 2012
Location: The Beaten Path, USA, Roundworld, This Side of Infinity
Device: Kindle Touch fw5.3.7 (Wifi only)
Quote:
Originally Posted by BetterRed View Post
What's JimmXinu got to do with it
Maybe if you didn't post seconds after I finished editing it, you wouldn't have seen the half-finished state which still partially resembled the template I copy-pasted from.

@szarroug3,

An Interface Plugin is referred to in layman's speech (i.e. end-user readable index listing) as a GUI Plugin.

Last edited by eschwartz; 04-18-2016 at 10:00 PM.
eschwartz is offline   Reply With Quote
Old 04-18-2016, 09:57 PM   #10
BetterRed
null operator
BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.
 
Posts: 7,497
Karma: 6867503
Join Date: Mar 2012
Location: NSW Australia
Device: none
Quote:
Originally Posted by szarroug3 View Post
@eschwartz - yeah the first 2 were attempts at a desktop version but yes i was going for a way to get Ephemerality's functionality but in a mass processing way.

@BetterRed - Thanks, programmatically (if that's what you're asking), it's an "Interface Plugin"; it updates the ASIN for a book if necessary, creates the x-ray file for the books and puts them in the correct location on the device so it could also be considered a metadata plugin or device plugin.. not really sure which one you'd consider it as
@szarroug3 - hmmm, eschwartz says its a GUI plugin, I can't really test it as I don't have a Kindle. There is no list of plugin types, i.e. the groupings that exist are somewhat arbitrary.

Maybe you and eschwartz can come to an agreement as to where it should be placed in the list, he's my goto man on Kindley things

BR
BetterRed is offline   Reply With Quote
Old 04-18-2016, 10:02 PM   #11
BetterRed
null operator
BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.
 
Posts: 7,497
Karma: 6867503
Join Date: Mar 2012
Location: NSW Australia
Device: none
Quote:
Originally Posted by eschwartz View Post
Maybe if you didn't post seconds after I finished editing it, you wouldn't have seen the half-finished state which still partially resembled the template I copy-pasted from.
yeah - theducks reminded me about the template file in the index thread in a PM - I'm hoping he will massage it to make it generic.

BR
BetterRed is offline   Reply With Quote
Old 04-18-2016, 10:38 PM   #12
davidfor
Grand Sorcerer
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: 10,628
Karma: 15894549
Join Date: Jul 2011
Location: Sydney, Australia
Device: Kobo: Touch, Glo, Aura H2O, Glo HD
Quote:
Originally Posted by BetterRed View Post
@szarroug3 - hmmm, eschwartz says its a GUI plugin, I can't really test it as I don't have a Kindle. There is no list of plugin types, i.e. the groupings that exist are somewhat arbitrary.
No they are not. The groups should match the plugin groups in calibre. And which of the groups the plugin goes into is defined by the base class the plugin uses. In the index "GUI Plugin" is used instead of "User Interface Action Plugins". These plugins are based on "InterfaceActionBase". The big difference about these plugins to all the others is that the user starts them directly (toolbar button or menu somewhere) rather than as part of some other calibre action (Metadata source plugins are used as part a metadata download, Output plugins as part of a conversion).

If you install this plugin, it will appear in the "User Interface Action Plugins" group in calibre, so in the index it is a "GUI Plugin".
davidfor is online now   Reply With Quote
Old 04-18-2016, 11:19 PM   #13
BetterRed
null operator
BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.
 
Posts: 7,497
Karma: 6867503
Join Date: Mar 2012
Location: NSW Australia
Device: none
@davidfor - perhaps you can PM me a list of groups, I looked I couldn't find anything, but I admit to not reading the manual in detail.

If you can do that then I will incorporate it into PI Index Thread.

@szarroug3 - if a PI has a user interaction the convention is to include screen shots in the first post. The lack of anything contributed to my questioning of what sort of plugin this is.

BR

Last edited by BetterRed; 04-18-2016 at 11:25 PM.
BetterRed is offline   Reply With Quote
Old 04-18-2016, 11:52 PM   #14
davidfor
Grand Sorcerer
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: 10,628
Karma: 15894549
Join Date: Jul 2011
Location: Sydney, Australia
Device: Kobo: Touch, Glo, Aura H2O, Glo HD
Quote:
Originally Posted by BetterRed View Post
@davidfor - perhaps you can PM me a list of groups, I looked I couldn't find anything, but I admit to not reading the manual in detail.

If you can do that then I will incorporate it into PI Index Thread.
Open the calibre preferences and go to the plugins page. The list of groups should be obvious. The index doesn't have all groups listed as I don't think plugins have been created for all groups.

There might be groups missing from your preferences list. A group is only shown if you have plugins installed for that group. But, I can only think of two groups that don't have builtin plugins. These are "Edit Book Tool" for the editor plugins and one for the ebook viewer. I think that is just "Viewer", but, at the moment, I can't install the only viewer plugin I can find.

Also, the index doesn't have a "Store" section. I think the Store plugins are in the "GetBooks" thread.
davidfor is online now   Reply With Quote
Old 04-19-2016, 12:47 AM   #15
BetterRed
null operator
BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.
 
Posts: 7,497
Karma: 6867503
Join Date: Mar 2012
Location: NSW Australia
Device: none
Of course - do you happen to know if that list is available as text, I can't be bothered OCRing a screen shot.

I have Diap's Toolbag and Christine Yu's TTS plugins, as you said they're in the Edit Book Tools and Viewer groups respectively



BR
BetterRed is offline   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] EpubMerge JimmXinu Plugins 281 12-07-2016 03:05 PM
[GUI Plugin] Unplugged Jellby Plugins 8 07-19-2016 05:27 AM
[GUI Plugin] KindleUnpack - The Plugin DiapDealer Plugins 362 04-25-2016 06:19 PM
[GUI Plugin] Astro-ph iatheia Plugins 14 07-26-2015 12:41 AM
[GUI Plugin] Plugin Updater **Deprecated** kiwidude Plugins 159 06-19-2011 01:27 PM


All times are GMT -4. The time now is 08:23 PM.


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