Once we’ve OK’d your selection and you’ve read the style manuals, you can get started! Follow the steps in our step-by-step guide to producing an ebook to take your ebook from start to finish.
Now that we’ve got the source text, we have to do some very broad cleanup before we perform our first commit:
@@ -209,7 +209,7 @@ proceed to seal up my confession, I bring the life of that unhappy Henry Jekyll
se british2american attempts to automate the conversion. Your work must already be typogrified (the previous step in this guide) for the script to work.
se british2american .
While se british2american tries its best, thanks to the quirkiness of English punctuation rules it’ll invariably mess some stuff up. Proofreading is required after running the conversion.
After you’ve run the conversion, do another commit.
git add -Agit commit -m "Convert from British-style quotation to American style"
-
This regex is useful for spotting incorrectly converted quotes next to em dashes: “[^”‘]+’—(?=[^”]*?</p>;)
+
This regex is useful for spotting incorrectly converted quotes next to em dashes: “[^”‘]+’—(?=[^”]*?</p>;)
Add semantics
@@ -232,7 +232,7 @@ proceed to seal up my confession, I bring the life of that unhappy Henry Jekyll
Semantics for italics: <em> should be used for when a passage is emphasized, as in when dialog is shouted or whispered. <i> is used for all other italics, with the appropriate semantic inflection. Older transcriptions usually use just <i> for both, so you must change them manually if necessary.
Sometimes, transcriptions from Project Gutenberg may use ALL CAPS instead of italics. To replace these, you can use sed:
- sed --regexp-extended --in-place "s|[A-Z’]{2,}|<em>\L&</em>|g" src/epub/text/*
+ sed --regexp-extended --in-place "s|[A-Z’]{2,}|<em>\L\1</em>|g" src/epub/text/*
This will unfortunately replace language tags like en-US, so fix those up with this:
sed --regexp-extended --in-place "s|en-<em>([a-z]+)</em>|en-\U\1|g" src/epub/text/*
These replacments don’t take Title Caps into account, so use git diff to review the changes and fix errors before committing.
@@ -242,13 +242,13 @@ proceed to seal up my confession, I bring the life of that unhappy Henry Jekyll
Specifically, see the typography rules for initials. Wrap people’s initials in <abbrclass="name">. This regex helps match initials: [A-Z]\.\s*([A-Z]\.\s*)+
+
Specifically, see the typography rules for initials. Wrap people’s initials in <abbrclass="name">. This regex helps match initials: [A-Z]\.\s*([A-Z]\.\s*)+
-
Typography rules for times. Wrap a.m. and p.m. in <abbrclass="time"> and add a no-break space between digits and a.m. or p.m.
+
Typography rules for times. Wrap a.m. and p.m. in <abbrclass="time"> and add a no-break space between digits and a.m. or p.m.
-
Words or phrases in foreign languages should always be marked up with <ixml:lang="TAG">, where TAG is an IETF language tag. This app can help you look them up. If the text uses fictional or unspecific languages, use the “x-” prefix and make up a subtag yourself.
+
Words or phrases in foreign languages should always be marked up with <ixml:lang="TAG">, where TAG is an IETF language tag. This app can help you look them up. If the text uses fictional or unspecific languages, use the “x-” prefix and make up a subtag yourself.
Semantics for poetry, verse, and song: Many Gutenberg productions use the <pre> tag to format poetry, verse, and song. This is, of course, semantically incorrect. See the Poetry section of the SEMOS for templates on how to semantically format poetry, verse, and song.
@@ -264,7 +264,6 @@ proceed to seal up my confession, I bring the life of that unhappy Henry Jekyll
Once you’ve verified the titles look good, commit:
git add -Agit commit -m "Add titles"
-
Modernize spelling and hyphenation
Many older works use outdated spelling and hyphenation that would distract a modern reader. (For example, “to-night” instead of “tonight”). se modernize-spelling automatically removes hyphens from words that used to be compounded, but aren’t anymore in modern English spelling.
+ + CoverImage2xAvifUrl !== null){ ?>