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

Update guides to split 'se print-manifest-and-spine' into two tools

Browse source
This commit is contained in:
Alex Cabal 2020-03-23 21:45:26 -05:00
parent 9601080308
commit 909370308d
2 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

4
www/contribute/metadata.php
View file

@ -315,9 +315,9 @@ require_once('Core.php');
</li>
</ol>
<h2>The <code class="html">&lt;manifest&gt;</code> element</h2>
<p>The <code class="html">&lt;manifest&gt;</code> element is a required part of the epub spec. This should usually be generated by the <code class="program">print-manifest-and-spine</code> tool and copy-and-pasted into the <code class="path">content.opf</code> file. It must be in alphabetical order, which is handled for you by the <code class="program">print-manifest-and-spine</code> tool.</p>
<p>The <code class="html">&lt;manifest&gt;</code> element is a required part of the epub spec. This should usually be generated by the <code class="program">print-manifest</code> tool and copy-and-pasted into the <code class="path">content.opf</code> file. It must be in alphabetical order, which is handled for you by the <code class="program">print-manifest-and-spine</code> tool.</p>
<h2>The <code class="html">&lt;spine&gt;</code> element</h2>
<p>The <code class="html">&lt;spine&gt;</code> element is a required part of the epub spec that defines the reading order of the files in the ebook. You can use the <code class="program">print-manifest-and-spine</code> tool to generate a draft of the spine. The tool makes a best guess as to the spine order, but it cannot be 100% correct; please review the output and adjust the reading order accordingly.</p>
<p>The <code class="html">&lt;spine&gt;</code> element is a required part of the epub spec that defines the reading order of the files in the ebook. You can use the <code class="program">print-spine</code> tool to generate a draft of the spine. The tool makes a best guess as to the spine order, but it cannot be 100% correct; please review the output and adjust the reading order accordingly.</p>
</article>
</main>
<?= Template::Footer() ?>

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

@ -339,11 +339,14 @@ require_once('Core.php');
<h2>Complete content.opf</h2>
<p><code class="path">content.opf</code> is the file that contains the ebook metadata like author, title, description, and reading order. Most of it will be filling in that basic information, and including links to various resources related to the text.</p>
<p>The <code class="path">content.opf</code> is standardized. Please <a href="/contribute/metadata">see our extensive Metadata Manual</a> for details on how to fill out <code class="path">content.opf</code>.</p>
<p>As you complete the metadata, you’ll have to order the spine and the manifest in this file. Fortunately, Standard Ebooks has a tool for that too: <code class="program">se print-manifest-and-spine</code>. Run this on our source directory and, as you can guess, it’ll print out the <code class="html">&lt;manifest&gt;</code> and <code class="html">&lt;spine&gt;</code> tags for this work.</p>
<p>If you’re using a Mac, and thus the badly-behaved Finder program, you may find that it has carelessly polluted your work directory with useless <code class="path">.DS_Store</code> files. Before continuing, you should <a href="https://duckduckgo.com/?q=mac+alternative+file+manager">find a better file manager program</a>, then delete all of that litter with the following command. Otherwise, <code class="program">se print-manifest-and-spine</code> will include that litter in its output and your epub won’t be valid.</p>
<p>As you complete the metadata, you’ll have to order the spine and the manifest in this file. Fortunately, Standard Ebooks tools for that too: <code class="program">se print-manifest</code> and <code class="program">se print-spine</code>. Run these on our source directory and, as you can guess, they’ll print out the <code class="html">&lt;manifest&gt;</code> and <code class="html">&lt;spine&gt;</code> tags for this work.</p>
<p>If you’re using a Mac, and thus the badly-behaved Finder program, you may find that it has carelessly polluted your work directory with useless <code class="path">.DS_Store</code> files. Before continuing, you should <a href="https://duckduckgo.com/?q=mac+alternative+file+manager">find a better file manager program</a>, then delete all of that litter with the following command. Otherwise, <code class="program">se print-manifest</code> and <code class="program">se print-spine</code> will include that litter in its output and your epub won’t be valid.</p>
<code class="terminal"><span>find . -name ".DS_Store" -type f -delete</span></code>
<p>Since this is the first time we’re editing <code class="path">content.opf</code>, we’re OK with replacing both the manifest and spine tags with a guess at the correct contents. We can do this using the <code class="program">--in-place</code> option. If we have to update the manifest or spine later, we can omit the option to print to standard output instead of altering <code class="path">content.opf</code> directly.</p>
<code class="terminal raw"><span>se print-manifest-and-spine --in-place .</span></code>
<code class="terminal">
<span>se print-manifest --in-place .</span>
<span>se print-spine --in-place .</span>
</code>
<p>The manifest is already in the correct order and doesn’t need to be edited. The spine, however, will have to be reordered to be in the correct reading order. Once you’ve done that, commit!</p><code class="terminal"><span>git add -A</span> <span>git commit -m "Complete content.opf"</span></code>
</li>
<li>