[GUI Plugin] FanFicFare

[ownedbycats]

It worked! Thank you.

Question: Is that whole bit of code supposed to appear purple in the editor? The normal "add_to_replace_metadata" has blue and green and white text but if I put it under the URL it turns the whole thing purple. (I'm in dark mode if that matters.) I'm not sure if that's a bug.

[JimmXinu]

Individual story URL sections are purple. If the section 'name' isn't a recognized story URL it goes to red.

Which keywords are valid depends on site/section and I vaguely recall that it was problematic to apply to individual story sections, so they got their own color.

[ownedbycats]

On the topic of the text colours: This might not be possible at all within the code, but is there a way to turn the blue colour something a bit lighter if Calibre is in dark mode? It's a little eye-searing.



EDIT: WebAIM's Contrast Checker can be helpful to check contrast; the background in dark mode is #121212

ANOTHER EDIT: Also, putting [archiveofourown.org] (presumably other site overrides too) turns it such a dark blue that I couldn't really read it at all on the dark background.

[ownedbycats]

Another topic, for another post:

I noticed that Fanfiction.net author pages have both the author's own stories and their favourited fics on the same page, which really makes a mess when trying to use "get story URLs from page."

Is there any trick to getting just the author's own stories?

EDIT: I discovered that changing the www. to m. works. Though it only shows 20 stories at a time. Oh well.

[JimmXinu]

New Test Version Posted

2020-07-03
- Change INI edit highlight colors when dark theme.

[ownedbycats]

All the colours are a lot easier to read now. Thank you.

[ownedbycats]

Question: Is there way to use an and statement in the In/exclude Metadata? I'd like to exclude "crossover" if it has two specific fandoms but the regexes I tried for matching multiple strings didn't really work.

Also something I found while trying to puzzle that out myself: The crossover crosscategory thing seems to have stopped working on AO3; I downloaded several multifandom fics to check and it doesn't add crossover to any of them. It does still work on FFNet though. I think it was working before so I'm not sure if AO3 changed something or if I managed to break it myself. Here's my ini file in the more likely event of the latter:

Spoiler:

## This is an example of what your personal configuration might look
## like.  Uncomment options by removing the '#' in front of them.

[defaults]

custom_columns_settings: 
 "N"=>#read
 oneshot=>#fanficstatus

## Some sites also require the user to confirm they are adult for
## adult content.  Uncomment by removing '#' in front of is_adult.
is_adult:true

## If set, an image (regardless of source) will only be used as a
## cover image if it is >= both the dimensions listed here.  When not
## set, any size image will be used.  Note that some sites, like ffnet
## use relatively small images(180,240).
cover_min_size: 100,100

replace_metadata: 
 site=>www.fanfiction.net=>FanFiction.net
 site=>archiveofourown.org=>Archive of Our Own
 author=>^orphan_account$=>Unknown
 author=>\(orphan_account\)=>
 category=>(\(Video Game\)|\([0-9]+\))=>
 category=>(^(?=.*Mass.Effect)(?!.*Mass Effect Trilogy).*|Mass Effect - All Media Types)=>Mass Effect Trilogy
 category=>Sims=>The Sims
 category=>(^(?=.*Elder Scrolls)(?!.*The Elder Scrolls).*|Elder Scrolls V: Skyrim)=>The Elder Scrolls
 category=>(Pocket Monsters \|\ Pokemon - All Media Types)=>Pokémon
 oneshot=>Completed=>Oneshot&&numChapters=>^1$
 tagscategory=>^(?!.*(Half-Life|Portal|Mass Effect|Crossover)).*$=>Other
 tagscategory=>^(.*)$=>Fanfiction.\1
 tagscategory=>(Portal|Half-Life)=>Half-Life & Portal
 tagscategory=>Mass Effect Trilogy=>Mass Effect

add_to_replace_metadata:
 description=><br/>=></p><p>

## Add "Crossover" to genre
add_genre_when_multi_category:Crossover

# 'add_to_' concats on to existing param, thus the leading comma
add_to_extra_valid_entries:,oneshot, tagscategory,crosscat

## fill with genre skipping replace/include/exclude
include_in_crosscat:genre.NOREPL

## only include Crossover in crosscat.  
## Again, incorporate with your existing, if  you have one.
add_to_include_metadata_pre:
 crosscat==Crossover

## remove Crossover from genre.  
## Again, incorporate with your existing, yada yada yada.
add_to_exclude_metadata_post:
 genre==Crossover

## add crosscat to category
## Again, incorporate with your existing, etc.
include_in_category:category,crosscat,

# oneshot is a copy of status because status itself isn't a list.
include_in_oneshot:status

# tagscategory is a copy category for Fanfiction.category in tags
include_in_tagscategory:category

include_subject_tags: tagscategory

generate_cover_settings:
 ${site}=>^FanFiction.net$=>FFNet
 ${site}=>^Archive of Our Own$=> AO3

[archiveofourown.org]
slow_down_sleep_time:0.5
## 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.)
## 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

[https://archiveofourown.org/works/21814324]
add_to_replace_metadata_filelist:file:///D:/Documents/Miscellany/ReplaceNBSP.txt

Thank you Sorry for all the silly questions. I think I'm frequent flier on this thread.

[JimmXinu]

Originally Posted by ownedbycats

Question: Is there way to use an and statement in the In/exclude Metadata? I'd like to exclude "crossover" if it has two specific fandoms but the regexes I tried for matching multiple strings didn't really work.

You could use try using fandoms_LIST and match against the entire list as a string.

Originally Posted by ownedbycats

Also something I found while trying to puzzle that out myself: The crossover crosscategory thing seems to have stopped working on AO3; I downloaded several multifandom fics to check and it doesn't add crossover to any of them. It does still work on FFNet though. I think it was working before so I'm not sure if AO3 changed something or if I managed to break it myself. Here's my ini file in the more likely event of the latter:

I will look at this if you also provide at least one story URL that exhibits the issue.

Have I mentioned my opinion about the futility of attempting to normalize AO3 metadata lately?

[ownedbycats]

Originally Posted by JimmXinu

You could use try using fandoms_LIST and match against the entire list as a string.



I will look at this if you also provide at least one story URL that exhibits the issue.

Have I mentioned my opinion about the futility of attempting to normalize AO3 metadata lately?

This is one of the fics that I was using on testing.

[JimmXinu]

Originally Posted by ownedbycats

This is one of the fics that I was using on testing.

Uuugh. This is crazy complicated.

Short answer: The genre(w/add_genre_when_multi_category) -> crosscat -> category trick isn't going to work with AO3 and a few other sites; those that don't internally collect category.

Arguably, it shouldn't work at all.

Long answer:

First problem -- from defaults.ini under [archiveofourown.org]:

## AO3 uses the word 'category' differently than most sites.  The
## adapter used to be hardcoded to include the site specific metadata
## fandom in the standard metadata field category.  By making it
## configurable, users can change it.
include_in_category:fandoms

defaults.ini[archiveofourown.org] takes precedence over personal.ini[defaults], so crosscat isn't being including.

The obvious answer to that is personal.ini:

[archiveofourown.org]
include_in_category:fandoms,crosscat

Now here's why it still doesn't work--and loses the value of crosscat to boot.

For reference, here's the INI code snippet I've been experimenting with:

[defaults]
is_adult:true

## Add "Crossover" to genre
add_genre_when_multi_category:Crossover

## a tmp var, basically.  
## Need to add to your add_to_extra_valid_entries line.
add_to_extra_valid_entries:,crosscat

## fill with genre skipping replace/include/exclude
include_in_crosscat:genre.NOREPL

## only include Crossover in crosscat.  
## Again, incorporate with your existing, if  you have one.
add_to_include_metadata_pre:
 crosscat==Crossover

## remove Crossover from genre.  
## Again, incorporate with your existing, yada yada yada.
#add_to_exclude_metadata_post:
 genre==Crossover

include_in_category:category,crosscat

[archiveofourown.org]
include_in_category:fandoms,crosscat

So the chain goes:

1. category calls for fandoms,crosscat
2. fandoms ->[list from story]
3. crosscat calls for genre.NOREPL(further includes, not relevant) AND category internally for add_genre_when_multi_category
4. category calls for fandoms,crosscat -- recursion check notes it's called from category above and bails

Point 4 is where ffnet (sites that collect category directly) differ from AO3 (sites that have fandoms, etc and load it into category)

When the recursion check bails, it does so returning the original category value--populated for ffnet, but empty for AO3. That's the part that "arguably, shouldn't work at all".

At that point, the current code also caches the failed value for crosscat, which is why the crosscat value disappears. That much I am prepared to call a bug that should be fixed. I even have the fix for it.

What I can't actually find is when the add_genre_when_multi_category setting was added and why. Earliest I can find was 6 years ago and it wasn't new then. I'm tempted to remove it for the sin of being too kludgey to live. But then I'd have to come up with some kind of replacement, I suppose.

[endeni]

Hi there, I have a question: when using Fanficfare together with Epubmerge by chance is there a way to change the name of the Anthology automatically? As in calling it a "series", a "collection" or whatnot?
Thank you!

[JimmXinu]

You can change that in personal.ini settings.

From defaults.ini [defaults] section:

## Uses a python template substitution.  The ${title} is the default
## title of a new anthology, <series name> in the case of a series, or
## the first book title otherwise.  This is only applied to new
## anthologies.
anthology_title_pattern:${title} Anthology

## Add tag(s) for anthology (series) books.  Set to empty to not add
## any anthology tags.
anthology_tags:Anthology

[endeni]

Yay thanks so much, it worked perfectly!

[JimmXinu]

Originally Posted by JimmXinu

Short answer: The genre(w/add_genre_when_multi_category) -> crosscat -> category trick isn't going to work with AO3 and a few other sites; those that don't internally collect category.

After some more thought, it occurred to me that while adding crosscat to category won't work, adding it to fandoms will:

[archiveofourown.org]
include_in_fandoms:fandoms,crosscat

Full INI code:

Spoiler:

[defaults]
is_adult:true

## Add "Crossover" to genre
add_genre_when_multi_category:Crossover

## a tmp var, basically.  
## Need to add to your add_to_extra_valid_entries line.
add_to_extra_valid_entries:,crosscat

## fill with genre skipping replace/include/exclude
include_in_crosscat:genre.NOREPL

## only include Crossover in crosscat.  
## Again, incorporate with your existing, if  you have one.
add_to_include_metadata_pre:
 crosscat==Crossover
 description==asdf
 characters==asdf

## remove Crossover from genre.  
## Again, incorporate with your existing, yada yada yada.
add_to_exclude_metadata_post:
 genre==Crossover

include_in_category:category,crosscat

[archiveofourown.org]
include_in_fandoms:fandoms,crosscat

So effectively the same thing.

[ownedbycats]

Hm, I can't seem to get that code working, same fic I tested before. Are there any mistakes I did when putting it in?

Spoiler:

## This is an example of what your personal configuration might look
## like.  Uncomment options by removing the '#' in front of them.

[defaults]

custom_columns_settings: 
 "N"=>#read
 oneshot=>#fanficstatus

## Some sites also require the user to confirm they are adult for
## adult content.  Uncomment by removing '#' in front of is_adult.
is_adult:true

## If set, an image (regardless of source) will only be used as a
## cover image if it is >= both the dimensions listed here.  When not
## set, any size image will be used.  Note that some sites, like ffnet
## use relatively small images(180,240).
cover_min_size: 50,50

replace_metadata: 
 site=>www.fanfiction.net=>FanFiction.net
 site=>archiveofourown.org=>Archive of Our Own
 author=>^orphan_account$=>Unknown
 author=>\(orphan_account\)=>
 category=>(\(Video Game\)|\([0-9]+\))=>
 category=>(^(?=.*Mass.Effect)(?!.*Mass Effect Trilogy).*|Mass Effect - All Media Types)=>Mass Effect Trilogy
 category=>Sims=>The Sims
 category=>(^(?=.*Elder Scrolls)(?!.*The Elder Scrolls).*|Elder Scrolls V: Skyrim)=>The Elder Scrolls
 category=>(Pocket Monsters \|\ Pokemon - All Media Types)=>Pokémon
 oneshot=>Completed=>Oneshot&&numChapters=>^1$
 tagscategory=>^(?!.*(Half-Life|Portal|Mass Effect|Crossover)).*$=>Other
 tagscategory=>^(.*)$=>Fanfiction.\1
 tagscategory=>(Portal|Half-Life)=>Half-Life & Portal
 tagscategory=>Mass Effect Trilogy=>Mass Effect

add_to_replace_metadata:
 description=><br/>=></p><p>

## Add "Crossover" to genre
add_genre_when_multi_category:Crossover

# 'add_to_' concats on to existing param, thus the leading comma
add_to_extra_valid_entries:,oneshot,tagscategory,crosscat

## fill with genre skipping replace/include/exclude
include_in_crosscat:genre.NOREPL

## only include Crossover in crosscat.  
## Again, incorporate with your existing, if  you have one.
add_to_include_metadata_pre:
 crosscat==Crossover

## remove Crossover from genre.  
## Again, incorporate with your existing, yada yada yada.
add_to_exclude_metadata_post:
 genre==Crossover

## add crosscat to category
## Again, incorporate with your existing, etc.
include_in_category:category,crosscat,

# oneshot is a copy of status because status itself isn't a list.
include_in_oneshot:status

# tagscategory is a copy category for Fanfiction.category in tags
include_in_tagscategory:category

include_subject_tags: tagscategory

generate_cover_settings:
 ${site}=>^FanFiction.net$=>FFNet
 ${site}=>^Archive of Our Own$=> AO3

[archiveofourown.org]
include_in_fandoms:fandoms,crosscat
slow_down_sleep_time:0.5
## 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.)
## 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

[https://archiveofourown.org/works/21814324]
add_to_replace_metadata_filelist:file:///D:/Documents/Miscellany/ReplaceNBSP.txt