From 1b73ea5fd3c45e9be831644699318a4bd52d261c Mon Sep 17 00:00:00 2001 From: Alex Cabal Date: Tue, 26 Mar 2019 17:43:55 -0500 Subject: [PATCH] Add note about print-toc to step by step guide --- www/contribute/producing-an-ebook-step-by-step.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/www/contribute/producing-an-ebook-step-by-step.php b/www/contribute/producing-an-ebook-step-by-step.php index e682bdc4..3030985a 100644 --- a/www/contribute/producing-an-ebook-step-by-step.php +++ b/www/contribute/producing-an-ebook-step-by-step.php @@ -350,7 +350,7 @@ require_once('Core.php');

The table of contents is a structured document that should let the reader easily navigate the book. In a Standard Ebook, it’s stored outside of the readable text directory with the assumption that the reading system will parse it and display a navigable representation for the user.

Once you’ve completed the <spine> element in content.opf, you can use se print-toc to generate a table of contents for this ebook. Since this is the first time we’re generating a ToC for this ebook, use the --in-place flag to replace the template ToC file with the generated ToC.

se print-toc --in-place . -

Review the generated ToC in ./src/epub/toc.xhtml to make sure se print-toc did the right thing. You may have to make changes by hand for complex or unusual books. +

Review the generated ToC in ./src/epub/toc.xhtml to make sure se print-toc did the right thing. se print-toc is valuable tool to discover structural problems in your ebook. If an entry is arranged in a way you weren’t expecting, perhaps the problem isn’t with se print-toc, but with your HTML code—be careful! You may have to make changes by hand for complex or unusual books.

Once you’re done, commit:

git add -A git commit -m "Add ToC"