Skip to content

Commit

Permalink
eBook → ebook in all documentation
Browse files Browse the repository at this point in the history
This casing appears to be used, e.g., in the latest EPUB specification.
  • Loading branch information
domenic committed Nov 6, 2024
1 parent bbd404d commit 32cc1ab
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _Worm_ Scraper

Scrapes the web serial [_Worm_](https://parahumans.wordpress.com/) and its sequel [_Ward_](https://www.parahumans.net/) into an eBook format.
Scrapes the web serial [_Worm_](https://parahumans.wordpress.com/) and its sequel [_Ward_](https://www.parahumans.net/) into an ebook format.

## How to use

Expand All @@ -18,7 +18,7 @@ This will take a while as it downloads this program and its dependencies from th
worm-scraper --help
```

If this outputs some help documentation, then the installation process went smoothly. You can move on to assemble the eBook by typing
If this outputs some help documentation, then the installation process went smoothly. You can move on to assemble the ebook by typing

```bash
worm-scraper
Expand All @@ -34,12 +34,12 @@ worm-scraper --book=ward

## EPUB vs. other formats

EPUB is one of the primary eBook formats, but it is not recognized by all readers, including most Amazon Kindle devices. You can use an online converter or other tool to convert EPUB to Kindle MOBI, or any other format.
EPUB is one of the primary ebook formats, but it is not recognized by all readers, including most Amazon Kindle devices. You can use an online converter or other tool to convert EPUB to Kindle MOBI, or any other format.

Alternately, if you are a developer, a pull request adding support for MOBI output would be appreciated; please open an issue to discuss how you plan to proceed.

## Text fixups

This project makes a lot of fixups to the original text, mostly around typos, punctuation, capitalization, and consistency. You can get a more specific idea of what these are via the code; there's [`convert-worker.js`](https://github.com/domenic/worm-scraper/blob/master/lib/convert-worker.js), where some things are handled generally, and [`substitutions.json`](https://github.com/domenic/worm-scraper/blob/master/lib/substitutions.json), for one-off fixes.

This process is designed to be extensible, so if you notice any problems with the original text that you think should be fixed, file an issue to let me know, and we can update the fixup code so that the resulting eBook is improved. (Or better yet, send a pull request!)
This process is designed to be extensible, so if you notice any problems with the original text that you think should be fixed, file an issue to let me know, and we can update the fixup code so that the resulting ebook is improved. (Or better yet, send a pull request!)
6 changes: 3 additions & 3 deletions lib/substitutions.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
{
"before": "<p><em>Brief note from the author: This story isn’t intended for young or sensitive readers. Readers who are on the lookout for <a href=\"http://www.urbandictionary.com/define.php?term=Trigger%20warning&amp;defid=6195009\">trigger warnings</a> are advised to give Worm a pass.</em></p>\n<p style=\"text-align: center;\">■</p>\n",
"after": "",
"_comment": "The pseudo-trigger warning is out of place in an eBook."
"_comment": "The pseudo-trigger warning is out of place in an ebook."
}
],
"https://parahumans.wordpress.com/2011/06/14/gestation-1-2/": [
Expand Down Expand Up @@ -4586,7 +4586,7 @@
{
"before": "<p>Ward is the second work in the Parahumans series, and reading <strong><a href=\"https://parahumans.wordpress.com/\">Worm</a></strong> first is strongly recommended. A lot of this won’t make sense otherwise and if you do find yourself a fan of the universe, the spoilers in Ward will affect the reading of the other work.</p>\n<p>Ward is not recommended for young or sensitive readers.</p>\n<p style=\"text-align: center;\">⊙</p>\n",
"after": "",
"_comment": "This is out of place in an eBook."
"_comment": "This is out of place in an ebook."
}
],
"https://www.parahumans.net/2017/11/21/daybreak-1-4/": [
Expand Down Expand Up @@ -5186,7 +5186,7 @@
{
"before": "<p style=\"text-align: center;\"><a href=\"/2018/05/26/eclipse-x-1/\"><strong>⊙</strong></a></p>",
"after": "",
"_comment": "This appears to be intentional, but it just duplicates the Next Chapter link (i.e. turning the page in the eBook), so we remove it"
"_comment": "This appears to be intentional, but it just duplicates the Next Chapter link (i.e. turning the page in the ebook), so we remove it"
},
{
"before": "those hectic days after dad’s head injury",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "worm-scraper",
"description": "Scrapes the web serial Worm and its sequel Ward into an eBook format",
"description": "Scrapes the web serial Worm and its sequel Ward into an ebook format",
"keywords": [
"ebook",
"worm",
Expand Down

0 comments on commit 32cc1ab

Please sign in to comment.