Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve chapter title and arc presentation #56

Merged
merged 11 commits into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,30 @@ worm-scraper --book=glow-worm

EPUBs are not the native format for Amazon Kindle devices and apps. However, you can send them to your Kindle library by following [Amazon's instructions](https://www.amazon.com/gp/help/customer/display.html?nodeId=G5WYD9SAF7PGXRNA).

## Chapter titles

The original chapter titles, i.e. the ones that appear as heading at the top of each chapter published online, are not very book-like. They vary wildly, e.g. "Gestation 1.1", "Daybreak – 1.2", "Interlude 1", "Flare – Interlude 2", "Interlude 10.y", "Interlude 10.5 (Bonus)", "Interlude 14.5 (Bonus Interlude)".

By default, `worm-scraper` simplifies the titles to be just numbers ("1", "2", "3"), with interludes denoted via Roman numerals ("Interlude I", "Interlude II", ...)—or left as simply "Interlude" if an arc contains a single interlude.

If you want the original chapter titles, you can pass the following option:

```bash
worm-scraper --chapter-titles=original
```

There's a third option, which is to have the interludes (and _Ward_'s epilogues) include character names. Samples of this format include "Interlude: Danny" or "Interlude: Armsmaster". Use

```bash
worm-scraper --chapter-titles=character-names
```

for this. _This can be a slight spoiler_, because the reading experience of many interludes relies on you gradually discovering who the main character is and how they relate to what you've seen before. It can also spoil you on which characters survive, if you look ahead in the table of contents.

This style is _sort of_ aligned with how the interludes are presented in the table of contents [for _Worm_](https://parahumans.wordpress.com/table-of-contents/) and [for _Ward_](https://www.parahumans.net/table-of-contents/). But even those are inconsistent, and `worm-scraper` departs from the table of contents names in several cases. `worm-scraper` generally tries to pick the name name by which the character is first referred to in the chapter, to minimize the spoiler effect, but sometimes takes influence from the original tables of contents, or the names chosen by [the Fandom wiki](https://worm.fandom.com/wiki/Chapter_List).

You can see all the chosen character-name titles in the [`chapter-data/`](./chapter-data/) directory's files. If you strongly disagree with a choice made, please file an issue.

## 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.
Expand Down
52 changes: 52 additions & 0 deletions chapter-data/glow-worm.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
[
{
"invisible": true,
"chapters": [
{
"url": "https://www.parahumans.net/2017/10/21/glow-worm-0-1/",
"simplifiedTitle": "1",
"characterNamesTitle": "Point_Me_@_The_Sky"
},
{
"url": "https://www.parahumans.net/2017/10/24/glow-worm-0-2/",
"simplifiedTitle": "2",
"characterNamesTitle": "Capricorn"
},
{
"url": "https://www.parahumans.net/2017/10/26/glow-worm-0-3/",
"simplifiedTitle": "3",
"characterNamesTitle": "Mangled_Wings"
},
{
"url": "https://www.parahumans.net/2017/10/28/glow-worm-0-4/",
"simplifiedTitle": "4",
"characterNamesTitle": "of5"
},
{
"url": "https://www.parahumans.net/2017/10/31/glow-worm-0-5/",
"simplifiedTitle": "5",
"characterNamesTitle": "Point_Me_@_The_Sky, part 2"
},
{
"url": "https://www.parahumans.net/2017/10/31/glow-worm-0-6/",
"simplifiedTitle": "6",
"characterNamesTitle": "Questionable_Cephalopod"
},
{
"url": "https://www.parahumans.net/2017/11/02/glow-worm-0-7/",
"simplifiedTitle": "7",
"characterNamesTitle": "Heart_Shaped_Pupil"
},
{
"url": "https://www.parahumans.net/2017/11/04/glow-worm-0-8/",
"simplifiedTitle": "8",
"characterNamesTitle": "Space_Squid"
},
{
"url": "https://www.parahumans.net/2017/11/07/glow-worm-0-9/",
"simplifiedTitle": "9",
"characterNamesTitle": "Point_Me_@_The_Sky, part 3"
}
]
}
]
Loading
Loading