|
|
# Copyright 2015 Fanficdownloader team, 2021 FanFicFare team
|
|
|
#
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
# You may obtain a copy of the License at
|
|
|
#
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
#
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
# See the License for the specific language governing permissions and
|
|
|
# limitations under the License.
|
|
|
#
|
|
|
|
|
|
[defaults]
|
|
|
|
|
|
## [defaults] section applies to all formats and sites but may be
|
|
|
## overridden at several levels. Example:
|
|
|
|
|
|
## [defaults]
|
|
|
## titlepage_entries: category,genre, status
|
|
|
## [www.whofic.com]
|
|
|
## # overrides defaults.
|
|
|
## titlepage_entries: category,genre, status,dateUpdated,rating
|
|
|
## [epub]
|
|
|
## # overrides defaults & site section
|
|
|
## titlepage_entries: category,genre,status,datePublished,dateUpdated,dateCreated
|
|
|
## [www.whofic.com:epub]
|
|
|
## # overrides defaults, site section & format section
|
|
|
## titlepage_entries: category,genre, status,datePublished
|
|
|
## [overrides]
|
|
|
## # overrides all other sections
|
|
|
## titlepage_entries: category
|
|
|
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. Defaults to false.
|
|
|
is_adult:true
|
|
|
|
|
|
## All available titlepage_entries and the label used for them:
|
|
|
## <entryname>_label:<label>
|
|
|
## Labels may be customized.
|
|
|
title_label:Title
|
|
|
storyUrl_label:Story URL
|
|
|
description_label:Summary
|
|
|
author_label:Author
|
|
|
authorUrl_label:Author URL
|
|
|
## epub, txt, html
|
|
|
formatname_label:File Format
|
|
|
## .epub, .txt, .html
|
|
|
formatext_label:File Extension
|
|
|
## Category and Genre have overlap, depending on the site.
|
|
|
## Sometimes Harry Potter is a category and Fantasy a genre. (fanfiction.net)
|
|
|
## Sometimes Fantasy is category *and* a genre (fictionpress.com)
|
|
|
## Sometimes there are multiple categories and/or genres.
|
|
|
category_label:Category
|
|
|
genre_label:Genre
|
|
|
language_label:Language
|
|
|
characters_label:Characters
|
|
|
ships_label:Relationships
|
|
|
series_label:Series
|
|
|
seriesUrl_label:Series URL
|
|
|
## seriesHTML is series as a link to seriesUrl.
|
|
|
seriesHTML_label:Series
|
|
|
## Completed/In-Progress
|
|
|
status_label:Status
|
|
|
## Dates story first published, last updated, and downloaded(last with time).
|
|
|
datePublished_label:Published
|
|
|
dateUpdated_label:Updated
|
|
|
dateCreated_label:Packaged
|
|
|
## Rating depends on the site. Some use K,T,M,etc, and some PG,R,NC-17
|
|
|
rating_label:Rating
|
|
|
## Also depends on the site.
|
|
|
warnings_label:Warnings
|
|
|
numChapters_label:Chapters
|
|
|
numWords_label:Words
|
|
|
## www.fanfiction.net, fictionalley-archive.com, etc.
|
|
|
site_label:Publisher
|
|
|
## ffnet, fpcom, etc.
|
|
|
siteabbrev_label:Site Abbrev
|
|
|
## The site's unique story/author identifier. Usually a number.
|
|
|
storyId_label:Story ID
|
|
|
authorId_label:Author ID
|
|
|
## Primarily to put specific values in dc:subject tags for epub. Will
|
|
|
## show up in Calibre as tags. Also carried into mobi when converted.
|
|
|
extratags_label:Extra Tags
|
|
|
## The version of FanFicFare
|
|
|
version_label:Downloader Version
|
|
|
|
|
|
## The metadata entry 'site' predates Calibre integration, and was
|
|
|
## later labeled Publisher and used to fill Calibre's Publisher field.
|
|
|
## Because users keep expecting it to be 'publisher' instead,
|
|
|
## 'publisher' is now a copy of 'site' and the Calibre plugin now uses
|
|
|
## 'publisher' instead. Default titlepage_entries are also changed.
|
|
|
include_in_publisher:site
|
|
|
publisher_label:Publisher
|
|
|
|
|
|
## Date formats used by FanFicFare. Published and Update don't have time.
|
|
|
## See http://docs.python.org/library/datetime.html#strftime-strptime-behavior
|
|
|
## Note that ini format requires % to be escaped as %%.
|
|
|
dateCreated_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
datePublished_format:%%Y-%%m-%%d
|
|
|
dateUpdated_format:%%Y-%%m-%%d
|
|
|
|
|
|
## Items to include in the title page
|
|
|
## Empty metadata entries will *not* appear, unless .SHOW_EMPTY is
|
|
|
## appended. Eg: titlepage_entries: ..., characters.SHOW_EMPTY,
|
|
|
## ships,... will always display Characters, but only show
|
|
|
## Relationships if there are any. You can include extra text or HTML
|
|
|
## that will be included as-is in the title page. Eg:
|
|
|
## titlepage_entries: ...,<br />,summary,<br />,...
|
|
|
## All current formats already include title and author.
|
|
|
titlepage_entries: seriesHTML,category,genre,language,characters,ships,status,datePublished,dateUpdated,dateCreated,rating,warnings,numChapters,numWords,publisher,description
|
|
|
|
|
|
## Try to collect series name and number of this story in series.
|
|
|
## Some sites (ab)use 'series' for reading lists and personal
|
|
|
## collections. This lets us turn it on and off by site without
|
|
|
## keeping a lengthy titlepage_entries per site and prevents it
|
|
|
## updating in the plugin.
|
|
|
collect_series: true
|
|
|
|
|
|
## include title page as first page.
|
|
|
include_titlepage: true
|
|
|
|
|
|
## include a TOC page before the story text
|
|
|
include_tocpage: true
|
|
|
|
|
|
## website encoding(s) In theory, each website reports the character
|
|
|
## encoding they use for each page. In practice, some sites report it
|
|
|
## incorrectly. Each adapter has a default list, usually "utf8,
|
|
|
## Windows-1252" or "Windows-1252, utf8", but this will let you
|
|
|
## explicitly set the encoding and order if you need to. The special
|
|
|
## value 'auto' will call chardet and use the encoding it reports if
|
|
|
## it has +90% confidence. 'auto' is not reliable.
|
|
|
#website_encodings: utf8, Windows-1252, iso-8859-1
|
|
|
## For sites (or individual stories) with problematic characters you
|
|
|
## can include ':ignore' after the encoding. This will discard
|
|
|
## unrecognized characters, but likely also prevent the rest of the
|
|
|
## encoding list from ever being used.
|
|
|
#website_encodings: utf8:ignore, Windows-1252, iso-8859-1
|
|
|
|
|
|
## When using 'auto' in website_encodings, you can tweak the
|
|
|
## confidence required to use the chardet detected.
|
|
|
#chardet_confidence_limit:0.9
|
|
|
|
|
|
## python string Template, string with ${title}, ${author} etc, same as titlepage_entries
|
|
|
## Can include directories.
|
|
|
#output_filename: books/${title}-${siteabbrev}_${storyId}${formatext}
|
|
|
#output_filename: books/${formatname}/${siteabbrev}/${authorId}/${title}-${siteabbrev}_${storyId}${formatext}
|
|
|
output_filename: ${title}-${siteabbrev}_${storyId}${formatext}
|
|
|
|
|
|
## Make directories as needed.
|
|
|
make_directories: true
|
|
|
|
|
|
## Always overwrite output files. Otherwise, the downloader checks
|
|
|
## the timestamp on the existing file and only overwrites if the story
|
|
|
## has been updated more recently. Command line version only
|
|
|
#always_overwrite: true
|
|
|
|
|
|
## put output (with output_filename) in a zip file zip_filename.
|
|
|
zip_output: false
|
|
|
|
|
|
## Can include directories.
|
|
|
zip_filename: ${title}-${siteabbrev}_${storyId}${formatext}.zip
|
|
|
|
|
|
## Normally, try to make the filenames 'safe' by removing invalid
|
|
|
## filename chars. Applies to default_cover_image, force_cover_image,
|
|
|
## output_filename & zip_filename.
|
|
|
allow_unsafe_filename: false
|
|
|
|
|
|
## The regex pattern of 'unsafe' filename chars for above. First
|
|
|
## character . OR any one or more characters that are NOT a letter,
|
|
|
## number, or one of _. []()&'-
|
|
|
output_filename_safepattern:(^\.|/\.|[^a-zA-Z0-9_\. \[\]\(\)&'-]+)
|
|
|
|
|
|
## entries to make epub subjects and calibre tags
|
|
|
## lastupdate creates two tags: "Last Update Year/Month: %Y/%m" and "Last Update: %Y/%m/%d"
|
|
|
include_subject_tags: extratags, genre, category, characters, ships, lastupdate, status
|
|
|
|
|
|
## extra tags (comma separated) to include, primarily for epub.
|
|
|
extratags: FanFiction
|
|
|
|
|
|
## extra categories, genres, characters, ships and warnings can be
|
|
|
## configured. Used primarily for sites that are dedicated to a genre
|
|
|
## or 'ship and so don't included it for every story.
|
|
|
#extracategories:
|
|
|
#extragenres:
|
|
|
#extracharacters:
|
|
|
#extraships:
|
|
|
#extrawarnings:
|
|
|
|
|
|
## Add this to *genre* if there's more than one category. Applied
|
|
|
## *before* genre replace_metadata/include/exclude_metadata
|
|
|
#add_genre_when_multi_category: Crossover
|
|
|
|
|
|
## Add this category if there's more than one category(before this is added).
|
|
|
## Applied *after* category replace_metadata/include/exclude_metadata
|
|
|
#add_category_when_multi_category: Crossover
|
|
|
|
|
|
## default_value_(entry) can be used to set the value for a metadata
|
|
|
## entry when no value has been found on the site. For example, some
|
|
|
## sites doesn't have a status metadatum. If uncommented, this will
|
|
|
## use 'Unknown' for status when no status is found.
|
|
|
#default_value_status:Unknown
|
|
|
## Can also be used for other metadata values
|
|
|
#default_value_category:FanFiction
|
|
|
|
|
|
## number of seconds to sleep between calls to the story site. May be
|
|
|
## useful if pulling large numbers of stories or if the site is slow.
|
|
|
## The actual sleep time used on each request is a random number
|
|
|
## between 0.5 and 1.5 times slow_down_sleep_time.
|
|
|
#slow_down_sleep_time:0.5
|
|
|
|
|
|
## How long to wait for each HTTP connection to finish. Longer times
|
|
|
## are better for sites that are slow to respond. Shorter times
|
|
|
## prevent excessive wait when your network or the site is down.
|
|
|
connect_timeout:60.0
|
|
|
|
|
|
## For use only with CLI version--run a command on the generated file
|
|
|
## after it's produced. All of the titlepage_entries values are
|
|
|
## available, plus output_filename.
|
|
|
#post_process_cmd: addbook -f "${output_filename}" -t "${title}"
|
|
|
|
|
|
## Some operating systems and command shells have problems with some
|
|
|
## characters. When set, post_process_safepattern will be applied to
|
|
|
## each metadata item passed to post_process_cmd before it's called.
|
|
|
#post_process_safepattern:(^\.|/\.|[^a-zA-Z0-9_\. \[\]\(\)&'-]+)
|
|
|
|
|
|
## For use only with CLI version--run a command *before* the output
|
|
|
## file is written. All of the titlepage_entries values are
|
|
|
## available, (but not output_filename). Can be used to generate
|
|
|
## cover images that are then included in the output ebook using
|
|
|
## default_cover_image.
|
|
|
#pre_process_cmd:tenprintcover.py --author "${author}" --title "${title}" --cover cover.png
|
|
|
|
|
|
## Some operating systems and command shells have problems with some
|
|
|
## characters. When set, pre_process_safepattern will be applied to
|
|
|
## each metadata item passed to pre_process_cmd before it's called.
|
|
|
#pre_process_safepattern:(^\.|/\.|[^a-zA-Z0-9_\. \[\]\(\)&'-]+)
|
|
|
|
|
|
## For use only with CLI version--display a simple progress bar while
|
|
|
## downloading--one dot(.) per network fetch. Same as using --progressbar
|
|
|
#progressbar:false
|
|
|
|
|
|
## Use regular expressions to find and replace (or remove) metadata.
|
|
|
## For example, you could change Sci-Fi=>SF, remove *-Centered tags,
|
|
|
## etc. See http://docs.python.org/library/re.html (look for re.sub)
|
|
|
## for regexp details.
|
|
|
##
|
|
|
## Make sure to keep at least one space at the start of each line and
|
|
|
## to escape % to %%, if used.
|
|
|
##
|
|
|
## Two, three or five part lines. Two part effect everything.
|
|
|
## Three part effect only those key(s) lists.
|
|
|
## *Five* part lines. Effect only when trailing conditional key=>regexp matches
|
|
|
## metakey[,metakey]=>pattern=>replacement[&&conditionalkey=>regexp]
|
|
|
##
|
|
|
## Note that if metakey == conditionalkey the conditional is ignored.
|
|
|
## You can use \s in the replacement to add explicit spaces. (The config parser
|
|
|
## tends to discard trailing spaces.)
|
|
|
##
|
|
|
## replace_metadata <entry>_LIST options: FanFicFare replace_metadata lines
|
|
|
## operate on individual list items for list entries. But if you
|
|
|
## want to do a replacement on the joined string for the whole list,
|
|
|
## you can by using <entry>_LIST. Example, if you added
|
|
|
## calibre_author: calibre_author_LIST=>^(.{,100}).*$=>\1
|
|
|
##
|
|
|
## You can 'split' one list item into multiple list entries by using
|
|
|
## \, in the replacement string.
|
|
|
##
|
|
|
## Examples:
|
|
|
#replace_metadata:
|
|
|
# genre,category=>Sci-Fi=>SF
|
|
|
# Puella Magi Madoka Magica.*=>Madoka
|
|
|
# Comedy=>Humor
|
|
|
# Crossover: (.*)=>\1
|
|
|
# title=>(.*)Great(.*)=>\1Moderate\2
|
|
|
# .*-Centered=>
|
|
|
# characters=>Sam W\.=>Sam Witwicky&&category=>Transformers
|
|
|
# characters=>Sam W\.=>Sam Winchester&&category=>Supernatural
|
|
|
# category=>Bitextual=>M/M\,F/M
|
|
|
|
|
|
|
|
|
## Include/Exclude metadata
|
|
|
##
|
|
|
## You can use the include/exclude metadata features to either limit
|
|
|
## the values of particular metadata lists to specific values or to
|
|
|
## exclude specific values. Further, you can conditionally apply each
|
|
|
## line depending on other metadata, use exact strings or regular
|
|
|
## expressions(regex) to match values, and negate matches.
|
|
|
##
|
|
|
## The settings are:
|
|
|
## include_metadata_pre
|
|
|
## exclude_metadata_pre
|
|
|
## include_metadata_post
|
|
|
## exclude_metadata_post
|
|
|
##
|
|
|
## The form of each line is:
|
|
|
## metakey[,metakey]==exactvalue
|
|
|
## metakey[,metakey]=~regex
|
|
|
## metakey[,metakey]==exactvalue&&conditionalkey==exactcondvalue
|
|
|
## metakey[,metakey]=~regex&&conditionalkey==exactcondvalue
|
|
|
## metakey[,metakey]==exactvalue&&conditionalkey=~condregex
|
|
|
##
|
|
|
## This is fairly complicated, so it's documented on its own wiki
|
|
|
## page:
|
|
|
## https://github.com/JimmXinu/FanFicFare/wiki/InExcludeMetadataFeature
|
|
|
|
|
|
## When set true, conditionals for both replace_metadata and
|
|
|
## Include/Exclude metadata will check against each list value rather
|
|
|
## than the entire list as a string which was the case prior to this
|
|
|
## change (~Dec 2018). replace_metadata conditionals (after &&) can
|
|
|
## also now use ==, !=, =~ and !~. => is the same as =~ .)
|
|
|
## Set false to get the old behavior. You can also compare the list
|
|
|
## as string by using <entry>_LIST, such as category_LIST
|
|
|
conditionals_use_lists:true
|
|
|
|
|
|
## You can exclude chapters from a story by listing their chapter URLs
|
|
|
## in ignore_chapter_url_list. Chapter URLs will be normalized before
|
|
|
## being used, so you can use either longer or normalized chapter
|
|
|
## URLs.
|
|
|
## NOTE: This will cause numWords(word count) to be off for most sites.
|
|
|
## This setting should be used in a specific story's section.
|
|
|
## Example:
|
|
|
#[https://forums.spacebattles.com/threads/lengthy-thread-name.100849/]
|
|
|
#ignore_chapter_url_list:
|
|
|
# https://forums.spacebattles.com/posts/10157294/
|
|
|
# https://forums.spacebattles.com/posts/10157297/
|
|
|
# https://forums.spacebattles.com/posts/10157299/
|
|
|
# https://forums.spacebattles.com/threads/lengthy-thread-name.100849/#post-10157400
|
|
|
|
|
|
## Rarely, some stories on some sites (observed on SpaceBattles) might
|
|
|
## have the same chapter URL listed more than once. Set true for
|
|
|
## those stories.
|
|
|
#dedup_chapter_list:false
|
|
|
|
|
|
## Some sites/authors/stories use several br tags for scene/section
|
|
|
## breaks. When set replace_xbr_with_hr:X will cause FFF to search
|
|
|
## for X or more consecutive br tags and replace them with br br hr br.
|
|
|
#replace_xbr_with_hr:3
|
|
|
|
|
|
## Some readers don't show horizontal rule (<hr />) tags correctly.
|
|
|
## This replaces them all with a centered '* * *'. (Note centering
|
|
|
## doesn't work on some devices either.)
|
|
|
#replace_hr: false
|
|
|
|
|
|
## Some sites/authors/stories use br tags instead of p tags for
|
|
|
## paragraphs. This feature uses some heuristics to find and replace
|
|
|
## br paragraphs with p tags while preserving scene breaks.
|
|
|
#replace_br_with_p: false
|
|
|
|
|
|
## If set false, the summary will have all html stripped.
|
|
|
## Both this and include_images must be true to get images in the
|
|
|
## summary.
|
|
|
keep_summary_html:true
|
|
|
|
|
|
## If set true, any style attributes on tags in the story HTML will be
|
|
|
## kept. Useful for keeping extra colors & formatting from original.
|
|
|
## DEPRECATED - use keep_html_attrs (or add_to_keep_html_attrs) instead.
|
|
|
#keep_style_attr: false
|
|
|
|
|
|
## If set true, any title attributes on tags in the story HTML will be
|
|
|
## kept. Some sites(AO3) use <a title="Translation">Foreign language</a>
|
|
|
## DEPRECATED - use keep_html_attrs (or add_to_keep_html_attrs) instead.
|
|
|
#keep_title_attr: false
|
|
|
|
|
|
## 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
|
|
|
|
|
|
## Some tags, notable chapter div tags from Base eFiction, have
|
|
|
## class='chapter', which causes calibre convert to identify it as a
|
|
|
## chapter and 'pagebreak' at that point, aka split the file, which
|
|
|
## adds unexpected pagebreaks and breaks FFF update if an epub to epub
|
|
|
## conversion is done. Remove class='chapter' from all tags by
|
|
|
## default. Also affects previously downloaded chapters on epub
|
|
|
## update.
|
|
|
remove_class_chapter:true
|
|
|
|
|
|
## Tags listed here will be replaced with <span class="tagname">.
|
|
|
## For example: <u>underlined text</u> becomes
|
|
|
## <span class="u">underlined text</span>
|
|
|
## Note that the output_css should contain the class .u, .big, etc for
|
|
|
## the spans to be useful.
|
|
|
## This feature is for replacing old tags deprecated/removed in newer
|
|
|
## HTML and EPUB standards.
|
|
|
replace_tags_with_spans:u,big,small
|
|
|
|
|
|
## By default, empty tags are removed as part of cleaning up the
|
|
|
## source HTML. However, a few tags should be kept even if empty.
|
|
|
## (Whitespace only, including is considered empty.) This
|
|
|
## setting can adjust which tags are kept.
|
|
|
keep_empty_tags:p,td,th
|
|
|
|
|
|
## By default, script and style tags are removed from chapter text as
|
|
|
## part of cleaning up the source HTML. Found several book readers
|
|
|
## that didn't treat those tags in <body> correctly. Set to empty if
|
|
|
## you want to keep those tags.
|
|
|
remove_tags:script,style
|
|
|
|
|
|
## If a chapter range was given, use this pattern for the book title.
|
|
|
## replace_metadata and include/exclude will be applied *after* this.
|
|
|
## Set to empty value to disable.
|
|
|
title_chapter_range_pattern:${title} (Ch ${first}-${last})
|
|
|
|
|
|
## Don't like the numbers at the start of chapter titles on some
|
|
|
## sites? You can use strip_chapter_numbers to strip them off. Just
|
|
|
## want to make them all look the same? Strip them off, then add them
|
|
|
## back on with add_chapter_numbers:true. Only want them added back
|
|
|
## on for Table of Contents(toc)? Use add_chapter_numbers:toconly.
|
|
|
## (toconly doesn't work on mobi output.) Don't like the way it
|
|
|
## strips numbers or adds them back? See chapter_title_strip_pattern
|
|
|
## and chapter_title_add_pattern.
|
|
|
strip_chapter_numbers:false
|
|
|
|
|
|
## add_chapter_numbers can be true, false or toconly
|
|
|
## (Note number is not added when there's only one chapter.)
|
|
|
add_chapter_numbers:false
|
|
|
|
|
|
## (Two versions of chapter_title_strip_pattern are shown below. You
|
|
|
## should only have one uncommented.)
|
|
|
## This version will remove the leading number from:
|
|
|
## "1." => ""
|
|
|
## "1. The Beginning" => "The Beginning"
|
|
|
## "1: Start" => "Start"
|
|
|
## "2, Chapter the second" => "Chapter the second"
|
|
|
## etc
|
|
|
## Leaves unchanged "1.1" or "1"
|
|
|
## Note that your ToC entry(ies) may be empty if the
|
|
|
## chapter_title_strip_pattern removes everything and you don't have
|
|
|
## add_chapter_numbers:true.
|
|
|
chapter_title_strip_pattern:^[0-9]+[\.: -]+(?=[^0-9]|$)
|
|
|
|
|
|
## This version remove leading numbers and 'Chapter 1':
|
|
|
## "Chapter 1" => ""
|
|
|
## "1. Chapter 1" => ""
|
|
|
## "1. Chapter 1, Bob's First Clue" => "Bob's First Clue"
|
|
|
## "Chapter 2 - Pirates Place" => "Pirates Place"
|
|
|
## etc
|
|
|
## Note that your ToC entry(ies) may be empty if the
|
|
|
## chapter_title_strip_pattern removes everything and you don't have
|
|
|
## add_chapter_numbers:true.
|
|
|
#chapter_title_strip_pattern:^([0-9]+[\.: -]+)?(Chapter *[0-9]+[\.:, -]*)?
|
|
|
|
|
|
## If true, when updating an epub that already has old chapters, new
|
|
|
## chapters will be marked in the TOC and chapter header by using
|
|
|
## chapter_title_new_pattern and chapter_title_addnew_pattern to set
|
|
|
## the chapter title.
|
|
|
## If set to latestonly, only new chapters downloaded this time will
|
|
|
## be marked (new) and existing chapters will have any (new) marks
|
|
|
## removed.
|
|
|
## mark_new_chapters can be true, false or latestonly
|
|
|
mark_new_chapters:false
|
|
|
|
|
|
## chapter title patterns use python template substitution. The
|
|
|
## ${number} is the 'chapter' number and ${title} is the chapter
|
|
|
## title, after applying chapter_title_strip_pattern. ${index04} is
|
|
|
## chapter number padded with leading zeros (mostly for internal use)
|
|
|
## such as 0001. ${index} == ${number} for backward compatibility. A
|
|
|
## few site adapters add additional chapter metadata.
|
|
|
|
|
|
## The basic pattern used when not using add_chapter_numbers or
|
|
|
## mark_new_chapters
|
|
|
chapter_title_def_pattern:${title}
|
|
|
|
|
|
## Pattern used with add_chapter_numbers, but not mark_new_chapters
|
|
|
chapter_title_add_pattern:${number}. ${title}
|
|
|
|
|
|
## Pattern used with mark_new_chapters, but not add_chapter_numbers
|
|
|
## (new) is just text and can be changed.
|
|
|
chapter_title_new_pattern:(new) ${title}
|
|
|
|
|
|
## Pattern used with add_chapter_numbers and mark_new_chapters
|
|
|
## (new) is just text and can be changed.
|
|
|
chapter_title_addnew_pattern:${number}. (new) ${title}
|
|
|
|
|
|
## Reorder ships so b/a and c/b/a become a/b and a/b/c. '/' is no
|
|
|
## longer hard coded and can be changed and added to with
|
|
|
## sort_ships_splits.
|
|
|
sort_ships:false
|
|
|
|
|
|
## Each line indicates first a regex that should be used to split each
|
|
|
## ships entry and then, after => the string to use to merge the parts
|
|
|
## back together. \s == blank space.
|
|
|
## Each part will have replace_metadata with key ships_CHARS applied.
|
|
|
sort_ships_splits:
|
|
|
[ ]*/[ ]*=>/
|
|
|
[ ]*&[ ]*=>\s&\s
|
|
|
|
|
|
## join_string_<entry> options -- FanFicFare list entries are comma
|
|
|
## separated by default. You can use this to change that. For example,
|
|
|
## if you want authors separated with ' & ' instead, use
|
|
|
## join_string_calibre_author:\s&\s. (\s == space)
|
|
|
#join_string_author:,\s
|
|
|
|
|
|
## keep_in_order_<entry> options: FanFicFare sorts list entries by default
|
|
|
## (except for author/authorUrl/authorId). But if you want to use an
|
|
|
## extra entry derived from author, it ends up sorted. For example, if
|
|
|
## you added calibre_author: keep_in_order_calibre_author:true
|
|
|
#keep_in_order_author:true
|
|
|
|
|
|
## User-agent
|
|
|
user_agent:FFF/4.X
|
|
|
|
|
|
## Added for [base_xenforoforum], but can be used with other sites,
|
|
|
## too. Limit the 'description' to the first X *characters*
|
|
|
## collected. Character count includes HTML tags, so it can be
|
|
|
## non-intuitive.
|
|
|
#description_limit:1000
|
|
|
|
|
|
## As a work around for certain sites blocking automated downloads,
|
|
|
## FFF now offers the ability to look for pages in your Chrome(or
|
|
|
## Chromium-derived) or Firefox browser's cache. Requires both
|
|
|
## use_browser_cache:true and browser_cache_path to be set.
|
|
|
##
|
|
|
## browser_cache_path needs to be set to the location of YOUR browser
|
|
|
## cache. Here are a few examples for different OS. Note that all
|
|
|
## have YOUR user name in them somewhere as well as a Profile name,
|
|
|
## frequently Default. Make sure you have personalized (and
|
|
|
## uncommented) ONE browser_cache_path setting. Also note that Chrome
|
|
|
## browsers added an additional directory level, 'Cache_Data', in
|
|
|
## early 2022.
|
|
|
|
|
|
## Note also that browser_cache_path is recommended under [defaults],
|
|
|
## but use_browser_cache should go under individual [site] sections.
|
|
|
|
|
|
## windows:
|
|
|
### Chrome:
|
|
|
#browser_cache_path:C:\Users\YourUser\AppData\Local\Google\Chrome\User Data\Default\Cache\Cache_Data
|
|
|
#browser_cache_path:C:\Users\YourUser\AppData\Local\Google\Chrome\User Data\Profile 1\Cache\Cache_Data
|
|
|
### Firefox
|
|
|
#browser_cache_path:C:\Users\YourUser\AppData\Local\Mozilla\Firefox\Profiles\ZjwI7Fo4.default\cache2
|
|
|
|
|
|
## mac:
|
|
|
### Chrome:
|
|
|
#browser_cache_path:/Users/your.user/Library/Caches/Google/Chrome/Default/Cache/Cache_Data
|
|
|
#browser_cache_path:/Users/your.user/Library/Caches/Google/Chrome/Profile 2/Cache/Cache_Data
|
|
|
### Firefox
|
|
|
#browser_cache_path:/Users/your.user/Library/Caches/Firefox/Profiles/43fkezvc.default-release/cache2
|
|
|
|
|
|
## linux:
|
|
|
### Chrome:
|
|
|
#browser_cache_path:/home/youruser/.cache/google-chrome/Default/Cache/Cache_Data
|
|
|
#browser_cache_path:/home/youruser/.cache/google-chrome/Profile 1/Cache/Cache_Data
|
|
|
### Firefox
|
|
|
#browser_cache_path:/home/youruser/.cache/mozilla/firefox/dk4o1y83.default-release/cache2
|
|
|
|
|
|
## It's common for browser cached files to be kept for several hours
|
|
|
## or more. You can limit the age of cached files FFF will use from
|
|
|
## browser_cache_path with browser_cache_age_limit. Only cached files
|
|
|
## that were downloaded within 'browser_cache_age_limit' hours will be
|
|
|
## used. If set to -1, all cached files will be used. Note that not
|
|
|
## all sites allow page caching--those will not work with the browser
|
|
|
## cache feature.
|
|
|
browser_cache_age_limit:4.0
|
|
|
|
|
|
## If browser_cache_path is set *and* use_browser_cache:true *and*
|
|
|
## use_browser_cache_only:true, then you can also set
|
|
|
## open_pages_in_browser:true then FFF to attempt to open each page it
|
|
|
## can't already find in browser cache in your default browser, then
|
|
|
## check for it in the cache again. Note that your browser_cache_path
|
|
|
## setting *must* use your default browser for this to work.
|
|
|
#open_pages_in_browser:false
|
|
|
|
|
|
## As a (second) work around for certain sites blocking automated
|
|
|
## downloads, FFF offers the ability to request pages through nsapa's
|
|
|
## fanfictionnet_ff_proxy and FlareSolverr proxy servers. See
|
|
|
## https://github.com/JimmXinu/FanFicFare/wiki/ProxyFeatures for more
|
|
|
## details.
|
|
|
|
|
|
## FlareSolverr (https://github.com/FlareSolverr/FlareSolverr) is a
|
|
|
## generic proxy that works with several otherwise blocked sites.
|
|
|
## It's recommended to only set use_flaresolverr_proxy:true for
|
|
|
## specific sites.
|
|
|
## FlareSolverr v1 doesn't work with some sites anymore (including
|
|
|
## ffnet), but FlareSolverr v2+ cannot download images.
|
|
|
## use_flaresolverr_proxy:true assumes FSv2 and automatically sets
|
|
|
## include_images:false
|
|
|
## If you want to use FSv1 with images, you can set
|
|
|
## use_flaresolverr_proxy:withimages
|
|
|
## flaresolverr_proxy_timeout is in integer milliseconds
|
|
|
|
|
|
#[www.fanfiction.net]
|
|
|
#use_flaresolverr_proxy:true
|
|
|
## option settings, these are the defaults:
|
|
|
#flaresolverr_proxy_address:localhost
|
|
|
#flaresolverr_proxy_port:8191
|
|
|
#flaresolverr_proxy_protocol:http
|
|
|
#flaresolverr_proxy_timeout:60000
|
|
|
|
|
|
## Because some adapters can pull chapter URLs from human posts, the
|
|
|
## odds of errors in the chapter URLs can be higher for some
|
|
|
## sites/stories. You can set continue_on_chapter_error:true to
|
|
|
## continue on after failing to download a chapter and instead record
|
|
|
## an error message in the ebook for that chapter.
|
|
|
continue_on_chapter_error:false
|
|
|
|
|
|
## Append this to chapter titles that errored. Only used with
|
|
|
## continue_on_chapter_error:true
|
|
|
## Set empty to not mark failed chapters.
|
|
|
chapter_title_error_mark:(CHAPTER ERROR)
|
|
|
|
|
|
## The FFF CLI can fetch story URLs from unread emails when configured
|
|
|
## to read from your IMAP mail server. The example shows GMail, but
|
|
|
## other services that support IMAP can be used. GMail requires you
|
|
|
## to turn on an option to enable IMAP access. Only the CLI uses these
|
|
|
## options--the Calibre Plugin stores these separately.
|
|
|
##
|
|
|
## It's safest if you create a separate email account that you use
|
|
|
## only for your story update notices. FanFicFare cannot guarantee
|
|
|
## that malicious code cannot get your email password once you've
|
|
|
## saved it. Use this feature at your own risk.
|
|
|
##
|
|
|
#imap_server:imap.gmail.com
|
|
|
#imap_username:youraddress@gmail.com
|
|
|
#imap_password:XXXXXXXX
|
|
|
#imap_folder:INBOX
|
|
|
|
|
|
## Mark mails with story URLs read:
|
|
|
## imap_mark_read can be 'true', 'false'(default) or 'downloadonly'.
|
|
|
##
|
|
|
## If 'true', unread emails will be marked as read when
|
|
|
## either CLI option --imap to list the story URLs or --download-imap
|
|
|
## to download story URLs from email are used.
|
|
|
##
|
|
|
## If 'downloadonly', unread emails will be marked as read
|
|
|
## only when CLI --download-imap to download story URLs from email are
|
|
|
## used.
|
|
|
##
|
|
|
## If 'false', unread emails will not be marked as read.
|
|
|
##
|
|
|
## Only unread emails will be searched for story URLs, and only emails
|
|
|
## containing valid story URLs will ever be marked read.
|
|
|
##
|
|
|
#imap_mark_read:true
|
|
|
|
|
|
## Some authors use 'Zalgo' text--arbitrary and often excessive
|
|
|
## added/combined unicode markings--to indicate 'noise' of some kind.
|
|
|
## While a critical part of some languages, when over used it can also
|
|
|
## cause problems for some ebook readers, such as Kindle.
|
|
|
## https://stackoverflow.com/questions/6579844/how-does-zalgo-text-work
|
|
|
## This setting will reduce the number 'Zalgo' characters. Set to 0
|
|
|
## to remove all of them, -1 or leave undefined for no limit.
|
|
|
## Note: This will also remove other 'marked' unicode characters. If
|
|
|
## set to 0, café will become cafe, déjà -> deja, etc. 1 will keep
|
|
|
## single marks and is the recommended setting if you use it.
|
|
|
#max_zalgo:1
|
|
|
|
|
|
## Apply adapter's normalize_chapterurl() to all links in chapter
|
|
|
## texts, if they match the known pattern(s) for chapter URLs. As of
|
|
|
## writing, base_xenforoforum, adapter_archiveofourownorg &
|
|
|
## adapter_tthfanficorg implement normalize_chapterurl().
|
|
|
normalize_text_links:true
|
|
|
|
|
|
## Search all links in the chapter texts and convert relative links to
|
|
|
## absolute links so they work from ebooks. Only works with epub and
|
|
|
## html output formats.
|
|
|
fix_relative_text_links:true
|
|
|
|
|
|
## Search all links in chapter texts and, if they match any included
|
|
|
## chapter URLs, replace them with links to the chapter in the
|
|
|
## download. Only works with epub and html output formats.
|
|
|
## normalize_text_links will improve URL matching considerably.
|
|
|
internalize_text_links:true
|
|
|
|
|
|
## Of the ~140 supported sites, only ~50 have been checked to work
|
|
|
## correctly with a page cache. The page cache is used save already
|
|
|
## downloaded pages which can be called more than once, especially in
|
|
|
## the Calibre plugin.
|
|
|
use_basic_cache:false
|
|
|
|
|
|
[base_efiction]
|
|
|
use_basic_cache:true
|
|
|
|
|
|
## At the time of writing, eFiction Base adapters allow downloading
|
|
|
## the whole story in bulk using the 'Print' feature. If 'bulk_load'
|
|
|
## is set to 'true', both metadata and chapters can be loaded in one
|
|
|
## step
|
|
|
bulk_load:true
|
|
|
|
|
|
## Extra metadata that many base_efiction sites have
|
|
|
add_to_extra_valid_entries:,storynotes
|
|
|
storynotes_label:Story Notes
|
|
|
add_to_extra_titlepage_entries:,storynotes
|
|
|
|
|
|
[base_xenforoforum]
|
|
|
use_basic_cache:true
|
|
|
## Some sites require login for some stories
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## XenForo sites require login for some stories, but don't report that
|
|
|
## to FFF. To download those, set your username, password and set
|
|
|
## always_login:true
|
|
|
#always_login:false
|
|
|
|
|
|
## We've been requested by the site(s) admin to rein in hits. If you
|
|
|
## download fewer stories less often you can likely get by with
|
|
|
## reducing this sleep.
|
|
|
slow_down_sleep_time:6
|
|
|
|
|
|
## exclude emoji and default avatars.
|
|
|
cover_exclusion_regexp:(/styles/|xenforo/avatars/avatar.*\.png|https://cdn\.jsdelivr\.net/gh/|https://cdn\.jsdelivr\.net/emojione)
|
|
|
|
|
|
## use author(original poster)'s avatar as cover image when true.
|
|
|
author_avatar_cover:false
|
|
|
|
|
|
## I saw lots of chapters name simply '1.1' etc during testing.
|
|
|
strip_chapter_numbers:false
|
|
|
|
|
|
## Copy title to tagsfromtitle for parsing tags.
|
|
|
add_to_extra_valid_entries:,tagsfromtitledetect,tagsfromtitle,forumtags,parentforums
|
|
|
|
|
|
## '.NOREPL' tells the system to *not* apply title's
|
|
|
## in/exclude/replace_metadata -- Only works on include_in_ lines.
|
|
|
include_in_tagsfromtitledetect:title.NOREPL,threadmarks_title
|
|
|
include_in_tagsfromtitle:tagsfromtitledetect
|
|
|
|
|
|
tagsfromtitle_label:Tags from Title
|
|
|
forumtags_label:Tags from Forum
|
|
|
parentforums_label:Parent Forums
|
|
|
keep_in_order_parentforums:true
|
|
|
|
|
|
## What forum a thread is in can be an indicator of it's category, but
|
|
|
## most are too general to be useful; only keep the more specific
|
|
|
## ones. You can replace add to this list in personal.ini
|
|
|
## [base_xenforoforum], or add to it in the sites' [section].
|
|
|
add_to_include_metadata_pre:
|
|
|
parentforums==Worm
|
|
|
parentforums==NSFW
|
|
|
parentforums==Original Fiction
|
|
|
|
|
|
## disable chapter range in title because of tagsfromtitle processing.
|
|
|
title_chapter_range_pattern:
|
|
|
|
|
|
add_to_replace_metadata:
|
|
|
# 'detects' if there are 'tags'. That is, [( in title. Replaces
|
|
|
# previous version's include_metadata_pre Can't do on tagsfromtitle
|
|
|
# because that's applied to each part after split.
|
|
|
tagsfromtitledetect=>^[^\]\)]+$=>
|
|
|
# change ][ and )( to , for [AU][Othertag] etc
|
|
|
tagsfromtitle=>\] *\[=>,
|
|
|
tagsfromtitle=>\) *\(=>,
|
|
|
# for QuestionableQuesting NSFW subforum.
|
|
|
tagsfromtitle=>^\[NSFW\].*?((?P<br>\[)|(?P<pr>\())(?P<tag>(?(br)[^\]]|(?(pr)[^\)]))+)(?(br)\]|(?(pr)\))).*?$=>NSFW\,\g<tag>
|
|
|
# remove anything outside () or []. Note \, at the end used to
|
|
|
# prevent looping back so '[Worm(AU)]' becomes 'Worm(AU)' not just 'AU'
|
|
|
tagsfromtitle=>^.*?((?P<br>\[)|(?P<pr>\())(?P<tag>(?(br)[^\]]|(?(pr)[^\)]))+)(?(br)\]|(?(pr)\))).*?$=>\g<tag>\,
|
|
|
# remove () []
|
|
|
# tagsfromtitle=>[\(\)\[\]]=>
|
|
|
# shield these html entities from the ';' pattern below
|
|
|
tagsfromtitle=>&(amp|lt|gt);=>&\1FFF_ENT_MARKER
|
|
|
# change (spaces)slash(or semicolon, pipe or comma)(spaces) to comma
|
|
|
tagsfromtitle=> *[/;|,] *=>,
|
|
|
# revert html entities
|
|
|
tagsfromtitle=>&(amp|lt|gt)FFF_ENT_MARKER=>&\1;
|
|
|
tagsfromtitle=> [xX] =>,
|
|
|
# split commas into individual list items.
|
|
|
# these will work on up to 14 splits, should be plenty.
|
|
|
tagsfromtitle=>([^,]+),([^,]+),([^,]+),([^,]+),([^,]+),(.+)=>\1\,\2\,\3,\4\,\5\,\6
|
|
|
tagsfromtitle=>([^,]+),([^,]+),([^,]+),([^,]+),(.+)=>\1\,\2\,\3,\4\,\5
|
|
|
tagsfromtitle=>([^,]+),([^,]+),([^,]+),(.+)=>\1\,\2\,\3,\4
|
|
|
tagsfromtitle=>([^,]+),([^,]+),(.+)=>\1\,\2\,\3
|
|
|
tagsfromtitle=>([^,]+),(.+)=>\1\,\2
|
|
|
|
|
|
# remove [] or () blocks and leading/trailing spaces/dashes/colons
|
|
|
title=>[-: ]*(\[([^\]]+)\]|\(([^\)]+)\))[-: ]*=>
|
|
|
# remove 'Thread' and the next word, usually "Thread 2", "Thread
|
|
|
# four", "Thread iv", "Story Thread", etc
|
|
|
title,tagsfromtitle=>[-: ,]*(Story *)?[Tt]hread [^ ]+[-: ]*=>
|
|
|
|
|
|
# Normalize 'fanfiction/fanfic/fan-fiction' a little.
|
|
|
forumtags=>[Ff]an-?[Ff]ic(tion)?=>FanFiction
|
|
|
|
|
|
add_to_extra_titlepage_entries:,tagsfromtitle,forumtags
|
|
|
|
|
|
## XenForo tags are all lowercase everywhere that I've seen. This
|
|
|
## makes the first letter of each word uppercase. Applied before
|
|
|
## replace_metadata.
|
|
|
capitalize_forumtags:true
|
|
|
|
|
|
## Add forumtags to standard entry genre and tagsfromtitle to
|
|
|
## category. Can be changed in personal.ini if desired.
|
|
|
include_in_genre:genre,forumtags
|
|
|
include_in_category:category,tagsfromtitle,parentforums
|
|
|
|
|
|
## Previously was:
|
|
|
#add_to_include_subject_tags:,tagsfromtitle.SPLIT,forumtags
|
|
|
|
|
|
## base_xenforoforum reads Published and Updated datetimes from
|
|
|
## Threadmarks if used, or from the posted & updated times of the
|
|
|
## 'first' post if no threadmarks.
|
|
|
datePublished_format:%%Y-%%m-%%d %%H:%%M
|
|
|
dateUpdated_format:%%Y-%%m-%%d %%H:%%M
|
|
|
|
|
|
## Only take the first X characters of the 'first' post to use as
|
|
|
## the description.
|
|
|
description_limit:500
|
|
|
|
|
|
## When given a thread URL, use threadmarks as chapter links when
|
|
|
## there are at least this many threadmarks. A number of older
|
|
|
## threads have a single threadmark to an 'index' post. Set to 1 to
|
|
|
## use threadmarks whenever they exist.
|
|
|
minimum_threadmarks:2
|
|
|
|
|
|
## When 'first post' (or post URL) is being added as a chapter, give
|
|
|
## the chapter this title.
|
|
|
first_post_title:First Post
|
|
|
|
|
|
## In normal operation, if given a post URL or a thread URL with less
|
|
|
## than minimum_threadmarks, the given post or the first post of the
|
|
|
## thread will be included as the first chapter (with chapter title
|
|
|
## from first_post_title) unless that post is explicitly linked to in
|
|
|
## the collected chapter list. First post is not included when using
|
|
|
## thread marks unless threadmarked.
|
|
|
##
|
|
|
## If always_include_first_post:true, then the given or first post
|
|
|
## will be included as above even if it is a link in the post or even
|
|
|
## if threadmarks are used. Can result in a duplicated chapter.
|
|
|
always_include_first_post:false
|
|
|
|
|
|
## In normal operation, when updating an existing epub, old chapters
|
|
|
## will be reused as-is. Normally, that works fine, but forum stories
|
|
|
## sometimes have an index post as the first 'chapter', and the
|
|
|
## version in the first chapter gets out of sync.
|
|
|
##
|
|
|
## If always_reload_first_chapter:true, then the first chapter will
|
|
|
## always be downloaded again (ie, reloaded). It will NOT be marked
|
|
|
## '(new)' (see mark_new_chapters). Because it is reloaded, manual
|
|
|
## edits made to the first chapter will be lost.
|
|
|
##
|
|
|
## While intended for base_xenforoforum sites, this setting can be
|
|
|
## applied to other sites.
|
|
|
always_reload_first_chapter:false
|
|
|
|
|
|
## In normal operation, forumtags will only be populated when
|
|
|
## threadmarks are used for chapters (see minimum_threadmarks above).
|
|
|
## When always_use_forumtags:true, always populate forumtags.
|
|
|
always_use_forumtags:false
|
|
|
|
|
|
## base_xenforoforum sites sometimes have 'spoiler' blocks in
|
|
|
## posts. When viewed in a browser, the block is hidden until a button
|
|
|
## is clicked. eBook viewers can't handle that and the javascript is
|
|
|
## disabled. The remove_spoilers option, if uncommented and set true,
|
|
|
## will remove spoiler blocks entirely.
|
|
|
#remove_spoilers:false
|
|
|
|
|
|
## This option if uncommented and set true, will put a box around the
|
|
|
## spoiler blocks with the original spoiler button text as a label
|
|
|
## using fieldset and legend HTML tags. For a simple box, see the
|
|
|
## add_to_output_css example for [base_xenforoforum:epub] below.
|
|
|
#legend_spoilers:false
|
|
|
|
|
|
## True by built-in default, but only applied if using threadmarks for
|
|
|
## chapters and a 'reader' URL is found in the thread, 'reader mode'
|
|
|
## will reduce the number of pages fetched by roughly 10 to 1 for a
|
|
|
## full story download by using the threadmarks-only reader pages.
|
|
|
#use_reader_mode:true
|
|
|
|
|
|
## In case the number of posts per reader page changes. Built-in default is
|
|
|
## 10.
|
|
|
#reader_posts_per_page:10
|
|
|
|
|
|
## xenforoforum has categories of threadmarks. This setting allows
|
|
|
## you to leave out categories you don't want. Skipping categories
|
|
|
## will also speed downloads as categories other than 'Threadmarks'
|
|
|
## don't use Reader Mode.
|
|
|
## The last known list of categories is:
|
|
|
## Threadmarks,Sidestory,Apocrypha,Media,Informational,Staff Post
|
|
|
#skip_threadmarks_categories:Staff Post
|
|
|
|
|
|
## I'm not a fan of using the word 'Apocrypha' for the threadmark
|
|
|
## category when everybody usually calls them Omake. Set true to
|
|
|
## change Apocrypha to Omake. Applied *after*
|
|
|
## skip_threadmarks_categories.
|
|
|
#apocrypha_to_omake:false
|
|
|
|
|
|
## If desired, you can change the order FFF places threadmark
|
|
|
## categories. (This setting does not remove categories, you need to
|
|
|
## use skip_threadmarks_categories for that.)
|
|
|
#threadmark_category_order:Threadmarks,Sidestory,Apocrypha,Omake,Media,Informational,Staff Post
|
|
|
|
|
|
## By default, FFF orders threadmarks first by category, then in the
|
|
|
## order they appear as determined by the author. When
|
|
|
## order_threadmarks_by_date:true, all included threadmarks
|
|
|
## (skip_threadmarks_categories still works) will instead be ordered
|
|
|
## by their datetime as reported in threadmarks. Different threadmark
|
|
|
## categories will be mixed together, and I've seen at least one case
|
|
|
## of post order on the site disagreeing with post datetime. Note
|
|
|
## that if order_threadmarks_by_date_categories (see below),
|
|
|
## order_threadmarks_by_date is ignored.
|
|
|
#order_threadmarks_by_date:false
|
|
|
|
|
|
## By default, FFF orders threadmarks first by category, then in the
|
|
|
## order they appear as determined by the author. When
|
|
|
## order_threadmarks_by_date_categories is set, the listed threadmark
|
|
|
## categories are sorted by their datetime (as reported in
|
|
|
## threadmarks), the different threadmark categories mixed together.
|
|
|
## Categories *not* listed in order_threadmarks_by_date_categories
|
|
|
## will all be *after* the date sorted threadmarks in category, then
|
|
|
## threadmark order. Note that if
|
|
|
## order_threadmarks_by_date_categories is set,
|
|
|
## order_threadmarks_by_date (see above) is ignored.
|
|
|
#order_threadmarks_by_date_categories:Threadmarks,Sidestory
|
|
|
|
|
|
## SV & SB (and possibly QQ and AH) like to use sprite smilies --
|
|
|
## smiley images that are all in one image file for performance and
|
|
|
## are shown by CSS background with offsets. Epub viewers don't like
|
|
|
## that.
|
|
|
##
|
|
|
## The sprite smiley img tags generally do have alt attributes that get
|
|
|
## the point across: ":)" ":D" ":(" ":lol" etc. And not all smilies
|
|
|
## on these sites use sprite images, so some can be used as is.
|
|
|
##
|
|
|
## When replace_failed_smilies_with_alt_text:true, any images that
|
|
|
## failed to download or are src=clear.png *and* have a class containing
|
|
|
## mceSmilie and an alt attribute will be replaced with:
|
|
|
## <span class="(classes)">(alt text)</span>
|
|
|
##
|
|
|
## The smiley classes are preserved in case the user wants to do
|
|
|
## something special with them.
|
|
|
#replace_failed_smilies_with_alt_text:false
|
|
|
|
|
|
## SB, SV & QQ (but not AH) provide word counts with threadmarks. Set
|
|
|
## use_threadmark_wordcounts:true to sum and use them to fill
|
|
|
## numWords. skip_threadmarks_categories and ignore_chapter_url_list
|
|
|
## are applied *before* summing.
|
|
|
## SB, SV & QQ base_xenforoforum sites using use_threadmark_wordcounts
|
|
|
## is one of the few cases where numWords is effected by
|
|
|
## ignore_chapter_url_list.
|
|
|
## Note: that if always_include_first_post is true, first post will not
|
|
|
## be included in the word count if not also threadmarked.
|
|
|
## Note 2: Word counts from the site exclude words inside Spoiler
|
|
|
## tags.
|
|
|
use_threadmark_wordcounts:true
|
|
|
|
|
|
## base_xenforoforum stories with threadmarks have a few additional
|
|
|
## pieces of metadata available that most adapters don't. 'date';
|
|
|
## 'words'--word count as number only: "12104"; and kwords--the
|
|
|
## threadmark human-readable string for word count with parens:
|
|
|
## "(12.1k)" These can be used with custom output (see
|
|
|
## https://github.com/JimmXinu/FanFicFare/wiki/CustomOutput ) or with
|
|
|
## chapter_title_*_pattern settings.
|
|
|
## Examples for html & epub:
|
|
|
#[base_xenforoforum:html]
|
|
|
#tocpage_entry:
|
|
|
# <a href="#section${index04}">${chapter}</a> ${date} ${kwords}<br />
|
|
|
#[base_xenforoforum:epub]
|
|
|
#tocpage_entry:
|
|
|
# <a href="file${index04}.xhtml">${chapter}</a> ${date} ${kwords}<br /><br />
|
|
|
|
|
|
## The 'date' value for chapters mentioned above can be formated with
|
|
|
## datethreadmark_format. Otherwise it will default to
|
|
|
## dateCreated_format
|
|
|
#datethreadmark_format:%%Y-%%m-%%d %%H:%%M
|
|
|
|
|
|
## The basic pattern used when not using add_chapter_numbers or
|
|
|
## mark_new_chapters
|
|
|
#chapter_title_def_pattern:${title} ${date}
|
|
|
|
|
|
## Pattern used with add_chapter_numbers, but not mark_new_chapters
|
|
|
#chapter_title_add_pattern:${number}. ${title} ${date}
|
|
|
|
|
|
## Pattern used with mark_new_chapters, but not add_chapter_numbers
|
|
|
## (new) is just text and can be changed.
|
|
|
#chapter_title_new_pattern:(new) ${title} ${date}
|
|
|
|
|
|
## Pattern used with add_chapter_numbers and mark_new_chapters
|
|
|
## (new) is just text and can be changed.
|
|
|
#chapter_title_addnew_pattern:${number}. (new) ${title} ${date}
|
|
|
|
|
|
## When set true, always_include_first_post_chapters will cause FFF to
|
|
|
## treat both threadmarks *and* first post links as chapter links.
|
|
|
#always_include_first_post_chapters:false
|
|
|
|
|
|
## When reveal_invisible_text is set true, adapter will search for
|
|
|
## <span style="color:transparent"> tags and remove the style
|
|
|
## attribute. Also adds class="invisible_text" for custom CSS
|
|
|
## styling, see invisible_text add_to_output_css example below.
|
|
|
#reveal_invisible_text:false
|
|
|
|
|
|
[base_xenforoforum:epub]
|
|
|
|
|
|
## See remove_spoilers above for more about 'spoilers'. This example
|
|
|
## shows how to put a simple line around spoiler blocks. Uncomment
|
|
|
## all three lines, keep the leading space before .bbCodeSpoilerContainer.
|
|
|
#add_to_keep_html_attrs:,style
|
|
|
#add_to_output_css:
|
|
|
# .bbCodeSpoilerContainer { border: 1px solid black; padding: 2px; }
|
|
|
|
|
|
## When reveal_invisible_text:true, you can style the class
|
|
|
## invisible_text as you like for forum "invisible text". See
|
|
|
## reveal_invisible_text above. This is just one example. Note that
|
|
|
## if you also use the add_to_output_css example above for
|
|
|
## bbCodeSpoilerContainer spoilers, you need to combine the CSS lines
|
|
|
## for both under one add_to_output_css setting, with a space leading
|
|
|
## each CSS line.
|
|
|
#add_to_output_css:
|
|
|
# .invisible_text { color:gray; }
|
|
|
|
|
|
[base_xenforo2forum]
|
|
|
## [base_xenforoforum] also applied, but [base_xenforo2forum] takes
|
|
|
## precedence.
|
|
|
|
|
|
## Some additional 'thread' metadata entries.
|
|
|
add_to_extra_valid_entries:,threadmarks_title,threadmarks_description,threadmarks_status,estimatedWords
|
|
|
#add_to_extra_titlepage_entries:,threadmarks_title,threadmarks_description,threadmarks_status,estimatedWords
|
|
|
|
|
|
# Just to remove '_'.
|
|
|
threadmarks_title_label:Threadmarks Title
|
|
|
threadmarks_description_label:Threadmarks Description
|
|
|
threadmarks_status_label:Threadmarks Status
|
|
|
estimatedWords_label:Estimated Word Count
|
|
|
|
|
|
## When use_threadmarks_description is set true,
|
|
|
## threadmarks_description will be used to fill in the standard
|
|
|
## description metadata entry. Some stories have poor
|
|
|
## threadmarks_description, you can use this setting to avoid using
|
|
|
## it.
|
|
|
use_threadmarks_description:true
|
|
|
## Increasing description_limit from base_xenforoforum's default of
|
|
|
## 500 is also useful with use_threadmarks_description
|
|
|
description_limit:1000
|
|
|
|
|
|
## When use_threadmarks_status is set true, a normalized version of
|
|
|
## threadmarks_status will be used to fill in the standard status
|
|
|
## metadata entry. (In-Progress, Completed plus site statuses.)
|
|
|
use_threadmarks_status:true
|
|
|
|
|
|
## When use_threadmarks_cover is set true, the threadmarks image will
|
|
|
## be used to fill in the cover image. Set true by default.
|
|
|
use_threadmarks_cover:true
|
|
|
|
|
|
## Sometimes there's a sticky post first (often a Staff Post?) rather
|
|
|
## than the true first post by the Original Poster, AKA author. By
|
|
|
## default, base_xenforo2forum will skip up to two sticky first posts.
|
|
|
## Configurable due to the extremely small sample size available when
|
|
|
## this was implemented.
|
|
|
skip_sticky_first_posts:true
|
|
|
|
|
|
## SV/SB sites include a dice roller that can attach dice roll results
|
|
|
## to a post. These are outside the actual post text. Setting
|
|
|
## include_dice_rolls:true will include a text version of those rolls
|
|
|
## in the FFF chapter that should be usable for all ebook readers.
|
|
|
## Setting include_dice_rolls:svg will keep the inline <svg> images of
|
|
|
## the rolls. It is the user's responsibility to also add
|
|
|
## add_to_keep_html_attrs and add_to_output_css settings to make them
|
|
|
## appear correctly. (include_dice_rolls:svg did *not* work in most
|
|
|
## ebook readers I tested with, even with appropriate attributes and
|
|
|
## css.)
|
|
|
## NOTE: SV requires login (always_login:true) to see dice rolls.
|
|
|
#include_dice_rolls:false
|
|
|
|
|
|
[epub]
|
|
|
|
|
|
## Each output format has a section that overrides [defaults]
|
|
|
|
|
|
## As of Jan 2020, FanFicFare can output either epub 2.0 or 3.0 (with
|
|
|
## backward compatibility toc.ncx file). 2.0 will still be the
|
|
|
## default for now.
|
|
|
epub_version:2.0
|
|
|
|
|
|
## epub is already a zip file.
|
|
|
zip_output: false
|
|
|
|
|
|
## epub carries the TOC in metadata.
|
|
|
## mobi generated from epub by calibre will have a TOC at the end.
|
|
|
include_tocpage: false
|
|
|
|
|
|
## include a Update Log page before the story text. If 'true', the
|
|
|
## log will be updated each time the epub is and all the metadata
|
|
|
## fields that have changed since the last update (typically
|
|
|
## dateUpdated,numChapters,numWords at a minimum) will be shown.
|
|
|
## Great for tracking when chapters came out and when the description,
|
|
|
## etc changed.
|
|
|
include_logpage: false
|
|
|
## If set to 'smart', logpage will only be included if the story is
|
|
|
## status:In-Progress or already had a logpage. That way you don't
|
|
|
## end up with Completed stories that have just one logpage entry.
|
|
|
#include_logpage: smart
|
|
|
|
|
|
## By default, logpage is placed before the story chapters. This
|
|
|
## setting, if true, will place the logpage after the chapters
|
|
|
## instead.
|
|
|
logpage_at_end: false
|
|
|
|
|
|
## items to include in the log page Empty metadata entries, or those
|
|
|
## that haven't changed since the last update, will *not* appear, even
|
|
|
## if in the list. You can include extra text or HTML that will be
|
|
|
## included as-is in each log entry. Eg: logpage_entries: ...,<br />,
|
|
|
## summary,<br />,...
|
|
|
logpage_entries: dateCreated,datePublished,dateUpdated,numChapters,numWords,status,series,title,author,description,category,genre,rating,warnings
|
|
|
|
|
|
## epub->mobi conversions typically don't like tables.
|
|
|
titlepage_use_table: false
|
|
|
|
|
|
## When using tables, make these span both columns.
|
|
|
wide_titlepage_entries: description, storyUrl, authorUrl, seriesUrl
|
|
|
|
|
|
## output background color--used by html and epub output_css (and will
|
|
|
## only be used in CSS if included in output_css). Also used by image
|
|
|
## processing for remove_transparency. Value is expected to be a hex
|
|
|
## code color.
|
|
|
background_color: ffffff
|
|
|
## WARNING: At some point between 2010 and 2020, it became common for
|
|
|
## Epub readers to ignore or override background-color CSS on <body>
|
|
|
## tags in favor of a color configured by the user in the reader.
|
|
|
## This background color in generated Epubs may not appear anymore.
|
|
|
|
|
|
## Allow customization of CSS. Make sure to keep at least one space
|
|
|
## at the start of each line and to escape % to %%. Also need
|
|
|
## background_color to be in the same section, if included in CSS.
|
|
|
## 'adobe-hyphenate: none;' prevents hyphenation on newer Nooks
|
|
|
## STR(wG) (1.2.1+ for sure)
|
|
|
output_css:
|
|
|
body { background-color: #%(background_color)s;
|
|
|
text-align: justify;
|
|
|
margin: 2%%;
|
|
|
adobe-hyphenate: none; }
|
|
|
pre { font-size: x-small; }
|
|
|
h1 { text-align: center; }
|
|
|
h2 { text-align: center; }
|
|
|
h3 { text-align: center; }
|
|
|
h4 { text-align: center; }
|
|
|
h5 { text-align: center; }
|
|
|
h6 { text-align: center; }
|
|
|
.CI {
|
|
|
text-align:center;
|
|
|
margin-top:0px;
|
|
|
margin-bottom:0px;
|
|
|
padding:0px;
|
|
|
}
|
|
|
.center {text-align: center;}
|
|
|
.cover {text-align: center;}
|
|
|
.full {width: 100%%; }
|
|
|
.quarter {width: 25%%; }
|
|
|
.smcap {font-variant: small-caps;}
|
|
|
.u {text-decoration: underline;}
|
|
|
.bold {font-weight: bold;}
|
|
|
.big { font-size: larger; }
|
|
|
.small { font-size: smaller; }
|
|
|
|
|
|
## include images from img tags in the body and summary of
|
|
|
## stories. Images will be converted to jpg for size if possible.
|
|
|
## include_images is *only* available in epub and html output format.
|
|
|
## include_images is *not* available in the web service in any format.
|
|
|
#include_images:false
|
|
|
|
|
|
## Quality level to use when converting images to jpg. Range is 0-100,
|
|
|
## reasonable values likely to be in the range 70-95.
|
|
|
jpg_quality: 95
|
|
|
|
|
|
## If set, the first image found will be made the cover image. If
|
|
|
## keep_summary_html is true, any images in summary will be before any
|
|
|
## in chapters.
|
|
|
#make_firstimage_cover: false
|
|
|
|
|
|
## When include_images:true, you can also specify a list of images to
|
|
|
## include in the EPUB or HTML, such as for use in customized CSS.
|
|
|
## Specified images will be included as "images/<basename>". So
|
|
|
## "images/background.jpeg" and "images/someimage.gif" in the examples
|
|
|
## below. No processing is done on additional_images.
|
|
|
## Note that when used with HTML format in the FFF Calibre Plugin,
|
|
|
## Calibre will discard any images that aren't used. Set up your
|
|
|
## custom output_css before testing additional_images.
|
|
|
## Note also that services such as imgur will start blocking you if
|
|
|
## you get images from them too often. It's better to have your own
|
|
|
## local copy.
|
|
|
#additional_images:file:///C:/Users/user/Desktop/nook/background.jpeg,http://www.somesite.com/someimage.gif
|
|
|
|
|
|
## If set, the epub will never have a cover downloaded, even if
|
|
|
## include_images is on and the site has specific cover images.
|
|
|
## However, any existing cover will be kept during EPUB update, and
|
|
|
## default_cover_image used if set.
|
|
|
## From FanFicFare v4.16, it is preferred to use use_old_cover or
|
|
|
## force_cover_image in most cases instead of never_make_cover
|
|
|
#never_make_cover: false
|
|
|
|
|
|
## If set, on EPUB update, the existing EPUB cover will be used,
|
|
|
## taking precedence over specific, first image, and
|
|
|
## default_cover_image, but not force_cover_image
|
|
|
#use_old_cover:false
|
|
|
|
|
|
## If set, story specific and first image covers 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). Default 10,10 to avoid
|
|
|
## spacer images.
|
|
|
cover_min_size: 10,10
|
|
|
|
|
|
## If set, and there isn't already a cover image from the adapter or
|
|
|
## from make_firstimage_cover, this image will be made the cover.
|
|
|
## It can be either a 'file:' or 'http:' url.
|
|
|
## Note that if you enable make_firstimage_cover in [epub], but want
|
|
|
## to use default_cover_image for a specific site, use the site:format
|
|
|
## section, for example: [ficwad.com:epub]
|
|
|
## default_cover_image is a python string Template string with
|
|
|
## ${title}, ${author} etc, same as titlepage_entries. Unless
|
|
|
## allow_unsafe_filename is true, invalid filename chars will be
|
|
|
## removed from metadata fields and spaces are allowed.
|
|
|
#default_cover_image:file:///C:/Users/username/Desktop/nook/images/icon.png
|
|
|
#default_cover_image:file:///C:/Users/username/Desktop/nook/images/${title}/icon.png
|
|
|
#default_cover_image:http://www.somesite.com/someimage.gif
|
|
|
|
|
|
## If set, force_cover_image will be made the cover, taking precedence
|
|
|
## over specific story cover, first image, default and
|
|
|
## pre-existing(aka old) EPUB cover image.
|
|
|
## It can be either a 'file:' or 'http:' url.
|
|
|
## force_cover_image is a python string Template string with
|
|
|
## ${title}, ${author} etc, same as titlepage_entries. Unless
|
|
|
## allow_unsafe_filename is true, invalid filename chars will be
|
|
|
## removed from metadata fields and spaces are allowed.
|
|
|
#force_cover_image:file:///C:/Users/username/Desktop/nook/images/icon.png
|
|
|
#force_cover_image:file:///C:/Users/username/Desktop/nook/images/${title}/icon.png
|
|
|
#force_cover_image:http://www.somesite.com/someimage.gif
|
|
|
|
|
|
## some sites include images that we don't ever want becoming the
|
|
|
## cover image. This lets you exclude them.
|
|
|
#cover_exclusion_regexp:/stories/999/images/.*?_trophy.png
|
|
|
|
|
|
## Resize images down to width, height, preserving aspect ratio.
|
|
|
## Nook size, with margin.
|
|
|
image_max_size: 580, 725
|
|
|
|
|
|
## Change image to grayscale, if graphics library allows, to save
|
|
|
## space. Transparency removed as if remove_transparency: true
|
|
|
#grayscale_images: false
|
|
|
|
|
|
## jpg or png
|
|
|
## -- jpg produces smaller images, and may be supported by more
|
|
|
## readers, but it's older and doesn't allow transparency.
|
|
|
## Transparency removed as if remove_transparency: true
|
|
|
## -- png is newer but does allow transparency, but only in CLI.
|
|
|
## It doesn't work in calibre PI due to limitations of the API.
|
|
|
convert_images_to: jpg
|
|
|
|
|
|
## Remove transparency and fill with background_color if true.
|
|
|
remove_transparency: true
|
|
|
|
|
|
## This switch prevents FanFicFare from doing any processing on the images.
|
|
|
## Usually they would be converted to jpg, resized and optionally made
|
|
|
## grayscale.
|
|
|
#no_image_processing: false
|
|
|
|
|
|
## If true, in-line images (<img src="data:image/...;base64,...") will
|
|
|
## be converted to files so the normal image processing can be
|
|
|
## applied, but only if base64 encoded. Note that in-line images are
|
|
|
## also removed when include_images:false. In-line images are not
|
|
|
## used as cover images unless converted. Default is false: in-line
|
|
|
## images kept as-is.
|
|
|
#convert_inline_images:false
|
|
|
|
|
|
## If set true, FFF will compare image all files(of the same size)
|
|
|
## looking for identical files with different URLs. fiction.live is
|
|
|
## the only site currently(Sep2020) known to benefit from this.
|
|
|
## (Images with the same URL are always detected and only one copy
|
|
|
## kept.)
|
|
|
#dedup_img_files:false
|
|
|
|
|
|
## If set, and the img tag's URL matches the regular expression, FFF
|
|
|
## will use the img tag's own src URL as the HTTP Referer instead of
|
|
|
## the page URL. This is useful for some image hosting sites that
|
|
|
## watermark or return HTML instead of image data without it.
|
|
|
#force_img_self_referer_regexp:gelbooru.com|photobucket.com
|
|
|
|
|
|
## if the <img> tag doesn't have a div or a p around it, nook gets
|
|
|
## confused and displays it on every page after that under the text
|
|
|
## for the rest of the chapter. I doubt adding a div around the img
|
|
|
## will break any other readers, but in case it does, the fix can be
|
|
|
## turned off. This setting is not used if replace_br_with_p is
|
|
|
## true--replace_br_with_p also fixes the problem.
|
|
|
nook_img_fix:true
|
|
|
|
|
|
## Some ebook readers (Moon+ Reader was reported) read <meta
|
|
|
## name="calibre:series"...> and <meta name="calibre:series_index"...>
|
|
|
## for series info. This is not epub standard, but not an
|
|
|
## unreasonable thing for FanFicFare to emulate. This is primarily
|
|
|
## useful for CLI and web service--the calibre plugin doesn't need it.
|
|
|
#calibre_series_meta:false
|
|
|
|
|
|
## By default, FanFicFare will not update an existing EPUB that has
|
|
|
## more chapters than the story does on the source site. When
|
|
|
## force_update_epub_always:true FFF will ignore that check when using
|
|
|
## 'Update EPUB Always' (plugin) or -U/--update-epub-always (CLI) and
|
|
|
## will discard chapters in the EPUB that are not listed on the source
|
|
|
## site anymore.
|
|
|
## This can be useful for authors that remove and/or replace chapters.
|
|
|
## Recommended to be set for individual stories or sites rather than
|
|
|
## under [defaults] or [epub].
|
|
|
#force_update_epub_always:false
|
|
|
|
|
|
[html]
|
|
|
|
|
|
## include images from img tags in the body and summary of
|
|
|
## stories. Images will be converted to jpg for size if possible.
|
|
|
## include_images is *only* available in epub and html output formats.
|
|
|
## include_images is *not* available in the web service in any format.
|
|
|
#include_images:false
|
|
|
|
|
|
## Quality level to use when converting images to jpg. Range is 0-100,
|
|
|
## reasonable values likely to be in the range 70-95.
|
|
|
#jpg_quality: 95
|
|
|
|
|
|
## When include_images:true, you can also specify a list of images to
|
|
|
## include in the EPUB or HTML, such as for use in customized CSS.
|
|
|
## Specified images will be included as "images/<basename>". So
|
|
|
## "images/background.jpeg" and "images/someimage.gif" in the examples
|
|
|
## below. No processing is done on additional_images.
|
|
|
## Note that when used with HTML format in the FFF Calibre Plugin,
|
|
|
## Calibre will discard any images that aren't used. Set up your
|
|
|
## custom output_css before testing additional_images.
|
|
|
## Note also that services such as imgur will start blocking you if
|
|
|
## you get images from them too often. It's better to have your own
|
|
|
## local copy.
|
|
|
#additional_images:file:///C:/Users/user/Desktop/nook/background.jpeg,http://www.somesite.com/someimage.gif
|
|
|
|
|
|
## Note that it's *highly* recommended to use zipfile output or story
|
|
|
## unique destination directories to avoid overwriting images.
|
|
|
#output_filename: books/${author}/${title}/${title}-${siteabbrev}_${authorId}_${storyId}${formatext}
|
|
|
#zip_output: false
|
|
|
|
|
|
## This switch prevents FanFicFare from doing any processing on the images.
|
|
|
## Usually they would be converted to jpg, resized and optionally made
|
|
|
## grayscale.
|
|
|
no_image_processing: true
|
|
|
|
|
|
## output background color--used by html and epub output_css (and will
|
|
|
## only be used in CSS if included in output_css). Also used by image
|
|
|
## processing for remove_transparency. Value is expected to be a hex
|
|
|
## code color.
|
|
|
background_color: ffffff
|
|
|
|
|
|
## Allow customization of CSS. Make sure to keep at least one space
|
|
|
## at the start of each line and to escape % to %%. Also need
|
|
|
## background_color to be in the same section, if included in CSS.
|
|
|
output_css:
|
|
|
body { background-color: #%(background_color)s; }
|
|
|
.CI {
|
|
|
text-align:center;
|
|
|
margin-top:0px;
|
|
|
margin-bottom:0px;
|
|
|
padding:0px;
|
|
|
}
|
|
|
.center {text-align: center;}
|
|
|
.cover {text-align: center;}
|
|
|
.full {width: 100%%; }
|
|
|
.quarter {width: 25%%; }
|
|
|
.smcap {font-variant: small-caps;}
|
|
|
.u {text-decoration: underline;}
|
|
|
.bold {font-weight: bold;}
|
|
|
.big { font-size: larger; }
|
|
|
.small { font-size: smaller; }
|
|
|
|
|
|
[txt]
|
|
|
keep_summary_html:false
|
|
|
|
|
|
## Add URLs since there aren't links.
|
|
|
titlepage_entries: series,seriesUrl,category,genre,language,characters,ships,status,datePublished,dateUpdated,dateCreated,rating,warnings,numChapters,numWords,publisher,storyUrl, authorUrl, description
|
|
|
|
|
|
## Width to word wrap text output. 0 indicates no wrapping.
|
|
|
wrap_width: 78
|
|
|
|
|
|
## use \r\n for line endings, the windows convention. text output only.
|
|
|
windows_eol: true
|
|
|
|
|
|
[mobi]
|
|
|
|
|
|
## mobi TOC cannot be turned off right now.
|
|
|
#include_tocpage: true
|
|
|
|
|
|
## Each site has a section that overrides [defaults].
|
|
|
## test1.com specifically is not a real story site. Instead,
|
|
|
## it is a fake site for testing configuration and output. It uses
|
|
|
## URLs like: http://test1.com?sid=12345
|
|
|
|
|
|
[test1.com]
|
|
|
use_basic_cache:true
|
|
|
## slow_down_sleep_time now applied to test1 chapters (with 0.5-1.5
|
|
|
## random fudge)
|
|
|
#slow_down_sleep_time:2
|
|
|
extratags: FanFiction,Testing
|
|
|
|
|
|
# extracategories:Fafner
|
|
|
# extragenres:Romance,Fluff
|
|
|
# extracharacters:Reginald Smythe-Smythe,Mokona,Harry P.
|
|
|
# extraships:Smythe-Smythe/Mokona
|
|
|
# extrawarnings:Extreme Bogosity
|
|
|
|
|
|
# extra_valid_entries:metaA,metaB,metaC,listX,listY,listZ,compositeJ,compositeK,compositeL
|
|
|
|
|
|
# include_in_compositeJ:dateCreated
|
|
|
# include_in_compositeK:metaC,listX,compositeL,compositeJ,compositeK,listZ
|
|
|
# include_in_compositeL:ships,metaA,listZ,datePublished,dateUpdated,
|
|
|
|
|
|
# extra_titlepage_entries: metaA,metaB,metaC,listX,listY,listZ,compositeJ,compositeK,compositeL
|
|
|
# extra_logpage_entries: metaA,metaB,metaC,listX,listY,listZ,compositeJ,compositeK,compositeL
|
|
|
# extra_subject_tags: metaA,metaB,metaC
|
|
|
|
|
|
# replace_metadata:
|
|
|
# compositeL=>Val=>VALUE
|
|
|
# series,extratags=>Test=>Plan
|
|
|
# Puella Magi Madoka Magica.* => Madoka
|
|
|
# Comedy=>Humor
|
|
|
# Crossover: (.*)=>\1
|
|
|
# (.*)Great(.*)=>\1Moderate\2
|
|
|
# .*-Centered=>
|
|
|
# characters=>Harry P\.=>Harry Potter
|
|
|
|
|
|
|
|
|
[test1.com:txt]
|
|
|
|
|
|
## If necessary, you can define [<site>:<format>] sections to
|
|
|
## customize the formats differently for the same site. Overrides
|
|
|
## defaults, format and site.
|
|
|
|
|
|
extratags: FanFiction,Testing,Text
|
|
|
|
|
|
[test1.com:html]
|
|
|
|
|
|
extratags: FanFiction,Testing,HTML
|
|
|
|
|
|
[teststory:defaults]
|
|
|
|
|
|
valid_entries:title,author_list,authorId_list,authorUrl_list,storyUrl,
|
|
|
datePublished,dateUpdated,numWords,status,language,series,seriesUrl,
|
|
|
rating,category_list,genre_list,warnings_list,characters_list,ships_list,
|
|
|
description,publisher,extratags
|
|
|
|
|
|
# {{storyId}} is a special case--it's the only one that works.
|
|
|
title:Test Story Title {{storyId}}
|
|
|
author_list:Test Author aa
|
|
|
authorId_list:1
|
|
|
authorUrl_list:http://test1.com?authid=1
|
|
|
storyUrl:http://test1.com?sid={{storyId}}
|
|
|
datePublished:1975-03-15
|
|
|
dateUpdated:1975-04-15
|
|
|
numWords:123,456
|
|
|
status:In-Progress
|
|
|
language:English
|
|
|
|
|
|
chaptertitles:Prologue
|
|
|
|
|
|
[teststory:1000]
|
|
|
|
|
|
## Add additional sections with different numbers to get different
|
|
|
## parameters for different story urls.
|
|
|
## test1.com?sid=1000
|
|
|
# note the leading commas when doing add_to_ with valid_entries and *_list
|
|
|
add_to_valid_entries:,favs
|
|
|
title:Testing New Feature {{storyId}}
|
|
|
author_list:Bob Smith
|
|
|
authorId_list:45
|
|
|
authorUrl_list:http://test1.com?authid=45
|
|
|
datePublished:2013-03-15
|
|
|
dateUpdated:2013-04-15
|
|
|
numWords:1456
|
|
|
favs:56
|
|
|
series:The Great Test [4]
|
|
|
seriesUrl:http://test1.com?seriesid=1
|
|
|
rating:Tweenie
|
|
|
category_list:Harry Potter,Furbie,Crossover,Puella Magi Madoka Magica/魔法少女まどか★マギカ,Magical Girl Lyrical Nanoha
|
|
|
genre_list:Fantasy,Comedy,Sci-Fi,Noir
|
|
|
warnings_list:Swearing,Violence
|
|
|
characters_list:Bob Smith,George Johnson,Fred Smythe
|
|
|
|
|
|
chaptertitles:Prologue,Chapter 1\, Xenos on Cinnabar,Chapter 2\, Sinmay on Kintikin,3. Chapter 3
|
|
|
|
|
|
[overrides]
|
|
|
|
|
|
## It may sometimes be useful to override all of the specific format,
|
|
|
## site and site:format sections in your private configuration. For
|
|
|
## example, this extratags param here would override all of the
|
|
|
## extratags params in all other sections. Only commandline options
|
|
|
## beat overrides.
|
|
|
#extratags:FanFicFare
|
|
|
|
|
|
|
|
|
[adult-fanfiction.org]
|
|
|
extra_valid_entries:eroticatags,disclaimer
|
|
|
eroticatags_label:Erotica Tags
|
|
|
disclaimer_label:Disclaimer
|
|
|
extra_titlepage_entries:eroticatags,disclaimer
|
|
|
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
[archive.skyehawke.com]
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[archiveofourown.org]
|
|
|
use_basic_cache:true
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## In order to get bookmarktags and bookmarksummary, you need to login
|
|
|
## all the time. This defaults to off to save time and network
|
|
|
## traffic. Requires valid AO3 username and password when true.
|
|
|
#always_login:false
|
|
|
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. In commandline version, this should go in your
|
|
|
## personal.ini, not defaults.ini.
|
|
|
is_adult:true
|
|
|
|
|
|
## AO3 offers a page to download the entire work at once. This can
|
|
|
## save a lot of network traffic if there are many chapters.
|
|
|
## True by built-in default.
|
|
|
use_view_full_work:true
|
|
|
|
|
|
## archiveofourown.org stories allow chapters to be added out of
|
|
|
## order. So the newest chapter may not be the last one. FanFicFare update
|
|
|
## doesn't like that. If do_update_hook is uncommented and set true,
|
|
|
## the adapter will discard all existing chapters from the newest one
|
|
|
## on when updating to enforce accurate chapters.
|
|
|
## Starting July 2015, FFF stores chapter URLs in the chapter files.
|
|
|
## Stories downloaded after that shouldn't need this setting anymore.
|
|
|
#do_update_hook:false
|
|
|
|
|
|
## Some adapters collect additional meta information beyond the
|
|
|
## standard ones. They need to be defined in extra_valid_entries to
|
|
|
## tell the rest of the FanFicFare system about them. They can be
|
|
|
## used in include_subject_tags, titlepage_entries,
|
|
|
## extra_titlepage_entries, logpage_entries, extra_logpage_entries,
|
|
|
## and include_in_* config items. You can also add additional entries
|
|
|
## here to build up composite metadata entries.
|
|
|
## archiveofourown.org, for example, fills genre (a standard
|
|
|
## entry) as the composite offreeformtags, ao3categories in
|
|
|
## include_in_genre. If there's ever more than 4 series, add
|
|
|
## series04,series04Url etc.
|
|
|
extra_valid_entries:fandoms, freeformtags, freefromtags,
|
|
|
ao3categories, comments, chapterslashtotal, chapterstotal, kudos,
|
|
|
hits, bookmarks, collections, byline, bookmarked, bookmarktags,
|
|
|
bookmarksummary, bookmarkprivate, bookmarkrec, restricted, series00,
|
|
|
series01, series02, series03, series00Url, series01Url, series02Url,
|
|
|
series03Url, series00HTML, series01HTML, series02HTML, series03HTML
|
|
|
fandoms_label:Fandoms
|
|
|
freeformtags_label:Freeform Tags
|
|
|
freefromtags_label:Freeform Tags
|
|
|
ao3categories_label:AO3 Categories
|
|
|
comments_label:Comments
|
|
|
chapterslashtotal_label:Chapters/Total Chapters
|
|
|
chapterstotal_label:Total Chapters
|
|
|
kudos_label:Kudos
|
|
|
hits_label:Hits
|
|
|
collections_label:Collections
|
|
|
## Count of bookmarks on story by all users
|
|
|
bookmarks_label:Bookmarks
|
|
|
## Tags & Summary from *your* bookmark on the story. Only collected
|
|
|
## if always_login:true
|
|
|
bookmarked_label:I Bookmarked Story
|
|
|
bookmarktags_label:My Bookmark Tags
|
|
|
bookmarksummary_label:My Bookmark Summary
|
|
|
bookmarkprivate_label:My Bookmark Private
|
|
|
bookmarkrec_label:My Bookmark Rec
|
|
|
restricted_label:Restricted to Registered Users
|
|
|
series00HTML_label:Series
|
|
|
series01HTML_label:Additional Series
|
|
|
series02HTML_label:Additional Series
|
|
|
series03HTML_label:Additional Series
|
|
|
|
|
|
## Assume entryUrl, apply to "<a class='%slink' href='%s'>%s</a>" to
|
|
|
## make entryHTML.
|
|
|
make_linkhtml_entries:series00,series01,series02,series03
|
|
|
|
|
|
## AO3 doesn't have anything it calls 'genre'. The adapter used to be
|
|
|
## hardcoded to include the site specific metadata freeformtags &
|
|
|
## ao3categories in the standard metadata field genre. By making it
|
|
|
## configurable, users can change it.
|
|
|
include_in_genre: freeformtags, ao3categories
|
|
|
|
|
|
## 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
|
|
|
|
|
|
## freeformtags was previously typo'ed as freefromtags. This way,
|
|
|
## freefromtags will still work for people who've used it.
|
|
|
include_in_freefromtags:freeformtags
|
|
|
|
|
|
## chapterslashtotal contains 1/3 or 1/1 or 3/? etc as reported by AO3.
|
|
|
## chapterstotal is just the total chapters part after the /
|
|
|
include_in_chapterstotal:chapterslashtotal.NOREPL
|
|
|
add_to_replace_metadata:
|
|
|
chapterstotal=>^([0-9])+/(.+)$=>\2
|
|
|
## Due to a bug with Archive of Our Own, the link to orphan_account
|
|
|
## just leads to a 404 page. Hopefully it will be fixed in future.
|
|
|
## Uncomment authorUrl line below (but keep one leading space) to
|
|
|
## replace orphan_account author links with one that works.
|
|
|
# authorUrl=>(/users/orphan_account)/pseuds/.*$=>\1
|
|
|
|
|
|
## adds to titlepage_entries instead of replacing it.
|
|
|
#extra_titlepage_entries: fandoms,freeformtags,ao3categories,comments,chapterslashtotal,chapterstotal,kudos,hits,bookmarks,bookmarked,bookmarktags,bookmarksummary,series01HTML,series02HTML,series03HTML,byline
|
|
|
|
|
|
## adds to include_subject_tags instead of replacing it.
|
|
|
#extra_subject_tags:fandoms,freeformtags,ao3categories
|
|
|
|
|
|
## AO3 chapters can include several different types of notes. We've
|
|
|
## traditionally included them all in the chapter text, but this allows
|
|
|
## you to customize which you include. Copy this parameter to your
|
|
|
## personal.ini and list the ones you don't want.
|
|
|
#exclude_notes:authorheadnotes,chaptersummary,chapterheadnotes,chapterfootnotes,authorfootnotes,inspiredlinks
|
|
|
|
|
|
## AO3 authorfootnotes and inspiredlinks end up in the 'last' chapter,
|
|
|
## but if updated, then there's a new 'last' chapter, leaving multiple
|
|
|
## copies. This option applies the 'skip_on_ffdl_update' class to
|
|
|
## those tags which means they will be removed during epub reading for
|
|
|
## update. This will only effect chapters added after turning the
|
|
|
## setting on.
|
|
|
## Result: Only the last chapter will have end notes.
|
|
|
## Side-effect: An 'Update Always' that doesn't add a new last
|
|
|
## chapter will also remove the end notes.
|
|
|
#remove_authorfootnotes_on_update:false
|
|
|
|
|
|
## AO3 is blocking people more aggressively. If you download fewer
|
|
|
## stories less often you can likely get by with reducing this sleep.
|
|
|
slow_down_sleep_time:2
|
|
|
|
|
|
## AO3 allows users to archive stories they didn't write in certain
|
|
|
## cases. These are indicated by showing a byline such as:
|
|
|
## 'Orig Author [archived by Archivist Author]'
|
|
|
## If use_archived_author is set true (and there's only one author
|
|
|
## listed), author will be set to 'Orig Author' instead of 'Archivist
|
|
|
## Author'. authorUrl will still point to the Archivist Author's page.
|
|
|
#use_archived_author:false
|
|
|
|
|
|
## AO3 chapters have 'date' available for each chapter.
|
|
|
## These can be used with custom output (see
|
|
|
## https://github.com/JimmXinu/FanFicFare/wiki/CustomOutput ) or with
|
|
|
## chapter_title_*_pattern settings.
|
|
|
## Examples for html & epub:
|
|
|
#[html]
|
|
|
#tocpage_entry:
|
|
|
# <a href="#section${index04}">${chapter}</a> ${date}<br />
|
|
|
#[epub]
|
|
|
#tocpage_entry:
|
|
|
# <a href="file${index04}.xhtml">${chapter}</a> ${date}<br /><br />
|
|
|
|
|
|
## The 'date' value for chapters mentioned above can be formated with
|
|
|
## datechapter_format. Otherwise it will default to
|
|
|
## datePublished_format
|
|
|
#datechapter_format:%%Y-%%m-%%d
|
|
|
|
|
|
[ashwinder.sycophanthex.com]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Harry Potter
|
|
|
extracharacters:Severus Snape,Hermione Granger
|
|
|
extraships:Severus Snape/Hermione Granger
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[bloodshedverse.com]
|
|
|
use_basic_cache:true
|
|
|
## website encoding(s) In theory, each website reports the character
|
|
|
## encoding they use for each page. In practice, some sites report it
|
|
|
## incorrectly. Each adapter has a default list, usually "utf8,
|
|
|
## Windows-1252" or "Windows-1252, utf8", but this will let you
|
|
|
## explicitly set the encoding and order if you need to. The special
|
|
|
## value 'auto' will call chardet and use the encoding it reports if
|
|
|
## it has +90% confidence. 'auto' is not reliable.
|
|
|
website_encodings:Windows-1252,ISO-8859-1,auto
|
|
|
|
|
|
## dateUpdate doesn't usually have time, but it does on
|
|
|
## bloodshedverse.com. See
|
|
|
## http://docs.python.org/library/datetime.html#strftime-strptime-behavior
|
|
|
## Note that ini format requires % to be escaped as %%.
|
|
|
dateUpdated_format:%%Y-%%m-%%d %%H:%%M
|
|
|
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:warnings,reviews
|
|
|
reviews_label:Reviews
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracharacters:Spike,Buffy
|
|
|
extracategories:Buffy the Vampire Slayer
|
|
|
|
|
|
## Strips links found in the story text
|
|
|
## Specific to bloodshedverse.com
|
|
|
strip_text_links:true
|
|
|
|
|
|
[chaos.sycophanthex.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## some sites include images that we don't ever want becoming the
|
|
|
## cover image. This lets you exclude them.
|
|
|
cover_exclusion_regexp:/images/.*?ribbon.gif
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[chireads.com]
|
|
|
use_basic_cache:true
|
|
|
|
|
|
[chosentwofanfic.com]
|
|
|
use_basic_cache:true
|
|
|
extra_valid_entries:disclaimer
|
|
|
disclaimer_label: Disclaimer
|
|
|
add_to_titlepage_entries:,disclaimer
|
|
|
|
|
|
website_encodings:Windows-1252,utf8,iso-8859-1
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Buffy the Vampire Slayer
|
|
|
|
|
|
[dark-solace.org]
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. In commandline version, this should go in your
|
|
|
## personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
extracategories:Buffy: The Vampire Slayer
|
|
|
extracharacters:Buffy, Spike
|
|
|
extraships:Spike/Buffy
|
|
|
|
|
|
[erosnsappho.sycophanthex.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Harry Potter
|
|
|
|
|
|
## some sites include images that we don't ever want becoming the
|
|
|
## cover image. This lets you exclude them.
|
|
|
cover_exclusion_regexp:/images/.*?ribbon.gif
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[fanficauthors.net]
|
|
|
use_basic_cache:true
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. In commandline version, this should go in your
|
|
|
## personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
[fanfics.me]
|
|
|
use_basic_cache:true
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
## fanfics.me requires you to have your age set to 18+ in your account
|
|
|
## to download stories with PG-13 or higher ratings.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
extra_valid_entries:fandoms,events,originUrl,
|
|
|
translators,translatorsId,translatorsUrl,translatorsHTML,
|
|
|
betas,betasId,betasUrl,betasHTML,
|
|
|
|
|
|
fandoms_label:Fandoms
|
|
|
translatorsHTML_label:Translators
|
|
|
betasHTML_label:Beta Readers
|
|
|
events_label:Events
|
|
|
originUrl:Original Story URL
|
|
|
|
|
|
make_linkhtml_entries:translators,betas
|
|
|
|
|
|
## For most sites, 'category' is the fandom, but fanfics.me has
|
|
|
## fandoms and a separate category. By making it configurable, users
|
|
|
## can change it.
|
|
|
include_in_category:fandoms
|
|
|
|
|
|
[fanfictalk.com]
|
|
|
use_basic_cache:true
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. In commandline version, this should go in your
|
|
|
## personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
add_to_extra_valid_entries:,tropes,themes,representation,inclusivity,
|
|
|
house,storytype,contentwarnings,
|
|
|
series00,series00Url,series00HTML,
|
|
|
series01,series01Url,series01HTML,
|
|
|
series02,series02Url,series02HTML,
|
|
|
series03,series03Url,series03HTML,
|
|
|
series04,series04Url,series04HTML,
|
|
|
series05,series05Url,series05HTML,
|
|
|
series06,series06Url,series06HTML,
|
|
|
series07,series07Url,series07HTML,
|
|
|
series08,series08Url,series08HTML,
|
|
|
series09,series09Url,series09HTML,
|
|
|
|
|
|
# fields changed name with domain name change.
|
|
|
include_in_inclusivity:representation
|
|
|
include_in_themes:tropes
|
|
|
|
|
|
## Assume entryUrl, apply to "<a class='%slink' href='%s'>%s</a>" to
|
|
|
## make entryHTML.
|
|
|
make_linkhtml_entries:series00,series01,series02,series03,series04,
|
|
|
series05,series06,series07,series08,series09
|
|
|
|
|
|
tropes_label:Tropes
|
|
|
representation_label:Representation
|
|
|
house_label:HPFT Forum House
|
|
|
storytype_label:Story Type
|
|
|
contentwarnings_label:Content Warnings
|
|
|
|
|
|
## series00 will be the same as common metadata series.
|
|
|
series00HTML_label:Series
|
|
|
series01HTML_label:Additional Series
|
|
|
series02HTML_label:Additional Series
|
|
|
series03HTML_label:Additional Series
|
|
|
series04HTML_label:Additional Series
|
|
|
series05HTML_label:Additional Series
|
|
|
series06HTML_label:Additional Series
|
|
|
series07HTML_label:Additional Series
|
|
|
series08HTML_label:Additional Series
|
|
|
series09HTML_label:Additional Series
|
|
|
|
|
|
## Try to collect series names and numbers of this story in those
|
|
|
## series. This lets us turn it on and off by site without keeping a
|
|
|
## lengthy titlepage_entries per site and prevents it updating in the
|
|
|
## plugin.
|
|
|
collect_series: true
|
|
|
|
|
|
#add_to_extra_titlepage_entries:,tropes,themes,representation,inclusivity,house,storytype,contentwarnings,series01HTML,series02HTML,series03HTML,
|
|
|
# series04HTML,series05HTML,series06HTML,series07HTML,series08HTML,series09HTML
|
|
|
|
|
|
## fanfictalk.com takes margins away, even from p tags, by default.
|
|
|
## So authors have to either include extra br/p tags or their own
|
|
|
## styles. These allow for both, but leave you at the mercy of author
|
|
|
## CSS.
|
|
|
add_to_output_css:
|
|
|
* {
|
|
|
margin: 0;
|
|
|
padding: 0;
|
|
|
}
|
|
|
add_to_keep_html_attrs:,style
|
|
|
|
|
|
[fastnovels.net]
|
|
|
use_basic_cache:true
|
|
|
add_to_extra_valid_entries:,tags
|
|
|
|
|
|
[ficbook.net]
|
|
|
use_basic_cache:true
|
|
|
|
|
|
## browser cache will only be used if use_browser_cache:true and ONLY
|
|
|
## for a few sites. Requires a browser_cache_path set in
|
|
|
## [defaults].
|
|
|
#use_browser_cache:false
|
|
|
|
|
|
## use_browser_cache_only:true prevents FFF from falling through to
|
|
|
## request from the server when a page isn't in the browser cache.
|
|
|
## You can turn this on to be sure you're only using the browser
|
|
|
## cache.
|
|
|
#use_browser_cache_only:false
|
|
|
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## ficbook.net isn't putting html line breaks in anymore and using
|
|
|
## this CSS instead.
|
|
|
add_to_output_css:
|
|
|
.part_text {
|
|
|
word-break: break-word;
|
|
|
white-space: pre-wrap;
|
|
|
}
|
|
|
|
|
|
[fiction.live]
|
|
|
## Recommended if you include images, fiction.live tends to have many
|
|
|
## duplicated images.
|
|
|
#dedup_img_files:true
|
|
|
|
|
|
## fiction.live spoilers display as a (blank) block until clicked, then they can become inline text.
|
|
|
## with true, adds them to an outlined block marked as a spoiler.
|
|
|
## with false, the text of the spoiler is unmarked and present in the work, as though alreday clicked
|
|
|
#legend_spoilers:true
|
|
|
## display 'spoiler' tags in the tag list, which can contain plot details
|
|
|
#show_spoiler_tags:false
|
|
|
## don't fetch covers marked as nsfw. covers for fiction.live can't be pornographic, but can get very close.
|
|
|
#show_nsfw_cover_images:false
|
|
|
## displays the timestamps on the story chunks, showing when each part went live.
|
|
|
#show_timestamps:false
|
|
|
|
|
|
## site has more original than fan fiction
|
|
|
extratags:
|
|
|
|
|
|
extra_valid_entries:tags, likes, live, reader_input
|
|
|
extra_titlepage_entries:tags, likes, live, reader_input
|
|
|
extra_subject_tags:tags
|
|
|
tags_label:Tags
|
|
|
live_label:Next Live Session
|
|
|
live_format:%%Y-%%m-%%d at %%H:%%M %%p
|
|
|
likes_label:Likes
|
|
|
reader_input_label:Reader Input
|
|
|
keep_in_order_tags:true
|
|
|
|
|
|
add_to_keep_html_attrs:,style
|
|
|
|
|
|
add_to_output_css:
|
|
|
table.voteblock { border-collapse: collapse; }
|
|
|
td { padding: 0.5em; }
|
|
|
td.votecount { text-align: right; }
|
|
|
.dice {
|
|
|
border-left: 1px solid;
|
|
|
padding-left: 0.25em;
|
|
|
}
|
|
|
.choiceitem {
|
|
|
border-bottom: 1px solid gray;
|
|
|
padding: 0.5em;
|
|
|
}
|
|
|
div.ut {
|
|
|
font-size: xx-small;
|
|
|
text-align: right;
|
|
|
opacity: 0.5;
|
|
|
}
|
|
|
|
|
|
[fictionhunt.com]
|
|
|
use_basic_cache:true
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Archive only site for ffnet stories.
|
|
|
|
|
|
extra_valid_entries: origin,originUrl,originHTML
|
|
|
originHTML_label:Original Story URL
|
|
|
|
|
|
## Assume entryUrl, apply to "<a class='%slink' href='%s'>%s</a>" to
|
|
|
## make entryHTML.
|
|
|
make_linkhtml_entries:origin
|
|
|
|
|
|
add_to_extra_titlepage_entries:originHTML
|
|
|
|
|
|
## dateUpdated/datePublished don't usually have time, but they do on this site.
|
|
|
## http://docs.python.org/library/datetime.html#strftime-strptime-behavior
|
|
|
## Note that ini format requires % to be escaped as %%.
|
|
|
dateUpdated_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
datePublished_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
|
|
|
[fictionmania.tv]
|
|
|
use_basic_cache:true
|
|
|
website_encodings:ISO-8859-1,auto
|
|
|
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:fileName,fileSize,oldName,newName,keyWords,mainCharactersAge,readings
|
|
|
|
|
|
## Turns all space characters into " " HTML entities to forcefully preserve
|
|
|
## formatting with spaces. Enabling this will blow up the filesize quite a bit
|
|
|
## and is probably not a good idea, unless you absolutely need the story
|
|
|
## formatting.
|
|
|
## Specific to fictionmania.tv
|
|
|
non_breaking_spaces:false
|
|
|
|
|
|
## fictionmania.tv serves both text and html versions. Pre-Dec 2019,
|
|
|
## FFF always used the text version. Now, FFF downloads the html
|
|
|
## version, but setting download_text_version will use the same code
|
|
|
## and text version as before.
|
|
|
download_text_version:false
|
|
|
|
|
|
## Clear FanFiction from defaults, site is original fiction.
|
|
|
extratags:
|
|
|
|
|
|
[ficwad.com]
|
|
|
use_basic_cache:true
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
[finestories.com]
|
|
|
use_basic_cache:true
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
## finestories.com has started requiring login by email rather than
|
|
|
## pen name.
|
|
|
#username:youremail@yourdomain.dom
|
|
|
#password:yourpassword
|
|
|
|
|
|
## dateUpdated/datePublished don't usually have time, but they do on this site.
|
|
|
## http://docs.python.org/library/datetime.html#strftime-strptime-behavior
|
|
|
## Note that ini format requires % to be escaped as %%.
|
|
|
dateUpdated_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
datePublished_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
|
|
|
## Clear FanFiction from defaults, site is original fiction.
|
|
|
extratags:
|
|
|
|
|
|
extra_valid_entries:size,universe,universeUrl,universeHTML,sitetags,notice,codes,score
|
|
|
#extra_titlepage_entries:size,universeHTML,sitetags,notice,score
|
|
|
include_in_codes:sitetags
|
|
|
|
|
|
## adds to include_subject_tags instead of replacing it.
|
|
|
#extra_subject_tags:sitetags
|
|
|
|
|
|
size_label:Size
|
|
|
universe_label:Universe
|
|
|
universeUrl_label:Universe URL
|
|
|
universeHTML_label:Universe
|
|
|
sitetags_label:Site Tags
|
|
|
notice_label:Notice
|
|
|
score_label:Score
|
|
|
|
|
|
## Assume entryUrl, apply to "<a class='%slink' href='%s'>%s</a>" to
|
|
|
## make entryHTML.
|
|
|
make_linkhtml_entries:universe
|
|
|
|
|
|
## finestories.com stories can be in a series and/or a universe. By
|
|
|
## default, series will be populated with the universe if there is
|
|
|
## universe but not series.
|
|
|
universe_as_series: true
|
|
|
|
|
|
## some sites include images that we don't ever want becoming the
|
|
|
## cover image. This lets you exclude them.
|
|
|
cover_exclusion_regexp:/css/bir.png
|
|
|
|
|
|
## This site uses shortened title chapters in chapter lists. When set
|
|
|
## true, this will inject the site's full length chapter title into
|
|
|
## the chapter text in a smaller h4 tag.
|
|
|
#inject_chapter_title:false
|
|
|
|
|
|
## append_datepublished_to_storyurl literally appends
|
|
|
## datePublished(-%Y-%m-%d) to storyUrl. This is an ugly kludge to
|
|
|
## (hopefully) help address the site's unfortunately habit of
|
|
|
## *reusing* storyId numbers. Off by default to *not* cause weirdness
|
|
|
## for those not expecting it.
|
|
|
#append_datepublished_to_storyurl:false
|
|
|
|
|
|
[forum.questionablequesting.com]
|
|
|
## see [base_xenforoforum]
|
|
|
|
|
|
## QQ shows more posts per reader page than other XF sites.
|
|
|
reader_posts_per_page:30
|
|
|
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
[forums.spacebattles.com]
|
|
|
## see [base_xenforoforum]
|
|
|
|
|
|
[forums.sufficientvelocity.com]
|
|
|
## see [base_xenforoforum]
|
|
|
|
|
|
[gluttonyfiction.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
[hlfiction.net]
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Highlander
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[imagine.e-fic.com]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. In commandline version, this should go in your
|
|
|
## personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[inkbunny.net]
|
|
|
use_basic_cache:true
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
[ksarchive.com]
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Star Trek
|
|
|
extracharacters:Kirk,Spock
|
|
|
extraships:Kirk/Spock
|
|
|
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:universe,crossoverfandom
|
|
|
universe_label:Universe
|
|
|
crossoverfandom_label:Crossover Fandom
|
|
|
extra_titlepage_entries:universe,crossoverfandom
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[lcfanfic.com]
|
|
|
use_basic_cache:true
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Lois & Clark: The New Adventures of Superman
|
|
|
|
|
|
[literotica.com]
|
|
|
use_basic_cache:true
|
|
|
user_agent:
|
|
|
extra_valid_entries:eroticatags,averrating
|
|
|
eroticatags_label:Erotica Tags
|
|
|
averrating_label:Average Rating
|
|
|
extra_titlepage_entries:eroticatags,averrating
|
|
|
|
|
|
## Extract more erotica_tags from the meta tag of each chapter
|
|
|
use_meta_keywords: true
|
|
|
|
|
|
## Chapters can be in different categories. Default to not using all
|
|
|
## to be consistent with previous version.
|
|
|
chapter_categories_use_all: false
|
|
|
|
|
|
## For multiple chapter stories, attempt to clean up the chapter title. This will
|
|
|
## remove the story title and change "Ch. 01" to "Chapter 1", "Pt. 01" to "Part 1"
|
|
|
## or just use the text. If this can't be done, the full title is used.
|
|
|
clean_chapter_titles: false
|
|
|
|
|
|
## Add the chapter description at the start of each chapter.
|
|
|
description_in_chapter: false
|
|
|
|
|
|
## Force chapters in a story to be sorted by date instead of the order
|
|
|
## given by the author. Used to be the default for literotica.
|
|
|
## Note that FFF normalizes literotica.com story URLs to the first
|
|
|
## chapter URL. If the first chapter is not the same by date and by
|
|
|
## list, you may need to set order_chapters_by_date under *both*
|
|
|
## [storyURL] sections.
|
|
|
order_chapters_by_date:false
|
|
|
|
|
|
## Clear FanFiction from defaults, site is original fiction.
|
|
|
extratags:Erotica
|
|
|
|
|
|
[lumos.sycophanthex.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Harry Potter
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[mcstories.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Clear FanFiction from defaults, site is original fiction.
|
|
|
extratags:Erotica
|
|
|
|
|
|
extra_valid_entries:eroticatags
|
|
|
eroticatags_label:Erotica Tags
|
|
|
extra_titlepage_entries: eroticatags
|
|
|
|
|
|
[mtt.just-once.net]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:The Office
|
|
|
|
|
|
[ninelivesarchive.com]
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:The Walking Dead
|
|
|
extracharacters:Carol,Daryl
|
|
|
extraships:Carol/Daryl
|
|
|
|
|
|
[novelfull.com]
|
|
|
use_basic_cache:true
|
|
|
extra_valid_entries:averrating
|
|
|
averrating_label:Average Rating
|
|
|
|
|
|
## Clear FanFiction from defaults, site is original fiction.
|
|
|
extratags:
|
|
|
|
|
|
slow_down_sleep_time:2
|
|
|
|
|
|
[novelonlinefull.com]
|
|
|
use_basic_cache:true
|
|
|
website_encodings: utf8:ignore, Windows-1252, iso-8859-1
|
|
|
|
|
|
## Clear FanFiction from defaults, site is original fiction.
|
|
|
extratags:
|
|
|
|
|
|
## Attempt to fix p and br excess from HTML in great many stories
|
|
|
fix_excess_space:true
|
|
|
|
|
|
[noveltrove.com]
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:copyright
|
|
|
copyright_label: Copyright
|
|
|
extra_titlepage_entries: copyright
|
|
|
|
|
|
[occlumency.sycophanthex.com]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Harry Potter
|
|
|
extracharacters:Severus Snape
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[ponyfictionarchive.net]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:My Little Pony: Friendship is Magic
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[pretendercentre.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:The Pretender
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[quotev.com]
|
|
|
use_basic_cache:true
|
|
|
|
|
|
## Using cloudscraper can satisfy the first couple levels of
|
|
|
## Cloudflare bot-proofing, but not all levels. Older versions of
|
|
|
## OpenSSL will also raise problems, so versions of Calibre older than
|
|
|
## v5 will probably fail. Only a few sites are configured with
|
|
|
## use_cloudscraper:true by default, but it can be applied in other
|
|
|
## sites' ini sections. user_agent setting is ignored when
|
|
|
## use_cloudscraper:true
|
|
|
use_cloudscraper:true
|
|
|
|
|
|
slow_down_sleep_time:2
|
|
|
extra_valid_entries:pages,readers,reads,favorites,searchtags,comments
|
|
|
pages_label:Pages
|
|
|
readers_label:Readers
|
|
|
reads_label:Reads
|
|
|
favorites_label:Favorites
|
|
|
searchtags_label:Search Tags
|
|
|
comments_label:Comments
|
|
|
|
|
|
include_in_category:category,searchtags
|
|
|
|
|
|
add_to_comma_entries:,pages,readers,reads,favorites,comments
|
|
|
|
|
|
website_encodings: utf8:ignore, Windows-1252, iso-8859-1
|
|
|
|
|
|
[readonlymind.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
## Login on readonlymind.com is optional and not used for adultcheck
|
|
|
#is_adult:true
|
|
|
|
|
|
## readonlymind.com chapters may have an author's note attached to them.
|
|
|
## Setting include_author_notes:true will include it with the chapter text.
|
|
|
#include_author_notes:false
|
|
|
|
|
|
## Clear FanFiction from defaults, site is original fiction.
|
|
|
extratags:Erotica
|
|
|
|
|
|
extra_valid_entries:eroticatags
|
|
|
eroticatags_label:Erotica Tags
|
|
|
extra_titlepage_entries: eroticatags
|
|
|
|
|
|
## some tags are used as series identification. There is no way to find a
|
|
|
## sequence, but at least the stories will be grouped. Use the tag as written
|
|
|
## without the hash mark. Keep underscores '_' in, they will be replaced by
|
|
|
## spaces in the metadata.
|
|
|
#series_tags:Human_Domestication_Guide
|
|
|
|
|
|
## If you want underscores replaced in the tags:
|
|
|
#add_to_replace_metadata:
|
|
|
# eroticatags=>_=>\s
|
|
|
|
|
|
[samandjack.net]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. In commandline version, this should go in your
|
|
|
## personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Stargate: SG-1
|
|
|
extracharacters:Sam,Jack
|
|
|
extraships:Sam/Jack
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[scifistories.com]
|
|
|
use_basic_cache:true
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
## scifistories.com has started requiring login by email rather than
|
|
|
## pen name.
|
|
|
#username:youremail@yourdomain.dom
|
|
|
#password:yourpassword
|
|
|
|
|
|
## dateUpdated/datePublished don't usually have time, but they do on this site.
|
|
|
## http://docs.python.org/library/datetime.html#strftime-strptime-behavior
|
|
|
## Note that ini format requires % to be escaped as %%.
|
|
|
dateUpdated_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
datePublished_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
|
|
|
## Clear FanFiction from defaults, site is original fiction.
|
|
|
extratags:
|
|
|
|
|
|
extra_valid_entries:size,universe,universeUrl,universeHTML,sitetags,notice,codes,score
|
|
|
#extra_titlepage_entries:size,universeHTML,sitetags,notice,score
|
|
|
include_in_codes:sitetags
|
|
|
|
|
|
## adds to include_subject_tags instead of replacing it.
|
|
|
#extra_subject_tags:sitetags
|
|
|
|
|
|
size_label:Size
|
|
|
universe_label:Universe
|
|
|
universeUrl_label:Universe URL
|
|
|
universeHTML_label:Universe
|
|
|
sitetags_label:Site Tags
|
|
|
notice_label:Notice
|
|
|
score_label:Score
|
|
|
|
|
|
## Assume entryUrl, apply to "<a class='%slink' href='%s'>%s</a>" to
|
|
|
## make entryHTML.
|
|
|
make_linkhtml_entries:universe
|
|
|
|
|
|
## scifistories.com stories can be in a series and/or a universe. By
|
|
|
## default, series will be populated with the universe if there is
|
|
|
## universe but not series.
|
|
|
universe_as_series: true
|
|
|
|
|
|
## some sites include images that we don't ever want becoming the
|
|
|
## cover image. This lets you exclude them.
|
|
|
cover_exclusion_regexp:/css/bir.png
|
|
|
|
|
|
## This site uses shortened title chapters in chapter lists. When set
|
|
|
## true, this will inject the site's full length chapter title into
|
|
|
## the chapter text in a smaller h4 tag.
|
|
|
#inject_chapter_title:false
|
|
|
|
|
|
## append_datepublished_to_storyurl literally appends
|
|
|
## datePublished(-%Y-%m-%d) to storyUrl. This is an ugly kludge to
|
|
|
## (hopefully) help address the site's unfortunately habit of
|
|
|
## *reusing* storyId numbers. Off by default to *not* cause weirdness
|
|
|
## for those not expecting it.
|
|
|
#append_datepublished_to_storyurl:false
|
|
|
|
|
|
[sheppardweir.com]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. In commandline version, this should go in your
|
|
|
## personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Stargate: Atlantis
|
|
|
extracharacters:John Sheppard,Elizabeth Weir
|
|
|
extraships:John Sheppard/Elizabeth Weir
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[spikeluver.com]
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:warnings,reviews
|
|
|
reviews_label:Reviews
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracharacters:Spike,Buffy
|
|
|
extracategories:Buffy the Vampire Slayer
|
|
|
|
|
|
[squidgeworld.org]
|
|
|
## squidgeworld.org is the first OTW site other than AO3. If/when a
|
|
|
## third comes along, we should refactor to use a common
|
|
|
## base_otw_adapter instead of just subclassing AO3. Note that
|
|
|
## ao3categories is still used, but labeled "SquidgeWorld Categories".
|
|
|
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## In order to get bookmarktags and bookmarksummary, you need to login
|
|
|
## all the time. This defaults to off to save time and network
|
|
|
## traffic. Requires valid username and password when true.
|
|
|
#always_login:false
|
|
|
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. In commandline version, this should go in your
|
|
|
## personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## OTW offers a page to download the entire work at once. This can
|
|
|
## save a lot of network traffic if there are many chapters.
|
|
|
## True by built-in default.
|
|
|
#use_view_full_work:true
|
|
|
|
|
|
## squidgeworld.org stories allow chapters to be added out of
|
|
|
## order. So the newest chapter may not be the last one. FanFicFare update
|
|
|
## doesn't like that. If do_update_hook is uncommented and set true,
|
|
|
## the adapter will discard all existing chapters from the newest one
|
|
|
## on when updating to enforce accurate chapters.
|
|
|
## Starting July 2015, FFF stores chapter URLs in the chapter files.
|
|
|
## Stories downloaded after that shouldn't need this setting anymore.
|
|
|
#do_update_hook:false
|
|
|
|
|
|
## Some adapters collect additional meta information beyond the
|
|
|
## standard ones. They need to be defined in extra_valid_entries to
|
|
|
## tell the rest of the FanFicFare system about them. They can be
|
|
|
## used in include_subject_tags, titlepage_entries,
|
|
|
## extra_titlepage_entries, logpage_entries, extra_logpage_entries,
|
|
|
## and include_in_* config items. You can also add additional entries
|
|
|
## here to build up composite metadata entries.
|
|
|
## squidgeworld.org, for example, fills genre (a standard
|
|
|
## entry) as the composite offreeformtags, ao3categories in
|
|
|
## include_in_genre. If there's ever more than 4 series, add
|
|
|
## series04,series04Url etc.
|
|
|
extra_valid_entries:fandoms, freeformtags, freefromtags,
|
|
|
ao3categories, comments, chapterslashtotal, chapterstotal, kudos,
|
|
|
hits, bookmarks, collections, byline, bookmarked, bookmarktags,
|
|
|
bookmarksummary, bookmarkprivate, bookmarkrec, restricted, series00,
|
|
|
series01, series02, series03, series00Url, series01Url, series02Url,
|
|
|
series03Url, series00HTML, series01HTML, series02HTML, series03HTML
|
|
|
fandoms_label:Fandoms
|
|
|
freeformtags_label:Freeform Tags
|
|
|
freefromtags_label:Freeform Tags
|
|
|
ao3categories_label:SquidgeWorld Categories
|
|
|
comments_label:Comments
|
|
|
chapterslashtotal_label:Chapters/Total Chapters
|
|
|
chapterstotal_label:Total Chapters
|
|
|
kudos_label:Kudos
|
|
|
hits_label:Hits
|
|
|
collections_label:Collections
|
|
|
## Count of bookmarks on story by all users
|
|
|
bookmarks_label:Bookmarks
|
|
|
## Tags & Summary from *your* bookmark on the story. Only collected
|
|
|
## if always_login:true
|
|
|
bookmarked_label:I Bookmarked Story
|
|
|
bookmarktags_label:My Bookmark Tags
|
|
|
bookmarksummary_label:My Bookmark Summary
|
|
|
bookmarkprivate_label:My Bookmark Private
|
|
|
bookmarkrec_label:My Bookmark Rec
|
|
|
restricted_label:Restricted to Registered Users
|
|
|
series00HTML_label:Series
|
|
|
series01HTML_label:Additional Series
|
|
|
series02HTML_label:Additional Series
|
|
|
series03HTML_label:Additional Series
|
|
|
|
|
|
## Assume entryUrl, apply to "<a class='%slink' href='%s'>%s</a>" to
|
|
|
## make entryHTML.
|
|
|
make_linkhtml_entries:series00,series01,series02,series03
|
|
|
|
|
|
## OTW doesn't have anything it calls 'genre'. The adapter used to be
|
|
|
## hardcoded to include the site specific metadata freeformtags &
|
|
|
## ao3categories in the standard metadata field genre. By making it
|
|
|
## configurable, users can change it.
|
|
|
include_in_genre: freeformtags, ao3categories
|
|
|
|
|
|
## OTW 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
|
|
|
|
|
|
## freeformtags was previously typo'ed as freefromtags. This way,
|
|
|
## freefromtags will still work for people who've used it.
|
|
|
include_in_freefromtags:freeformtags
|
|
|
|
|
|
## chapterslashtotal contains 1/3 or 1/1 or 3/? etc as reported by OTW.
|
|
|
## chapterstotal is just the total chapters part after the /
|
|
|
include_in_chapterstotal:chapterslashtotal.NOREPL
|
|
|
add_to_replace_metadata:
|
|
|
chapterstotal=>^([0-9])+/(.+)$=>\2
|
|
|
|
|
|
## adds to titlepage_entries instead of replacing it.
|
|
|
#extra_titlepage_entries: fandoms,freeformtags,ao3categories,comments,chapterslashtotal,chapterstotal,kudos,hits,bookmarks,bookmarked,bookmarktags,bookmarksummary,series01HTML,series02HTML,series03HTML,byline
|
|
|
|
|
|
## adds to include_subject_tags instead of replacing it.
|
|
|
#extra_subject_tags:fandoms,freeformtags,ao3categories
|
|
|
|
|
|
## OTW chapters can include several different types of notes. We've
|
|
|
## traditionally included them all in the chapter text, but this allows
|
|
|
## you to customize which you include. Copy this parameter to your
|
|
|
## personal.ini and list the ones you don't want.
|
|
|
#exclude_notes:authorheadnotes,chaptersummary,chapterheadnotes,chapterfootnotes,authorfootnotes,inspiredlinks
|
|
|
|
|
|
## OTW authorfootnotes and inspiredlinks end up in the 'last' chapter,
|
|
|
## but if updated, then there's a new 'last' chapter, leaving multiple
|
|
|
## copies. This option applies the 'skip_on_ffdl_update' class to
|
|
|
## those tags which means they will be removed during epub reading for
|
|
|
## update. This will only effect chapters added after turning the
|
|
|
## setting on.
|
|
|
## Result: Only the last chapter will have end notes.
|
|
|
## Side-effect: An 'Update Always' that doesn't add a new last
|
|
|
## chapter will also remove the end notes.
|
|
|
#remove_authorfootnotes_on_update:false
|
|
|
|
|
|
## OTW is blocking people more aggressively. If you download fewer
|
|
|
## stories less often you can likely get by with reducing this sleep.
|
|
|
slow_down_sleep_time:2
|
|
|
|
|
|
## OTW allows users to archive stories they didn't write in certain
|
|
|
## cases. These are indicated by showing a byline such as:
|
|
|
## 'Orig Author [archived by Archivist Author]'
|
|
|
## If use_archived_author is set true (and there's only one author
|
|
|
## listed), author will be set to 'Orig Author' instead of 'Archivist
|
|
|
## Author'. authorUrl will still point to the Archivist Author's page.
|
|
|
#use_archived_author:false
|
|
|
|
|
|
## OTW chapters have 'date' available for each chapter.
|
|
|
## These can be used with custom output (see
|
|
|
## https://github.com/JimmXinu/FanFicFare/wiki/CustomOutput ) or with
|
|
|
## chapter_title_*_pattern settings.
|
|
|
## Examples for html & epub:
|
|
|
#[html]
|
|
|
#tocpage_entry:
|
|
|
# <a href="#section${index04}">${chapter}</a> ${date}<br />
|
|
|
#[epub]
|
|
|
#tocpage_entry:
|
|
|
# <a href="file${index04}.xhtml">${chapter}</a> ${date}<br /><br />
|
|
|
|
|
|
## The 'date' value for chapters mentioned above can be formated with
|
|
|
## datechapter_format. Otherwise it will default to
|
|
|
## datePublished_format
|
|
|
#datechapter_format:%%Y-%%m-%%d
|
|
|
|
|
|
[starslibrary.net]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:youremail@yourdomain.dom
|
|
|
#password:yourpassword
|
|
|
|
|
|
[storiesonline.net]
|
|
|
use_basic_cache:true
|
|
|
slow_down_sleep_time:1
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
## storiesonline.net has started requiring login by email rather than
|
|
|
## pen name.
|
|
|
#username:youremail@yourdomain.dom
|
|
|
#password:yourpassword
|
|
|
|
|
|
## dateUpdated/datePublished don't usually have time, but they do on this site.
|
|
|
## http://docs.python.org/library/datetime.html#strftime-strptime-behavior
|
|
|
## Note that ini format requires % to be escaped as %%.
|
|
|
dateUpdated_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
datePublished_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
|
|
|
## Clear FanFiction from defaults, site is original fiction.
|
|
|
extratags:
|
|
|
|
|
|
extra_valid_entries:size,universe,universeUrl,universeHTML,sitetags,notice,codes,score
|
|
|
#extra_titlepage_entries:size,universeHTML,sitetags,notice,score
|
|
|
include_in_codes:sitetags
|
|
|
|
|
|
## adds to include_subject_tags instead of replacing it.
|
|
|
#extra_subject_tags:sitetags
|
|
|
|
|
|
size_label:Size
|
|
|
universe_label:Universe
|
|
|
universeUrl_label:Universe URL
|
|
|
universeHTML_label:Universe
|
|
|
sitetags_label:Site Tags
|
|
|
notice_label:Notice
|
|
|
score_label:Score
|
|
|
|
|
|
## Assume entryUrl, apply to "<a class='%slink' href='%s'>%s</a>" to
|
|
|
## make entryHTML.
|
|
|
make_linkhtml_entries:universe
|
|
|
|
|
|
## storiesonline.net stories can be in a series and/or a universe. By
|
|
|
## default, series will be populated with the universe if there is
|
|
|
## universe but not series.
|
|
|
universe_as_series: true
|
|
|
|
|
|
## some sites include images that we don't ever want becoming the
|
|
|
## cover image. This lets you exclude them.
|
|
|
cover_exclusion_regexp:/css/bir.png
|
|
|
|
|
|
## This site uses shortened title chapters in chapter lists. When set
|
|
|
## true, this will inject the site's full length chapter title into
|
|
|
## the chapter text in a smaller h4 tag.
|
|
|
#inject_chapter_title:false
|
|
|
|
|
|
## append_datepublished_to_storyurl literally appends
|
|
|
## datePublished(-%Y-%m-%d) to storyUrl. This is an ugly kludge to
|
|
|
## (hopefully) help address the site's unfortunately habit of
|
|
|
## *reusing* storyId numbers. Off by default to *not* cause weirdness
|
|
|
## for those not expecting it.
|
|
|
#append_datepublished_to_storyurl:false
|
|
|
|
|
|
[t.evancurrie.ca]
|
|
|
# was fanfiction.tenhawkpresents.ink
|
|
|
use_basic_cache:true
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[tgstorytime.com]
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Transgender
|
|
|
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content.
|
|
|
#is_adult:true
|
|
|
|
|
|
## This site has a number of additional site specific metadata
|
|
|
## entries. This is the first test case of base_efiction 'Auto
|
|
|
## metadata' automatically including unrecognized metadata. Still
|
|
|
## requires entries in extra_valid_entries to be used.
|
|
|
extra_valid_entries:turnedinto,featureditems,locale,motivationforchange,sexualorientation,storytheme,bodymodification,personality,storytype,typeofchange
|
|
|
#add_to_titlepage_entries:,turnedinto,featureditems,locale,motivationforchange,sexualorientation,storytheme,bodymodification,personality,storytype,typeofchange
|
|
|
|
|
|
turnedinto_label:Turned Into
|
|
|
featureditems_label:Featured Items
|
|
|
locale_label:Locale
|
|
|
motivationforchange_label:Motivation for Change
|
|
|
sexualorientation_label:Sexual Orientation
|
|
|
storytheme_label:Story Theme
|
|
|
bodymodification_label:Body Modification
|
|
|
personality_label:Personality
|
|
|
storytype_label:Story Type
|
|
|
typeofchange_label:Type of Change
|
|
|
|
|
|
## Clear FanFiction from defaults, site is original fiction.
|
|
|
extratags:
|
|
|
|
|
|
[thehookupzone.net]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. In commandline version, this should go in your
|
|
|
## personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Criminal Minds
|
|
|
|
|
|
[themasque.net]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. In commandline version, this should go in your
|
|
|
## personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[trekfanfiction.net]
|
|
|
use_basic_cache:true
|
|
|
website_encodings:utf8,Windows-1252,iso-8859-1
|
|
|
|
|
|
[voracity2.e-fic.com]
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:reviews,readings
|
|
|
reviews_label:Reviews
|
|
|
readings_label:Readings
|
|
|
|
|
|
[wattpad.com]
|
|
|
use_basic_cache:true
|
|
|
#is_adult:true
|
|
|
extra_titlepage_entries: language, reads
|
|
|
extra_valid_entries: language, tags, reads
|
|
|
reads_label:Read Count
|
|
|
include_in_genre: tags
|
|
|
|
|
|
# Add comma separators for numeric reads. Eg 10000 becomes 10,000
|
|
|
add_to_comma_entries:,reads
|
|
|
|
|
|
## number of seconds to sleep between calls to the story site. There
|
|
|
## are reports that sound like site throttling without it.
|
|
|
slow_down_sleep_time:2
|
|
|
|
|
|
## wattpad.com chapters can have a banner image at the top of the
|
|
|
## page. When include_chapter_banner_images:true the banner image
|
|
|
## will be prepended to the chapter text during download as:
|
|
|
## <img class="photoUrl banner-image" src="<img url>">
|
|
|
include_chapter_banner_images:true
|
|
|
|
|
|
[www.adastrafanfic.com]
|
|
|
use_basic_cache:true
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Star Trek
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.alternatehistory.com]
|
|
|
## see [base_xenforoforum]
|
|
|
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
[www.asexstories.com]
|
|
|
## 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
|
|
|
|
|
|
## This site has links to a vidow site embeded in the text. They are
|
|
|
## not needed, and will be removed if the below property is set to true
|
|
|
strip_text_links:true
|
|
|
|
|
|
[www.asianfanfics.com]
|
|
|
use_basic_cache:true
|
|
|
slow_down_sleep_time:2
|
|
|
## Unlike most sites, asianfanfics.com, instead of denying access to
|
|
|
## 'adult' or subscriber-only content, will censor the text of stories
|
|
|
## to remove 'adult' words or entire portions of the text. This is why
|
|
|
## an account is required to download stories from this site. It is
|
|
|
## also strongly recommended to consider enabling auto_sub in order to
|
|
|
## further avoid this from happening.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. In commandline version, this should go in your
|
|
|
## personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Additional metadata entries.
|
|
|
extra_valid_entries:tags,characters,upvotes,subscribers,views
|
|
|
tags_label:Tags
|
|
|
characters_label:Characters
|
|
|
upvotes_label:Upvotes
|
|
|
subscribers_label:Subscribers
|
|
|
views_label:Views
|
|
|
|
|
|
include_in_category:tags
|
|
|
|
|
|
#extra_titlepage_entries:upvotes,subscribers,views
|
|
|
|
|
|
## This site uses shortened title chapters in chapter lists. When set
|
|
|
## true, this will inject the site's full length chapter title into
|
|
|
## the chapter text in a smaller h4 tag.
|
|
|
#inject_chapter_title:false
|
|
|
|
|
|
## This website removes certain HTML tags and portions of the story
|
|
|
## from subscriber-only stories. It is strongly recommended to turn
|
|
|
## this option on. This will automatically subscribe you to such
|
|
|
## stories in order to acquire the unaltered text. You can
|
|
|
## unsubscribe manually on the website after the story has been
|
|
|
## downloaded.
|
|
|
auto_sub:false
|
|
|
|
|
|
[www.bdsmlibrary.com]
|
|
|
use_basic_cache:true
|
|
|
## 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
|
|
|
|
|
|
extra_valid_entries:eroticatags,size,comments
|
|
|
size_label: Size
|
|
|
comments_label: Comments
|
|
|
eroticatags_label:Erotica Tags
|
|
|
extra_titlepage_entries:size,comments,eroticatags
|
|
|
keep_style_attr: false
|
|
|
|
|
|
[www.destinysgateway.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.deviantart.com]
|
|
|
use_basic_cache:true
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Clear FanFiction from defaults, dA also hosts original fiction.
|
|
|
extratags:
|
|
|
|
|
|
[www.dokuga.com]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:InuYasha
|
|
|
extracharacters:Sesshoumaru,Kagome
|
|
|
extraships:Sesshoumaru/Kagome
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.dracoandginny.com]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Some sites also require the user to confirm they are adult for
|
|
|
## adult content. In commandline version, this should go in your
|
|
|
## personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Harry Potter
|
|
|
extracharacters:Draco Malfoy,Ginny Weasley
|
|
|
extraships:Draco Malfoy/Ginny Weasley
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.efpfanfic.net]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:notes,context,type
|
|
|
notes_label:Notes
|
|
|
context_label:Context
|
|
|
type_label:Type of Couple
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.fanfiction.net]
|
|
|
use_basic_cache:true
|
|
|
|
|
|
## Errors on more common during long downloads. This way, at least
|
|
|
## the chapters the worked are saved. Often running an update will
|
|
|
## fix the error chapters.
|
|
|
continue_on_chapter_error:true
|
|
|
|
|
|
## browser cache will only be used if use_browser_cache:true and ONLY
|
|
|
## for a few sites. Requires a browser_cache_path set in
|
|
|
## [defaults].
|
|
|
#use_browser_cache:false
|
|
|
|
|
|
## use_browser_cache_only:true prevents FFF from falling through to
|
|
|
## request from the server when a page isn't in the browser cache.
|
|
|
## You can turn this on to be sure you're only using the browser
|
|
|
## cache.
|
|
|
#use_browser_cache_only:false
|
|
|
|
|
|
## fanfiction.net's 'cover' images are really just tiny thumbnails.
|
|
|
## Set this to true to never use them.
|
|
|
#never_make_cover: false
|
|
|
|
|
|
## exclude fanfiction.net imageu (old user vs story detect) and
|
|
|
## default user (d_60_90)
|
|
|
cover_exclusion_regexp:(/imageu/|d_60_90\.jpg)
|
|
|
|
|
|
## April 2015, ffnet changed their story and user pictures urls to be
|
|
|
## the same. Now the only way to know if the story image is really
|
|
|
## the author image is to go get the author image and check.
|
|
|
skip_author_cover:true
|
|
|
|
|
|
## fanfiction.net is blocking people more aggressively. If you
|
|
|
## download fewer stories less often you can likely get by with
|
|
|
## reducing this sleep.
|
|
|
slow_down_sleep_time:12
|
|
|
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:reviews,favs,follows
|
|
|
|
|
|
## ffnet uses 'Pairings', not 'Relationship', stating they don't have
|
|
|
## to be romantic pairings.
|
|
|
ships_label:Pairings
|
|
|
|
|
|
## Date formats used by FanFicFare. Published and Update don't usually have
|
|
|
## time, but they do now on ffnet.
|
|
|
## See http://docs.python.org/library/datetime.html#strftime-strptime-behavior
|
|
|
## Note that ini format requires % to be escaped as %%.
|
|
|
#dateCreated_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
datePublished_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
dateUpdated_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
|
|
|
## ffnet used to have a tendency to send out update notices in email
|
|
|
## before all their servers were showing the update on the first
|
|
|
## chapter. It generates another server request and doesn't seem to
|
|
|
## be needed lately, so now default it to off.
|
|
|
check_next_chapter:false
|
|
|
|
|
|
## ffnet sometimes doesn't update the metadata on the first chapter
|
|
|
## immediately. meta_from_last_chapter:true will instruct the adapter
|
|
|
## to take the metadata from the last chapter instead of chapter 1.
|
|
|
## It can generate another server request and usually isn't necessary,
|
|
|
## so it defaults to off.
|
|
|
meta_from_last_chapter:false
|
|
|
|
|
|
[www.fanfiktion.de]
|
|
|
use_basic_cache:true
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:native_status
|
|
|
|
|
|
[www.fictionalley-archive.org]
|
|
|
## also accepts fictionalley.org story URLs
|
|
|
use_basic_cache:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Harry Potter
|
|
|
|
|
|
## fictionalley-archive.org storyIds are not unique. Combine with authorId.
|
|
|
output_filename: ${title}-${siteabbrev}_${authorId}_${storyId}${formatext}
|
|
|
|
|
|
## fictionalley-archive.org doesn't have a status metadatum. If uncommented,
|
|
|
## this will be used for status.
|
|
|
#default_value_status:Unknown
|
|
|
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:house,era,spoilers,hits
|
|
|
|
|
|
## fictionalley-archive chapters have 'date', 'words', 'hits' and
|
|
|
## 'summary' available for each chapter. These can be used with
|
|
|
## custom output (see
|
|
|
## https://github.com/JimmXinu/FanFicFare/wiki/CustomOutput ) or with
|
|
|
## chapter_title_*_pattern settings.
|
|
|
## Examples for html & epub:
|
|
|
#[html]
|
|
|
#tocpage_entry:
|
|
|
# <a href="#section${index04}">${chapter}</a> ${date} ${words}<br />
|
|
|
#[epub]
|
|
|
#tocpage_entry:
|
|
|
# <a href="file${index04}.xhtml">${chapter}</a> ${date} ${words}<br /><br />
|
|
|
|
|
|
## The 'date' value for chapters mentioned above can be formated with
|
|
|
## datechapter_format. Otherwise it will default to
|
|
|
## datePublished_format
|
|
|
#datechapter_format:%%Y-%%m-%%d
|
|
|
|
|
|
## fictionalley-archive.org chapters can have author notes attached to
|
|
|
## them. Setting include_author_notes:true will include them with the
|
|
|
## chapter text. Includes both leading and trailing notes.
|
|
|
#include_author_notes:false
|
|
|
|
|
|
[www.fictionpress.com]
|
|
|
use_basic_cache:true
|
|
|
|
|
|
## Errors on more common during long downloads. This way, at least
|
|
|
## the chapters the worked are saved. Often running an update will
|
|
|
## fix the error chapters.
|
|
|
continue_on_chapter_error:true
|
|
|
|
|
|
## browser cache will only be used if use_browser_cache:true and ONLY
|
|
|
## for a few sites. Requires a browser_cache_path set in
|
|
|
## [defaults].
|
|
|
#use_browser_cache:false
|
|
|
|
|
|
## use_browser_cache_only:true prevents FFF from falling through to
|
|
|
## request from the server when a page isn't in the browser cache.
|
|
|
## You can turn this on to be sure you're only using the browser
|
|
|
## cache.
|
|
|
#use_browser_cache_only:false
|
|
|
|
|
|
## Clear FanFiction from defaults, fictionpress.com is original fiction.
|
|
|
extratags:
|
|
|
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:reviews,favs,follows
|
|
|
|
|
|
## fictionpress.com shows the user's
|
|
|
cover_exclusion_regexp:(/imageu/|d_60_90\.jpg)
|
|
|
|
|
|
## fictionpress.com is blocking people more aggressively. If you
|
|
|
## download fewer stories less often you can likely get by with
|
|
|
## reducing this sleep.
|
|
|
slow_down_sleep_time:8
|
|
|
|
|
|
## Date formats used by FanFicFare. Published and Update don't usually have
|
|
|
## time, but they do now on ffnet.
|
|
|
## See http://docs.python.org/library/datetime.html#strftime-strptime-behavior
|
|
|
## Note that ini format requires % to be escaped as %%.
|
|
|
#dateCreated_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
datePublished_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
dateUpdated_format:%%Y-%%m-%%d %%H:%%M:%%S
|
|
|
|
|
|
[www.fimfiction.net]
|
|
|
use_basic_cache:true
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## fimfiction.net stories can be locked requiring individual
|
|
|
## passwords. If fail_on_password is set, the downloader will fail
|
|
|
## when a password is required rather than prompting every time.
|
|
|
#fail_on_password: false
|
|
|
|
|
|
## fimfiction.net stories allow chapters to be added out of order. So
|
|
|
## the newest chapter may not be the last one. FanFicFare update doesn't
|
|
|
## like that. If do_update_hook is uncommented and set true, the
|
|
|
## adapter will discard all existing chapters from the newest one on
|
|
|
## when updating to enforce accurate chapters.
|
|
|
#do_update_hook:false
|
|
|
|
|
|
## fimfiction.net is reported to misinterprete some BBCode with
|
|
|
## blockquotes incorrectly. This fixes those instances and defaults
|
|
|
## to on, but can be switched off if it is found to cause problems.
|
|
|
fix_fimf_blockquotes:true
|
|
|
|
|
|
## fimfiction.net stories can have 'prequels' which it indicates by
|
|
|
## putting a link in the description. By default, those are removed
|
|
|
## in favor of the 'prequel' site specific metadata items. Setting
|
|
|
## keep_prequel_in_description:true will keep it instead.
|
|
|
#keep_prequel_in_description:false
|
|
|
|
|
|
## fimfiction.net chapters can have author notes attached to them.
|
|
|
## Setting include_author_notes:true will include them with the
|
|
|
## chapter text.
|
|
|
#include_author_notes:false
|
|
|
|
|
|
## some sites include images that we don't ever want becoming the
|
|
|
## cover image. This lets you exclude them.
|
|
|
cover_exclusion_regexp:/images/emoticons/
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:My Little Pony: Friendship is Magic
|
|
|
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:likes,dislikes,views,total_views,short_description,groups,groupsUrl,groupsHTML,prequel,prequelUrl,prequelHTML,sequels,sequelsUrl,sequelsHTML,comment_count,coverSource,coverSourceUrl,coverSourceHTML,authorLastLogin,content,fandoms
|
|
|
likes_label:Likes
|
|
|
dislikes_label:Dislikes
|
|
|
views_label:Highest Single Chapter Views
|
|
|
total_views_label:Total Views
|
|
|
short_description_label:Short Summary
|
|
|
groups_label:Groups
|
|
|
groupsUrl_label:Groups URLs
|
|
|
groupsHTML_label:Groups
|
|
|
prequel_label:Prequel
|
|
|
prequelUrl_label:Prequel URL
|
|
|
prequelHTML_label:Prequel
|
|
|
sequels_label:Sequels
|
|
|
sequelsUrl_label:Sequel URLs
|
|
|
sequelsHTML_label:Sequels
|
|
|
comment_count_label:Comment Count
|
|
|
coverSource_label:Cover Source
|
|
|
coverSourceUrl_label:Cover Source URL
|
|
|
coverSourceHTML_label:Cover Source
|
|
|
authorLastLogin_label:Author Last Logged In
|
|
|
content_label:Content
|
|
|
fandoms_label:Fandoms
|
|
|
|
|
|
keep_in_order_sequels:true
|
|
|
keep_in_order_sequelsUrl:true
|
|
|
keep_in_order_groups:true
|
|
|
keep_in_order_groupsUrl:true
|
|
|
|
|
|
## Assume entryUrl, apply to "<a class='%slink' href='%s'>%s</a>" to
|
|
|
## make entryHTML.
|
|
|
make_linkhtml_entries:prequel,sequels,groups,coverSource
|
|
|
|
|
|
## What are now content tags used to be included in genre. Copy to
|
|
|
## genre by default.
|
|
|
include_in_genre:genre,content
|
|
|
|
|
|
## What fimfiction.net has labeled 'fandoms', FFF historically calls
|
|
|
## 'category'. Commented out by default due to "My Little Pony:
|
|
|
## Friendship is Magic" from extracategories vs "MLP: FiM" in fandoms.
|
|
|
#include_in_category:category,fandoms
|
|
|
|
|
|
[www.fireflyfans.net]
|
|
|
website_encodings:Windows-1252,utf8,iso-8859-1
|
|
|
|
|
|
[www.giantessworld.net]
|
|
|
extra_valid_entries:growth, shrink, sizeroles
|
|
|
growth_label: Growth
|
|
|
shrink_label:Shrink
|
|
|
sizeroles_label:Size Roles
|
|
|
add_to_titlepage_entries:,growth, shrink, sizeroles
|
|
|
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
[www.hentai-foundry.com]
|
|
|
use_basic_cache:true
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
extra_valid_entries:comments,views,size,favs,vote_rating
|
|
|
add_to_titlepage_entries:,comments,views,size,favs,vote_rating
|
|
|
|
|
|
comments_label:Comments
|
|
|
views_label:Views
|
|
|
size_label:Size
|
|
|
favs_label:Faves
|
|
|
vote_rating_label:Votes(Rating)
|
|
|
|
|
|
## HF chapters have 'date', 'update', 'words', 'size', 'comments' and
|
|
|
## 'views' available for each chapter. These can be used with custom
|
|
|
## output (see
|
|
|
## https://github.com/JimmXinu/FanFicFare/wiki/CustomOutput ) or with
|
|
|
## chapter_title_*_pattern settings.
|
|
|
## Examples for html & epub:
|
|
|
#[html]
|
|
|
#tocpage_entry:
|
|
|
# <a href="#section${index04}">${chapter}</a> ${date} ${size}<br />
|
|
|
#[epub]
|
|
|
#tocpage_entry:
|
|
|
# <a href="file${index04}.xhtml">${chapter}</a> ${date} ${size}<br /><br />
|
|
|
|
|
|
## The 'date' and 'update' value for chapters mentioned above can be
|
|
|
## formated with datechapter_format. Otherwise it will default to
|
|
|
## datePublished_format
|
|
|
#datechapter_format:%%Y-%%m-%%d
|
|
|
|
|
|
## Sometimes (perhaps often?) HF stories word counts and size are
|
|
|
## incorrect. You can exclude them from being used like so:
|
|
|
#add_to_exclude_metadata_pre:
|
|
|
# numWords=~.*
|
|
|
# size=~.*
|
|
|
|
|
|
[www.libraryofmoria.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Lord of the Rings
|
|
|
|
|
|
[www.lotrgfic.com]
|
|
|
use_basic_cache:true
|
|
|
extra_valid_entries:places, times
|
|
|
places_label: Places
|
|
|
times_label:Times
|
|
|
add_to_titlepage_entries:,places, times
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
[www.lushstories.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
extra_valid_entries:eroticatags
|
|
|
eroticatags_label:Erotica Tags
|
|
|
extra_titlepage_entries:eroticatags
|
|
|
|
|
|
[www.masseffect2.in]
|
|
|
use_basic_cache:true
|
|
|
## Site dedicated to this fandom.
|
|
|
extracategories: Mass Effect
|
|
|
|
|
|
## Ucoz.com engine, upon which MassEffect2.in is based, imposes an
|
|
|
## unspecified limit on request frequency. Reports vary from `5
|
|
|
## requests per second' to `2 requests per second for more than 10 per
|
|
|
## minute'. With default settings, a several-hours IP ban may follow,
|
|
|
## so set it higher.
|
|
|
slow_down_sleep_time: 2
|
|
|
|
|
|
## Whether to exclude editor signature from the bottom of chapter text.
|
|
|
exclude_editor_signature: false
|
|
|
|
|
|
## Stories on the site almost never have cover image, and for the
|
|
|
## stories which do, this may be adjusted in `personal.ini' before
|
|
|
## downloading.
|
|
|
never_make_cover: true
|
|
|
|
|
|
## Titles for ratings identified by 1- or 2-letter codes from `ERATING system'
|
|
|
## (`система Р.Е.Й.Т.И.Н.Г.'). MassEffect2.in and some other sites adopted it,
|
|
|
## but changed titles and update them occasionally.
|
|
|
rating_titles: R=RESTRICTED (16+), E=EXEMPT (18+), I=ART HOUSE, T=To every, A=IN=Иной мир, Nn=Новый мир, G=О\, Господи!
|
|
|
adult_ratings: E,R
|
|
|
|
|
|
website_encodings:utf8
|
|
|
|
|
|
[www.mediaminer.org]
|
|
|
## Using basic_cache with mediaminer.org caused SSL errors in Calibre.
|
|
|
## I've no idea why, but turning off explicitly.
|
|
|
use_basic_cache:true
|
|
|
|
|
|
## Note that mediaminer doesn't give datePublished on the story's
|
|
|
## index page--it's collected from the earliest uploaded chapter. So
|
|
|
## it's not available when only fetching metadata.
|
|
|
|
|
|
## some sites include images that we don't ever want becoming the
|
|
|
## cover image. This lets you exclude them.
|
|
|
cover_exclusion_regexp:/img/rss.png
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.midnightwhispers.net]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Queer as Folk
|
|
|
|
|
|
## some sites include images that we don't ever want becoming the
|
|
|
## cover image. This lets you exclude them.
|
|
|
cover_exclusion_regexp:/stories/999/images/.*?_trophy.png
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.mugglenetfanfiction.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Harry Potter
|
|
|
|
|
|
[www.naiceanilme.net]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
[www.narutofic.org]
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Naruto
|
|
|
|
|
|
[www.ncisfiction.com]
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:NCIS
|
|
|
|
|
|
[www.novelall.com]
|
|
|
use_basic_cache:true
|
|
|
website_encodings: utf8:ignore, Windows-1252, iso-8859-1
|
|
|
|
|
|
## Clear FanFiction from defaults, site is original fiction.
|
|
|
extratags:
|
|
|
extra_valid_entries:stars,votes,releaseFrequency,views,released,follows,altTitles,translator,sitetags
|
|
|
extra_titlepage_entries:altTitles,released,sitetags
|
|
|
|
|
|
# Labels
|
|
|
stars_label:Stars
|
|
|
votes_label:Votes
|
|
|
releaseFrequency_label:Release Frequency
|
|
|
views_label:Views
|
|
|
released_label:Released
|
|
|
follows_label:Follows
|
|
|
altTitles_label:Alternative titles
|
|
|
translator_label:Translator
|
|
|
sitetags_label:Site tags
|
|
|
|
|
|
## Attempt to fix p and br excess from HTML in great many stories
|
|
|
fix_excess_space:false
|
|
|
|
|
|
[www.novelupdates.cc]
|
|
|
## Note that novelupdates.cc != novelupdates.com
|
|
|
use_basic_cache:true
|
|
|
|
|
|
## There is reason to believe that novelupdates.cc may be a
|
|
|
## replacement for wuxiaworld.co, but currently both exist with
|
|
|
## different data.
|
|
|
|
|
|
## When dedup_order_chapter_list:true, use a heuristic algorithm
|
|
|
## specific to novelupdates.cc order and dedup chapters.
|
|
|
dedup_order_chapter_list:false
|
|
|
|
|
|
[www.phoenixsong.net]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Harry Potter
|
|
|
extraships:Harry Potter/Ginny Weasley
|
|
|
|
|
|
website_encodings:utf8,Windows-1252
|
|
|
|
|
|
[www.potionsandsnitches.org]
|
|
|
extra_valid_entries:stars,reviews,reads,takesplaces,snapeflavours,sitetags
|
|
|
stars_label:Frogs
|
|
|
takesplaces_label:Takes Place
|
|
|
snapeflavours_label:Snape Flavour
|
|
|
sitetags_label:Site Tags
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Harry Potter
|
|
|
|
|
|
#add_to_include_subject_tags:,takesplaces,snapeflavours,sitetags
|
|
|
#add_to_extra_titlepage_entries:,stars,reviews,reads,takesplaces,snapeflavours,sitetags
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.psychfic.com]
|
|
|
use_basic_cache:true
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Psych
|
|
|
|
|
|
[www.royalroad.com]
|
|
|
use_basic_cache:true
|
|
|
extra_valid_entries:stars
|
|
|
|
|
|
#add_to_extra_titlepage_entries:,stars
|
|
|
|
|
|
## some sites include images that we don't ever want becoming the
|
|
|
## cover image. This lets you exclude them.
|
|
|
cover_exclusion_regexp:(imgur.com/dzOACJf.png|/forum/images/smilies/)
|
|
|
|
|
|
## Clear FanFiction from defaults, site has fanfictions and original fiction.
|
|
|
extratags:
|
|
|
|
|
|
## royalroad.com stories sometimes have 'spoiler' blocks in
|
|
|
## posts. When viewed in a browser, the block is hidden until a button
|
|
|
## is clicked. eBook viewers can't handle that and the javascript is
|
|
|
## disabled. The remove_spoilers option, if uncommented, will remove
|
|
|
## spoiler blocks entirely.
|
|
|
#remove_spoilers:true
|
|
|
|
|
|
## This option if uncommented, will put a box around the spoiler
|
|
|
## blocks with the original spoiler button text as a label using
|
|
|
## fieldset and legend HTML tags. For a simple box, see the
|
|
|
## add_to_output_css example for [base_xenforoforum:epub].
|
|
|
#legend_spoilers:true
|
|
|
|
|
|
## royalroad.com chapters can have author notes attached to them.
|
|
|
## Setting include_author_notes:true will include them with the
|
|
|
## chapter text.
|
|
|
#include_author_notes:true
|
|
|
|
|
|
## default formatting for author's notes and tables in the story text
|
|
|
## makes some stories drastically easier to visually parse
|
|
|
add_to_output_css:
|
|
|
td { padding: 0.5em }
|
|
|
table { border: 1px solid; border-collapse: collapse; }
|
|
|
.author-note-portlet { border: 1px solid; border-collapse: collapse; padding: 0.5em }
|
|
|
|
|
|
[www.scarvesandcoffee.net]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Glee
|
|
|
extracharacters:Kurt Hummel,Blaine Anderson
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.scribblehub.com]
|
|
|
use_basic_cache:true
|
|
|
extra_valid_entries:views, averageWords, fandoms
|
|
|
views_label:Views
|
|
|
averageWords_label:Average Words (Chapter)
|
|
|
add_to_titlepage_entries:,views, averageWords, fandoms
|
|
|
|
|
|
## Scribble Hub chapters can include author's notes, news blocks, spoilers,
|
|
|
## and inline footnotes. We've traditionally included them all in the chapter
|
|
|
## text, but this allows you to customize which you include. Copy this
|
|
|
## parameter to your personal.ini and list the ones you don't want.
|
|
|
#exclude_notes:authornotes,newsboxes,spoilers,footnotes
|
|
|
|
|
|
[www.silmarillionwritersguild.org]
|
|
|
use_basic_cache:true
|
|
|
|
|
|
[www.siye.co.uk]
|
|
|
use_basic_cache:true
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Harry Potter
|
|
|
extracharacters:Harry Potter,Ginny Weasley
|
|
|
extraships:Harry Potter/Ginny Weasley
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.starskyhutcharchive.net]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Starsky and Hutch
|
|
|
|
|
|
[www.storiesofarda.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Lord of the Rings
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.swi.org.ru]
|
|
|
use_basic_cache:true
|
|
|
|
|
|
[www.the-sietch.com]
|
|
|
## see [base_xenforoforum]
|
|
|
|
|
|
## the-sietch.com shows more posts per reader page than other XF sites.
|
|
|
reader_posts_per_page:15
|
|
|
|
|
|
[www.thedelphicexpanse.com]
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Star Trek: Enterprise
|
|
|
|
|
|
[www.tthfanfic.org]
|
|
|
use_basic_cache:true
|
|
|
user_agent:
|
|
|
slow_down_sleep_time:2
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## tth is a little unusual--it doesn't require user/pass, but the site
|
|
|
## keeps track of which chapters you've read and won't send another
|
|
|
## update until it thinks you're up to date. This way, on download,
|
|
|
## it thinks you're up to date.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## TtH uses 'category' Buffy-Centered, Xander-Centered, etc. If
|
|
|
## centeredcat_to_characters:true, they will not be included in the
|
|
|
## category list and Buffy, Xander, etc will instead be included in
|
|
|
## the characters list.
|
|
|
centeredcat_to_characters:true
|
|
|
|
|
|
## TtH uses 'category' Pairing: Dawn, Pairing: Willow, etc, but only
|
|
|
## if there's already been a -Centered category, like Xander-Centered.
|
|
|
## If pairingcat_to_characters_ships:true, Pairing: Whomever will not
|
|
|
## be included in the category list and Dawn, Willow, etc will instead
|
|
|
## be included in the characters list *and* an entry added to the
|
|
|
## ships list for Centered character / Pairing character. IE,
|
|
|
## category: Xander-Centered, Pairing: Dawn becomes characters:
|
|
|
## Xander, Dawn and ships: Xander/Dawn.
|
|
|
pairingcat_to_characters_ships:true
|
|
|
|
|
|
## TtH uses 'category' Romance followed by a pairing 'category', such
|
|
|
## as Romance > Buffy/Spike. If romancecat_to_characters_ships:true,
|
|
|
## Romance will still be added to category, but Buffy/Spike will
|
|
|
## instead be added to characters Buffy, Spike and ships Buffy/Spike
|
|
|
romancecat_to_characters_ships:true
|
|
|
|
|
|
[www.twilighted.net]
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Twilight
|
|
|
|
|
|
## twilighted.net (ab)uses series as personal reading lists.
|
|
|
collect_series: false
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.utopiastories.com]
|
|
|
use_basic_cache:true
|
|
|
## Extra metadata that this adapter knows about. See [archiveofourown.org]
|
|
|
## for examples of how to use them.
|
|
|
extra_valid_entries:eroticatags,siterating_votes,siterating,siterank_of,siterank,views
|
|
|
eroticatags_label:Erotica Tags
|
|
|
siterating_votes_label:Site Rating with Votes
|
|
|
siterating_label:Site Rating
|
|
|
siterank_of_label:Site Rank of Total
|
|
|
siterank_label:Site Rank
|
|
|
views_label:Views
|
|
|
extra_titlepage_entries:eroticatags
|
|
|
keep_style_attr: false
|
|
|
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
[www.valentchamber.com]
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Some sites require login (or login for some rated stories) The
|
|
|
## program can prompt you, or you can save it in config. In
|
|
|
## commandline version, this should go in your personal.ini, not
|
|
|
## defaults.ini.
|
|
|
#username:YourName
|
|
|
#password:yourpassword
|
|
|
|
|
|
[www.walkingtheplank.org]
|
|
|
extra_valid_entries:reads
|
|
|
reads_label:Read Count
|
|
|
|
|
|
## Some sites do not require a login, but do require the user to
|
|
|
## confirm they are adult for adult content. In commandline version,
|
|
|
## this should go in your personal.ini, not defaults.ini.
|
|
|
#is_adult:true
|
|
|
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:Harry Potter
|
|
|
extracharacters:Severus Snape,Harry Potter
|
|
|
extraships:Severus Snape/Harry Potter
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.whofic.com]
|
|
|
use_basic_cache:true
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.wolverineandrogue.com]
|
|
|
## Site dedicated to these categories/characters/ships
|
|
|
extracategories:X-Men Movie
|
|
|
extracharacters:Wolverine,Rogue
|
|
|
|
|
|
website_encodings:Windows-1252,utf8
|
|
|
|
|
|
[www.wuxiaworld.xyz]
|
|
|
use_basic_cache:true
|
|
|
## Was wuxiaworld.co
|
|
|
## Note that wuxiaworld.co != wuxiaworld.com
|
|
|
## When dedup_order_chapter_list:true, use a heuristic algorithm
|
|
|
## specific to wuxiaworld.xyz order and dedup chapters.
|
|
|
dedup_order_chapter_list:false
|