[GUI Plugin] FanFicFare

[JimmXinu]

Originally Posted by TheOne320

I just got my new Kindle Colorsoft and now I am wondering how can I get FanFicFare to import stories with colours? Some RoyalRoad stories use colour in tables or just to highlight specific words. How can I setup FanFicFare to save these colours in the epub?

Depends on the story and how color is implemented.

Tag Styles

A lot of the time, it's style attributes on individual tags. By default, FFF removes style attributes from tags.

From defaults.ini:

Spoiler:

## Some attributes cause problems for EBook readers.  By default,
## FanFicFare will remove all attributes except the ones specified
## from all tags.  (The only exception is that <img> tags will also
## keep src, alt and longdesc attributes.  data-orighref is used by
## internalize_text_links to preserve links when chapters are
## inserted.)
## Example: To add 'style', 'title' and 'align' to the list to keep,
## in your personal.ini [defaults] put:
## add_to_keep_html_attrs:,style,title,align
keep_html_attrs:href,name,class,id,colspan,rowspan,data-orighref

You can keep style and align attrs for RR only, or all epubs like so:

[www.royalroad.com]
add_to_keep_html_attrs:,style
# use one or the other, not both
[epub]
add_to_keep_html_attrs:,style

Stylesheets

In some stories/sites, colors/styles are implemented in a separate CSS stylesheet tag or file and applied by tag/class/id.

There isn't a one-line solution for those. You'll need to identify the needed CSS and add it to personal.ini with add_to_output_css. Probably on a story-by-story basis; unless a site or author has a common CSS they use.

In either case, you'll have to do an overwrite always download to get these changes in stories you've already downloaded before.

[XRoverMaelstromX]

I am trying to change how FanFicFare phrases the status metadata piece when it puts it into tags. I used replace metadata and it came out very weird and I don't understand why.

My personal.ini has the following:

include_subject_tags: status, extratags

extratags: Type - Fanfiction

Previously, this resulted in the tags Completed or In-Progress being inserted into my tags column, depending on how the fic was marked on Ao3.

Today I added:

replace_metadata:
 status=>Completed=>Status - Completed
 status=>In-Progress=>Status - In-Progress

This resulted in the tags Status - Status - Completed or Status - Status - In-Progress being inserted into my tags column, depending on how the fic was marked as normal.

I don't understand where that extra "Status - " came from at all and I'm very lost on how to fix that.

Also, I realized this messes with the way my title page is generated, since the title page now has Status: Status - Completed or Status: Status - In-Progress, which makes sense for my use of replace_metadata but isn't ideal. Is there a way to change just the way the status metadata piece is phrased when it's put into the tags but not on the title page of the epub? I feel like there is and I'm just missing something, but I'm not sure.

[ownedbycats]

a bit tired to explain it coherently, but try using anchors to define the beginning and end of strings, e.g.

replace_metadata: 

 author=>^Anonymous$=>Unknown
 author=>^orphan_account$=>Unknown

[XRoverMaelstromX]

Welp, that worked for the duplication in the tag, thank you! Fun fact, I tested to see if the dash was the issue, and changing the replacement phrase to Status.Completed resulted in Status.Status.Completed, and I'm seriously curious as to why not having the anchors defining the beginning and ends of the string resulted in that kind of duplication!

Do you, or anyone, know how to make it do the replacement only for where it's dropping the status into the tags but not on the title page? I can live with it being slightly awkward on the title page, but I'd prefer it not to be.

[JimmXinu]

The duplication is an odd interaction between how FFF treats list vs scalar(single) metadata entries with regard to replace_metata and how the method to get subject tags explicitly calls for lists.

Using ^ and $ anchors just means the regex doesn't match the 'Status - ' version when it comes by again.

This is a bug. Hopefully I'll be able to come up with a proper fix.

Yes, it's possible to change only the tags version by making a copy of status to modify and include in subject tags. In fact, if you'd done that first, I don't think this bug would have been revealed.

Search for include_in_ and add_to_extra_valid_entries if you don't want to wait while I'm bug hunting.

[JimmXinu]

New Test Version Posted

2024-11-08
- Add subject_tags to -m/j CLI output
- Fix for double replace_metadata when non-list metadata called by getList().

Test version should address XRoverMaelstromX's duplication issue.

Originally Posted by XRoverMaelstromX

I am trying to change how FanFicFare phrases the status metadata piece when it puts it into tags. I used replace metadata and it came out very weird and I don't understand why.

