diff --git a/www/contribute/producing-an-ebook-step-by-step.php b/www/contribute/producing-an-ebook-step-by-step.php index 7f4666d1..7c3cf8b9 100644 --- a/www/contribute/producing-an-ebook-step-by-step.php +++ b/www/contribute/producing-an-ebook-step-by-step.php @@ -271,7 +271,7 @@ proceed to seal up my confession, I bring the life of that unhappy Henry Jekyll
Semantics rules for abbreviations. Abbreviations should always be wrapped in the <abbr>
element and with the correct class
attribute.
Specifically, see the typography rules for initials. Wrap people’s initials in <abbr class="name">
. This command helps wrap initials:
se interactive-replace '(?<!<abbr[^<]*?>)([A-Z]\.(\s?[A-Z]\.)*)(?!</abbr>|”)' '<abbr class="name">\1</abbr>' src/epub/text/*
+ se interactive-replace '(?<!<abbr[^<]*?>)([A-Z]\.(\s?[A-Z]\.)*)(?!</abbr>|”)' '<abbr epub:type="z3998:given-name">\1</abbr>' src/epub/text/*
Typography rules for times. Wrap a.m. and p.m. in <abbr class="time">
and add a no-break space between digits and a.m. or p.m.
Similar to se find-mismatched-diacritics
, se find-mismatched-dashes
lists instances where a compound word is spelled both with and without a dash. Dashes in words should be normalized to one or the other style.
<title>
elementsAfter you’ve added semantics and correctly marked up section headers, it’s time to update the <title>
elements in each chapter to match their expected values.
It’s a good idea to run se typogrify
and se clean
one more time before running these final checks. Make sure to review the changes with git difftool
before accepting them—se typogrify
is usually right, but not always!
Now that our ebook is complete, let’s verify that there are no errors at the S.E. style level:
se lint .
- Once se lint
completes without errors, we’re ready to confirm that there are no errors at the epub level. We do this by invoking se build
with the --check
flag, which will run epubcheck
to verify that our final epub has no errors:
se build --check --output-dir=${TMPDIR:-/tmp} .
+ Once se lint
completes without errors, we’re ready to confirm that there are no errors at the epub level. We do this by invoking se build
with the --check-only
flag, which will run epubcheck
to verify that our final epub has no errors, but won’t output an ebook files, since we don’t need them right now.
se build --check-only .
Once that completes without errors, we’re ready to move on to the final step!