diff --git a/calibre-plugin/plugin-example.ini b/calibre-plugin/plugin-example.ini index c2c00b25..044d7f8d 100644 --- a/calibre-plugin/plugin-example.ini +++ b/calibre-plugin/plugin-example.ini @@ -3,22 +3,9 @@ [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 +## overridden at several levels. See +## https://github.com/JimmXinu/FanFicFare/wiki/INI-File for more +## details. ## Some sites also require the user to confirm they are adult for ## adult content. Uncomment by removing '#' in front of is_adult. @@ -29,42 +16,32 @@ ## want to make them all look the same? Strip them off, then add them ## back on with add_chapter_numbers. Don't like the way it strips ## numbers or adds them back? See chapter_title_strip_pattern and -## chapter_title_add_pattern. +## chapter_title_add_pattern in defaults.ini. #strip_chapter_numbers:true #add_chapter_numbers:true -## Add this to genre if there's more than one category. -#add_genre_when_multi_category: Crossover [epub] -## include images from img tags in the body and summary of stories. +## Include images from img tags in the body and summary of stories. ## Images will be converted to jpg for size if possible. Images work ## in epub format only. To get mobi or other format with images, ## download as epub and use Calibre to convert. +## true by default, uncomment and set false to not include images. #include_images:true -## 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 not set, the summary will have all html stripped for safety. +## If set false, the summary will have all html stripped for safety. ## Both this and include_images must be true to get images in the ## summary. +## true by default, uncomment and set false to not keep summary html. #keep_summary_html:true -## 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 +## If set true, and there isn't a specific cover image, the first +## image found in the story will be made the cover image. If +## keep_summary_html is true, images in the summary will be before any ## in chapters. +## true by default, uncomment and set false to turn off #make_firstimage_cover:true -## 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. -#grayscale_images: false - ## Most common, I expect will be using this to save username/passwords ## for different sites. Here are a few examples. See defaults.ini @@ -76,22 +53,6 @@ ## default is false #collect_series: true -[ficwad.com] -#username:YourUsername -#password:YourPassword - -[www.adastrafanfic.com] -## Some sites do not require a login, but do require the user to -## confirm they are adult for adult content. -#is_adult:true - -[www.twcslibrary.net] -#username:YourName -#password:yourpassword -#is_adult:true -## default is false -#collect_series: true - [www.fimfiction.net] #is_adult:true #fail_on_password: false @@ -100,8 +61,9 @@ #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. +## update until it thinks you're up to date. If you set +## username/password, FFF will login to download. Then the site +## thinks you're up to date. #username:YourName #password:yourpassword