I would further suggest:

# make a copy of status
add_to_extra_valid_entries:,headerstatus
include_in_headerstatus:status

# add 'Status - ' to all possible status values--some sites do have more
# but only on copy
replace_metadata:
 headerstatus=>^=>Status -\s

# use headerstatus in subject tags only.
include_subject_tags: headerstatus, extratags

[MsFlutter]

Sorry if this is a common question, but do you have any plans to enable editing the calibre library from the command line? It's mentioned in the top post, but I wasn't sure if it was something you were working on, or if it's just been fully shelved until further notice.

I've been interested in making a script of some kind to make importing fics easier when I'm not at home. I could in theory download the fics and then import them, but I rely pretty heavily on Calibre's columns so I'd probably end up just having to update the metadata manually anyway.

[JimmXinu]

Not really.

In theory, it's possible. But it would require re-implementing everything the plugin does using Calibre's CLI interface.

Plus the FFF plugin have several features that need to pop dialogs to the user and/or call other plugins.

[XRoverMaelstromX]

Thanks for the bugfix! I really appreciate the help there!

I have another question - I searched the thread and I think this isn't possible, but I'm unsure so I wanted to check in case it has become possible. I have my personal.ini set up to grab my subscription status and it works perfectly for single stories, but for anthologies made from series URLs it returns the subscription status for all the stories in the series and not the series itself. Is there a way to pull the subscribed status for the series instead? I know this was mentioned earlier in the thread as not being possible, but I also know that the Status metadata is pulled from the series instead of the individual fics within it for that yes/no column, so I was hoping that whatever the issue before was has been fixed (or is possible to fix) with the newer updates. Thanks!

[JimmXinu]

There's special code in the plugin for anthology status, and it's honestly a bit of a kludge.

I don't really want to also add special code for site specific metadata like subscribed.

[XRoverMaelstromX]

Originally Posted by JimmXinu

There's special code in the plugin for anthology status, and it's honestly a bit of a kludge.

I don't really want to also add special code for site specific metadata like subscribed.

That's totally fair! Thanks for doing all you have with this so far!

[John Maverick]

A month ago I upgrade the OS of my linux PC. Since then open_pages_in_browser isn't working.

Maybe some library was lost in the upgrade or something?

Since the OS upgrade I have updated Calibre and FFF hoping that the problem would solve, but that didn't change anything.

My setup is the following:
OS: Linux Mint 22.0 x86_64 (Upgraded from 21.3)
Calibre version: 7.21 (Official install from Calibre website, not the distro repository)
FanFicFare version: v4.40.0

I attached in this post the debug log of Calibre ten FFF try to open the browser and my safe personal.ini

Somebody has an idea of what is happening?

Like always thanks in advance.

[JimmXinu]

Originally Posted by John Maverick

A month ago I upgrade the OS of my linux PC. Since then open_pages_in_browser isn't working.

Maybe some library was lost in the upgrade or something?

Since the OS upgrade I have updated Calibre and FFF hoping that the problem would solve, but that didn't change anything.

The page doesn't open in your browser? Does it work to click a story (or other) link in Calibre and have it open in browser?

As I recall, FFF uses the same code to open a web page in browser that Calibre does, except in a background process.

Or the page opens, but the cache lookup fails? That would suggest the browser cache location setting in FFF may be wrong now. IE, your browser cache lives in a different place, or you're using a different browser now.

[John Maverick]

Originally Posted by JimmXinu

The page doesn't open in your browser?

Yes. FFF Seems to try opening the page in the default browser of the OS, but nothings happens

Originally Posted by JimmXinu

Does it work to click a story (or other) link in Calibre and have it open in browser?

Yes, it works from Calibre. If click in the story id in Calibre the page of the story is opened in the Browser. It works with the default browser or choosing an specific browser from the setting "openers_by_scheme". Like this:

# Cambiar los programas que se ejecutan al abrir archivos o URL

openers_by_scheme = {'http*': 'firefox %u'}

Originally Posted by JimmXinu

Or the page opens, but the cache lookup fails? That would suggest the browser cache location setting in FFF may be wrong now. IE, your browser cache lives in a different place, or you're using a different browser now.

The page are never opened. But FF can read the Browser cache. I have to open the stories chapters in the browser like before "open_pages_in_browser" was implemented to update or download stories.

If it helps the default browser of the OS is Chromium. Switching it for Firefox does the same. And trying to open urls from other programs like the text editor or even the command line works fine.