standardebooks/web
1
0
Fork 0
mirror of https://github.com/standardebooks/web.git synced 2025-07-14 02:21:55 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add note about print-toc to step by step guide

Browse source
This commit is contained in:
Alex Cabal 2019-03-26 17:43:55 -05:00
parent 6e0e78b71e
commit 1b73ea5fd3
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
www/contribute/producing-an-ebook-step-by-step.php
View file

@ -350,7 +350,7 @@ require_once('Core.php');
<p>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.</p> <p>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.</p>
<p>Once you’ve completed the <code class="html">&lt;spine&gt;</code> element in <code class="path">content.opf</code>, you can use <code class="program">se print-toc</code> 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 <code class="program">--in-place</code> flag to replace the template ToC file with the generated ToC.</p> <p>Once you’ve completed the <code class="html">&lt;spine&gt;</code> element in <code class="path">content.opf</code>, you can use <code class="program">se print-toc</code> 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 <code class="program">--in-place</code> flag to replace the template ToC file with the generated ToC.</p>
<code class="terminal raw"><span>se print-toc --in-place .</span></code> <code class="terminal raw"><span>se print-toc --in-place .</span></code>
<p>Review the generated ToC in <code class="path">./src/epub/toc.xhtml</code> to make sure <code class="program">se print-toc</code> did the right thing. You may have to make changes by hand for complex or unusual books. <p>Review the generated ToC in <code class="path">./src/epub/toc.xhtml</code> to make sure <code class="program">se print-toc</code> did the right thing. <code class="program">se print-toc</code> 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 <code class="program">se print-toc</code>, but with your HTML code—be careful! You may have to make changes by hand for complex or unusual books.</p>
<p>Once you’re done, commit:</p> <p>Once you’re done, commit:</p>
<code class="terminal"><span>git add -A</span> <span>git commit -m "Add ToC"</span></code> <code class="terminal"><span>git add -A</span> <span>git commit -m "Add ToC"</span></code>
</li> </li>