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 09-01-2015, 06:01 AM   #1
dickloraine
Fanatic
dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.
 
Posts: 584
Karma: 7024486
Join Date: Apr 2013
Location: Berlin
Device: PRS 350, Kobo Aura
[Metadata Writer Plugin] Embed Comic Metadata

Embed Comic Metadata
A Calibre Plugin to manage comic metadata in calibre.

Version History
Spoiler:

Version 1.31 - 07.04.2016
Fixed a bug if embeding in a cbz file without metadata

Version 1.3 - 06.04.2016
Added options to customize the toolbar menu
Added the possibility of translations
German translation
An option to embed the calibre cover into a comic
Major internal refactoring
Various bug fixes

Version 1.2 - 019.09.2015
Major update:
Allow importing and embeding to custom columns.

Version 1.1.1 - 019.09.2015
Fixed issue with last version.

Version 1.1.1 - 019.09.2015
Fixed importing of unicode fractionals as issue number

Version 1.1 - 019.09.2015
Added the ability to import metadata from comic archives into calibre

Version 1.0.1 - 01.09.2015
Setting the language metadata is now handled by calibres localization functions

Version 1.0 - 01.09.2015
Initial release


Special Notes
Requires calibre version 1.0.0 or later.

Main Features
- Can embed the metadata to the zip comment or a ComicInfo.xml file inside the archives
- Can read the above metadata formats and import them into calibre
- Can write many additional metadata into custom columns Can automatically convert cbr files to cbz
- Can embed the calibre cover into cbz comics (experimental)

Usage

To embed calibres metadata into the comic archive
  • Select the comics that should be updated in the library.
  • Click the addon EmbedComicMetadata icon in your toolbar
  • (You can select a specific action or open the configuration bei clicking on the small arrow on the icon and selecting the desired option)

To import the comic archive metadata into calibre
  • Select the comics that should be updated in the library.
  • Click the small arrow on the addon EmbedComicMetadata icon in your toolbar
  • Click on "Import Metadata from the comic archive into calibre"

Custom Columns
You can make custom columns in calibre and populate them with metadata imported with the plugin.
In the configuration use the dropdown menu for the columns to select what metadata should be written to what custom column.

The custom columns you make in calibre should be of the following type, depending on the metadata stored in them:

Comma seperated text, like tags, shown in the tag browser with "Contains names" checked:
  • Penciller, Inker, Colorist, Letterer, Cover Artist, Editor
Comma seperated text, like tags, shown in the tag browser:
  • Characters, Teams, Locations, Genre
Text, column shown in the tag browser:
  • Story Arc, Volume

Customizing the main menu
The menu in the toolbar can be custimized to your liking through the options in the configuration.

Embed Cover
Use with care, just inserts the calibre cover as "00000000_cover" into the comic archive (previously inserted calibre covers are overwritten).

Configuration
  • 'Write metadata in zip comment': This format is used by calibre, if you import comic files and by ComicbookLovers (default: on)
  • 'Write metadata in ComicInfo.xml': This format is used by ComicRack and some other comic readers (default: on)
  • 'Auto convert cbr to cbz': If a comic has only the cbr format, convert it to store the metadata (default: on)
  • 'Auto convert while importing to calibre': As above, but even when importing metadata into calibre (default: off)
  • 'Delete cbr after conversion': Deletes the cbr format after the conversion (default: off)
  • 'Swap names to "LN, FN" when importing metadata': Does just what it says
  • 'Main Button Action': You can set, what action should be performed if the big toolbar button is pressed. Needs a calibre restart (default: Embed metadata)
  • 'Menu Buttons': The dropdown menu on the icon in the toolbar can be custimized to your liking through these options

Acknowledgement
The handling of the comic metadata is done by using code from ComicTagger
Attached Files
File Type: zip EmbedComicMetadata.zip (26.7 KB, 6763 views)

Last edited by dickloraine; 04-07-2016 at 06:03 AM. Reason: update to version 1.31
dickloraine is offline   Reply With Quote
Old 09-06-2015, 12:15 AM   #2
DreamStatic
Enthusiast
DreamStatic began at the beginning.
 
Posts: 28
Karma: 10
Join Date: Aug 2014
Device: iphone, ipad, computer
Thanks for this awesome plugin. I am curious what your current workflow is to get your comics into Calibre? Do you have any plugins that will pull the info down from ComicVine?
DreamStatic is offline   Reply With Quote
Old 09-06-2015, 07:25 AM   #3
dickloraine
Fanatic
dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.
 
Posts: 584
Karma: 7024486
Join Date: Apr 2013
Location: Berlin
Device: PRS 350, Kobo Aura
Currently I still use ComicTagger and then import to calibre (calibre imports metadata stored in the zip comment. To be compatible with the comictagger metadata you need to change the options in calibres comic metadata reader plugin to "issue"). But I make sometimes changes in calibre or add webcomics or add the metadata manually (which is a pain in comictagger). In these cases I needed a method to save the metadata in calibre.

There was a comicvine plugin for calibre: http://www.mobileread.com/forums/sho...ght=comic+vine There is a fix somewhere in the thread, but I didn't test it yet. Maybe I change to that, if it works. But comictagger has some advantages, such as comparing the cover to get acurate metadata.

Last edited by dickloraine; 09-06-2015 at 07:28 AM.
dickloraine is offline   Reply With Quote
Old 09-06-2015, 10:29 AM   #4
DreamStatic
Enthusiast
DreamStatic began at the beginning.
 
Posts: 28
Karma: 10
Join Date: Aug 2014
Device: iphone, ipad, computer
Very cool. Thanks again for the plugin and the info about your workflow. Keep up the good work.
DreamStatic is offline   Reply With Quote
Old 09-16-2015, 02:07 AM   #5
DreamStatic
Enthusiast
DreamStatic began at the beginning.
 
Posts: 28
Karma: 10
Join Date: Aug 2014
Device: iphone, ipad, computer
Really enjoying this plugin. Thanks again.

Any thoughts on writing a plugin that will read ComicInfo.xml files that reside in the book directory?
DreamStatic is offline   Reply With Quote
Old 09-16-2015, 06:47 AM   #6
dickloraine
Fanatic
dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.
 
Posts: 584
Karma: 7024486
Join Date: Apr 2013
Location: Berlin
Device: PRS 350, Kobo Aura
Do you mean a plugin that reads the metadata from the comicinfo.xml instead/in addition of the zip comment? Or something else?

It would be easy to add that as an option to the plugin, I think. Better of course would be a seperate plugin, that does this, when a comic is added. Since I first use comictagger, my files have always both, but I can see, that it could be usefull.
dickloraine is offline   Reply With Quote
Old 09-16-2015, 11:24 AM   #7
DreamStatic
Enthusiast
DreamStatic began at the beginning.
 
Posts: 28
Karma: 10
Join Date: Aug 2014
Device: iphone, ipad, computer
Yes, the thought would be to have either one that reads comicinfo.xml when adding the files, and/or the option in this plugin to update the data from either the zip comment or comicinfo.xml. That way if I update the data outside Calibre, it would be easy to pull in those updates thru your plugin.

I would love to be able to utilize the additional items Comicrack includes such as Penciller, Writer, Cover Artist, etc. either to custom fields or just concatenate them all into the Comments. So from this point of view, be super cool to have a GUI that would show all fields I have available in Calibre, and then a way to map the nodes of the xml to each of these fields. With additional ability to add text and nodes together. So I could build a title from <series>Army of Darkness</series> + " #" + <seriesNumber>1</seriesNumber> + " - " + <title>Release the Kraken</title> which would then load Army of Darkness #1 - Release the Kraken to the Title field in Calibre.

Just trying to think out loud and save me from having to retag all my comics down the road. I would like to figure out a way to do right the first time.

I can do some of this thru the Importlist plugin, but it isn't really built for this and can only do one file manually at a time, so it is very time consuming. And it doesn't have the ability to add nodes with text to build custom results which I believe will be the killer feature. Here is the post I added to the Importlist plugin topic: Go there

Last edited by DreamStatic; 09-16-2015 at 11:30 AM.
DreamStatic is offline   Reply With Quote
Old 09-16-2015, 06:01 PM   #8
dickloraine
Fanatic
dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.
 
Posts: 584
Karma: 7024486
Join Date: Apr 2013
Location: Berlin
Device: PRS 350, Kobo Aura
I have begun to implement reading metadata from the comic file, but only a first workflow. I think I can include this relatively easy.

Expanding that to read more than the standart calibre metadata would be possible. What needed to be done in addition is making an option menu, where the user could enter the names of his custom columns for that extra infos and just expanding the function that maps comictagger metadata to calibre metadata with the additional fields.
I don't know if I myself will do this. I haven't worked with custom columns in the code yet and it would be some work to write the gui and map all the additional infos.

The project is on github (the version there is a little bit different to the live plugin, since I have tinkered with it since the last real version). I develop the read feature currently in the " read_cix_metadata" branch.
dickloraine is offline   Reply With Quote
Old 09-16-2015, 07:21 PM   #9
DreamStatic
Enthusiast
DreamStatic began at the beginning.
 
Posts: 28
Karma: 10
Join Date: Aug 2014
Device: iphone, ipad, computer
Wow!! I appreciate you taking the time to implement this idea. I tried to download the project from github to give it a go but ran into an error.

calibre, version 2.38.0
ERROR: Unhandled exception: <b>InvalidPlugin</b>:The plugin in u'/Path/to/Plugin/EmbedComicMetadata-read_cix_metadata.zip' is invalid. It does not contain a top-level __init__.py file


Sorry if I jumped the gun and it isn't ready just yet. Thanks again.
DreamStatic is offline   Reply With Quote
Old 09-16-2015, 09:35 PM   #10
dickloraine
Fanatic
dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.
 
Posts: 584
Karma: 7024486
Join Date: Apr 2013
Location: Berlin
Device: PRS 350, Kobo Aura
It is not ready yet
The newest version should at least run, but has only some fields ready to test. If you download the zip from the development branch, github seems to put the content into a folder inside the zip file. Just unzip the folder and zip only the content.
dickloraine is offline   Reply With Quote
Old 09-16-2015, 09:39 PM   #11
DreamStatic
Enthusiast
DreamStatic began at the beginning.
 
Posts: 28
Karma: 10
Join Date: Aug 2014
Device: iphone, ipad, computer
Cool, no worries. I will wait until it is ready for testing. Thanks again. Just jumping the gun due to my excitement.
DreamStatic is offline   Reply With Quote
Old 09-17-2015, 10:49 AM   #12
dickloraine
Fanatic
dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.
 
Posts: 584
Karma: 7024486
Join Date: Apr 2013
Location: Berlin
Device: PRS 350, Kobo Aura
Okay, the code in the "read_cix_metadata" branch should now work. It needs some testing and reading from cbr is disabled for now, since I don't have a file to test it (but converting it on the fly to cbz of course works).
Before I include the changes here, it will need a bit of testing and I think I simplify the dropdown ui (with an option to have all commands). So it will take a couple of days (depending on how much time I find).
dickloraine is offline   Reply With Quote
Old 09-17-2015, 12:56 PM   #13
DreamStatic
Enthusiast
DreamStatic began at the beginning.
 
Posts: 28
Karma: 10
Join Date: Aug 2014
Device: iphone, ipad, computer
Wow you are pretty awesome!! At first I thought it wasn't working since Calibre doesn't auto update until you click to another row. VERY IMPRESSED with how quickly you implemented this. You code for a living?
DreamStatic is offline   Reply With Quote
Old 09-18-2015, 08:04 AM   #14
dickloraine
Fanatic
dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.dickloraine ought to be getting tired of karma fortunes by now.
 
Posts: 584
Karma: 7024486
Join Date: Apr 2013
Location: Berlin
Device: PRS 350, Kobo Aura
No, I don't. This plugin is not that difficult to write. I use code from comictagger for transforming the metadata and calibre provides functions for most of the other needs. So it is mostly just: If this do that.
dickloraine is offline   Reply With Quote
Old 09-20-2015, 04:14 PM   #15
DreamStatic
Enthusiast
DreamStatic began at the beginning.
 
Posts: 28
Karma: 10
Join Date: Aug 2014
Device: iphone, ipad, computer
Liking where you are headed with this branch. Nice work. You decided if you are going to implement Custom Column mapping? i.e. Cover Artist to custom column Cover Artist, Imprint to custom column Imprint.

I noticed the Count Pages and Import List plugins utilize the Custom Columns, maybe they will be of help if you decide to implement this mapping feature. I looked at them to see if I could decipher custom columns, but I haven't had any luck yet.
DreamStatic 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
[Metadata Writer Plugin] KePub Metadata Writer jgoguen Plugins 53 06-26-2016 02:35 AM
Failed to embed metadata mihal.v Library Management 6 07-11-2015 12:21 PM
embed metadata option mytrivo Library Management 3 06-24-2015 01:34 AM
Regarding using metadata objects in identify method of metadata download plugin api aprekates Development 1 07-06-2014 03:35 AM
[Metadata Download Plugin] Goodreads Metadata **Deprecated** kiwidude Plugins 30 04-23-2011 02:10 PM


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


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