mirror of
https://github.com/lise-henry/crowbook
synced 2024-05-11 09:36:19 +02:00
Update guide
This commit is contained in:
Elisabeth Henry
parent
d5c78fcd5a
commit
f05bb3019d
Binary file not shown.
|
|
@ -563,7 +563,7 @@ function toggle() {
|
|||
"@type": "Book",
|
||||
"author": "Élisabeth Henry",
|
||||
"name": "Crowbook User Guide",
|
||||
"version": "0.14.0",
|
||||
"version": "0.14.1",
|
||||
|
||||
|
||||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||||
|
|
@ -572,7 +572,7 @@ function toggle() {
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
</script>
|
||||
<nav id = "nav">
|
||||
|
|
@ -580,128 +580,129 @@ function toggle() {
|
|||
<h2><a href = "#link-0">Crowbook User Guide</a></h2>
|
||||
</div>
|
||||
<ul>
|
||||
<li><a href = "#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "#link-2">1.1. Example</a></li>
|
||||
<li><a href = "#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "#link-22">1.10. Library</a></li>
|
||||
<li><a href = "#link-23">1.11. License</a></li>
|
||||
<li><a href="#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="#link-2">1.1. Example</a></li>
|
||||
<li><a href="#link-3">1.2. Installing</a></li>
|
||||
<li><a href="#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="#link-8">1.5. Current features</a></li>
|
||||
<li><a href="#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="#link-22">1.10. Library</a></li>
|
||||
<li><a href="#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="#link-24">2. Arguments</a>
|
||||
<ul><li><a href="#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="#link-78">4.1. Tables</a></li>
|
||||
<li><a href="#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "#link-83">5. Templates</a>
|
||||
<ul><li><a href = "#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="#link-83">5. Templates</a>
|
||||
<ul><li><a href="#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="#link-113">7.1. Basics</a></li>
|
||||
<li><a href="#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="#link-123">9. Contributing</a>
|
||||
<ul><li><a href="#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "#link-126">unreleased</a></li>
|
||||
<li><a href = "#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="#link-125">ChangeLog</a>
|
||||
<ul><li><a href="#link-126">unreleased</a></li>
|
||||
<li><a href="#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-346">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-346">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -729,7 +730,7 @@ function toggle() {
|
|||
<p id = "para-7">If you are on Debian GNU/Linux or Ubuntu (on a PC architecture), you can also download <code>.deb</code> packages on <a href = "https://github.com/lise-henry/crowbook/releases">the releases page</a>.</p>
|
||||
<h3 id = "link-5">Using Cargo</h3>
|
||||
<p id = "para-8"><a href = "https://crates.io/">Cargo</a> is the <a href = "https://www.rust-lang.org/">Rust</a>’s package manager. You can <a href = "https://www.rust-lang.org/downloads.html">install it here</a>. Once it is done:</p>
|
||||
<pre><span style="color:#839496;">$ cargo </span><span style="color:#859900;">install</span><span style="color:#839496;"> crowbook
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> cargo install crowbook
|
||||
</span></pre><p id = "para-9">will automatically download the latest <code>crowbook</code> release on <a href = "https://crates.io/crates/crowbook">crates.io</a>, compile it, and install it on your system.</p>
|
||||
<blockquote><p id = "para-10">Some dependencies also require building C libraries; you might thus also need to install a C compiler and <code>make</code>/<code>cmake</code> build tools. You can also try to build a version of Crowbook without optional features: <code>cargo install crowbook --no-default-features --features “clap”</code> will disable syntactic highlighting and proofreading, requiring less dependencies.</p>
|
||||
</blockquote>
|
||||
|
|
@ -741,13 +742,13 @@ function toggle() {
|
|||
</ul>
|
||||
<h2 id = "link-7">1.4. Quick tour</h2>
|
||||
<p id = "para-12">The simplest command is:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook </span><span style="color:#859900;"><</span><span style="color:#839496;">BOOK</span><span style="color:#859900;">></span><span style="color:#839496;">
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook </span><span style="color:#657b83;"><</span><span style="color:#839496;">BOOK</span><span style="color:#657b83;">>
|
||||
</span></pre><p id = "para-13">where <code>BOOK</code> is a configuration file. Crowbook will parse this file and generate HTML, EPUB, and/or PDF output formats, according to the settings in the configuration file.</p>
|
||||
<p id = "para-14">To create a new book, assuming you have a list of Markdown files, you can generate a template configuration file with the <code>--create</code> argument:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook my.book --create chapter_</span><span style="color:#859900;">*</span><span style="color:#839496;">.md
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook my.book</span><span style="color:#268bd2;"> --create</span><span style="color:#839496;"> chapter_</span><span style="color:#859900;">*</span><span style="color:#839496;">.md
|
||||
</span></pre><p id = "para-15">This will generate a default <code>my.book</code> file, which you’ll need to complete. This configuration file contains some metadata, options, and lists the Markdown files.</p>
|
||||
<p id = "para-16">For short books containing only a single Markdown file, it is possible to embed some metadata at the beginning of the file and use the <code>--single</code> or <code>-s</code> option to run <code>crowbook</code> directly on this Markdown file and avoid creating a separate book configuration file:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook -s text.md
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> -s</span><span style="color:#839496;"> text.md
|
||||
</span></pre><p id = "para-17">For more information, see the chapters on <a href = "#chapter-1">the arguments supported by <code>crowbook</code></a> and on <a href = "#chapter-2">the configuration file</a>.</p>
|
||||
<h2 id = "link-8">1.5. Current features</h2>
|
||||
<h3 id = "link-9">Output formats</h3>
|
||||
|
|
@ -762,10 +763,10 @@ function toggle() {
|
|||
<p id = "para-22">Crowbook tries to correctly translate local links in the input Markdown files: e.g. if you have a link to a Markdown file that is part of your book, it will be transformed into a link inside the document.</p>
|
||||
<h3 id = "link-13">Inline YAML blocks</h3>
|
||||
<p id = "para-23">Crowbook supports inline YAML blocks:</p>
|
||||
<pre><span style="color:#839496;">---</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Me</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">My title</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">---</span><span style="color:#839496;">
|
||||
<pre><span style="color:#839496;">---
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Me
|
||||
title</span><span style="color:#839496;">: </span><span style="color:#2aa198;">My title
|
||||
</span><span style="color:#839496;">---
|
||||
</span></pre><p id = "para-24">This is mostly useful when Crowbook is run with the <code>--single</code> argument (receiving a single Markdown file instead of a book configuration file), for short texts that only contain one “chapter”.</p>
|
||||
<h3 id = "link-14">Proofreading</h3>
|
||||
<p id = "para-25">Crowbook can also generate “proofreading” copies in HTML or PDF, highlighting grammar errors and repetitions. For more information, see <a href = "#chapter-5">the proofreading chapter of the guide</a>.</p>
|
||||
|
|
@ -816,20 +817,20 @@ function toggle() {
|
|||
|
||||
</div><div id = "chapter-1" class = "chapter">
|
||||
<h1 id = 'link-24'><span class = 'chapter-header'>Chapter 2</span><br />Arguments</h1><p id = "para-46">Crowbook can take a number of arguments, generally in the form:</p>
|
||||
<pre><span style="color:#839496;">crowbook [OPTIONS] [BOOK]
|
||||
<pre><span style="color:#b58900;">crowbook </span><span style="color:#859900;">[</span><span style="color:#839496;">OPTIONS</span><span style="color:#859900;">] [</span><span style="color:#839496;">BOOK</span><span style="color:#859900;">]
|
||||
</span></pre><p id = "para-47">The most important argument is obviously the book configuration file. It is mandatory in most cases: if you don’t pass it, Crowbook will simply display an error. In a normal use case this is the only argument you’ll need to pass, as most options will be set in this configuration file.</p>
|
||||
<p id = "para-48">It is, however, possible to pass more arguments to <code>crowbook</code>:</p>
|
||||
<h2 id = "link-25">2.1. <code>--create</code></h2>
|
||||
<p id = "para-49"><b>Usage</b>: <code>crowbook [BOOK] --create file_1.md file_2.md ...</code></p>
|
||||
<p id = "para-50">(or <code>crowbook [BOOK] -c file_1.md file_2.md ...</code>)</p>
|
||||
<p id = "para-51">Creates a new book from a list of Markdown files. It will generate a book configuration file with all file names specified as chapters. It either prints the result to stdout (if <code>BOOK</code> is not specified) or generate the file <code>BOOK</code> (or abort if it already exists).</p>
|
||||
<pre><span style="color:#839496;">crowbook foo.book --create chapter_1.md chapter_2.md chapter_3.md
|
||||
<pre><span style="color:#b58900;">crowbook</span><span style="color:#839496;"> foo.book</span><span style="color:#268bd2;"> --create</span><span style="color:#839496;"> chapter_1.md chapter_2.md chapter_3.md
|
||||
</span></pre><p id = "para-52">will thus generate a file <code>foo.book</code> containing:</p>
|
||||
<pre><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Your name</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Your title</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">lang</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">en</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Your name
|
||||
title</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Your title
|
||||
lang</span><span style="color:#839496;">: </span><span style="color:#2aa198;">en
|
||||
|
||||
</span><span style="color:#586e75;">#</span><span style="color:#586e75;"># Output formats
|
||||
</span><span style="color:#586e75;">## Output formats
|
||||
|
||||
# Uncomment and fill to generate files
|
||||
# output.html: some_file.html
|
||||
|
|
@ -843,33 +844,33 @@ function toggle() {
|
|||
# cover: some_cover.png
|
||||
|
||||
## List of chapters
|
||||
+ chapter_1.md
|
||||
</span><span style="color:#2aa198;">+ chapter_1.md
|
||||
+ chapter_2.md
|
||||
+ chapter_3.md
|
||||
</span></pre><p id = "para-53">while</p>
|
||||
<pre><span style="color:#839496;">crowbook --create chapter_1.md chapter_2.md chapter_3.md
|
||||
<pre><span style="color:#b58900;">crowbook</span><span style="color:#268bd2;"> --create</span><span style="color:#839496;"> chapter_1.md chapter_2.md chapter_3.md
|
||||
</span></pre><p id = "para-54">will print the same result, but to stdout (without creating a file).</p>
|
||||
<h2 id = "link-26">2.2. <code>--single</code></h2>
|
||||
<p id = "para-55"><b>Usage</b>: <code>crowbook --single <FILE></code></p>
|
||||
<p id = "para-56">(or <code>crowbook -s <FILE></code>)</p>
|
||||
<p id = "para-57">This argument allows you to give <code>crowbook</code> a single Markdown file. This file can contain an inline YAML block to set some book options. Inline YAML blocks must start and end with a line containing only <code>---</code> (three dashes). E.g:</p>
|
||||
<pre><span style="color:#839496;">---</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Joan Doe</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">A short story</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">output</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">html</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">---</span><span style="color:#839496;">
|
||||
<pre><span style="color:#839496;">---
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Joan Doe
|
||||
title</span><span style="color:#839496;">: </span><span style="color:#268bd2;">A short story
|
||||
output</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">html</span><span style="color:#839496;">, </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">, </span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">]
|
||||
---
|
||||
|
||||
</span><span style="color:#2aa198;">Content of the story in Markdown.</span><span style="color:#839496;">
|
||||
</span><span style="color:#2aa198;">Content of the story in Markdown.
|
||||
</span></pre><p id = "para-58">If this YAML block is not at the beginning of a file, it must also be preceded by a blank line.</p>
|
||||
<p id = "para-59">This allows to not have to write a <code>.book</code> configuration file for a short story or an article. <code>crowbook -s foo.md</code> is rougly equivalent to having a book configuration file containing:</p>
|
||||
<pre><span style="color:#268bd2;">!</span><span style="color:#839496;"> </span><span style="color:#2aa198;">foo.md</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">! </span><span style="color:#2aa198;">foo.md
|
||||
</span></pre><p id = "para-60">That is, the chapter heading (if any) won’t be displayed in the output documents (though they still appear in the TOC).</p>
|
||||
<blockquote><p id = "para-61">Note that by default, using <code>--single</code> or <code>-s</code> sets the default LaTeX class of the book to <code>article</code> instead of <code>book</code>.</p>
|
||||
</blockquote>
|
||||
<h2 id = "link-27">2.3. <code>--set</code></h2>
|
||||
<p id = "para-62"><b>Usage</b>: <code>crowbook <BOOK> --set [KEY] [VALUE]...</code></p>
|
||||
<p id = "para-63">This argument takes a list of <code>KEY</code> <code>VALUE</code> pairs and allows setting or overriding a book configuration option. All valid options in the configuration files are valid as keys. For more information, see <a href = "#chapter-2">the configuration file</a>.</p>
|
||||
<pre><span style="color:#839496;">$ crowbook foo.book --</span><span style="color:#859900;">set</span><span style="color:#839496;"> tex.paper.size a4paper
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook foo.book</span><span style="color:#268bd2;"> --set</span><span style="color:#839496;"> tex.paper.size a4paper
|
||||
</span></pre><p id = "para-64">will override the paper size for PDF generation.</p>
|
||||
<h2 id = "link-28">2.4. <code>--list-options</code></h2>
|
||||
<p id = "para-65"><b>Usage</b>: <code>crowbook --list-options</code></p>
|
||||
|
|
@ -878,14 +879,14 @@ function toggle() {
|
|||
<h2 id = "link-29">2.5. <code>--print-template</code></h2>
|
||||
<p id = "para-68"><b>Usage</b>: <code>crowbook --print-template <TEMPLATE></code></p>
|
||||
<p id = "para-69">Prints the built-in template to stdout. Useful if you want to customize the appearance of your document. E.g., if you want to modify the CSS used for HTML rendering:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook --print-template html.css </span><span style="color:#859900;">></span><span style="color:#839496;"> my_style.css
|
||||
</span><span style="color:#586e75;">#</span><span style="color:#586e75;"> edit my_style.css in your favourite editor
|
||||
</span><span style="color:#839496;">$ crowbook my.book --</span><span style="color:#859900;">set</span><span style="color:#839496;"> html.css my_style.css
|
||||
</span><span style="color:#586e75;">#</span><span style="color:#586e75;"> or add "html.css: my_style.css" in my.book
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> --print-template</span><span style="color:#839496;"> html.css </span><span style="color:#657b83;">></span><span style="color:#839496;"> my_style.css
|
||||
</span><span style="color:#586e75;"># edit my_style.css in your favourite editor
|
||||
</span><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook my.book</span><span style="color:#268bd2;"> --set</span><span style="color:#839496;"> html.css my_style.css
|
||||
</span><span style="color:#586e75;"># or add "html.css: my_style.css" in my.book
|
||||
</span></pre><h2 id = "link-30">2.6. <code>--stats</code></h2>
|
||||
<p id = "para-70"><b>Usage</b>: <code>crowbook --stats <BOOK></code></p>
|
||||
<p id = "para-71">(or <code>crowbook -S <BOOK></code>)</p>
|
||||
<p id = "para-72">Display some statistics (word and character counts) about the book.</p>
|
||||
<p id = "para-72">Display some statistics (word and character counts) about the book. If you use the <code>--verbose</code> or <code>-v</code> option (and your version of Crowbook has been compiled with support for this feature) you will get advanced statistics such as Felsch readability index.</p>
|
||||
<h2 id = "link-31">2.7. <code>--proofread</code></h2>
|
||||
<p id = "para-73"><b>Usage</b>: <code>crowbook --proofread <BOOK></code></p>
|
||||
<p id = "para-74">(or <code>crowbook -p <BOOK></code>)</p>
|
||||
|
|
@ -912,9 +913,9 @@ Cheers, *Joan*
|
|||
<p id = "para-84">Generate only the specified format. <code>FORMAT</code> must be either <code>epub</code>, <code>pdf</code>, <code>html</code>, <code>html.dir</code>, <code>odt</code> or <code>tex</code>.</p>
|
||||
<p id = "para-85">If an output file for the format is not specified in the book configuration file, <code>crowbook</code> will fail to render PDF, ODT and EPUB, whereas it will print HTML and TeX files on stdout. It is, however, possible to specify a file with the <code>--output</code> option.</p>
|
||||
<h3 id = "link-36">Examples</h3>
|
||||
<pre><span style="color:#839496;">crowbook --to html foo.book
|
||||
<pre><span style="color:#b58900;">crowbook</span><span style="color:#268bd2;"> --to</span><span style="color:#839496;"> html foo.book
|
||||
</span></pre><p id = "para-86">will generate some HTML, and prints it either to the file specified by <code>output.html</code> in <code>foo.book</code>, or to stdout if it is not specified.</p>
|
||||
<pre><span style="color:#839496;">crowbook --to pdf --output foo.pdf foo.book
|
||||
<pre><span style="color:#b58900;">crowbook</span><span style="color:#268bd2;"> --to</span><span style="color:#839496;"> pdf</span><span style="color:#268bd2;"> --output</span><span style="color:#839496;"> foo.pdf foo.book
|
||||
</span></pre><p id = "para-87">will generate a <code>foo.pdf</code> file.</p>
|
||||
<h2 id = "link-37">2.11. <code>--output</code></h2>
|
||||
<p id = "para-88"><b>Usage</b>: <code>crowbook <BOOK> --to <FORMAT> --output <FILE></code></p>
|
||||
|
|
@ -933,20 +934,20 @@ Cheers, *Joan*
|
|||
</div><div id = "chapter-2" class = "chapter">
|
||||
<h1 id = 'link-40'><span class = 'chapter-header'>Chapter 3</span><br />The configuration file</h1><p id = "para-97">If you want to use Crowbook for your book, this configuration file is all you’ll have to add, beside the Markdown files containing the text of your book.</p>
|
||||
<p id = "para-98">The format is not very complicated. This is an example of it:</p>
|
||||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> metadata
|
||||
author: Joan Doe
|
||||
title: Some book
|
||||
lang: en
|
||||
<pre><span style="color:#586e75;"># metadata
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Joan Doe
|
||||
title</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Some book
|
||||
lang</span><span style="color:#839496;">: </span><span style="color:#268bd2;">en
|
||||
|
||||
output: [html, pdf, epub]
|
||||
output</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">html</span><span style="color:#839496;">, </span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">]
|
||||
|
||||
# list of chapters
|
||||
- preface.md
|
||||
</span><span style="color:#586e75;"># list of chapters
|
||||
</span><span style="color:#839496;">- </span><span style="color:#2aa198;">preface.md
|
||||
+ chapter_1.md
|
||||
+ chapter_2.md
|
||||
+ chapter_3.md
|
||||
+ chapter_4.md
|
||||
- epilogue.md
|
||||
</span><span style="color:#839496;">- </span><span style="color:#2aa198;">epilogue.md
|
||||
</span></pre><p id = "para-99">Basically, it is divided in two parts:</p>
|
||||
<ul>
|
||||
<li>a list of options, under the form <code>key: value</code>, following YAML syntax.</li>
|
||||
|
|
@ -955,20 +956,20 @@ output: [html, pdf, epub]
|
|||
<p id = "para-100">Lines starting with the <code>#</code> characters are comments and are discarded.</p>
|
||||
<h2 id = "link-41">3.1. Configuration in an inline YAML block</h2>
|
||||
<p id = "para-101">Sometimes, you only have one Markdown file and might not want to have a separate configuration file. In this case, you can specify options at the beginning of your Markdown file, using an inline YAML block, separated by two lines containing only <code>---</code>:</p>
|
||||
<pre><span style="color:#839496;">---</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">author: Joan Doe
|
||||
<pre><span style="color:#839496;">---
|
||||
author: Joan Doe
|
||||
title: Some (short) book
|
||||
lang: en
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">output: [html, pdf, epub]
|
||||
</span><span style="color:#b58900;">---</span><span style="color:#839496;">
|
||||
|
||||
</span><span style="color:#b58900;">#</span><span style="color:#b58900;"> </span><span style="color:#cb4b16;">Some (short) book</span><span style="color:#b58900;">
|
||||
</span><span style="color:#839496;">
|
||||
output: [html, pdf, epub]
|
||||
</span><span style="color:#b58900;">---
|
||||
|
||||
# </span><span style="color:#cb4b16;">Some (short) book
|
||||
|
||||
</span><span style="color:#839496;">The book content, formatted in Markdown.
|
||||
</span></pre><p id = "para-102">This method only allows to set up options: you can’t include a list of chapters in this way, since the only “chapter” that will be included is this Markdown file itself.</p>
|
||||
<p id = "para-103">You can then use</p>
|
||||
<pre><span style="color:#839496;">crowbook -s some_book.md
|
||||
<pre><span style="color:#b58900;">crowbook</span><span style="color:#268bd2;"> -s</span><span style="color:#839496;"> some_book.md
|
||||
</span></pre><p id = "para-104">to generate output formats from this Markdown file.</p>
|
||||
<blockquote><p id = "para-105">By default (unless <code>input.yaml_blocks</code> is set to true), Crowboook will only read those inline blocks when it is runned with <code>crowbook --single</code> (or <code>crowbook -s</code>).</p>
|
||||
</blockquote>
|
||||
|
|
@ -982,13 +983,13 @@ lang: en
|
|||
<li><code>@</code> includes a part instead of a chapter.</li>
|
||||
</ul>
|
||||
<p id = "para-107">So a typical usage might look like this:</p>
|
||||
<pre><span style="color:#268bd2;">!</span><span style="color:#839496;"> </span><span style="color:#2aa198;">copyright.md</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">-</span><span style="color:#839496;"> </span><span style="color:#2aa198;">preface.md</span><span style="color:#839496;">
|
||||
</span><span style="color:#2aa198;">0. chapter_0.md</span><span style="color:#839496;"> </span><span style="color:#586e75;">#</span><span style="color:#586e75;"> We want to start at chapter 0 instead of 1
|
||||
<pre><span style="color:#268bd2;">! </span><span style="color:#2aa198;">copyright.md
|
||||
</span><span style="color:#839496;">- </span><span style="color:#2aa198;">preface.md
|
||||
0. chapter_0.md </span><span style="color:#586e75;"># We want to start at chapter 0 instead of 1
|
||||
# Next chapters can be numbered automatically
|
||||
+ chapter_1.md
|
||||
</span><span style="color:#2aa198;">+ chapter_1.md
|
||||
+ chapter_2.md
|
||||
...
|
||||
</span><span style="color:#839496;">...
|
||||
</span></pre><p id = "para-108">There are two important things to note:</p>
|
||||
<ol>
|
||||
<li>you must <em>not</em> use quotes around the file names.</li>
|
||||
|
|
@ -997,7 +998,7 @@ lang: en
|
|||
<p id = "para-109">Also note that you don’t have to specify a title. This is because the title of the chapter is inferred from the Markdown document. To go back to our previous example:</p>
|
||||
<pre><span style="color:#839496;">+ chapter_1.md
|
||||
</span></pre><p id = "para-110">does not specify a chapter title, because it will read it directly in <code>chapter_1.md</code>, e.g.:</p>
|
||||
<pre><span style="color:#b58900;">#</span><span style="color:#b58900;"> </span><span style="color:#cb4b16;">The day I was born</span><span style="color:#b58900;"> </span><span style="color:#b58900;">#</span><span style="color:#b58900;">
|
||||
<pre><span style="color:#b58900;"># </span><span style="color:#cb4b16;">The day I was born </span><span style="color:#b58900;">#
|
||||
</span><span style="color:#839496;">...
|
||||
</span></pre><p id = "para-111">Ideally, you should have one and only one level-one header (i.e. chapter title) in each Markdown file. If you have more than one, it might mess with the table of contents in some cases (e.g. for EPUB).</p>
|
||||
<h3 id = "link-43">Parts</h3>
|
||||
|
|
@ -1032,15 +1033,15 @@ lang: en
|
|||
</blockquote>
|
||||
<h2 id = "link-45">3.3. Crowbook options</h2>
|
||||
<p id = "para-119">The first part of the configuration file is dedicated to pass options to Crowbook. This is <a href = "https://en.wikipedia.org/wiki/YAML">YAML syntax</a>, so each line should be of the form <code>key: value</code>. Note that in most cases you don’t have to put string in quotes, e.g.:</p>
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">My title</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">: </span><span style="color:#2aa198;">My title
|
||||
</span></pre><p id = "para-120">It is however possible (and sometimes necessary) to escape some characters using quotes around strings:</p>
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">My: title!</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">My: title!</span><span style="color:#839496;">"
|
||||
</span></pre><p id = "para-121">It is possible to use multiline strings with <code>>-</code> and then indenting the lines that are part of the string:</p>
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#859900;">></span><span style="color:#93a1a1;">-</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">: </span><span style="color:#859900;">></span><span style="color:#93a1a1;">-
|
||||
</span><span style="color:#2aa198;"> A
|
||||
long
|
||||
title
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">Joan Doe</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#2aa198;">Joan Doe
|
||||
</span></pre><p id = "para-122">will set <code>title</code> to <code>“A long title”</code>. See <a href = "https://en.wikipedia.org/wiki/YAML#Block_literals">block literals in YAML</a> for more information on the various way to insert multiline strings (which mostly change the way newlines will or won’t be inserted).</p>
|
||||
<p id = "para-123">A final note on the syntax: all options must be set <em>before</em> the first chapter inclusion (that is, a line beginning with ‘+’, ‘-’, ‘x.’ (where <code>x</code> is a number) or ‘!’).</p>
|
||||
<h3 id = "link-46">Metadata</h3>
|
||||
|
|
@ -1064,33 +1065,33 @@ lang: en
|
|||
<p id = "para-127">All metadata are accessible from templates, see <a href = "#chapter-4">Templates</a>.</p>
|
||||
<h3 id = "link-47">The <code>import</code> special option</h3>
|
||||
<p id = "para-128">The special <code>import</code> option allows you to include the options of another book configuration file. E.g., assuming that you want some common options to be applied to both <code>foo.book</code> and <code>bar.book</code>, you can create a <code>common.book</code> file:</p>
|
||||
<pre><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Joan Doe</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">lang</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">en</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">license</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">Copyright (C) Joan Doe. All rights reserved.</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Joan Doe
|
||||
lang</span><span style="color:#839496;">: </span><span style="color:#268bd2;">en
|
||||
license</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">Copyright (C) Joan Doe. All rights reserved.</span><span style="color:#839496;">"
|
||||
|
||||
</span><span style="color:#268bd2;">html.header</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">[Joan Doe's website](http://joan-doe.com)</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">tex.template</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">my_template.tex</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">html.header</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">[Joan Doe's website](http://joan-doe.com)</span><span style="color:#839496;">"
|
||||
</span><span style="color:#268bd2;">tex.template</span><span style="color:#839496;">: </span><span style="color:#2aa198;">my_template.tex
|
||||
</span></pre><p id = "para-129">You can then include this file in <code>foo.book</code>:</p>
|
||||
<pre><span style="color:#268bd2;">import</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">common.book</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">Foo</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">import</span><span style="color:#839496;">: </span><span style="color:#268bd2;">common.book
|
||||
title</span><span style="color:#839496;">: </span><span style="color:#2aa198;">Foo
|
||||
|
||||
</span><span style="color:#2aa198;">+ foo_01.md</span><span style="color:#839496;">
|
||||
</span><span style="color:#2aa198;">+ foo_02.md</span><span style="color:#839496;">
|
||||
+ foo_01.md
|
||||
+ foo_02.md
|
||||
</span></pre><p id = "para-130">Or include it in <code>bar.book</code>, but override some of its features:</p>
|
||||
<pre><span style="color:#268bd2;">import</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">common.book</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Bar</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">license</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">CC-BY-SA</span><span style="color:#839496;"> </span><span style="color:#586e75;">#</span><span style="color:#586e75;"> Override the license from common.book
|
||||
<pre><span style="color:#268bd2;">import</span><span style="color:#839496;">: </span><span style="color:#268bd2;">common.book
|
||||
title</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Bar
|
||||
license</span><span style="color:#839496;">: </span><span style="color:#2aa198;">CC-BY-SA </span><span style="color:#586e75;"># Override the license from common.book
|
||||
|
||||
+ bar_01.md
|
||||
</span><span style="color:#2aa198;">+ bar_01.md
|
||||
</span></pre><h3 id = "link-48">Output options</h3>
|
||||
<p id = "para-131">These options specify which files to generate.</p>
|
||||
<p id = "para-132">Note that all file paths are relative to the directory where the configuration file is, not to the one where you run <code>crowbook</code>. So if you set</p>
|
||||
<pre><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">foo.epub</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">: </span><span style="color:#2aa198;">foo.epub
|
||||
</span></pre><p id = "para-133">and run</p>
|
||||
<pre><span style="color:#839496;">$ crowbook some/</span><span style="color:#859900;">dir</span><span style="color:#839496;">/config.book
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook some/dir/config.book
|
||||
</span></pre><p id = "para-134"><code>foo.epub</code> will be generated in <code>some/dir</code>, not in your current directory.</p>
|
||||
<p id = "para-135">Crowbook will try to generate each of the <code>output.xxx</code> files that are specified. That means that you’ll have to set at least one of those if you want a call to</p>
|
||||
<pre><span style="color:#839496;">$ crowbook my.book
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook my.book
|
||||
</span></pre><p id = "para-136">to generate anything. (It’s still possible to generate a specific format, and only this one, by using the <code>--to</code> and <code>--output</code> argument on the command line).</p>
|
||||
<p id = "para-137">Note that some formats depend on some commands being installed on your system. Most notably, Crowbook depends on LaTeX (<code>xelatex</code> by default, though you can specify another command to use with <code>tex.command</code>) to generate a PDF file, so PDF rendering won’t work if it is not installed on your system. Crowbook also uses the <code>zip</code> command to generate the EPUB and ODT files.</p>
|
||||
<p id = "para-138">Current output options are:</p>
|
||||
|
|
@ -1104,22 +1105,22 @@ lang: en
|
|||
<p id = "para-139">(There are other output options for generating proofreading files, see <a href = "#chapter-5">Proofreading</a>, and interactive fiction, see <a href = "#chapter-6">Interactive fiction</a>.)</p>
|
||||
<h4 id = "link-49">The <code>output</code> option</h4>
|
||||
<p id = "para-140">Setting output file names manually can be a bit tedious, and is not always necessary. You can also specify a list of output formats with the <code>output</code> option:</p>
|
||||
<pre><span style="color:#268bd2;">output</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">html</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">output</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">, </span><span style="color:#2aa198;">html</span><span style="color:#839496;">]
|
||||
</span></pre><p id = "para-141">This is similar to the alternative syntax for YAML list:</p>
|
||||
<pre><span style="color:#268bd2;">output</span><span style="color:#839496;">:</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">-</span><span style="color:#839496;"> </span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">-</span><span style="color:#839496;"> </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">-</span><span style="color:#839496;"> </span><span style="color:#2aa198;">html</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">output</span><span style="color:#839496;">:
|
||||
- </span><span style="color:#2aa198;">pdf
|
||||
</span><span style="color:#839496;">- </span><span style="color:#2aa198;">epub
|
||||
</span><span style="color:#839496;">- </span><span style="color:#2aa198;">html
|
||||
</span></pre><p id = "para-142">This option will set default output path for PDF, EPUB and HTML according to the book configuration file name. So, if your book is <code>my_book.book</code> (or <code>my_book.md</code>), it will generate <code>my_book.pdf</code>, <code>my_book.html</code> and <code>my_book.epub</code>.</p>
|
||||
<blockquote><p id = "para-143">You can also infer the output file name by specifying “auto” to e.g. <code>output.html</code>. The previous example is thus equivalent to</p>
|
||||
<pre><span style="color:#268bd2;">output.pdf</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">auto</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">auto</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">output.html</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">auto</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">output.pdf</span><span style="color:#839496;">: </span><span style="color:#268bd2;">auto
|
||||
output.epub</span><span style="color:#839496;">: </span><span style="color:#268bd2;">auto
|
||||
output.html</span><span style="color:#839496;">: </span><span style="color:#2aa198;">auto
|
||||
</span></pre></blockquote>
|
||||
<h4 id = "link-50"><code>output.base_path</code></h4>
|
||||
<p id = "para-144">Additionally, the <code>output.base_path</code> option allows you to set where the output files will be written (relatively to the book configuration file). E.g.,</p>
|
||||
<pre><span style="color:#268bd2;">output.base_path</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">docs/book</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">book.epub</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">output.base_path</span><span style="color:#839496;">: </span><span style="color:#268bd2;">docs/book
|
||||
output.epub</span><span style="color:#839496;">: </span><span style="color:#2aa198;">book.epub
|
||||
</span></pre><p id = "para-145">will render the EPUB file in <code>docs/book/book.epub</code>.</p>
|
||||
<h3 id = "link-51">Input options</h3>
|
||||
<p id = "para-146">Crowbook does its best to improve the typography of your text. Default settings should be good enough for most usages, but you can enable/disable specific options:</p>
|
||||
|
|
@ -1183,20 +1184,20 @@ lang: en
|
|||
<p id = "para-152">These options allow to embed additional files for some formats (currently, only EPUB). This can be useful for embedding fonts.</p>
|
||||
<h4 id = "link-58">resources.files</h4>
|
||||
<p id = "para-153">A list of files or directories that should be added.</p>
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">font1.otf</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">font2.otf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">font1.otf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">font2.otf</span><span style="color:#839496;">]
|
||||
</span></pre><p id = "para-154">It is also possible to specify a directory (or multiple directories). So if you have a <code>fonts</code> directories containing <code>font1.otf</code> and <code>font2.otf</code>,</p>
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">fonts</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">fonts</span><span style="color:#839496;">]
|
||||
</span></pre><p id = "para-155">will be equivalent to:</p>
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">fonts/font1.otf</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">fonts/font2.otf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">fonts/font1.otf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">fonts/font2.otf</span><span style="color:#839496;">]
|
||||
</span></pre><p id = "para-156"><b>default</b>: not set</p>
|
||||
<h4 id = "link-59">resources.out_path</h4>
|
||||
<p id = "para-157">This option determine where (in which directory), <em>in the resulting document</em>, those files will be copied. The default is <code>data</code>, so by default the <code>resources.files</code> in the first example above will search <code>font1.otf</code> and <code>font2.otf</code> <em>in the same directory than the <code>.book</code> file</em>, and will copy them to <code>data/font1.otf</code> and <code>data/font2.otf</code> <em>in the EPUB file</em>. This is therefore this last path that you should use if you want to access those files e.g. in a custom CSS stylesheet.</p>
|
||||
<p id = "para-158">Note that if you pass directories to <code>resources.files</code>, the whole directory would be copied. So assuming <code>fonts/</code> contains <code>font1.otf</code> and <code>font2.otf</code></p>
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">fonts</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">resources.path</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">data</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">fonts</span><span style="color:#839496;">]
|
||||
</span><span style="color:#268bd2;">resources.path</span><span style="color:#839496;">: </span><span style="color:#2aa198;">data
|
||||
</span></pre><p id = "para-159">will copy these two files to <code>data/fonts/font1.otf</code> and <code>data/fonts/font2.otf</code> (and not <code>data/font1.otf</code> and <code>data/font2.otf</code>).</p>
|
||||
<p id = "para-160">Similarly, the whole path of <code>resources.files</code> is copied, so</p>
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">fonts/font1.otf</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">fonts/font2.otf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">fonts/font1.otf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">fonts/font2.otf</span><span style="color:#839496;">]
|
||||
</span></pre><p id = "para-161">will yield the same result.</p>
|
||||
<p id = "para-162"><b>default</b>: <code>data</code></p>
|
||||
<h2 id = "link-60">3.4. Full list of options</h2>
|
||||
|
|
@ -1904,11 +1905,11 @@ lang: en
|
|||
<p id = "para-166">However, pulldown-cmark also implements a handful of unofficial extensions, and Crowbook also adds its own variants, so there are a few syntax elements that are not covered by the CommonMark reference.</p>
|
||||
<h2 id = "link-78">4.1. Tables</h2>
|
||||
<p id = "para-167">Tables can be included in your Markdown file. E.g.:</p>
|
||||
<pre><span style="color:#839496;">|</span><span style="color:#839496;"> Author </span><span style="color:#839496;">|</span><span style="color:#839496;"> Book </span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">|</span><span style="color:#657b83;">--------------------</span><span style="color:#839496;">|</span><span style="color:#657b83;">----------------------------</span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">|</span><span style="color:#839496;"> Anne Rice </span><span style="color:#839496;">|</span><span style="color:#839496;"> Interview With the Vampire </span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">|</span><span style="color:#839496;"> Terry Pratchett </span><span style="color:#839496;">|</span><span style="color:#839496;"> Hogfather </span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">|</span><span style="color:#839496;"> George Martin </span><span style="color:#839496;">|</span><span style="color:#839496;"> A Dance with Dragons </span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||||
<pre><span style="color:#839496;">| Author | Book |
|
||||
|</span><span style="color:#657b83;">--------------------</span><span style="color:#839496;">|</span><span style="color:#657b83;">----------------------------</span><span style="color:#839496;">|
|
||||
| Anne Rice | Interview With the Vampire |
|
||||
| Terry Pratchett | Hogfather |
|
||||
| George Martin | A Dance with Dragons |
|
||||
</span></pre><p id = "para-168">will render as</p>
|
||||
<div class = "table">
|
||||
<table>
|
||||
|
|
@ -1928,24 +1929,24 @@ lang: en
|
|||
<h2 id = "link-79">4.2. Footnotes</h2>
|
||||
<p id = "para-170">Footnotes can be specified the following way:</p>
|
||||
<pre><span style="color:#839496;">Footnotes can be useful[^1] and make you look clever.
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">[</span><span style="color:#2aa198;">^1</span><span style="color:#839496;">]</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">But</span><span style="color:#839496;"> </span><span style="color:#839496;">you shouldn't use them too much.</span><span style="color:#839496;">
|
||||
|
||||
[</span><span style="color:#b58900;">^1</span><span style="color:#839496;">]: </span><span style="color:#2aa198;">But </span><span style="color:#839496;">you shouldn't use them too much.</span><span style="color:#839496;">
|
||||
</span></pre><p id = "para-171">Will be rendered as:</p>
|
||||
<blockquote><p id = "para-173">Footnotes can be useful<a href = "#note-dest-1"><sup id = "note-source-1">[1]</sup></a> and make you look clever.</p>
|
||||
</blockquote>
|
||||
<p id = "para-174">You can use multiple paragraphs in a footnote definition. This can sometimes be useful, but it can also be tricky, as if you only let an empty line before the next paragraph, it will also be included in the footnote. And probably the next one and the following one too:</p>
|
||||
<pre><span style="color:#839496;">This is a footnote usage[^1].
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">[</span><span style="color:#2aa198;">^1</span><span style="color:#839496;">]</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">This</span><span style="color:#839496;"> </span><span style="color:#839496;">is obviously part of the footnote definition.</span><span style="color:#839496;">
|
||||
|
||||
</span><span style="color:#839496;">This is less obviously ALSO part of the footnote definition.
|
||||
[</span><span style="color:#b58900;">^1</span><span style="color:#839496;">]: </span><span style="color:#2aa198;">This </span><span style="color:#839496;">is obviously part of the footnote definition.</span><span style="color:#839496;">
|
||||
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">This is NOT part of the foonote.
|
||||
This is less obviously ALSO part of the footnote definition.
|
||||
|
||||
|
||||
This is NOT part of the foonote.
|
||||
</span></pre><p id = "para-175">Due to its own quirks, Crowbook will duplicate footnotes if you reference them multiple times:</p>
|
||||
<pre><span style="color:#839496;">This footnote is unique[^2] but referenced twice[^2].
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">[</span><span style="color:#2aa198;">^2</span><span style="color:#839496;">]</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">Or</span><span style="color:#839496;"> </span><span style="color:#839496;">is it?</span><span style="color:#839496;">
|
||||
|
||||
[</span><span style="color:#b58900;">^2</span><span style="color:#839496;">]: </span><span style="color:#2aa198;">Or </span><span style="color:#839496;">is it?</span><span style="color:#839496;">
|
||||
</span></pre><blockquote><p id = "para-178">This footnote is unique<a href = "#note-dest-2"><sup id = "note-source-2">[2]</sup></a> but referenced twice<a href = "#note-dest-3"><sup id = "note-source-3">[3]</sup></a>.</p>
|
||||
</blockquote>
|
||||
<h2 id = "link-80">4.3. Superscript and subscript</h2>
|
||||
|
|
@ -1967,7 +1968,7 @@ lang: en
|
|||
</div><div id = "chapter-4" class = "chapter">
|
||||
<h1 id = 'link-83'><span class = 'chapter-header'>Chapter 5</span><br />Templates</h1><p id = "para-186">Crowbook allows the user to specify a number of templates.<a href = "#note-dest-4"><sup id = "note-source-4">[4]</sup></a></p>
|
||||
<p id = "para-187">Each of this template can be overriden by a custom one, by setting e.g.:</p>
|
||||
<pre><span style="color:#268bd2;">html.css</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">my_template.css</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">html.css</span><span style="color:#839496;">: </span><span style="color:#2aa198;">my_template.css
|
||||
</span></pre><p id = "para-188">in the book configuration file. The templates that you are most susceptible to modify are the following:</p>
|
||||
<ul>
|
||||
<li><code>html.css</code>: stylesheet for HTML output;</li>
|
||||
|
|
@ -1976,27 +1977,27 @@ lang: en
|
|||
</ul>
|
||||
<h2 id = "link-84">5.1. Create and edit template</h2>
|
||||
<p id = "para-189">Except for inline templates, which are set directly in the book configuration file:</p>
|
||||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> Template that modify how a chapter title is displayed
|
||||
rendering.chapter.template: "{{{loc_chapter}}} {{{number}}}: {{{chapter_title}}}"
|
||||
<pre><span style="color:#586e75;"># Template that modify how a chapter title is displayed
|
||||
</span><span style="color:#268bd2;">rendering.chapter.template</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">{{{loc_chapter}}} {{{number}}}: {{{chapter_title}}}</span><span style="color:#839496;">"
|
||||
|
||||
# CSS code added to default CSS templates (but don't override it)
|
||||
html.css.add: "h1 { background-color: red; }"
|
||||
epub.css.add: "h1 { background-color: gray; }"
|
||||
</span><span style="color:#586e75;"># CSS code added to default CSS templates (but don't override it)
|
||||
</span><span style="color:#268bd2;">html.css.add</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">h1 { background-color: red; }</span><span style="color:#839496;">"
|
||||
</span><span style="color:#268bd2;">epub.css.add</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">h1 { background-color: gray; }</span><span style="color:#839496;">"
|
||||
|
||||
# LaTeX code added to default LaTeX template (but doesn't override it)
|
||||
template.tex.add: "\usepackage{libertineotf}"
|
||||
</span><span style="color:#586e75;"># LaTeX code added to default LaTeX template (but doesn't override it)
|
||||
</span><span style="color:#268bd2;">template.tex.add</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">\usepackage{libertineotf}</span><span style="color:#839496;">"
|
||||
</span></pre><p id = "para-190">most templates must be in a separate file:</p>
|
||||
<pre><span style="color:#268bd2;">tex.template</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">my_template.tex</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">tex.template</span><span style="color:#839496;">: </span><span style="color:#2aa198;">my_template.tex
|
||||
</span></pre><h3 id = "link-85"><code>--print-template</code></h3>
|
||||
<p id = "para-191">The easiest way to create a new template is to start with the default one. In order to do so, you can use the <code>--print-template</code> argument:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook --print-template tex.template </span><span style="color:#859900;">></span><span style="color:#839496;"> my_template.tex
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> --print-template</span><span style="color:#839496;"> tex.template </span><span style="color:#657b83;">></span><span style="color:#839496;"> my_template.tex
|
||||
</span></pre><p id = "para-192">In order to get the <code>chapter.xhtml</code> template for EPUB3, you’ll also have to use <code>--set epub.version 3</code>:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook --print-template epub.chapter.xhtml --</span><span style="color:#859900;">set</span><span style="color:#839496;"> epub.version 3 </span><span style="color:#859900;">></span><span style="color:#839496;"> my_epub3_template.xhtml
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> --print-template</span><span style="color:#839496;"> epub.chapter.xhtml</span><span style="color:#268bd2;"> --set</span><span style="color:#839496;"> epub.version 3 </span><span style="color:#657b83;">></span><span style="color:#839496;"> my_epub3_template.xhtml
|
||||
</span></pre><h3 id = "link-86">Mustache syntax</h3>
|
||||
<p id = "para-193">Crowbook uses <a href = "https://crates.io/crates/mustache">rust-mustache</a> as its templating engine, which allows to use <a href = "http://mustache.github.io/">Mustache</a> syntax in the templates.</p>
|
||||
<p id = "para-195">It mainly boils down to using <code>{{{foo}}}</code><a href = "#note-dest-5"><sup id = "note-source-5">[5]</sup></a> to insert the value of variable <code>foo</code> in the document:</p>
|
||||
<pre><span style="color:#586e75;"><</span><span style="color:#268bd2;">h1</span><span style="color:#657b83;"> </span><span style="color:#b58900;">class</span><span style="color:#657b83;"> </span><span style="color:#657b83;">=</span><span style="color:#657b83;"> </span><span style="color:#839496;">"</span><span style="color:#657b83;">title</span><span style="color:#839496;">"</span><span style="color:#657b83;"> </span><span style="color:#586e75;">></span><span style="color:#839496;">{{{title}}}</span><span style="color:#586e75;"><</span><span style="color:#268bd2;">h1</span><span style="color:#586e75;">></span><span style="color:#839496;">
|
||||
</span><span style="color:#586e75;"><</span><span style="color:#268bd2;">h2</span><span style="color:#657b83;"> </span><span style="color:#b58900;">class</span><span style="color:#657b83;"> </span><span style="color:#657b83;">=</span><span style="color:#657b83;"> </span><span style="color:#839496;">"</span><span style="color:#657b83;">author</span><span style="color:#839496;">"</span><span style="color:#586e75;">></span><span style="color:#839496;">{{{author}}}</span><span style="color:#586e75;"></</span><span style="color:#268bd2;">h2</span><span style="color:#586e75;">></span><span style="color:#839496;">
|
||||
<pre><span style="color:#586e75;"><</span><span style="color:#268bd2;">h1 </span><span style="color:#b58900;">class </span><span style="color:#657b83;">= </span><span style="color:#839496;">"</span><span style="color:#657b83;">title</span><span style="color:#839496;">" </span><span style="color:#586e75;">></span><span style="color:#839496;">{{{title}}}</span><span style="color:#586e75;"><</span><span style="color:#268bd2;">h1</span><span style="color:#586e75;">>
|
||||
<</span><span style="color:#268bd2;">h2 </span><span style="color:#b58900;">class </span><span style="color:#657b83;">= </span><span style="color:#839496;">"</span><span style="color:#657b83;">author</span><span style="color:#839496;">"</span><span style="color:#586e75;">></span><span style="color:#839496;">{{{author}}}</span><span style="color:#586e75;"></</span><span style="color:#268bd2;">h2</span><span style="color:#586e75;">>
|
||||
</span></pre><p id = "para-196">Mustache also provides the possibility of checking whether a variable is set:</p>
|
||||
<pre><span style="color:#839496;">{{#foo}}
|
||||
Foo exists
|
||||
|
|
@ -2005,20 +2006,20 @@ Foo exists
|
|||
Foo does not exist
|
||||
{{^foo}}
|
||||
</span></pre><p id = "para-197">Crowbook uses this and sets some variables to <code>true</code> to allow templates to conditionally include some portions. E.g., in <code>html.css</code>:</p>
|
||||
<pre><span style="color:#657b83;">{</span><span style="color:#839496;">{#</span><span style="color:#839496;">lang</span><span style="color:#839496;">_</span><span style="color:#839496;">fr</span><span style="color:#657b83;">}</span><span style="color:#839496;">}
|
||||
</span><span style="color:#586e75;">/*</span><span style="color:#586e75;"> Make list displays '–' instead of bullets </span><span style="color:#586e75;">*/</span><span style="color:#657b83;">
|
||||
</span><span style="color:#b58900;">ul</span><span style="color:#657b83;"> </span><span style="color:#b58900;">li</span><span style="color:#657b83;"> </span><span style="color:#657b83;">{</span><span style="color:#839496;">
|
||||
</span><span style="color:#859900;">list-style-type</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">'</span><span style="color:#2aa198;">–</span><span style="color:#839496;">'</span><span style="color:#839496;">;</span><span style="color:#839496;">
|
||||
</span><span style="color:#859900;">padding-left</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#6c71c4;">.5</span><span style="color:#859900;">em</span><span style="color:#839496;">;</span><span style="color:#839496;">
|
||||
</span><span style="color:#657b83;">}</span><span style="color:#839496;">
|
||||
</span><span style="color:#657b83;">{</span><span style="color:#839496;">{/</span><span style="color:#839496;">lang</span><span style="color:#839496;">_</span><span style="color:#839496;">fr</span><span style="color:#657b83;">}</span><span style="color:#839496;">}
|
||||
<pre><span style="color:#657b83;">{</span><span style="color:#839496;">{#lang_fr</span><span style="color:#657b83;">}</span><span style="color:#839496;">}
|
||||
</span><span style="color:#586e75;">/* Make list displays '–' instead of bullets */
|
||||
</span><span style="color:#b58900;">ul li </span><span style="color:#657b83;">{
|
||||
</span><span style="color:#859900;">list-style-type</span><span style="color:#839496;">: '</span><span style="color:#2aa198;">–</span><span style="color:#839496;">';
|
||||
</span><span style="color:#859900;">padding-left</span><span style="color:#839496;">: </span><span style="color:#6c71c4;">.5</span><span style="color:#859900;">em</span><span style="color:#839496;">;
|
||||
</span><span style="color:#657b83;">}
|
||||
{</span><span style="color:#839496;">{/lang_fr</span><span style="color:#657b83;">}</span><span style="color:#839496;">}
|
||||
</span></pre><p id = "para-198">In this case, Crowbook sets a variable whose name is equal to <code>lang_foo</code> to <code>true</code>, allowing to have different styles for some elements according to the language.</p>
|
||||
<p id = "para-199">For more information about Mustache syntax, see the <a href = "http://mustache.github.io/mustache.5.html">Mustache manual</a>.</p>
|
||||
<h4 id = "link-87">Syntax in LaTeX</h4>
|
||||
<p id = "para-201">Since LaTeX already uses a lot of curly brackets, the default template sets an altenative syntax to access variables, with <code><<&foo>></code><a href = "#note-dest-6"><sup id = "note-source-6">[6]</sup></a>:</p>
|
||||
<pre><span style="color:#859900;">\</span><span style="color:#859900;">title</span><span style="color:#839496;">{</span><span style="color:#839496;"><<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">title>></span><span style="color:#839496;">}</span><span style="color:#839496;">
|
||||
</span><span style="color:#859900;">\</span><span style="color:#859900;">author</span><span style="color:#839496;">{</span><span style="color:#839496;"><<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">author>></span><span style="color:#839496;">}</span><span style="color:#839496;">
|
||||
<<#has_date>></span><span style="color:#859900;">\</span><span style="color:#859900;">date</span><span style="color:#839496;">{</span><span style="color:#839496;"><<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">date>></span><span style="color:#839496;">}</span><span style="color:#839496;"><</has_date>
|
||||
<pre><span style="color:#859900;">\title</span><span style="color:#839496;">{<<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">title>>}
|
||||
</span><span style="color:#859900;">\author</span><span style="color:#839496;">{<<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">author>>}
|
||||
<<#has_date>></span><span style="color:#859900;">\date</span><span style="color:#839496;">{<<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">date>>}<</has_date>
|
||||
</span></pre> <h3 id = "link-89">html.js</h3>
|
||||
<p id = "para-202">The javascript file used by both the standalone HTML renderer and the multiple files HTML renderer.</p>
|
||||
<p id = "para-203">This is not currently an actual template, just a plain javascript file which cannot contain <code>mustache</code> tags.</p>
|
||||
|
|
@ -2189,32 +2190,32 @@ Foo does not exist
|
|||
</ul>
|
||||
<h2 id = "link-107">6.1. Enabling proofreading</h2>
|
||||
<p id = "para-229">Since proofreading can take quite a lot of time, particularly for a long book, it is disabled by default. You’ll have to run</p>
|
||||
<pre><span style="color:#839496;">$ crowbook --proofread my.book
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> --proofread</span><span style="color:#839496;"> my.book
|
||||
</span></pre><p id = "para-230">or</p>
|
||||
<pre><span style="color:#839496;">$ crowbook -p my.book
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> -p</span><span style="color:#839496;"> my.book
|
||||
</span></pre><p id = "para-231">to generate proofreading copies. Alternatively, if you want it to be activated each time you run <code>crowbook</code> on this book (which is <em>not</em> recommanded for long books, particularly if you want to perform a grammar check), you can set</p>
|
||||
<pre><span style="color:#268bd2;">proofread</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#b58900;">true</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">proofread</span><span style="color:#839496;">: </span><span style="color:#b58900;">true
|
||||
</span></pre><p id = "para-232">in the book configuration file.</p>
|
||||
<h2 id = "link-108">6.2. Repetition detection</h2>
|
||||
<p id = "para-233">Repetition detection is enabled with:</p>
|
||||
<pre><span style="color:#268bd2;">proofread.repetitions</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#b58900;">true</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">proofread.repetitions</span><span style="color:#839496;">: </span><span style="color:#b58900;">true
|
||||
</span></pre><p id = "para-234">It uses <a href = "https://github.com/lise-henry/caribon">Caribon</a> library to detect the repetition in your text. Since the notion of a repetition is relatively arbitrary, it is possible to adapt the settings. Default are:</p>
|
||||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> The maximum distance between two identical words to
|
||||
<pre><span style="color:#586e75;"># The maximum distance between two identical words to
|
||||
# consider them a repetition
|
||||
proofread.repetitions.max_distance: 25
|
||||
# The minimal number of occurences to consider it a repetition
|
||||
proofread.repetitions.threshold: 2.0
|
||||
# Ignore proper nouns (words starting by a capital,
|
||||
</span><span style="color:#268bd2;">proofread.repetitions.max_distance</span><span style="color:#839496;">: </span><span style="color:#6c71c4;">25
|
||||
</span><span style="color:#586e75;"># The minimal number of occurences to consider it a repetition
|
||||
</span><span style="color:#268bd2;">proofread.repetitions.threshold</span><span style="color:#839496;">: </span><span style="color:#6c71c4;">2.0
|
||||
</span><span style="color:#586e75;"># Ignore proper nouns (words starting by a capital,
|
||||
# not at a beginning of a sentence)
|
||||
proofread.repetitions.ignore_proper: true
|
||||
</span><span style="color:#268bd2;">proofread.repetitions.ignore_proper</span><span style="color:#839496;">: </span><span style="color:#b58900;">true
|
||||
|
||||
# Activate fuzzy string matching
|
||||
proofread.repetitions.fuzzy: true
|
||||
# The maximal ratio of difference to consider
|
||||
</span><span style="color:#586e75;"># Activate fuzzy string matching
|
||||
</span><span style="color:#268bd2;">proofread.repetitions.fuzzy</span><span style="color:#839496;">: </span><span style="color:#b58900;">true
|
||||
</span><span style="color:#586e75;"># The maximal ratio of difference to consider
|
||||
# that two words are identical
|
||||
# (E.g., with 0.2, "Rust" and "Lust" won't be
|
||||
# considered as the same word, but they will be with 0.5)
|
||||
proofread.repetitions.fuzzy.threshold: 0.2
|
||||
</span><span style="color:#268bd2;">proofread.repetitions.fuzzy.threshold</span><span style="color:#839496;">: </span><span style="color:#6c71c4;">0.2
|
||||
</span></pre><p id = "para-235">For more information, see <a href = "https://github.com/lise-henry/caribon">Caribon</a>’s documentation.</p>
|
||||
<blockquote><p id = "para-236">Currently, repetitions are not displayed in PDF proofreading output.</p>
|
||||
</blockquote>
|
||||
|
|
@ -2222,24 +2223,24 @@ proofread.repetitions.fuzzy.threshold: 0.2
|
|||
<h3 id = "link-110">With Languagetool</h3>
|
||||
<p id = "para-237">Crowbook can use <a href = "https://languagetool.org/">LanguageTool</a> to detect grammar errors in your text. It is, however, a bit more complex to activate.</p>
|
||||
<p id = "para-238">First, you’ll have to activate this feature in your book configuration file:</p>
|
||||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> Activate language tool support
|
||||
proofread.languagetool: true
|
||||
# (Optional) Sets the port number to connect to (default below)
|
||||
proofread.languagetool.port: 8081
|
||||
<pre><span style="color:#586e75;"># Activate language tool support
|
||||
</span><span style="color:#268bd2;">proofread.languagetool</span><span style="color:#839496;">: </span><span style="color:#b58900;">true
|
||||
</span><span style="color:#586e75;"># (Optional) Sets the port number to connect to (default below)
|
||||
</span><span style="color:#268bd2;">proofread.languagetool.port</span><span style="color:#839496;">: </span><span style="color:#6c71c4;">8081
|
||||
</span></pre><p id = "para-239">You’ll then have to download the stand-alone version of <a href = "https://languagetool.org/">LanguageTool</a>. It includes a server mode, which you’ll have to launch:</p>
|
||||
<pre><span style="color:#839496;">$ </span><span style="color:#859900;">java</span><span style="color:#839496;"> -</span><span style="color:#859900;">cp</span><span style="color:#839496;"> languagetool-server.</span><span style="color:#859900;">jar</span><span style="color:#839496;"> org.languagetool.server.HTTPServer --port 8081
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> java</span><span style="color:#268bd2;"> -cp</span><span style="color:#839496;"> languagetool-server.jar org.languagetool.server.HTTPServer</span><span style="color:#268bd2;"> --port</span><span style="color:#839496;"> 8081
|
||||
</span></pre><p id = "para-240">You can also use the LanguageTool GUI (<code>languagetool.jar</code>) and start the server from the menu “Text Checking -> Options”. This also allows you to configure LanguageTool more precisely by activating or deactivating rules.</p>
|
||||
<p id = "para-241">You can then run Crowbook, and it will highlight grammar errors in HTML or PDF proofreading output files.</p>
|
||||
<blockquote><p id = "para-242">Note: running a grammar check on a long book (like a novel) can take up to a few minutes.</p>
|
||||
</blockquote>
|
||||
<h3 id = "link-111">With Grammalecte</h3>
|
||||
<p id = "para-243"><a href = "http://grammalecte.net/">Grammalecte</a> is a grammar checker specialized for the french language. If the language of your book is french, you can use it in a similar fashion to languagetool:</p>
|
||||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> Activate grammalecte support
|
||||
proofread.grammalecte: true
|
||||
# (Optional) Sets the port number to connect to (default below)
|
||||
proofread.grammalecte.port: 8080
|
||||
<pre><span style="color:#586e75;"># Activate grammalecte support
|
||||
</span><span style="color:#268bd2;">proofread.grammalecte</span><span style="color:#839496;">: </span><span style="color:#b58900;">true
|
||||
</span><span style="color:#586e75;"># (Optional) Sets the port number to connect to (default below)
|
||||
</span><span style="color:#268bd2;">proofread.grammalecte.port</span><span style="color:#839496;">: </span><span style="color:#6c71c4;">8080
|
||||
</span></pre><p id = "para-244">You’ll also need to run the Grammalecte server. First <a href = "https://www.dicollecte.org/#download_div">download the CLI and server version</a>, then:</p>
|
||||
<pre><span style="color:#839496;">$ </span><span style="color:#859900;">python3</span><span style="color:#839496;"> server.</span><span style="color:#859900;">py</span><span style="color:#839496;">
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> python3 server.py
|
||||
</span></pre><p id = "para-245">You can then run Crowbook with <code>--proofread</code> to check the grammar of your book. It is possible to run both LanguageTool and Grammalecte on the same book (though might take a while for a long book...).</p>
|
||||
|
||||
</div><div id = "chapter-6" class = "chapter">
|
||||
|
|
@ -2248,41 +2249,41 @@ proofread.grammalecte.port: 8080
|
|||
</blockquote>
|
||||
<h2 id = "link-113">7.1. Basics</h2>
|
||||
<p id = "para-248">If you want to have a non-linear story, you can simply use Markdown links just as you would for any other link:</p>
|
||||
<pre><span style="color:#839496;">*</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#839496;">Open the treasure chest</span><span style="color:#839496;">]</span><span style="color:#839496;">(</span><span style="color:#2aa198;">open_chest.md</span><span style="color:#839496;">)</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">*</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#839496;">It might be trapped, stay away from it</span><span style="color:#839496;">]</span><span style="color:#839496;">(</span><span style="color:#2aa198;">stay_away.md</span><span style="color:#839496;">)</span><span style="color:#839496;">
|
||||
<pre><span style="color:#839496;">* [Open the treasure chest](</span><span style="color:#2aa198;">open_chest.md</span><span style="color:#839496;">)
|
||||
* [It might be trapped, stay away from it](</span><span style="color:#2aa198;">stay_away.md</span><span style="color:#839496;">)
|
||||
</span></pre><p id = "para-249">All Crowbook renderers should render this correctly, allowing the reader to “choose her adventure”. Note, however, that you still need to include all these Markdown files in you book configuration files.</p>
|
||||
<h2 id = "link-114">7.2. The interactive fiction renderer</h2>
|
||||
<p id = "para-250">While the above allows you to generate correct EPUB and PDF files, it will still display all the content if the reader chooses to read your book linearly. While this may not be a problem, you might want to only display the part of the book that the reader is actually exploring.</p>
|
||||
<p id = "para-251">In order to do so, you can use the interactive fiction html renderer:</p>
|
||||
<pre><span style="color:#268bd2;">output.html.if</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">my_book.html</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">output.html.if</span><span style="color:#839496;">: </span><span style="color:#2aa198;">my_book.html
|
||||
</span></pre><p id = "para-252">This output is similar to the standalone HTML output, except the option to display only a chapter at a time is always true, and there is no way to display the table of contents.</p>
|
||||
<h2 id = "link-115">7.3. Using Javascript in your interactive fiction</h2>
|
||||
<p id = "para-253">While the above allows the reader to choose his own path, its interactivity is quite limited. With the interactive fiction renderer, it is possible to include Javascript code in your Markdown files, using a code block element:</p>
|
||||
<pre><span style="color:#839496;">You open the chest, and you find a shiny sword. Yay!
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;"> user_has_sword = true;
|
||||
|
||||
user_has_sword = true;
|
||||
</span></pre><p id = "para-254">This Javascript code can return a string value, which will be displayed inside the document according to the reader’s previous choices:</p>
|
||||
<pre><span style="color:#839496;">You encounter a goblin, armed with a knife!
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;"> if (user_has_sword) {
|
||||
</span><span style="color:#839496;"> return "You kill him with your sword, congratulations!";
|
||||
</span><span style="color:#839496;"> } else {
|
||||
</span><span style="color:#839496;"> return "You don't have any weapon, you die :(";
|
||||
</span><span style="color:#839496;"> }
|
||||
|
||||
if (user_has_sword) {
|
||||
return "You kill him with your sword, congratulations!";
|
||||
} else {
|
||||
return "You don't have any weapon, you die :(";
|
||||
}
|
||||
</span></pre><blockquote><p id = "para-255">Note that <em>only</em> the interactive fiction renderer supports this way of embedding Javascript code. If you try to render a document containing such code blocks to EPUB, PDF, or the “normal” HTML renderer, they will be displayed as regular code blocks.</p>
|
||||
</blockquote>
|
||||
<h2 id = "link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</h2>
|
||||
<p id = "para-256">If you want to include Markdown formatting in the Javascript code (to display a passage or another without having to write HTML code), you can use the <code>@"..."@</code> syntax:</p>
|
||||
<pre><span style="color:#839496;"> @"You face a troll!"@
|
||||
</span><span style="color:#839496;"> if (user_has_sword) {
|
||||
</span><span style="color:#839496;"> @"* [Attack him with your sword](fight_troll.md)"@
|
||||
</span><span style="color:#839496;"> } else {
|
||||
</span><span style="color:#839496;"> @"* [Better run away](run_away.md)"@
|
||||
</span><span style="color:#839496;"> }
|
||||
if (user_has_sword) {
|
||||
@"* [Attack him with your sword](fight_troll.md)"@
|
||||
} else {
|
||||
@"* [Better run away](run_away.md)"@
|
||||
}
|
||||
</span></pre><p id = "para-257">Note that in this case you don’t need to return a value, this is done behind your back. Similarly, <code>@"..."@</code> blocks don’t require semicolons.</p>
|
||||
<p id = "para-258">If you need to access the value of a Javascript variable inside this Markdown code, you can use the <code>{{...}}</code> syntax:</p>
|
||||
<pre><span style="color:#839496;"> var name = prompt("Enter your name", "world");
|
||||
</span><span style="color:#839496;"> @"Hello, {{name}}"@
|
||||
@"Hello, {{name}}"@
|
||||
</span></pre><h2 id = "link-117">7.5. Conditional blocks</h2>
|
||||
<p id = "para-259">Sometimes, you want some text (or Javascript code) to only be displayed (or run) when the reader reads this passage the first time, or alternatively when she goes back to it. While it is trivial to add some code to check that, it is a common enough pattern to justify its own variant : you’ll juste have to insert a named code block with the number:</p>
|
||||
<pre><span style="color:#839496;">```1
|
||||
|
|
@ -2299,18 +2300,18 @@ proofread.grammalecte.port: 8080
|
|||
</span></pre><h2 id = "link-118">7.6. Interactive fiction options</h2>
|
||||
<p id = "para-260">As other renderers, there are options specific to the interactive fiction.</p>
|
||||
<p id = "para-261"><b>html.if.new_game</b> allows you to specify the path to a Javascript that will be run at the beginning of the game. Since this code is not embedded in a function and is at the root (and the beginning) of the document, it is a good place to declare all the functions and the global variables you might need for your interactive fiction mechanics. e.g.:</p>
|
||||
<pre><span style="color:#268bd2;">html.if.new_game</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">some_file.js</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">html.if.new_game</span><span style="color:#839496;">: </span><span style="color:#2aa198;">some_file.js
|
||||
</span></pre><p id = "para-262"><b>html.if.new_turn</b> and <b>html.if.end_turn</b> allow you to specify some Javascript code that will be executed at the beginning and the end of each segment. Unlike <code>html.if.new_game</code>, the (usually shorter) code is specified inline, and can return a string value that will be displayed at the beginning and the end of each segment. This is exactly like including code blocks at the beginning or the end of each of your Markdown file. E.g.:</p>
|
||||
<pre><span style="color:#268bd2;">html.if.new_turn</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">nb_turns += 1;</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">html.end_turn</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">return 'Turn: ' + nb_turns;</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">html.if.new_turn</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">nb_turns += 1;</span><span style="color:#839496;">"
|
||||
</span><span style="color:#268bd2;">html.end_turn</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">return 'Turn: ' + nb_turns;</span><span style="color:#839496;">"
|
||||
</span></pre><p id = "para-263"><b>html.if.script</b> allows you to specify the name of a Javascript file to override the default script.</p>
|
||||
|
||||
</div><div id = "chapter-7" class = "chapter">
|
||||
<h1 id = 'link-119'><span class = 'chapter-header'>Chapter 8</span><br />Tips and tricks</h1><h2 id = "link-120">8.1. Using Crowbook with Emacs’ markdown mode</h2>
|
||||
<p id = "para-264">If you use <a href = "https://www.gnu.org/software/emacs/">Emacs</a> as a text editor, there is a nice <a href = "http://jblevins.org/projects/markdown-mode/">Markdown mode</a> to edit Markdown files.</p>
|
||||
<p id = "para-265">It is possible to use Crowbook for HTML previewing in this mode, which <a href = "http://xkcd.com/1742/">requires only minimal configuration and tweaking</a>:</p>
|
||||
<pre><span style="color:#839496;">(</span><span style="color:#839496;">custom</span><span style="color:#657b83;">-</span><span style="color:#859900;">set</span><span style="color:#657b83;">-</span><span style="color:#839496;">variables
|
||||
'</span><span style="color:#839496;">(</span><span style="color:#839496;">markdown</span><span style="color:#657b83;">-</span><span style="color:#839496;">command </span><span style="color:#839496;">"</span><span style="color:#2aa198;">crowbook - -qs --to html --output -</span><span style="color:#839496;">"</span><span style="color:#839496;">)</span><span style="color:#839496;">)</span><span style="color:#839496;">
|
||||
<pre><span style="color:#839496;">(custom</span><span style="color:#657b83;">-</span><span style="color:#859900;">set</span><span style="color:#657b83;">-</span><span style="color:#839496;">variables
|
||||
'(markdown</span><span style="color:#657b83;">-</span><span style="color:#839496;">command "</span><span style="color:#2aa198;">crowbook - -qs --to html --output -</span><span style="color:#839496;">"))
|
||||
</span></pre><p id = "para-266">You can then use <code>markdown-preview</code> (or <code>C-c C-c p</code>) to run Crowbook on this file and preview it in your browser, or run <code>markdown-live-preview-mode</code> to see a live preview (updated each time you save your file) in Emacs’ integrated browser.</p>
|
||||
<h3 id = "link-121">Some explanations if it looks a bit cryptic to you</h3>
|
||||
<p id = "para-267">We set <code>markdown-command</code> to <code>crowbook</code>, the reason for this is a bit obvious. The arguments we give to crowbook might be a bit less obvious:</p>
|
||||
|
|
@ -2322,20 +2323,20 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
<h2 id = "link-122">8.2. Embedding fonts in an EPUB file</h2>
|
||||
<p id = "para-268">In order to embed fonts in an EPUB file, you’ll first have to edit the stylesheet, which you can first obtain with:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook --print-template epub.css </span><span style="color:#859900;">></span><span style="color:#839496;"> my_epub_stylesheet.css
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> --print-template</span><span style="color:#839496;"> epub.css </span><span style="color:#657b83;">></span><span style="color:#839496;"> my_epub_stylesheet.css
|
||||
</span></pre><p id = "para-269">You’ll need to use the <a href = "https://developer.mozilla.org/fr/docs/Web/CSS/@font-face"><code>@font-face</code> attribute</a>:</p>
|
||||
<pre><span style="color:#859900;">@</span><span style="color:#859900;">font-face</span><span style="color:#839496;"> </span><span style="color:#657b83;">{</span><span style="color:#839496;">
|
||||
</span><span style="color:#859900;">font-family</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">MyFont</span><span style="color:#839496;">;</span><span style="color:#839496;">
|
||||
</span><span style="color:#859900;">src</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#859900;">url</span><span style="color:#839496;">(</span><span style="color:#2aa198;">d</span><span style="color:#2aa198;">a</span><span style="color:#2aa198;">t</span><span style="color:#2aa198;">a</span><span style="color:#2aa198;">/</span><span style="color:#2aa198;">m</span><span style="color:#2aa198;">y</span><span style="color:#2aa198;">_</span><span style="color:#2aa198;">f</span><span style="color:#2aa198;">o</span><span style="color:#2aa198;">n</span><span style="color:#2aa198;">t</span><span style="color:#2aa198;">.</span><span style="color:#2aa198;">t</span><span style="color:#2aa198;">t</span><span style="color:#2aa198;">f</span><span style="color:#839496;">)</span><span style="color:#839496;">;</span><span style="color:#839496;">
|
||||
</span><span style="color:#657b83;">}</span><span style="color:#839496;">
|
||||
<pre><span style="color:#859900;">@font-face </span><span style="color:#657b83;">{
|
||||
</span><span style="color:#859900;">font-family</span><span style="color:#839496;">: </span><span style="color:#2aa198;">MyFont</span><span style="color:#839496;">;
|
||||
</span><span style="color:#859900;">src</span><span style="color:#839496;">: </span><span style="color:#859900;">url</span><span style="color:#839496;">(</span><span style="color:#2aa198;">data/my_font.ttf</span><span style="color:#839496;">);
|
||||
</span><span style="color:#657b83;">}
|
||||
</span></pre><p id = "para-270">Then you can add <code>my_font.ttf</code> to the files that need to be added to the EPUB zip file:</p>
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">My Book</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Me</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">: </span><span style="color:#268bd2;">My Book
|
||||
author</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Me
|
||||
|
||||
</span><span style="color:#268bd2;">cover</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">cover.png</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">book.epub</span><span style="color:#839496;">
|
||||
cover</span><span style="color:#839496;">: </span><span style="color:#268bd2;">cover.png
|
||||
output.epub</span><span style="color:#839496;">: </span><span style="color:#268bd2;">book.epub
|
||||
|
||||
</span><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">my_font.ttf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">my_font.ttf</span><span style="color:#839496;">]
|
||||
</span></pre><p id = "para-271">(Note that you’ll have to repeat the process for the different <code>font-weight</code> and <code>font-style</code> variants of your font if you want it to display correctly when there is some text in <b>bold</b>, <em>italics</em>, or <b><em>both</em></b>.)</p>
|
||||
|
||||
</div><div id = "chapter-8" class = "chapter">
|
||||
|
|
@ -2351,6 +2352,12 @@ proofread.grammalecte.port: 8080
|
|||
</div><div id = "chapter-9" class = "chapter">
|
||||
<h1 id = 'link-125'>ChangeLog</h1><h2 id = "link-126">unreleased</h2>
|
||||
<ul>
|
||||
<li><code>--stats</code> can now display more statistics when used with the <code>--verbose</code> option (if support for advanced statistics is compiled)</li>
|
||||
<li>LaTeX outputs now make uses of user-defined <code>rendering.chapter</code> and <code>rendering.part</code></li>
|
||||
<li>Dependencies update</li>
|
||||
</ul>
|
||||
<h2 id = "link-127">0.14.0 (2017-11-26)</h2>
|
||||
<ul>
|
||||
<li>New option:<ul>
|
||||
<li><code>autograph</code> is an autograph added after title.</li>
|
||||
</ul>
|
||||
|
|
@ -2368,7 +2375,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-127">0.14.0-beta (2017-10-08)</h2>
|
||||
<h2 id = "link-128">0.14.0-beta (2017-10-08)</h2>
|
||||
<ul>
|
||||
<li>Bugfixes:<ul>
|
||||
<li>EPUB: escape quotes in content.opf.</li>
|
||||
|
|
@ -2388,7 +2395,7 @@ proofread.grammalecte.port: 8080
|
|||
</li>
|
||||
<li>Now requires rustc >= 1.20.0</li>
|
||||
</ul>
|
||||
<h2 id = "link-128">0.13.0 (2017-07-14)</h2>
|
||||
<h2 id = "link-129">0.13.0 (2017-07-14)</h2>
|
||||
<ul>
|
||||
<li>Breaking changes:<ul>
|
||||
<li>The <code>template.tex</code> template was quite modified. Crowbook now uses custom command for most markdown elements, defined in the template. This allow an user to redefine the way the book is rendered without having to modify Crowbook itself. Unfortunately, as tex templates for previous Crowbook versions won’t work anymore.</li>
|
||||
|
|
@ -2423,7 +2430,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-129">0.12.0 (2017-06-05)</h2>
|
||||
<h2 id = "link-130">0.12.0 (2017-06-05)</h2>
|
||||
<p id = "para-274">This release includes a few new features, such as the possiblity to include Markdown files as section/subsections and not only as chapter, experimental support for superscript and subscript, and yet more experimental support for writing interactive fiction.</p>
|
||||
<ul>
|
||||
<li>Book configuration file:<ul>
|
||||
|
|
@ -2470,7 +2477,7 @@ proofread.grammalecte.port: 8080
|
|||
</li>
|
||||
<li>Crowbook now requires rustc >= 1.17.0</li>
|
||||
</ul>
|
||||
<h2 id = "link-130">0.11.4 (2017-03-21)</h2>
|
||||
<h2 id = "link-131">0.11.4 (2017-03-21)</h2>
|
||||
<ul>
|
||||
<li>An image can now be considered standalone even if it is inside a link.</li>
|
||||
<li>Bugfixes:<ul>
|
||||
|
|
@ -2488,7 +2495,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-131">0.11.3 (2017-03-19)</h2>
|
||||
<h2 id = "link-132">0.11.3 (2017-03-19)</h2>
|
||||
<ul>
|
||||
<li>When crowbook parses the book’s contents, it now detects which features are used. This is useful in various ways:<ul>
|
||||
<li>The ODT renderer only displays a global warning showing the lists of used features that are not implemented, instead of a warning each time such a feature is encountered.</li>
|
||||
|
|
@ -2507,7 +2514,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-132">0.11.2 (2017-03-05)</h2>
|
||||
<h2 id = "link-133">0.11.2 (2017-03-05)</h2>
|
||||
<ul>
|
||||
<li>General:<ul>
|
||||
<li>When there is an error setting an option from the book configuration file (e.g. because it is an invalid key), print an error but do not abort, only ignore this specific option.</li>
|
||||
|
|
@ -2543,7 +2550,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-133">0.11.1 (2017-01-05)</h2>
|
||||
<h2 id = "link-134">0.11.1 (2017-01-05)</h2>
|
||||
<ul>
|
||||
<li>Rendering:<ul>
|
||||
<li>Avoid page break before or after a separating rule.</li>
|
||||
|
|
@ -2575,7 +2582,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-134">0.11.0 (2016-12-31)</h2>
|
||||
<h2 id = "link-135">0.11.0 (2016-12-31)</h2>
|
||||
<p id = "para-275">Substantial changes in this release, the more important one being support for parts!</p>
|
||||
<ul>
|
||||
<li><b>Breaking changes</b>: the API has undergone some breaking changes, hoping they will be the last ones for a while. API should now be more simple and consistent (?). This version contains also substantial options renaming (see below).</li>
|
||||
|
|
@ -2639,7 +2646,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-135">0.10.4 (2016-12-16)</h2>
|
||||
<h2 id = "link-136">0.10.4 (2016-12-16)</h2>
|
||||
<ul>
|
||||
<li>New options:<ul>
|
||||
<li><code>tex.font_size</code> specifies an optional font size (in pt) passed to the LaTeX class (must be 10, 11 or 12).</li>
|
||||
|
|
@ -2661,7 +2668,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-136">0.10.3 (2016-11-19)</h2>
|
||||
<h2 id = "link-137">0.10.3 (2016-11-19)</h2>
|
||||
<ul>
|
||||
<li>Building:<ul>
|
||||
<li>Crowbook now requires rustc >= 1.13.0 to build.</li>
|
||||
|
|
@ -2682,7 +2689,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-137">0.10.2 (2016-10-21)</h2>
|
||||
<h2 id = "link-138">0.10.2 (2016-10-21)</h2>
|
||||
<p id = "para-276">Only minor changes in this version:</p>
|
||||
<ul>
|
||||
<li>Options:<ul>
|
||||
|
|
@ -2698,9 +2705,9 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-138">0.10.1 (2016-10-18)</h2>
|
||||
<h2 id = "link-139">0.10.1 (2016-10-18)</h2>
|
||||
<p id = "para-277">Fixed a bug in <code>fr.po</code> translation that prevented building from fresh install.</p>
|
||||
<h2 id = "link-139">0.10.0 (2016-10-18)</h2>
|
||||
<h2 id = "link-140">0.10.0 (2016-10-18)</h2>
|
||||
<p id = "para-278">This release contains some breaking changes (mostly for the API, which has been split in separate libraries). It alse features some internationalization support, and the program should now be tranlated if your <code>LANG</code> environment variable is set to french.</p>
|
||||
<ul>
|
||||
<li><b>Breaking changes</b>:<ul>
|
||||
|
|
@ -2737,7 +2744,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-140">0.9.1 (2016-09-29)</h2>
|
||||
<h2 id = "link-141">0.9.1 (2016-09-29)</h2>
|
||||
<p id = "para-279">This release mainly introduces generation of proofreading copies, allowing, if they are set (and <code>crowbook</code> was compiled with the <code>proofread</code> feature) to generate proofreading copies, using tools to check grammar and detect repetitions. These features are currently experimental.</p>
|
||||
<ul>
|
||||
<li>New options:<ul>
|
||||
|
|
@ -2768,7 +2775,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-141">0.9.0 (2016-09-23)</h2>
|
||||
<h2 id = "link-142">0.9.0 (2016-09-23)</h2>
|
||||
<p id = "para-280">The main objective of this release is to clean public interfaces, in order to limit breaking changes in the future. <em>Ideally</em>, all pre-1.0 releases should thus be 0.9.x. Concretely, this meant three things:</p>
|
||||
<ul>
|
||||
<li>reducing the surface of Crowbook’s library API;</li>
|
||||
|
|
@ -2833,7 +2840,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-142">0.8.0 (2016-09-19)</h2>
|
||||
<h2 id = "link-143">0.8.0 (2016-09-19)</h2>
|
||||
<p id = "para-281">This release adds support for syntax higlighting in code blocks, customized top and footer blocks for HTML rendering, and the special <code>import_config</code> option that allows to import options from another book file. It also provides (hopefully) better error messages.</p>
|
||||
<ul>
|
||||
<li>New options:<ul>
|
||||
|
|
@ -2873,7 +2880,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-143">0.7.0 (2016-09-11)</h2>
|
||||
<h2 id = "link-144">0.7.0 (2016-09-11)</h2>
|
||||
<p id = "para-282">This releases renders images differently when they are on a standalone paragraph or inside a paragraph.</p>
|
||||
<ul>
|
||||
<li>Internal/API:<ul>
|
||||
|
|
@ -2887,7 +2894,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-144">0.6.0 (2016-09-09)</h2>
|
||||
<h2 id = "link-145">0.6.0 (2016-09-09)</h2>
|
||||
<ul>
|
||||
<li>Deprecated options:<ul>
|
||||
<li><code>nb_char</code>: since it was only used for french cleaner and for typography reasons it’s better to use different non breaking spaces according to context, this option was not really useful anymore.</li>
|
||||
|
|
@ -2914,7 +2921,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-145">0.5.1 (2016-04-14)</h2>
|
||||
<h2 id = "link-146">0.5.1 (2016-04-14)</h2>
|
||||
<p id = "para-283">Mostly rendering fixes:</p>
|
||||
<ul>
|
||||
<li>Epub:<ul>
|
||||
|
|
@ -2940,7 +2947,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-146">0.5.0 (2016-04-02)</h2>
|
||||
<h2 id = "link-147">0.5.0 (2016-04-02)</h2>
|
||||
<ul>
|
||||
<li>Crowbook now requires Rustc 1.7.0.</li>
|
||||
<li>It is now possible to render HTML in multiple files:<ul>
|
||||
|
|
@ -2979,7 +2986,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-147">0.4.0 (2016-03-01)</h2>
|
||||
<h2 id = "link-148">0.4.0 (2016-03-01)</h2>
|
||||
<ul>
|
||||
<li>Crowbook now internally uses a true YAML parser, <code>yaml_rust</code>, for its options. Since the “old” Crowbooks’s config format was similar, but had some subtle differences, this is somewhat of a breaking change:<ul>
|
||||
<li>strings should now be escaped with “” in some cases (e.g. if it contains special characters). On the other hand, it <em>allows</em> to optionally escape a string with these quotes, which wasn’t possible until then and might be useful in some cases.</li>
|
||||
|
|
@ -2999,7 +3006,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-148">0.3.0 (2016-02-27)</h2>
|
||||
<h2 id = "link-149">0.3.0 (2016-02-27)</h2>
|
||||
<ul>
|
||||
<li>Crowbook now tries to convert local links. That is, if you link to a Markdown file that is used in the book. (e.g. <a href = "#chapter-0">README.md</a>), it <em>should</em> link to an appropriate inner reference inside the book.</li>
|
||||
<li>Latex renderer now supports (local) images.</li>
|
||||
|
|
@ -3017,14 +3024,14 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-149">0.2.2 (2016-02-25)</h2>
|
||||
<h2 id = "link-150">0.2.2 (2016-02-25)</h2>
|
||||
<ul>
|
||||
<li>Bugfixes:<ul>
|
||||
<li>French cleaner now correctly replaces space after — (in e.g. dialogs) with “em space”.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-150">0.2.1 (2016-02-25)</h2>
|
||||
<h2 id = "link-151">0.2.1 (2016-02-25)</h2>
|
||||
<ul>
|
||||
<li>Bugfixes:<ul>
|
||||
<li>HTML/Epub rendering no longer incorrectly increment chapter count for unnumbered chapters.</li>
|
||||
|
|
@ -3036,7 +3043,7 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-151">0.2.0 (2016-02-25)</h2>
|
||||
<h2 id = "link-152">0.2.0 (2016-02-25)</h2>
|
||||
<ul>
|
||||
<li>Command line arguments:<ul>
|
||||
<li>New argument <code>--print-template</code> now allows to print a built-in template to stdout.</li>
|
||||
|
|
@ -3061,13 +3068,13 @@ proofread.grammalecte.port: 8080
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-152">0.1.0 (2016-02-21)</h2>
|
||||
<h2 id = "link-153">0.1.0 (2016-02-21)</h2>
|
||||
<ul>
|
||||
<li>initial release</li>
|
||||
</ul>
|
||||
|
||||
</div><div id = "chapter-10" class = "chapter">
|
||||
<h1 id = 'link-153'>GNU LESSER GENERAL PUBLIC LICENSE</h1><pre><span style="color:#839496;"> Version 2.1, February 1999
|
||||
<h1 id = 'link-154'>GNU LESSER GENERAL PUBLIC LICENSE</h1><pre><span style="color:#839496;"> Version 2.1, February 1999
|
||||
</span></pre><p id = "para-284">Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.</p>
|
||||
<p id = "para-285">[This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.]</p>
|
||||
<pre><span style="color:#839496;"> Preamble
|
||||
|
|
@ -3336,7 +3343,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|||
|
||||
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-345">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-345">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
Binary file not shown.
Binary file not shown.
|
|
@ -66,7 +66,7 @@ function toggle() {
|
|||
"@type": "Book",
|
||||
"author": "Élisabeth Henry",
|
||||
"name": "Crowbook User Guide",
|
||||
"version": "0.14.0",
|
||||
"version": "0.14.1",
|
||||
|
||||
|
||||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||||
|
|
@ -75,134 +75,135 @@ function toggle() {
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
</script>
|
||||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-23">1.11. License</a></li>
|
||||
<li><a href="chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href="chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href="chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href="chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href = "chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href="chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href="chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href="chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href = "chapter_009.html#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "chapter_009.html#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "chapter_009.html#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_009.html#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_009.html#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_009.html#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_009.html#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_009.html#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_009.html#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_009.html#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_009.html#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href="chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href="chapter_009.html#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="chapter_009.html#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="chapter_009.html#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="chapter_009.html#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="chapter_009.html#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="chapter_009.html#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="chapter_009.html#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="chapter_009.html#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="chapter_009.html#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="chapter_009.html#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="chapter_009.html#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="chapter_009.html#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_010.html#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="chapter_010.html#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-346">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-346">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -224,7 +225,7 @@ function toggle() {
|
|||
<p id = "para-7">If you are on Debian GNU/Linux or Ubuntu (on a PC architecture), you can also download <code>.deb</code> packages on <a href = "https://github.com/lise-henry/crowbook/releases">the releases page</a>.</p>
|
||||
<h3 id = "link-5">Using Cargo</h3>
|
||||
<p id = "para-8"><a href = "https://crates.io/">Cargo</a> is the <a href = "https://www.rust-lang.org/">Rust</a>’s package manager. You can <a href = "https://www.rust-lang.org/downloads.html">install it here</a>. Once it is done:</p>
|
||||
<pre><span style="color:#839496;">$ cargo </span><span style="color:#859900;">install</span><span style="color:#839496;"> crowbook
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> cargo install crowbook
|
||||
</span></pre><p id = "para-9">will automatically download the latest <code>crowbook</code> release on <a href = "https://crates.io/crates/crowbook">crates.io</a>, compile it, and install it on your system.</p>
|
||||
<blockquote><p id = "para-10">Some dependencies also require building C libraries; you might thus also need to install a C compiler and <code>make</code>/<code>cmake</code> build tools. You can also try to build a version of Crowbook without optional features: <code>cargo install crowbook --no-default-features --features “clap”</code> will disable syntactic highlighting and proofreading, requiring less dependencies.</p>
|
||||
</blockquote>
|
||||
|
|
@ -236,13 +237,13 @@ function toggle() {
|
|||
</ul>
|
||||
<h2 id = "link-7">1.4. Quick tour</h2>
|
||||
<p id = "para-12">The simplest command is:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook </span><span style="color:#859900;"><</span><span style="color:#839496;">BOOK</span><span style="color:#859900;">></span><span style="color:#839496;">
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook </span><span style="color:#657b83;"><</span><span style="color:#839496;">BOOK</span><span style="color:#657b83;">>
|
||||
</span></pre><p id = "para-13">where <code>BOOK</code> is a configuration file. Crowbook will parse this file and generate HTML, EPUB, and/or PDF output formats, according to the settings in the configuration file.</p>
|
||||
<p id = "para-14">To create a new book, assuming you have a list of Markdown files, you can generate a template configuration file with the <code>--create</code> argument:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook my.book --create chapter_</span><span style="color:#859900;">*</span><span style="color:#839496;">.md
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook my.book</span><span style="color:#268bd2;"> --create</span><span style="color:#839496;"> chapter_</span><span style="color:#859900;">*</span><span style="color:#839496;">.md
|
||||
</span></pre><p id = "para-15">This will generate a default <code>my.book</code> file, which you’ll need to complete. This configuration file contains some metadata, options, and lists the Markdown files.</p>
|
||||
<p id = "para-16">For short books containing only a single Markdown file, it is possible to embed some metadata at the beginning of the file and use the <code>--single</code> or <code>-s</code> option to run <code>crowbook</code> directly on this Markdown file and avoid creating a separate book configuration file:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook -s text.md
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> -s</span><span style="color:#839496;"> text.md
|
||||
</span></pre><p id = "para-17">For more information, see the chapters on <a href = "chapter_001.html">the arguments supported by <code>crowbook</code></a> and on <a href = "chapter_002.html">the configuration file</a>.</p>
|
||||
<h2 id = "link-8">1.5. Current features</h2>
|
||||
<h3 id = "link-9">Output formats</h3>
|
||||
|
|
@ -257,10 +258,10 @@ function toggle() {
|
|||
<p id = "para-22">Crowbook tries to correctly translate local links in the input Markdown files: e.g. if you have a link to a Markdown file that is part of your book, it will be transformed into a link inside the document.</p>
|
||||
<h3 id = "link-13">Inline YAML blocks</h3>
|
||||
<p id = "para-23">Crowbook supports inline YAML blocks:</p>
|
||||
<pre><span style="color:#839496;">---</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Me</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">My title</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">---</span><span style="color:#839496;">
|
||||
<pre><span style="color:#839496;">---
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Me
|
||||
title</span><span style="color:#839496;">: </span><span style="color:#2aa198;">My title
|
||||
</span><span style="color:#839496;">---
|
||||
</span></pre><p id = "para-24">This is mostly useful when Crowbook is run with the <code>--single</code> argument (receiving a single Markdown file instead of a book configuration file), for short texts that only contain one “chapter”.</p>
|
||||
<h3 id = "link-14">Proofreading</h3>
|
||||
<p id = "para-25">Crowbook can also generate “proofreading” copies in HTML or PDF, highlighting grammar errors and repetitions. For more information, see <a href = "chapter_005.html">the proofreading chapter of the guide</a>.</p>
|
||||
|
|
@ -315,7 +316,7 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-345">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-345">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ function toggle() {
|
|||
"@type": "Book",
|
||||
"author": "Élisabeth Henry",
|
||||
"name": "Crowbook User Guide",
|
||||
"version": "0.14.0",
|
||||
"version": "0.14.1",
|
||||
|
||||
|
||||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||||
|
|
@ -75,134 +75,135 @@ function toggle() {
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
</script>
|
||||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-23">1.11. License</a></li>
|
||||
<li><a href="chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href="chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href="chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href="chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href = "chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href="chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href="chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href="chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href = "chapter_009.html#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "chapter_009.html#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "chapter_009.html#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_009.html#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_009.html#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_009.html#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_009.html#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_009.html#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_009.html#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_009.html#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_009.html#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href="chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href="chapter_009.html#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="chapter_009.html#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="chapter_009.html#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="chapter_009.html#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="chapter_009.html#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="chapter_009.html#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="chapter_009.html#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="chapter_009.html#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="chapter_009.html#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="chapter_009.html#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="chapter_009.html#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="chapter_009.html#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_010.html#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="chapter_010.html#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-348">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-348">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -217,20 +218,20 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
<h1 id = 'link-24'><span class = 'chapter-header'>Chapter 2</span><br />Arguments</h1><p id = "para-46">Crowbook can take a number of arguments, generally in the form:</p>
|
||||
<pre><span style="color:#839496;">crowbook [OPTIONS] [BOOK]
|
||||
<pre><span style="color:#b58900;">crowbook </span><span style="color:#859900;">[</span><span style="color:#839496;">OPTIONS</span><span style="color:#859900;">] [</span><span style="color:#839496;">BOOK</span><span style="color:#859900;">]
|
||||
</span></pre><p id = "para-47">The most important argument is obviously the book configuration file. It is mandatory in most cases: if you don’t pass it, Crowbook will simply display an error. In a normal use case this is the only argument you’ll need to pass, as most options will be set in this configuration file.</p>
|
||||
<p id = "para-48">It is, however, possible to pass more arguments to <code>crowbook</code>:</p>
|
||||
<h2 id = "link-25">2.1. <code>--create</code></h2>
|
||||
<p id = "para-49"><b>Usage</b>: <code>crowbook [BOOK] --create file_1.md file_2.md ...</code></p>
|
||||
<p id = "para-50">(or <code>crowbook [BOOK] -c file_1.md file_2.md ...</code>)</p>
|
||||
<p id = "para-51">Creates a new book from a list of Markdown files. It will generate a book configuration file with all file names specified as chapters. It either prints the result to stdout (if <code>BOOK</code> is not specified) or generate the file <code>BOOK</code> (or abort if it already exists).</p>
|
||||
<pre><span style="color:#839496;">crowbook foo.book --create chapter_1.md chapter_2.md chapter_3.md
|
||||
<pre><span style="color:#b58900;">crowbook</span><span style="color:#839496;"> foo.book</span><span style="color:#268bd2;"> --create</span><span style="color:#839496;"> chapter_1.md chapter_2.md chapter_3.md
|
||||
</span></pre><p id = "para-52">will thus generate a file <code>foo.book</code> containing:</p>
|
||||
<pre><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Your name</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Your title</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">lang</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">en</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Your name
|
||||
title</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Your title
|
||||
lang</span><span style="color:#839496;">: </span><span style="color:#2aa198;">en
|
||||
|
||||
</span><span style="color:#586e75;">#</span><span style="color:#586e75;"># Output formats
|
||||
</span><span style="color:#586e75;">## Output formats
|
||||
|
||||
# Uncomment and fill to generate files
|
||||
# output.html: some_file.html
|
||||
|
|
@ -244,33 +245,33 @@ function toggle() {
|
|||
# cover: some_cover.png
|
||||
|
||||
## List of chapters
|
||||
+ chapter_1.md
|
||||
</span><span style="color:#2aa198;">+ chapter_1.md
|
||||
+ chapter_2.md
|
||||
+ chapter_3.md
|
||||
</span></pre><p id = "para-53">while</p>
|
||||
<pre><span style="color:#839496;">crowbook --create chapter_1.md chapter_2.md chapter_3.md
|
||||
<pre><span style="color:#b58900;">crowbook</span><span style="color:#268bd2;"> --create</span><span style="color:#839496;"> chapter_1.md chapter_2.md chapter_3.md
|
||||
</span></pre><p id = "para-54">will print the same result, but to stdout (without creating a file).</p>
|
||||
<h2 id = "link-26">2.2. <code>--single</code></h2>
|
||||
<p id = "para-55"><b>Usage</b>: <code>crowbook --single <FILE></code></p>
|
||||
<p id = "para-56">(or <code>crowbook -s <FILE></code>)</p>
|
||||
<p id = "para-57">This argument allows you to give <code>crowbook</code> a single Markdown file. This file can contain an inline YAML block to set some book options. Inline YAML blocks must start and end with a line containing only <code>---</code> (three dashes). E.g:</p>
|
||||
<pre><span style="color:#839496;">---</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Joan Doe</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">A short story</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">output</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">html</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">---</span><span style="color:#839496;">
|
||||
<pre><span style="color:#839496;">---
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Joan Doe
|
||||
title</span><span style="color:#839496;">: </span><span style="color:#268bd2;">A short story
|
||||
output</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">html</span><span style="color:#839496;">, </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">, </span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">]
|
||||
---
|
||||
|
||||
</span><span style="color:#2aa198;">Content of the story in Markdown.</span><span style="color:#839496;">
|
||||
</span><span style="color:#2aa198;">Content of the story in Markdown.
|
||||
</span></pre><p id = "para-58">If this YAML block is not at the beginning of a file, it must also be preceded by a blank line.</p>
|
||||
<p id = "para-59">This allows to not have to write a <code>.book</code> configuration file for a short story or an article. <code>crowbook -s foo.md</code> is rougly equivalent to having a book configuration file containing:</p>
|
||||
<pre><span style="color:#268bd2;">!</span><span style="color:#839496;"> </span><span style="color:#2aa198;">foo.md</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">! </span><span style="color:#2aa198;">foo.md
|
||||
</span></pre><p id = "para-60">That is, the chapter heading (if any) won’t be displayed in the output documents (though they still appear in the TOC).</p>
|
||||
<blockquote><p id = "para-61">Note that by default, using <code>--single</code> or <code>-s</code> sets the default LaTeX class of the book to <code>article</code> instead of <code>book</code>.</p>
|
||||
</blockquote>
|
||||
<h2 id = "link-27">2.3. <code>--set</code></h2>
|
||||
<p id = "para-62"><b>Usage</b>: <code>crowbook <BOOK> --set [KEY] [VALUE]...</code></p>
|
||||
<p id = "para-63">This argument takes a list of <code>KEY</code> <code>VALUE</code> pairs and allows setting or overriding a book configuration option. All valid options in the configuration files are valid as keys. For more information, see <a href = "chapter_002.html">the configuration file</a>.</p>
|
||||
<pre><span style="color:#839496;">$ crowbook foo.book --</span><span style="color:#859900;">set</span><span style="color:#839496;"> tex.paper.size a4paper
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook foo.book</span><span style="color:#268bd2;"> --set</span><span style="color:#839496;"> tex.paper.size a4paper
|
||||
</span></pre><p id = "para-64">will override the paper size for PDF generation.</p>
|
||||
<h2 id = "link-28">2.4. <code>--list-options</code></h2>
|
||||
<p id = "para-65"><b>Usage</b>: <code>crowbook --list-options</code></p>
|
||||
|
|
@ -279,14 +280,14 @@ function toggle() {
|
|||
<h2 id = "link-29">2.5. <code>--print-template</code></h2>
|
||||
<p id = "para-68"><b>Usage</b>: <code>crowbook --print-template <TEMPLATE></code></p>
|
||||
<p id = "para-69">Prints the built-in template to stdout. Useful if you want to customize the appearance of your document. E.g., if you want to modify the CSS used for HTML rendering:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook --print-template html.css </span><span style="color:#859900;">></span><span style="color:#839496;"> my_style.css
|
||||
</span><span style="color:#586e75;">#</span><span style="color:#586e75;"> edit my_style.css in your favourite editor
|
||||
</span><span style="color:#839496;">$ crowbook my.book --</span><span style="color:#859900;">set</span><span style="color:#839496;"> html.css my_style.css
|
||||
</span><span style="color:#586e75;">#</span><span style="color:#586e75;"> or add "html.css: my_style.css" in my.book
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> --print-template</span><span style="color:#839496;"> html.css </span><span style="color:#657b83;">></span><span style="color:#839496;"> my_style.css
|
||||
</span><span style="color:#586e75;"># edit my_style.css in your favourite editor
|
||||
</span><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook my.book</span><span style="color:#268bd2;"> --set</span><span style="color:#839496;"> html.css my_style.css
|
||||
</span><span style="color:#586e75;"># or add "html.css: my_style.css" in my.book
|
||||
</span></pre><h2 id = "link-30">2.6. <code>--stats</code></h2>
|
||||
<p id = "para-70"><b>Usage</b>: <code>crowbook --stats <BOOK></code></p>
|
||||
<p id = "para-71">(or <code>crowbook -S <BOOK></code>)</p>
|
||||
<p id = "para-72">Display some statistics (word and character counts) about the book.</p>
|
||||
<p id = "para-72">Display some statistics (word and character counts) about the book. If you use the <code>--verbose</code> or <code>-v</code> option (and your version of Crowbook has been compiled with support for this feature) you will get advanced statistics such as Felsch readability index.</p>
|
||||
<h2 id = "link-31">2.7. <code>--proofread</code></h2>
|
||||
<p id = "para-73"><b>Usage</b>: <code>crowbook --proofread <BOOK></code></p>
|
||||
<p id = "para-74">(or <code>crowbook -p <BOOK></code>)</p>
|
||||
|
|
@ -313,9 +314,9 @@ Cheers, *Joan*
|
|||
<p id = "para-84">Generate only the specified format. <code>FORMAT</code> must be either <code>epub</code>, <code>pdf</code>, <code>html</code>, <code>html.dir</code>, <code>odt</code> or <code>tex</code>.</p>
|
||||
<p id = "para-85">If an output file for the format is not specified in the book configuration file, <code>crowbook</code> will fail to render PDF, ODT and EPUB, whereas it will print HTML and TeX files on stdout. It is, however, possible to specify a file with the <code>--output</code> option.</p>
|
||||
<h3 id = "link-36">Examples</h3>
|
||||
<pre><span style="color:#839496;">crowbook --to html foo.book
|
||||
<pre><span style="color:#b58900;">crowbook</span><span style="color:#268bd2;"> --to</span><span style="color:#839496;"> html foo.book
|
||||
</span></pre><p id = "para-86">will generate some HTML, and prints it either to the file specified by <code>output.html</code> in <code>foo.book</code>, or to stdout if it is not specified.</p>
|
||||
<pre><span style="color:#839496;">crowbook --to pdf --output foo.pdf foo.book
|
||||
<pre><span style="color:#b58900;">crowbook</span><span style="color:#268bd2;"> --to</span><span style="color:#839496;"> pdf</span><span style="color:#268bd2;"> --output</span><span style="color:#839496;"> foo.pdf foo.book
|
||||
</span></pre><p id = "para-87">will generate a <code>foo.pdf</code> file.</p>
|
||||
<h2 id = "link-37">2.11. <code>--output</code></h2>
|
||||
<p id = "para-88"><b>Usage</b>: <code>crowbook <BOOK> --to <FORMAT> --output <FILE></code></p>
|
||||
|
|
@ -337,7 +338,7 @@ Cheers, *Joan*
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-347">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-347">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ function toggle() {
|
|||
"@type": "Book",
|
||||
"author": "Élisabeth Henry",
|
||||
"name": "Crowbook User Guide",
|
||||
"version": "0.14.0",
|
||||
"version": "0.14.1",
|
||||
|
||||
|
||||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||||
|
|
@ -75,134 +75,135 @@ function toggle() {
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
</script>
|
||||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-23">1.11. License</a></li>
|
||||
<li><a href="chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href="chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href="chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href="chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href = "chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href="chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href="chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href="chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href = "chapter_009.html#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "chapter_009.html#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "chapter_009.html#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_009.html#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_009.html#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_009.html#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_009.html#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_009.html#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_009.html#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_009.html#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_009.html#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href="chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href="chapter_009.html#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="chapter_009.html#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="chapter_009.html#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="chapter_009.html#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="chapter_009.html#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="chapter_009.html#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="chapter_009.html#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="chapter_009.html#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="chapter_009.html#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="chapter_009.html#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="chapter_009.html#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="chapter_009.html#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_010.html#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="chapter_010.html#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-350">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-350">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -218,20 +219,20 @@ function toggle() {
|
|||
</p>
|
||||
<h1 id = 'link-40'><span class = 'chapter-header'>Chapter 3</span><br />The configuration file</h1><p id = "para-97">If you want to use Crowbook for your book, this configuration file is all you’ll have to add, beside the Markdown files containing the text of your book.</p>
|
||||
<p id = "para-98">The format is not very complicated. This is an example of it:</p>
|
||||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> metadata
|
||||
author: Joan Doe
|
||||
title: Some book
|
||||
lang: en
|
||||
<pre><span style="color:#586e75;"># metadata
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Joan Doe
|
||||
title</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Some book
|
||||
lang</span><span style="color:#839496;">: </span><span style="color:#268bd2;">en
|
||||
|
||||
output: [html, pdf, epub]
|
||||
output</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">html</span><span style="color:#839496;">, </span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">]
|
||||
|
||||
# list of chapters
|
||||
- preface.md
|
||||
</span><span style="color:#586e75;"># list of chapters
|
||||
</span><span style="color:#839496;">- </span><span style="color:#2aa198;">preface.md
|
||||
+ chapter_1.md
|
||||
+ chapter_2.md
|
||||
+ chapter_3.md
|
||||
+ chapter_4.md
|
||||
- epilogue.md
|
||||
</span><span style="color:#839496;">- </span><span style="color:#2aa198;">epilogue.md
|
||||
</span></pre><p id = "para-99">Basically, it is divided in two parts:</p>
|
||||
<ul>
|
||||
<li>a list of options, under the form <code>key: value</code>, following YAML syntax.</li>
|
||||
|
|
@ -240,20 +241,20 @@ output: [html, pdf, epub]
|
|||
<p id = "para-100">Lines starting with the <code>#</code> characters are comments and are discarded.</p>
|
||||
<h2 id = "link-41">3.1. Configuration in an inline YAML block</h2>
|
||||
<p id = "para-101">Sometimes, you only have one Markdown file and might not want to have a separate configuration file. In this case, you can specify options at the beginning of your Markdown file, using an inline YAML block, separated by two lines containing only <code>---</code>:</p>
|
||||
<pre><span style="color:#839496;">---</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">author: Joan Doe
|
||||
<pre><span style="color:#839496;">---
|
||||
author: Joan Doe
|
||||
title: Some (short) book
|
||||
lang: en
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">output: [html, pdf, epub]
|
||||
</span><span style="color:#b58900;">---</span><span style="color:#839496;">
|
||||
|
||||
</span><span style="color:#b58900;">#</span><span style="color:#b58900;"> </span><span style="color:#cb4b16;">Some (short) book</span><span style="color:#b58900;">
|
||||
</span><span style="color:#839496;">
|
||||
output: [html, pdf, epub]
|
||||
</span><span style="color:#b58900;">---
|
||||
|
||||
# </span><span style="color:#cb4b16;">Some (short) book
|
||||
|
||||
</span><span style="color:#839496;">The book content, formatted in Markdown.
|
||||
</span></pre><p id = "para-102">This method only allows to set up options: you can’t include a list of chapters in this way, since the only “chapter” that will be included is this Markdown file itself.</p>
|
||||
<p id = "para-103">You can then use</p>
|
||||
<pre><span style="color:#839496;">crowbook -s some_book.md
|
||||
<pre><span style="color:#b58900;">crowbook</span><span style="color:#268bd2;"> -s</span><span style="color:#839496;"> some_book.md
|
||||
</span></pre><p id = "para-104">to generate output formats from this Markdown file.</p>
|
||||
<blockquote><p id = "para-105">By default (unless <code>input.yaml_blocks</code> is set to true), Crowboook will only read those inline blocks when it is runned with <code>crowbook --single</code> (or <code>crowbook -s</code>).</p>
|
||||
</blockquote>
|
||||
|
|
@ -267,13 +268,13 @@ lang: en
|
|||
<li><code>@</code> includes a part instead of a chapter.</li>
|
||||
</ul>
|
||||
<p id = "para-107">So a typical usage might look like this:</p>
|
||||
<pre><span style="color:#268bd2;">!</span><span style="color:#839496;"> </span><span style="color:#2aa198;">copyright.md</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">-</span><span style="color:#839496;"> </span><span style="color:#2aa198;">preface.md</span><span style="color:#839496;">
|
||||
</span><span style="color:#2aa198;">0. chapter_0.md</span><span style="color:#839496;"> </span><span style="color:#586e75;">#</span><span style="color:#586e75;"> We want to start at chapter 0 instead of 1
|
||||
<pre><span style="color:#268bd2;">! </span><span style="color:#2aa198;">copyright.md
|
||||
</span><span style="color:#839496;">- </span><span style="color:#2aa198;">preface.md
|
||||
0. chapter_0.md </span><span style="color:#586e75;"># We want to start at chapter 0 instead of 1
|
||||
# Next chapters can be numbered automatically
|
||||
+ chapter_1.md
|
||||
</span><span style="color:#2aa198;">+ chapter_1.md
|
||||
+ chapter_2.md
|
||||
...
|
||||
</span><span style="color:#839496;">...
|
||||
</span></pre><p id = "para-108">There are two important things to note:</p>
|
||||
<ol>
|
||||
<li>you must <em>not</em> use quotes around the file names.</li>
|
||||
|
|
@ -282,7 +283,7 @@ lang: en
|
|||
<p id = "para-109">Also note that you don’t have to specify a title. This is because the title of the chapter is inferred from the Markdown document. To go back to our previous example:</p>
|
||||
<pre><span style="color:#839496;">+ chapter_1.md
|
||||
</span></pre><p id = "para-110">does not specify a chapter title, because it will read it directly in <code>chapter_1.md</code>, e.g.:</p>
|
||||
<pre><span style="color:#b58900;">#</span><span style="color:#b58900;"> </span><span style="color:#cb4b16;">The day I was born</span><span style="color:#b58900;"> </span><span style="color:#b58900;">#</span><span style="color:#b58900;">
|
||||
<pre><span style="color:#b58900;"># </span><span style="color:#cb4b16;">The day I was born </span><span style="color:#b58900;">#
|
||||
</span><span style="color:#839496;">...
|
||||
</span></pre><p id = "para-111">Ideally, you should have one and only one level-one header (i.e. chapter title) in each Markdown file. If you have more than one, it might mess with the table of contents in some cases (e.g. for EPUB).</p>
|
||||
<h3 id = "link-43">Parts</h3>
|
||||
|
|
@ -317,15 +318,15 @@ lang: en
|
|||
</blockquote>
|
||||
<h2 id = "link-45">3.3. Crowbook options</h2>
|
||||
<p id = "para-119">The first part of the configuration file is dedicated to pass options to Crowbook. This is <a href = "https://en.wikipedia.org/wiki/YAML">YAML syntax</a>, so each line should be of the form <code>key: value</code>. Note that in most cases you don’t have to put string in quotes, e.g.:</p>
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">My title</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">: </span><span style="color:#2aa198;">My title
|
||||
</span></pre><p id = "para-120">It is however possible (and sometimes necessary) to escape some characters using quotes around strings:</p>
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">My: title!</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">My: title!</span><span style="color:#839496;">"
|
||||
</span></pre><p id = "para-121">It is possible to use multiline strings with <code>>-</code> and then indenting the lines that are part of the string:</p>
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#859900;">></span><span style="color:#93a1a1;">-</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">: </span><span style="color:#859900;">></span><span style="color:#93a1a1;">-
|
||||
</span><span style="color:#2aa198;"> A
|
||||
long
|
||||
title
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">Joan Doe</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#2aa198;">Joan Doe
|
||||
</span></pre><p id = "para-122">will set <code>title</code> to <code>“A long title”</code>. See <a href = "https://en.wikipedia.org/wiki/YAML#Block_literals">block literals in YAML</a> for more information on the various way to insert multiline strings (which mostly change the way newlines will or won’t be inserted).</p>
|
||||
<p id = "para-123">A final note on the syntax: all options must be set <em>before</em> the first chapter inclusion (that is, a line beginning with ‘+’, ‘-’, ‘x.’ (where <code>x</code> is a number) or ‘!’).</p>
|
||||
<h3 id = "link-46">Metadata</h3>
|
||||
|
|
@ -349,33 +350,33 @@ lang: en
|
|||
<p id = "para-127">All metadata are accessible from templates, see <a href = "chapter_004.html">Templates</a>.</p>
|
||||
<h3 id = "link-47">The <code>import</code> special option</h3>
|
||||
<p id = "para-128">The special <code>import</code> option allows you to include the options of another book configuration file. E.g., assuming that you want some common options to be applied to both <code>foo.book</code> and <code>bar.book</code>, you can create a <code>common.book</code> file:</p>
|
||||
<pre><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Joan Doe</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">lang</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">en</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">license</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">Copyright (C) Joan Doe. All rights reserved.</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Joan Doe
|
||||
lang</span><span style="color:#839496;">: </span><span style="color:#268bd2;">en
|
||||
license</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">Copyright (C) Joan Doe. All rights reserved.</span><span style="color:#839496;">"
|
||||
|
||||
</span><span style="color:#268bd2;">html.header</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">[Joan Doe's website](http://joan-doe.com)</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">tex.template</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">my_template.tex</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">html.header</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">[Joan Doe's website](http://joan-doe.com)</span><span style="color:#839496;">"
|
||||
</span><span style="color:#268bd2;">tex.template</span><span style="color:#839496;">: </span><span style="color:#2aa198;">my_template.tex
|
||||
</span></pre><p id = "para-129">You can then include this file in <code>foo.book</code>:</p>
|
||||
<pre><span style="color:#268bd2;">import</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">common.book</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">Foo</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">import</span><span style="color:#839496;">: </span><span style="color:#268bd2;">common.book
|
||||
title</span><span style="color:#839496;">: </span><span style="color:#2aa198;">Foo
|
||||
|
||||
</span><span style="color:#2aa198;">+ foo_01.md</span><span style="color:#839496;">
|
||||
</span><span style="color:#2aa198;">+ foo_02.md</span><span style="color:#839496;">
|
||||
+ foo_01.md
|
||||
+ foo_02.md
|
||||
</span></pre><p id = "para-130">Or include it in <code>bar.book</code>, but override some of its features:</p>
|
||||
<pre><span style="color:#268bd2;">import</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">common.book</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Bar</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">license</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">CC-BY-SA</span><span style="color:#839496;"> </span><span style="color:#586e75;">#</span><span style="color:#586e75;"> Override the license from common.book
|
||||
<pre><span style="color:#268bd2;">import</span><span style="color:#839496;">: </span><span style="color:#268bd2;">common.book
|
||||
title</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Bar
|
||||
license</span><span style="color:#839496;">: </span><span style="color:#2aa198;">CC-BY-SA </span><span style="color:#586e75;"># Override the license from common.book
|
||||
|
||||
+ bar_01.md
|
||||
</span><span style="color:#2aa198;">+ bar_01.md
|
||||
</span></pre><h3 id = "link-48">Output options</h3>
|
||||
<p id = "para-131">These options specify which files to generate.</p>
|
||||
<p id = "para-132">Note that all file paths are relative to the directory where the configuration file is, not to the one where you run <code>crowbook</code>. So if you set</p>
|
||||
<pre><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">foo.epub</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">: </span><span style="color:#2aa198;">foo.epub
|
||||
</span></pre><p id = "para-133">and run</p>
|
||||
<pre><span style="color:#839496;">$ crowbook some/</span><span style="color:#859900;">dir</span><span style="color:#839496;">/config.book
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook some/dir/config.book
|
||||
</span></pre><p id = "para-134"><code>foo.epub</code> will be generated in <code>some/dir</code>, not in your current directory.</p>
|
||||
<p id = "para-135">Crowbook will try to generate each of the <code>output.xxx</code> files that are specified. That means that you’ll have to set at least one of those if you want a call to</p>
|
||||
<pre><span style="color:#839496;">$ crowbook my.book
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook my.book
|
||||
</span></pre><p id = "para-136">to generate anything. (It’s still possible to generate a specific format, and only this one, by using the <code>--to</code> and <code>--output</code> argument on the command line).</p>
|
||||
<p id = "para-137">Note that some formats depend on some commands being installed on your system. Most notably, Crowbook depends on LaTeX (<code>xelatex</code> by default, though you can specify another command to use with <code>tex.command</code>) to generate a PDF file, so PDF rendering won’t work if it is not installed on your system. Crowbook also uses the <code>zip</code> command to generate the EPUB and ODT files.</p>
|
||||
<p id = "para-138">Current output options are:</p>
|
||||
|
|
@ -389,22 +390,22 @@ lang: en
|
|||
<p id = "para-139">(There are other output options for generating proofreading files, see <a href = "chapter_005.html">Proofreading</a>, and interactive fiction, see <a href = "chapter_006.html">Interactive fiction</a>.)</p>
|
||||
<h4 id = "link-49">The <code>output</code> option</h4>
|
||||
<p id = "para-140">Setting output file names manually can be a bit tedious, and is not always necessary. You can also specify a list of output formats with the <code>output</code> option:</p>
|
||||
<pre><span style="color:#268bd2;">output</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">html</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">output</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">, </span><span style="color:#2aa198;">html</span><span style="color:#839496;">]
|
||||
</span></pre><p id = "para-141">This is similar to the alternative syntax for YAML list:</p>
|
||||
<pre><span style="color:#268bd2;">output</span><span style="color:#839496;">:</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">-</span><span style="color:#839496;"> </span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">-</span><span style="color:#839496;"> </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">-</span><span style="color:#839496;"> </span><span style="color:#2aa198;">html</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">output</span><span style="color:#839496;">:
|
||||
- </span><span style="color:#2aa198;">pdf
|
||||
</span><span style="color:#839496;">- </span><span style="color:#2aa198;">epub
|
||||
</span><span style="color:#839496;">- </span><span style="color:#2aa198;">html
|
||||
</span></pre><p id = "para-142">This option will set default output path for PDF, EPUB and HTML according to the book configuration file name. So, if your book is <code>my_book.book</code> (or <code>my_book.md</code>), it will generate <code>my_book.pdf</code>, <code>my_book.html</code> and <code>my_book.epub</code>.</p>
|
||||
<blockquote><p id = "para-143">You can also infer the output file name by specifying “auto” to e.g. <code>output.html</code>. The previous example is thus equivalent to</p>
|
||||
<pre><span style="color:#268bd2;">output.pdf</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">auto</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">auto</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">output.html</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">auto</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">output.pdf</span><span style="color:#839496;">: </span><span style="color:#268bd2;">auto
|
||||
output.epub</span><span style="color:#839496;">: </span><span style="color:#268bd2;">auto
|
||||
output.html</span><span style="color:#839496;">: </span><span style="color:#2aa198;">auto
|
||||
</span></pre></blockquote>
|
||||
<h4 id = "link-50"><code>output.base_path</code></h4>
|
||||
<p id = "para-144">Additionally, the <code>output.base_path</code> option allows you to set where the output files will be written (relatively to the book configuration file). E.g.,</p>
|
||||
<pre><span style="color:#268bd2;">output.base_path</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">docs/book</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">book.epub</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">output.base_path</span><span style="color:#839496;">: </span><span style="color:#268bd2;">docs/book
|
||||
output.epub</span><span style="color:#839496;">: </span><span style="color:#2aa198;">book.epub
|
||||
</span></pre><p id = "para-145">will render the EPUB file in <code>docs/book/book.epub</code>.</p>
|
||||
<h3 id = "link-51">Input options</h3>
|
||||
<p id = "para-146">Crowbook does its best to improve the typography of your text. Default settings should be good enough for most usages, but you can enable/disable specific options:</p>
|
||||
|
|
@ -468,20 +469,20 @@ lang: en
|
|||
<p id = "para-152">These options allow to embed additional files for some formats (currently, only EPUB). This can be useful for embedding fonts.</p>
|
||||
<h4 id = "link-58">resources.files</h4>
|
||||
<p id = "para-153">A list of files or directories that should be added.</p>
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">font1.otf</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">font2.otf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">font1.otf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">font2.otf</span><span style="color:#839496;">]
|
||||
</span></pre><p id = "para-154">It is also possible to specify a directory (or multiple directories). So if you have a <code>fonts</code> directories containing <code>font1.otf</code> and <code>font2.otf</code>,</p>
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">fonts</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">fonts</span><span style="color:#839496;">]
|
||||
</span></pre><p id = "para-155">will be equivalent to:</p>
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">fonts/font1.otf</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">fonts/font2.otf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">fonts/font1.otf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">fonts/font2.otf</span><span style="color:#839496;">]
|
||||
</span></pre><p id = "para-156"><b>default</b>: not set</p>
|
||||
<h4 id = "link-59">resources.out_path</h4>
|
||||
<p id = "para-157">This option determine where (in which directory), <em>in the resulting document</em>, those files will be copied. The default is <code>data</code>, so by default the <code>resources.files</code> in the first example above will search <code>font1.otf</code> and <code>font2.otf</code> <em>in the same directory than the <code>.book</code> file</em>, and will copy them to <code>data/font1.otf</code> and <code>data/font2.otf</code> <em>in the EPUB file</em>. This is therefore this last path that you should use if you want to access those files e.g. in a custom CSS stylesheet.</p>
|
||||
<p id = "para-158">Note that if you pass directories to <code>resources.files</code>, the whole directory would be copied. So assuming <code>fonts/</code> contains <code>font1.otf</code> and <code>font2.otf</code></p>
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">fonts</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">resources.path</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">data</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">fonts</span><span style="color:#839496;">]
|
||||
</span><span style="color:#268bd2;">resources.path</span><span style="color:#839496;">: </span><span style="color:#2aa198;">data
|
||||
</span></pre><p id = "para-159">will copy these two files to <code>data/fonts/font1.otf</code> and <code>data/fonts/font2.otf</code> (and not <code>data/font1.otf</code> and <code>data/font2.otf</code>).</p>
|
||||
<p id = "para-160">Similarly, the whole path of <code>resources.files</code> is copied, so</p>
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">fonts/font1.otf</span><span style="color:#839496;">,</span><span style="color:#839496;"> </span><span style="color:#2aa198;">fonts/font2.otf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">fonts/font1.otf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">fonts/font2.otf</span><span style="color:#839496;">]
|
||||
</span></pre><p id = "para-161">will yield the same result.</p>
|
||||
<p id = "para-162"><b>default</b>: <code>data</code></p>
|
||||
<h2 id = "link-60">3.4. Full list of options</h2>
|
||||
|
|
@ -1190,7 +1191,7 @@ lang: en
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-349">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-349">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ function toggle() {
|
|||
"@type": "Book",
|
||||
"author": "Élisabeth Henry",
|
||||
"name": "Crowbook User Guide",
|
||||
"version": "0.14.0",
|
||||
"version": "0.14.1",
|
||||
|
||||
|
||||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||||
|
|
@ -75,134 +75,135 @@ function toggle() {
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
</script>
|
||||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-23">1.11. License</a></li>
|
||||
<li><a href="chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href="chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href="chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href="chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href = "chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href="chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href="chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href="chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href = "chapter_009.html#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "chapter_009.html#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "chapter_009.html#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_009.html#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_009.html#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_009.html#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_009.html#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_009.html#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_009.html#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_009.html#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_009.html#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href="chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href="chapter_009.html#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="chapter_009.html#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="chapter_009.html#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="chapter_009.html#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="chapter_009.html#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="chapter_009.html#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="chapter_009.html#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="chapter_009.html#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="chapter_009.html#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="chapter_009.html#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="chapter_009.html#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="chapter_009.html#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_010.html#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="chapter_010.html#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-352">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-352">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -220,11 +221,11 @@ function toggle() {
|
|||
<p id = "para-166">However, pulldown-cmark also implements a handful of unofficial extensions, and Crowbook also adds its own variants, so there are a few syntax elements that are not covered by the CommonMark reference.</p>
|
||||
<h2 id = "link-78">4.1. Tables</h2>
|
||||
<p id = "para-167">Tables can be included in your Markdown file. E.g.:</p>
|
||||
<pre><span style="color:#839496;">|</span><span style="color:#839496;"> Author </span><span style="color:#839496;">|</span><span style="color:#839496;"> Book </span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">|</span><span style="color:#657b83;">--------------------</span><span style="color:#839496;">|</span><span style="color:#657b83;">----------------------------</span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">|</span><span style="color:#839496;"> Anne Rice </span><span style="color:#839496;">|</span><span style="color:#839496;"> Interview With the Vampire </span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">|</span><span style="color:#839496;"> Terry Pratchett </span><span style="color:#839496;">|</span><span style="color:#839496;"> Hogfather </span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">|</span><span style="color:#839496;"> George Martin </span><span style="color:#839496;">|</span><span style="color:#839496;"> A Dance with Dragons </span><span style="color:#839496;">|</span><span style="color:#839496;">
|
||||
<pre><span style="color:#839496;">| Author | Book |
|
||||
|</span><span style="color:#657b83;">--------------------</span><span style="color:#839496;">|</span><span style="color:#657b83;">----------------------------</span><span style="color:#839496;">|
|
||||
| Anne Rice | Interview With the Vampire |
|
||||
| Terry Pratchett | Hogfather |
|
||||
| George Martin | A Dance with Dragons |
|
||||
</span></pre><p id = "para-168">will render as</p>
|
||||
<div class = "table">
|
||||
<table>
|
||||
|
|
@ -244,24 +245,24 @@ function toggle() {
|
|||
<h2 id = "link-79">4.2. Footnotes</h2>
|
||||
<p id = "para-170">Footnotes can be specified the following way:</p>
|
||||
<pre><span style="color:#839496;">Footnotes can be useful[^1] and make you look clever.
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">[</span><span style="color:#2aa198;">^1</span><span style="color:#839496;">]</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">But</span><span style="color:#839496;"> </span><span style="color:#839496;">you shouldn't use them too much.</span><span style="color:#839496;">
|
||||
|
||||
[</span><span style="color:#b58900;">^1</span><span style="color:#839496;">]: </span><span style="color:#2aa198;">But </span><span style="color:#839496;">you shouldn't use them too much.</span><span style="color:#839496;">
|
||||
</span></pre><p id = "para-171">Will be rendered as:</p>
|
||||
<blockquote><p id = "para-173">Footnotes can be useful<a href = "#note-dest-1"><sup id = "note-source-1">[1]</sup></a> and make you look clever.</p>
|
||||
</blockquote>
|
||||
<p id = "para-174">You can use multiple paragraphs in a footnote definition. This can sometimes be useful, but it can also be tricky, as if you only let an empty line before the next paragraph, it will also be included in the footnote. And probably the next one and the following one too:</p>
|
||||
<pre><span style="color:#839496;">This is a footnote usage[^1].
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">[</span><span style="color:#2aa198;">^1</span><span style="color:#839496;">]</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">This</span><span style="color:#839496;"> </span><span style="color:#839496;">is obviously part of the footnote definition.</span><span style="color:#839496;">
|
||||
|
||||
</span><span style="color:#839496;">This is less obviously ALSO part of the footnote definition.
|
||||
[</span><span style="color:#b58900;">^1</span><span style="color:#839496;">]: </span><span style="color:#2aa198;">This </span><span style="color:#839496;">is obviously part of the footnote definition.</span><span style="color:#839496;">
|
||||
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">This is NOT part of the foonote.
|
||||
This is less obviously ALSO part of the footnote definition.
|
||||
|
||||
|
||||
This is NOT part of the foonote.
|
||||
</span></pre><p id = "para-175">Due to its own quirks, Crowbook will duplicate footnotes if you reference them multiple times:</p>
|
||||
<pre><span style="color:#839496;">This footnote is unique[^2] but referenced twice[^2].
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">[</span><span style="color:#2aa198;">^2</span><span style="color:#839496;">]</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">Or</span><span style="color:#839496;"> </span><span style="color:#839496;">is it?</span><span style="color:#839496;">
|
||||
|
||||
[</span><span style="color:#b58900;">^2</span><span style="color:#839496;">]: </span><span style="color:#2aa198;">Or </span><span style="color:#839496;">is it?</span><span style="color:#839496;">
|
||||
</span></pre><blockquote><p id = "para-178">This footnote is unique<a href = "#note-dest-2"><sup id = "note-source-2">[2]</sup></a> but referenced twice<a href = "#note-dest-3"><sup id = "note-source-3">[3]</sup></a>.</p>
|
||||
</blockquote>
|
||||
<h2 id = "link-80">4.3. Superscript and subscript</h2>
|
||||
|
|
@ -327,7 +328,7 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-351">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-351">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ function toggle() {
|
|||
"@type": "Book",
|
||||
"author": "Élisabeth Henry",
|
||||
"name": "Crowbook User Guide",
|
||||
"version": "0.14.0",
|
||||
"version": "0.14.1",
|
||||
|
||||
|
||||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||||
|
|
@ -75,134 +75,135 @@ function toggle() {
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
</script>
|
||||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-23">1.11. License</a></li>
|
||||
<li><a href="chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href="chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href="chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href="chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href = "chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href="chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href="chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href="chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href = "chapter_009.html#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "chapter_009.html#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "chapter_009.html#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_009.html#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_009.html#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_009.html#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_009.html#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_009.html#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_009.html#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_009.html#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_009.html#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href="chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href="chapter_009.html#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="chapter_009.html#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="chapter_009.html#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="chapter_009.html#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="chapter_009.html#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="chapter_009.html#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="chapter_009.html#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="chapter_009.html#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="chapter_009.html#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="chapter_009.html#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="chapter_009.html#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="chapter_009.html#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_010.html#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="chapter_010.html#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-354">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-354">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -218,7 +219,7 @@ function toggle() {
|
|||
</p>
|
||||
<h1 id = 'link-83'><span class = 'chapter-header'>Chapter 5</span><br />Templates</h1><p id = "para-186">Crowbook allows the user to specify a number of templates.<a href = "#note-dest-4"><sup id = "note-source-4">[4]</sup></a></p>
|
||||
<p id = "para-187">Each of this template can be overriden by a custom one, by setting e.g.:</p>
|
||||
<pre><span style="color:#268bd2;">html.css</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">my_template.css</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">html.css</span><span style="color:#839496;">: </span><span style="color:#2aa198;">my_template.css
|
||||
</span></pre><p id = "para-188">in the book configuration file. The templates that you are most susceptible to modify are the following:</p>
|
||||
<ul>
|
||||
<li><code>html.css</code>: stylesheet for HTML output;</li>
|
||||
|
|
@ -227,27 +228,27 @@ function toggle() {
|
|||
</ul>
|
||||
<h2 id = "link-84">5.1. Create and edit template</h2>
|
||||
<p id = "para-189">Except for inline templates, which are set directly in the book configuration file:</p>
|
||||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> Template that modify how a chapter title is displayed
|
||||
rendering.chapter.template: "{{{loc_chapter}}} {{{number}}}: {{{chapter_title}}}"
|
||||
<pre><span style="color:#586e75;"># Template that modify how a chapter title is displayed
|
||||
</span><span style="color:#268bd2;">rendering.chapter.template</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">{{{loc_chapter}}} {{{number}}}: {{{chapter_title}}}</span><span style="color:#839496;">"
|
||||
|
||||
# CSS code added to default CSS templates (but don't override it)
|
||||
html.css.add: "h1 { background-color: red; }"
|
||||
epub.css.add: "h1 { background-color: gray; }"
|
||||
</span><span style="color:#586e75;"># CSS code added to default CSS templates (but don't override it)
|
||||
</span><span style="color:#268bd2;">html.css.add</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">h1 { background-color: red; }</span><span style="color:#839496;">"
|
||||
</span><span style="color:#268bd2;">epub.css.add</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">h1 { background-color: gray; }</span><span style="color:#839496;">"
|
||||
|
||||
# LaTeX code added to default LaTeX template (but doesn't override it)
|
||||
template.tex.add: "\usepackage{libertineotf}"
|
||||
</span><span style="color:#586e75;"># LaTeX code added to default LaTeX template (but doesn't override it)
|
||||
</span><span style="color:#268bd2;">template.tex.add</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">\usepackage{libertineotf}</span><span style="color:#839496;">"
|
||||
</span></pre><p id = "para-190">most templates must be in a separate file:</p>
|
||||
<pre><span style="color:#268bd2;">tex.template</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">my_template.tex</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">tex.template</span><span style="color:#839496;">: </span><span style="color:#2aa198;">my_template.tex
|
||||
</span></pre><h3 id = "link-85"><code>--print-template</code></h3>
|
||||
<p id = "para-191">The easiest way to create a new template is to start with the default one. In order to do so, you can use the <code>--print-template</code> argument:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook --print-template tex.template </span><span style="color:#859900;">></span><span style="color:#839496;"> my_template.tex
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> --print-template</span><span style="color:#839496;"> tex.template </span><span style="color:#657b83;">></span><span style="color:#839496;"> my_template.tex
|
||||
</span></pre><p id = "para-192">In order to get the <code>chapter.xhtml</code> template for EPUB3, you’ll also have to use <code>--set epub.version 3</code>:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook --print-template epub.chapter.xhtml --</span><span style="color:#859900;">set</span><span style="color:#839496;"> epub.version 3 </span><span style="color:#859900;">></span><span style="color:#839496;"> my_epub3_template.xhtml
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> --print-template</span><span style="color:#839496;"> epub.chapter.xhtml</span><span style="color:#268bd2;"> --set</span><span style="color:#839496;"> epub.version 3 </span><span style="color:#657b83;">></span><span style="color:#839496;"> my_epub3_template.xhtml
|
||||
</span></pre><h3 id = "link-86">Mustache syntax</h3>
|
||||
<p id = "para-193">Crowbook uses <a href = "https://crates.io/crates/mustache">rust-mustache</a> as its templating engine, which allows to use <a href = "http://mustache.github.io/">Mustache</a> syntax in the templates.</p>
|
||||
<p id = "para-195">It mainly boils down to using <code>{{{foo}}}</code><a href = "#note-dest-5"><sup id = "note-source-5">[5]</sup></a> to insert the value of variable <code>foo</code> in the document:</p>
|
||||
<pre><span style="color:#586e75;"><</span><span style="color:#268bd2;">h1</span><span style="color:#657b83;"> </span><span style="color:#b58900;">class</span><span style="color:#657b83;"> </span><span style="color:#657b83;">=</span><span style="color:#657b83;"> </span><span style="color:#839496;">"</span><span style="color:#657b83;">title</span><span style="color:#839496;">"</span><span style="color:#657b83;"> </span><span style="color:#586e75;">></span><span style="color:#839496;">{{{title}}}</span><span style="color:#586e75;"><</span><span style="color:#268bd2;">h1</span><span style="color:#586e75;">></span><span style="color:#839496;">
|
||||
</span><span style="color:#586e75;"><</span><span style="color:#268bd2;">h2</span><span style="color:#657b83;"> </span><span style="color:#b58900;">class</span><span style="color:#657b83;"> </span><span style="color:#657b83;">=</span><span style="color:#657b83;"> </span><span style="color:#839496;">"</span><span style="color:#657b83;">author</span><span style="color:#839496;">"</span><span style="color:#586e75;">></span><span style="color:#839496;">{{{author}}}</span><span style="color:#586e75;"></</span><span style="color:#268bd2;">h2</span><span style="color:#586e75;">></span><span style="color:#839496;">
|
||||
<pre><span style="color:#586e75;"><</span><span style="color:#268bd2;">h1 </span><span style="color:#b58900;">class </span><span style="color:#657b83;">= </span><span style="color:#839496;">"</span><span style="color:#657b83;">title</span><span style="color:#839496;">" </span><span style="color:#586e75;">></span><span style="color:#839496;">{{{title}}}</span><span style="color:#586e75;"><</span><span style="color:#268bd2;">h1</span><span style="color:#586e75;">>
|
||||
<</span><span style="color:#268bd2;">h2 </span><span style="color:#b58900;">class </span><span style="color:#657b83;">= </span><span style="color:#839496;">"</span><span style="color:#657b83;">author</span><span style="color:#839496;">"</span><span style="color:#586e75;">></span><span style="color:#839496;">{{{author}}}</span><span style="color:#586e75;"></</span><span style="color:#268bd2;">h2</span><span style="color:#586e75;">>
|
||||
</span></pre><p id = "para-196">Mustache also provides the possibility of checking whether a variable is set:</p>
|
||||
<pre><span style="color:#839496;">{{#foo}}
|
||||
Foo exists
|
||||
|
|
@ -256,20 +257,20 @@ Foo exists
|
|||
Foo does not exist
|
||||
{{^foo}}
|
||||
</span></pre><p id = "para-197">Crowbook uses this and sets some variables to <code>true</code> to allow templates to conditionally include some portions. E.g., in <code>html.css</code>:</p>
|
||||
<pre><span style="color:#657b83;">{</span><span style="color:#839496;">{#</span><span style="color:#839496;">lang</span><span style="color:#839496;">_</span><span style="color:#839496;">fr</span><span style="color:#657b83;">}</span><span style="color:#839496;">}
|
||||
</span><span style="color:#586e75;">/*</span><span style="color:#586e75;"> Make list displays '–' instead of bullets </span><span style="color:#586e75;">*/</span><span style="color:#657b83;">
|
||||
</span><span style="color:#b58900;">ul</span><span style="color:#657b83;"> </span><span style="color:#b58900;">li</span><span style="color:#657b83;"> </span><span style="color:#657b83;">{</span><span style="color:#839496;">
|
||||
</span><span style="color:#859900;">list-style-type</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">'</span><span style="color:#2aa198;">–</span><span style="color:#839496;">'</span><span style="color:#839496;">;</span><span style="color:#839496;">
|
||||
</span><span style="color:#859900;">padding-left</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#6c71c4;">.5</span><span style="color:#859900;">em</span><span style="color:#839496;">;</span><span style="color:#839496;">
|
||||
</span><span style="color:#657b83;">}</span><span style="color:#839496;">
|
||||
</span><span style="color:#657b83;">{</span><span style="color:#839496;">{/</span><span style="color:#839496;">lang</span><span style="color:#839496;">_</span><span style="color:#839496;">fr</span><span style="color:#657b83;">}</span><span style="color:#839496;">}
|
||||
<pre><span style="color:#657b83;">{</span><span style="color:#839496;">{#lang_fr</span><span style="color:#657b83;">}</span><span style="color:#839496;">}
|
||||
</span><span style="color:#586e75;">/* Make list displays '–' instead of bullets */
|
||||
</span><span style="color:#b58900;">ul li </span><span style="color:#657b83;">{
|
||||
</span><span style="color:#859900;">list-style-type</span><span style="color:#839496;">: '</span><span style="color:#2aa198;">–</span><span style="color:#839496;">';
|
||||
</span><span style="color:#859900;">padding-left</span><span style="color:#839496;">: </span><span style="color:#6c71c4;">.5</span><span style="color:#859900;">em</span><span style="color:#839496;">;
|
||||
</span><span style="color:#657b83;">}
|
||||
{</span><span style="color:#839496;">{/lang_fr</span><span style="color:#657b83;">}</span><span style="color:#839496;">}
|
||||
</span></pre><p id = "para-198">In this case, Crowbook sets a variable whose name is equal to <code>lang_foo</code> to <code>true</code>, allowing to have different styles for some elements according to the language.</p>
|
||||
<p id = "para-199">For more information about Mustache syntax, see the <a href = "http://mustache.github.io/mustache.5.html">Mustache manual</a>.</p>
|
||||
<h4 id = "link-87">Syntax in LaTeX</h4>
|
||||
<p id = "para-201">Since LaTeX already uses a lot of curly brackets, the default template sets an altenative syntax to access variables, with <code><<&foo>></code><a href = "#note-dest-6"><sup id = "note-source-6">[6]</sup></a>:</p>
|
||||
<pre><span style="color:#859900;">\</span><span style="color:#859900;">title</span><span style="color:#839496;">{</span><span style="color:#839496;"><<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">title>></span><span style="color:#839496;">}</span><span style="color:#839496;">
|
||||
</span><span style="color:#859900;">\</span><span style="color:#859900;">author</span><span style="color:#839496;">{</span><span style="color:#839496;"><<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">author>></span><span style="color:#839496;">}</span><span style="color:#839496;">
|
||||
<<#has_date>></span><span style="color:#859900;">\</span><span style="color:#859900;">date</span><span style="color:#839496;">{</span><span style="color:#839496;"><<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">date>></span><span style="color:#839496;">}</span><span style="color:#839496;"><</has_date>
|
||||
<pre><span style="color:#859900;">\title</span><span style="color:#839496;">{<<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">title>>}
|
||||
</span><span style="color:#859900;">\author</span><span style="color:#839496;">{<<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">author>>}
|
||||
<<#has_date>></span><span style="color:#859900;">\date</span><span style="color:#839496;">{<<</span><span style="color:#cb4b16;">&</span><span style="color:#839496;">date>>}<</has_date>
|
||||
</span></pre> <h3 id = "link-89">html.js</h3>
|
||||
<p id = "para-202">The javascript file used by both the standalone HTML renderer and the multiple files HTML renderer.</p>
|
||||
<p id = "para-203">This is not currently an actual template, just a plain javascript file which cannot contain <code>mustache</code> tags.</p>
|
||||
|
|
@ -477,7 +478,7 @@ Foo does not exist
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-353">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-353">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ function toggle() {
|
|||
"@type": "Book",
|
||||
"author": "Élisabeth Henry",
|
||||
"name": "Crowbook User Guide",
|
||||
"version": "0.14.0",
|
||||
"version": "0.14.1",
|
||||
|
||||
|
||||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||||
|
|
@ -75,134 +75,135 @@ function toggle() {
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
</script>
|
||||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-23">1.11. License</a></li>
|
||||
<li><a href="chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href="chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href="chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href="chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href = "chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href="chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href="chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href="chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href = "chapter_009.html#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "chapter_009.html#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "chapter_009.html#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_009.html#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_009.html#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_009.html#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_009.html#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_009.html#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_009.html#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_009.html#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_009.html#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href="chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href="chapter_009.html#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="chapter_009.html#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="chapter_009.html#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="chapter_009.html#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="chapter_009.html#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="chapter_009.html#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="chapter_009.html#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="chapter_009.html#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="chapter_009.html#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="chapter_009.html#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="chapter_009.html#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="chapter_009.html#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_010.html#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="chapter_010.html#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-356">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-356">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -230,32 +231,32 @@ function toggle() {
|
|||
</ul>
|
||||
<h2 id = "link-107">6.1. Enabling proofreading</h2>
|
||||
<p id = "para-229">Since proofreading can take quite a lot of time, particularly for a long book, it is disabled by default. You’ll have to run</p>
|
||||
<pre><span style="color:#839496;">$ crowbook --proofread my.book
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> --proofread</span><span style="color:#839496;"> my.book
|
||||
</span></pre><p id = "para-230">or</p>
|
||||
<pre><span style="color:#839496;">$ crowbook -p my.book
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> -p</span><span style="color:#839496;"> my.book
|
||||
</span></pre><p id = "para-231">to generate proofreading copies. Alternatively, if you want it to be activated each time you run <code>crowbook</code> on this book (which is <em>not</em> recommanded for long books, particularly if you want to perform a grammar check), you can set</p>
|
||||
<pre><span style="color:#268bd2;">proofread</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#b58900;">true</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">proofread</span><span style="color:#839496;">: </span><span style="color:#b58900;">true
|
||||
</span></pre><p id = "para-232">in the book configuration file.</p>
|
||||
<h2 id = "link-108">6.2. Repetition detection</h2>
|
||||
<p id = "para-233">Repetition detection is enabled with:</p>
|
||||
<pre><span style="color:#268bd2;">proofread.repetitions</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#b58900;">true</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">proofread.repetitions</span><span style="color:#839496;">: </span><span style="color:#b58900;">true
|
||||
</span></pre><p id = "para-234">It uses <a href = "https://github.com/lise-henry/caribon">Caribon</a> library to detect the repetition in your text. Since the notion of a repetition is relatively arbitrary, it is possible to adapt the settings. Default are:</p>
|
||||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> The maximum distance between two identical words to
|
||||
<pre><span style="color:#586e75;"># The maximum distance between two identical words to
|
||||
# consider them a repetition
|
||||
proofread.repetitions.max_distance: 25
|
||||
# The minimal number of occurences to consider it a repetition
|
||||
proofread.repetitions.threshold: 2.0
|
||||
# Ignore proper nouns (words starting by a capital,
|
||||
</span><span style="color:#268bd2;">proofread.repetitions.max_distance</span><span style="color:#839496;">: </span><span style="color:#6c71c4;">25
|
||||
</span><span style="color:#586e75;"># The minimal number of occurences to consider it a repetition
|
||||
</span><span style="color:#268bd2;">proofread.repetitions.threshold</span><span style="color:#839496;">: </span><span style="color:#6c71c4;">2.0
|
||||
</span><span style="color:#586e75;"># Ignore proper nouns (words starting by a capital,
|
||||
# not at a beginning of a sentence)
|
||||
proofread.repetitions.ignore_proper: true
|
||||
</span><span style="color:#268bd2;">proofread.repetitions.ignore_proper</span><span style="color:#839496;">: </span><span style="color:#b58900;">true
|
||||
|
||||
# Activate fuzzy string matching
|
||||
proofread.repetitions.fuzzy: true
|
||||
# The maximal ratio of difference to consider
|
||||
</span><span style="color:#586e75;"># Activate fuzzy string matching
|
||||
</span><span style="color:#268bd2;">proofread.repetitions.fuzzy</span><span style="color:#839496;">: </span><span style="color:#b58900;">true
|
||||
</span><span style="color:#586e75;"># The maximal ratio of difference to consider
|
||||
# that two words are identical
|
||||
# (E.g., with 0.2, "Rust" and "Lust" won't be
|
||||
# considered as the same word, but they will be with 0.5)
|
||||
proofread.repetitions.fuzzy.threshold: 0.2
|
||||
</span><span style="color:#268bd2;">proofread.repetitions.fuzzy.threshold</span><span style="color:#839496;">: </span><span style="color:#6c71c4;">0.2
|
||||
</span></pre><p id = "para-235">For more information, see <a href = "https://github.com/lise-henry/caribon">Caribon</a>’s documentation.</p>
|
||||
<blockquote><p id = "para-236">Currently, repetitions are not displayed in PDF proofreading output.</p>
|
||||
</blockquote>
|
||||
|
|
@ -263,24 +264,24 @@ proofread.repetitions.fuzzy.threshold: 0.2
|
|||
<h3 id = "link-110">With Languagetool</h3>
|
||||
<p id = "para-237">Crowbook can use <a href = "https://languagetool.org/">LanguageTool</a> to detect grammar errors in your text. It is, however, a bit more complex to activate.</p>
|
||||
<p id = "para-238">First, you’ll have to activate this feature in your book configuration file:</p>
|
||||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> Activate language tool support
|
||||
proofread.languagetool: true
|
||||
# (Optional) Sets the port number to connect to (default below)
|
||||
proofread.languagetool.port: 8081
|
||||
<pre><span style="color:#586e75;"># Activate language tool support
|
||||
</span><span style="color:#268bd2;">proofread.languagetool</span><span style="color:#839496;">: </span><span style="color:#b58900;">true
|
||||
</span><span style="color:#586e75;"># (Optional) Sets the port number to connect to (default below)
|
||||
</span><span style="color:#268bd2;">proofread.languagetool.port</span><span style="color:#839496;">: </span><span style="color:#6c71c4;">8081
|
||||
</span></pre><p id = "para-239">You’ll then have to download the stand-alone version of <a href = "https://languagetool.org/">LanguageTool</a>. It includes a server mode, which you’ll have to launch:</p>
|
||||
<pre><span style="color:#839496;">$ </span><span style="color:#859900;">java</span><span style="color:#839496;"> -</span><span style="color:#859900;">cp</span><span style="color:#839496;"> languagetool-server.</span><span style="color:#859900;">jar</span><span style="color:#839496;"> org.languagetool.server.HTTPServer --port 8081
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> java</span><span style="color:#268bd2;"> -cp</span><span style="color:#839496;"> languagetool-server.jar org.languagetool.server.HTTPServer</span><span style="color:#268bd2;"> --port</span><span style="color:#839496;"> 8081
|
||||
</span></pre><p id = "para-240">You can also use the LanguageTool GUI (<code>languagetool.jar</code>) and start the server from the menu “Text Checking -> Options”. This also allows you to configure LanguageTool more precisely by activating or deactivating rules.</p>
|
||||
<p id = "para-241">You can then run Crowbook, and it will highlight grammar errors in HTML or PDF proofreading output files.</p>
|
||||
<blockquote><p id = "para-242">Note: running a grammar check on a long book (like a novel) can take up to a few minutes.</p>
|
||||
</blockquote>
|
||||
<h3 id = "link-111">With Grammalecte</h3>
|
||||
<p id = "para-243"><a href = "http://grammalecte.net/">Grammalecte</a> is a grammar checker specialized for the french language. If the language of your book is french, you can use it in a similar fashion to languagetool:</p>
|
||||
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> Activate grammalecte support
|
||||
proofread.grammalecte: true
|
||||
# (Optional) Sets the port number to connect to (default below)
|
||||
proofread.grammalecte.port: 8080
|
||||
<pre><span style="color:#586e75;"># Activate grammalecte support
|
||||
</span><span style="color:#268bd2;">proofread.grammalecte</span><span style="color:#839496;">: </span><span style="color:#b58900;">true
|
||||
</span><span style="color:#586e75;"># (Optional) Sets the port number to connect to (default below)
|
||||
</span><span style="color:#268bd2;">proofread.grammalecte.port</span><span style="color:#839496;">: </span><span style="color:#6c71c4;">8080
|
||||
</span></pre><p id = "para-244">You’ll also need to run the Grammalecte server. First <a href = "https://www.dicollecte.org/#download_div">download the CLI and server version</a>, then:</p>
|
||||
<pre><span style="color:#839496;">$ </span><span style="color:#859900;">python3</span><span style="color:#839496;"> server.</span><span style="color:#859900;">py</span><span style="color:#839496;">
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> python3 server.py
|
||||
</span></pre><p id = "para-245">You can then run Crowbook with <code>--proofread</code> to check the grammar of your book. It is possible to run both LanguageTool and Grammalecte on the same book (though might take a while for a long book...).</p>
|
||||
|
||||
<p class = "next_chapter">
|
||||
|
|
@ -289,7 +290,7 @@ proofread.grammalecte.port: 8080
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-355">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-355">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ function toggle() {
|
|||
"@type": "Book",
|
||||
"author": "Élisabeth Henry",
|
||||
"name": "Crowbook User Guide",
|
||||
"version": "0.14.0",
|
||||
"version": "0.14.1",
|
||||
|
||||
|
||||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||||
|
|
@ -75,134 +75,135 @@ function toggle() {
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
</script>
|
||||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-23">1.11. License</a></li>
|
||||
<li><a href="chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href="chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href="chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href="chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href = "chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href="chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href="chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href="chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href = "chapter_009.html#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "chapter_009.html#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "chapter_009.html#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_009.html#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_009.html#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_009.html#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_009.html#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_009.html#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_009.html#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_009.html#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_009.html#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href="chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href="chapter_009.html#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="chapter_009.html#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="chapter_009.html#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="chapter_009.html#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="chapter_009.html#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="chapter_009.html#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="chapter_009.html#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="chapter_009.html#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="chapter_009.html#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="chapter_009.html#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="chapter_009.html#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="chapter_009.html#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_010.html#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="chapter_010.html#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-358">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-358">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -221,41 +222,41 @@ function toggle() {
|
|||
</blockquote>
|
||||
<h2 id = "link-113">7.1. Basics</h2>
|
||||
<p id = "para-248">If you want to have a non-linear story, you can simply use Markdown links just as you would for any other link:</p>
|
||||
<pre><span style="color:#839496;">*</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#839496;">Open the treasure chest</span><span style="color:#839496;">]</span><span style="color:#839496;">(</span><span style="color:#2aa198;">open_chest.md</span><span style="color:#839496;">)</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;">*</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#839496;">It might be trapped, stay away from it</span><span style="color:#839496;">]</span><span style="color:#839496;">(</span><span style="color:#2aa198;">stay_away.md</span><span style="color:#839496;">)</span><span style="color:#839496;">
|
||||
<pre><span style="color:#839496;">* [Open the treasure chest](</span><span style="color:#2aa198;">open_chest.md</span><span style="color:#839496;">)
|
||||
* [It might be trapped, stay away from it](</span><span style="color:#2aa198;">stay_away.md</span><span style="color:#839496;">)
|
||||
</span></pre><p id = "para-249">All Crowbook renderers should render this correctly, allowing the reader to “choose her adventure”. Note, however, that you still need to include all these Markdown files in you book configuration files.</p>
|
||||
<h2 id = "link-114">7.2. The interactive fiction renderer</h2>
|
||||
<p id = "para-250">While the above allows you to generate correct EPUB and PDF files, it will still display all the content if the reader chooses to read your book linearly. While this may not be a problem, you might want to only display the part of the book that the reader is actually exploring.</p>
|
||||
<p id = "para-251">In order to do so, you can use the interactive fiction html renderer:</p>
|
||||
<pre><span style="color:#268bd2;">output.html.if</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">my_book.html</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">output.html.if</span><span style="color:#839496;">: </span><span style="color:#2aa198;">my_book.html
|
||||
</span></pre><p id = "para-252">This output is similar to the standalone HTML output, except the option to display only a chapter at a time is always true, and there is no way to display the table of contents.</p>
|
||||
<h2 id = "link-115">7.3. Using Javascript in your interactive fiction</h2>
|
||||
<p id = "para-253">While the above allows the reader to choose his own path, its interactivity is quite limited. With the interactive fiction renderer, it is possible to include Javascript code in your Markdown files, using a code block element:</p>
|
||||
<pre><span style="color:#839496;">You open the chest, and you find a shiny sword. Yay!
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;"> user_has_sword = true;
|
||||
|
||||
user_has_sword = true;
|
||||
</span></pre><p id = "para-254">This Javascript code can return a string value, which will be displayed inside the document according to the reader’s previous choices:</p>
|
||||
<pre><span style="color:#839496;">You encounter a goblin, armed with a knife!
|
||||
</span><span style="color:#839496;">
|
||||
</span><span style="color:#839496;"> if (user_has_sword) {
|
||||
</span><span style="color:#839496;"> return "You kill him with your sword, congratulations!";
|
||||
</span><span style="color:#839496;"> } else {
|
||||
</span><span style="color:#839496;"> return "You don't have any weapon, you die :(";
|
||||
</span><span style="color:#839496;"> }
|
||||
|
||||
if (user_has_sword) {
|
||||
return "You kill him with your sword, congratulations!";
|
||||
} else {
|
||||
return "You don't have any weapon, you die :(";
|
||||
}
|
||||
</span></pre><blockquote><p id = "para-255">Note that <em>only</em> the interactive fiction renderer supports this way of embedding Javascript code. If you try to render a document containing such code blocks to EPUB, PDF, or the “normal” HTML renderer, they will be displayed as regular code blocks.</p>
|
||||
</blockquote>
|
||||
<h2 id = "link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</h2>
|
||||
<p id = "para-256">If you want to include Markdown formatting in the Javascript code (to display a passage or another without having to write HTML code), you can use the <code>@"..."@</code> syntax:</p>
|
||||
<pre><span style="color:#839496;"> @"You face a troll!"@
|
||||
</span><span style="color:#839496;"> if (user_has_sword) {
|
||||
</span><span style="color:#839496;"> @"* [Attack him with your sword](fight_troll.md)"@
|
||||
</span><span style="color:#839496;"> } else {
|
||||
</span><span style="color:#839496;"> @"* [Better run away](run_away.md)"@
|
||||
</span><span style="color:#839496;"> }
|
||||
if (user_has_sword) {
|
||||
@"* [Attack him with your sword](fight_troll.md)"@
|
||||
} else {
|
||||
@"* [Better run away](run_away.md)"@
|
||||
}
|
||||
</span></pre><p id = "para-257">Note that in this case you don’t need to return a value, this is done behind your back. Similarly, <code>@"..."@</code> blocks don’t require semicolons.</p>
|
||||
<p id = "para-258">If you need to access the value of a Javascript variable inside this Markdown code, you can use the <code>{{...}}</code> syntax:</p>
|
||||
<pre><span style="color:#839496;"> var name = prompt("Enter your name", "world");
|
||||
</span><span style="color:#839496;"> @"Hello, {{name}}"@
|
||||
@"Hello, {{name}}"@
|
||||
</span></pre><h2 id = "link-117">7.5. Conditional blocks</h2>
|
||||
<p id = "para-259">Sometimes, you want some text (or Javascript code) to only be displayed (or run) when the reader reads this passage the first time, or alternatively when she goes back to it. While it is trivial to add some code to check that, it is a common enough pattern to justify its own variant : you’ll juste have to insert a named code block with the number:</p>
|
||||
<pre><span style="color:#839496;">```1
|
||||
|
|
@ -272,10 +273,10 @@ function toggle() {
|
|||
</span></pre><h2 id = "link-118">7.6. Interactive fiction options</h2>
|
||||
<p id = "para-260">As other renderers, there are options specific to the interactive fiction.</p>
|
||||
<p id = "para-261"><b>html.if.new_game</b> allows you to specify the path to a Javascript that will be run at the beginning of the game. Since this code is not embedded in a function and is at the root (and the beginning) of the document, it is a good place to declare all the functions and the global variables you might need for your interactive fiction mechanics. e.g.:</p>
|
||||
<pre><span style="color:#268bd2;">html.if.new_game</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">some_file.js</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">html.if.new_game</span><span style="color:#839496;">: </span><span style="color:#2aa198;">some_file.js
|
||||
</span></pre><p id = "para-262"><b>html.if.new_turn</b> and <b>html.if.end_turn</b> allow you to specify some Javascript code that will be executed at the beginning and the end of each segment. Unlike <code>html.if.new_game</code>, the (usually shorter) code is specified inline, and can return a string value that will be displayed at the beginning and the end of each segment. This is exactly like including code blocks at the beginning or the end of each of your Markdown file. E.g.:</p>
|
||||
<pre><span style="color:#268bd2;">html.if.new_turn</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">nb_turns += 1;</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">html.end_turn</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">"</span><span style="color:#2aa198;">return 'Turn: ' + nb_turns;</span><span style="color:#839496;">"</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">html.if.new_turn</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">nb_turns += 1;</span><span style="color:#839496;">"
|
||||
</span><span style="color:#268bd2;">html.end_turn</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">return 'Turn: ' + nb_turns;</span><span style="color:#839496;">"
|
||||
</span></pre><p id = "para-263"><b>html.if.script</b> allows you to specify the name of a Javascript file to override the default script.</p>
|
||||
|
||||
<p class = "next_chapter">
|
||||
|
|
@ -284,7 +285,7 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-357">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-357">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ function toggle() {
|
|||
"@type": "Book",
|
||||
"author": "Élisabeth Henry",
|
||||
"name": "Crowbook User Guide",
|
||||
"version": "0.14.0",
|
||||
"version": "0.14.1",
|
||||
|
||||
|
||||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||||
|
|
@ -75,134 +75,135 @@ function toggle() {
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
</script>
|
||||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-23">1.11. License</a></li>
|
||||
<li><a href="chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href="chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href="chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href="chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href = "chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href="chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href="chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href="chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href = "chapter_009.html#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "chapter_009.html#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "chapter_009.html#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_009.html#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_009.html#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_009.html#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_009.html#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_009.html#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_009.html#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_009.html#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_009.html#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href="chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href="chapter_009.html#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="chapter_009.html#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="chapter_009.html#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="chapter_009.html#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="chapter_009.html#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="chapter_009.html#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="chapter_009.html#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="chapter_009.html#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="chapter_009.html#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="chapter_009.html#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="chapter_009.html#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="chapter_009.html#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_010.html#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="chapter_010.html#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-360">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-360">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -219,8 +220,8 @@ function toggle() {
|
|||
<h1 id = 'link-119'><span class = 'chapter-header'>Chapter 8</span><br />Tips and tricks</h1><h2 id = "link-120">8.1. Using Crowbook with Emacs’ markdown mode</h2>
|
||||
<p id = "para-264">If you use <a href = "https://www.gnu.org/software/emacs/">Emacs</a> as a text editor, there is a nice <a href = "http://jblevins.org/projects/markdown-mode/">Markdown mode</a> to edit Markdown files.</p>
|
||||
<p id = "para-265">It is possible to use Crowbook for HTML previewing in this mode, which <a href = "http://xkcd.com/1742/">requires only minimal configuration and tweaking</a>:</p>
|
||||
<pre><span style="color:#839496;">(</span><span style="color:#839496;">custom</span><span style="color:#657b83;">-</span><span style="color:#859900;">set</span><span style="color:#657b83;">-</span><span style="color:#839496;">variables
|
||||
'</span><span style="color:#839496;">(</span><span style="color:#839496;">markdown</span><span style="color:#657b83;">-</span><span style="color:#839496;">command </span><span style="color:#839496;">"</span><span style="color:#2aa198;">crowbook - -qs --to html --output -</span><span style="color:#839496;">"</span><span style="color:#839496;">)</span><span style="color:#839496;">)</span><span style="color:#839496;">
|
||||
<pre><span style="color:#839496;">(custom</span><span style="color:#657b83;">-</span><span style="color:#859900;">set</span><span style="color:#657b83;">-</span><span style="color:#839496;">variables
|
||||
'(markdown</span><span style="color:#657b83;">-</span><span style="color:#839496;">command "</span><span style="color:#2aa198;">crowbook - -qs --to html --output -</span><span style="color:#839496;">"))
|
||||
</span></pre><p id = "para-266">You can then use <code>markdown-preview</code> (or <code>C-c C-c p</code>) to run Crowbook on this file and preview it in your browser, or run <code>markdown-live-preview-mode</code> to see a live preview (updated each time you save your file) in Emacs’ integrated browser.</p>
|
||||
<h3 id = "link-121">Some explanations if it looks a bit cryptic to you</h3>
|
||||
<p id = "para-267">We set <code>markdown-command</code> to <code>crowbook</code>, the reason for this is a bit obvious. The arguments we give to crowbook might be a bit less obvious:</p>
|
||||
|
|
@ -232,20 +233,20 @@ function toggle() {
|
|||
</ul>
|
||||
<h2 id = "link-122">8.2. Embedding fonts in an EPUB file</h2>
|
||||
<p id = "para-268">In order to embed fonts in an EPUB file, you’ll first have to edit the stylesheet, which you can first obtain with:</p>
|
||||
<pre><span style="color:#839496;">$ crowbook --print-template epub.css </span><span style="color:#859900;">></span><span style="color:#839496;"> my_epub_stylesheet.css
|
||||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook</span><span style="color:#268bd2;"> --print-template</span><span style="color:#839496;"> epub.css </span><span style="color:#657b83;">></span><span style="color:#839496;"> my_epub_stylesheet.css
|
||||
</span></pre><p id = "para-269">You’ll need to use the <a href = "https://developer.mozilla.org/fr/docs/Web/CSS/@font-face"><code>@font-face</code> attribute</a>:</p>
|
||||
<pre><span style="color:#859900;">@</span><span style="color:#859900;">font-face</span><span style="color:#839496;"> </span><span style="color:#657b83;">{</span><span style="color:#839496;">
|
||||
</span><span style="color:#859900;">font-family</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#2aa198;">MyFont</span><span style="color:#839496;">;</span><span style="color:#839496;">
|
||||
</span><span style="color:#859900;">src</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#859900;">url</span><span style="color:#839496;">(</span><span style="color:#2aa198;">d</span><span style="color:#2aa198;">a</span><span style="color:#2aa198;">t</span><span style="color:#2aa198;">a</span><span style="color:#2aa198;">/</span><span style="color:#2aa198;">m</span><span style="color:#2aa198;">y</span><span style="color:#2aa198;">_</span><span style="color:#2aa198;">f</span><span style="color:#2aa198;">o</span><span style="color:#2aa198;">n</span><span style="color:#2aa198;">t</span><span style="color:#2aa198;">.</span><span style="color:#2aa198;">t</span><span style="color:#2aa198;">t</span><span style="color:#2aa198;">f</span><span style="color:#839496;">)</span><span style="color:#839496;">;</span><span style="color:#839496;">
|
||||
</span><span style="color:#657b83;">}</span><span style="color:#839496;">
|
||||
<pre><span style="color:#859900;">@font-face </span><span style="color:#657b83;">{
|
||||
</span><span style="color:#859900;">font-family</span><span style="color:#839496;">: </span><span style="color:#2aa198;">MyFont</span><span style="color:#839496;">;
|
||||
</span><span style="color:#859900;">src</span><span style="color:#839496;">: </span><span style="color:#859900;">url</span><span style="color:#839496;">(</span><span style="color:#2aa198;">data/my_font.ttf</span><span style="color:#839496;">);
|
||||
</span><span style="color:#657b83;">}
|
||||
</span></pre><p id = "para-270">Then you can add <code>my_font.ttf</code> to the files that need to be added to the EPUB zip file:</p>
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">My Book</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">author</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">Me</span><span style="color:#839496;">
|
||||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">: </span><span style="color:#268bd2;">My Book
|
||||
author</span><span style="color:#839496;">: </span><span style="color:#268bd2;">Me
|
||||
|
||||
</span><span style="color:#268bd2;">cover</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">cover.png</span><span style="color:#839496;">
|
||||
</span><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#268bd2;">book.epub</span><span style="color:#839496;">
|
||||
cover</span><span style="color:#839496;">: </span><span style="color:#268bd2;">cover.png
|
||||
output.epub</span><span style="color:#839496;">: </span><span style="color:#268bd2;">book.epub
|
||||
|
||||
</span><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">:</span><span style="color:#839496;"> </span><span style="color:#839496;">[</span><span style="color:#2aa198;">my_font.ttf</span><span style="color:#839496;">]</span><span style="color:#839496;">
|
||||
resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">my_font.ttf</span><span style="color:#839496;">]
|
||||
</span></pre><p id = "para-271">(Note that you’ll have to repeat the process for the different <code>font-weight</code> and <code>font-style</code> variants of your font if you want it to display correctly when there is some text in <b>bold</b>, <em>italics</em>, or <b><em>both</em></b>.)</p>
|
||||
|
||||
<p class = "next_chapter">
|
||||
|
|
@ -254,7 +255,7 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-359">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-359">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ function toggle() {
|
|||
"@type": "Book",
|
||||
"author": "Élisabeth Henry",
|
||||
"name": "Crowbook User Guide",
|
||||
"version": "0.14.0",
|
||||
"version": "0.14.1",
|
||||
|
||||
|
||||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||||
|
|
@ -75,134 +75,135 @@ function toggle() {
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
</script>
|
||||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-23">1.11. License</a></li>
|
||||
<li><a href="chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href="chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href="chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href="chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href = "chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href="chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href="chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href="chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href = "chapter_009.html#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "chapter_009.html#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "chapter_009.html#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_009.html#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_009.html#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_009.html#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_009.html#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_009.html#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_009.html#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_009.html#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_009.html#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href="chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href="chapter_009.html#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="chapter_009.html#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="chapter_009.html#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="chapter_009.html#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="chapter_009.html#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="chapter_009.html#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="chapter_009.html#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="chapter_009.html#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="chapter_009.html#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="chapter_009.html#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="chapter_009.html#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="chapter_009.html#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_010.html#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="chapter_010.html#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-362">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-362">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -231,7 +232,7 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-361">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-361">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ function toggle() {
|
|||
"@type": "Book",
|
||||
"author": "Élisabeth Henry",
|
||||
"name": "Crowbook User Guide",
|
||||
"version": "0.14.0",
|
||||
"version": "0.14.1",
|
||||
|
||||
|
||||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||||
|
|
@ -75,134 +75,135 @@ function toggle() {
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
</script>
|
||||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-23">1.11. License</a></li>
|
||||
<li><a href="chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href="chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href="chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href="chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href = "chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href="chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href="chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href="chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href = "chapter_009.html#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "chapter_009.html#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "chapter_009.html#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_009.html#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_009.html#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_009.html#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_009.html#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_009.html#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_009.html#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_009.html#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_009.html#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href="chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href="chapter_009.html#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="chapter_009.html#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="chapter_009.html#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="chapter_009.html#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="chapter_009.html#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="chapter_009.html#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="chapter_009.html#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="chapter_009.html#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="chapter_009.html#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="chapter_009.html#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="chapter_009.html#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="chapter_009.html#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_010.html#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="chapter_010.html#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-364">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-364">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -218,6 +219,12 @@ function toggle() {
|
|||
</p>
|
||||
<h1 id = 'link-125'>ChangeLog</h1><h2 id = "link-126">unreleased</h2>
|
||||
<ul>
|
||||
<li><code>--stats</code> can now display more statistics when used with the <code>--verbose</code> option (if support for advanced statistics is compiled)</li>
|
||||
<li>LaTeX outputs now make uses of user-defined <code>rendering.chapter</code> and <code>rendering.part</code></li>
|
||||
<li>Dependencies update</li>
|
||||
</ul>
|
||||
<h2 id = "link-127">0.14.0 (2017-11-26)</h2>
|
||||
<ul>
|
||||
<li>New option:<ul>
|
||||
<li><code>autograph</code> is an autograph added after title.</li>
|
||||
</ul>
|
||||
|
|
@ -235,7 +242,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-127">0.14.0-beta (2017-10-08)</h2>
|
||||
<h2 id = "link-128">0.14.0-beta (2017-10-08)</h2>
|
||||
<ul>
|
||||
<li>Bugfixes:<ul>
|
||||
<li>EPUB: escape quotes in content.opf.</li>
|
||||
|
|
@ -255,7 +262,7 @@ function toggle() {
|
|||
</li>
|
||||
<li>Now requires rustc >= 1.20.0</li>
|
||||
</ul>
|
||||
<h2 id = "link-128">0.13.0 (2017-07-14)</h2>
|
||||
<h2 id = "link-129">0.13.0 (2017-07-14)</h2>
|
||||
<ul>
|
||||
<li>Breaking changes:<ul>
|
||||
<li>The <code>template.tex</code> template was quite modified. Crowbook now uses custom command for most markdown elements, defined in the template. This allow an user to redefine the way the book is rendered without having to modify Crowbook itself. Unfortunately, as tex templates for previous Crowbook versions won’t work anymore.</li>
|
||||
|
|
@ -290,7 +297,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-129">0.12.0 (2017-06-05)</h2>
|
||||
<h2 id = "link-130">0.12.0 (2017-06-05)</h2>
|
||||
<p id = "para-274">This release includes a few new features, such as the possiblity to include Markdown files as section/subsections and not only as chapter, experimental support for superscript and subscript, and yet more experimental support for writing interactive fiction.</p>
|
||||
<ul>
|
||||
<li>Book configuration file:<ul>
|
||||
|
|
@ -337,7 +344,7 @@ function toggle() {
|
|||
</li>
|
||||
<li>Crowbook now requires rustc >= 1.17.0</li>
|
||||
</ul>
|
||||
<h2 id = "link-130">0.11.4 (2017-03-21)</h2>
|
||||
<h2 id = "link-131">0.11.4 (2017-03-21)</h2>
|
||||
<ul>
|
||||
<li>An image can now be considered standalone even if it is inside a link.</li>
|
||||
<li>Bugfixes:<ul>
|
||||
|
|
@ -355,7 +362,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-131">0.11.3 (2017-03-19)</h2>
|
||||
<h2 id = "link-132">0.11.3 (2017-03-19)</h2>
|
||||
<ul>
|
||||
<li>When crowbook parses the book’s contents, it now detects which features are used. This is useful in various ways:<ul>
|
||||
<li>The ODT renderer only displays a global warning showing the lists of used features that are not implemented, instead of a warning each time such a feature is encountered.</li>
|
||||
|
|
@ -374,7 +381,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-132">0.11.2 (2017-03-05)</h2>
|
||||
<h2 id = "link-133">0.11.2 (2017-03-05)</h2>
|
||||
<ul>
|
||||
<li>General:<ul>
|
||||
<li>When there is an error setting an option from the book configuration file (e.g. because it is an invalid key), print an error but do not abort, only ignore this specific option.</li>
|
||||
|
|
@ -410,7 +417,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-133">0.11.1 (2017-01-05)</h2>
|
||||
<h2 id = "link-134">0.11.1 (2017-01-05)</h2>
|
||||
<ul>
|
||||
<li>Rendering:<ul>
|
||||
<li>Avoid page break before or after a separating rule.</li>
|
||||
|
|
@ -442,7 +449,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-134">0.11.0 (2016-12-31)</h2>
|
||||
<h2 id = "link-135">0.11.0 (2016-12-31)</h2>
|
||||
<p id = "para-275">Substantial changes in this release, the more important one being support for parts!</p>
|
||||
<ul>
|
||||
<li><b>Breaking changes</b>: the API has undergone some breaking changes, hoping they will be the last ones for a while. API should now be more simple and consistent (?). This version contains also substantial options renaming (see below).</li>
|
||||
|
|
@ -506,7 +513,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-135">0.10.4 (2016-12-16)</h2>
|
||||
<h2 id = "link-136">0.10.4 (2016-12-16)</h2>
|
||||
<ul>
|
||||
<li>New options:<ul>
|
||||
<li><code>tex.font_size</code> specifies an optional font size (in pt) passed to the LaTeX class (must be 10, 11 or 12).</li>
|
||||
|
|
@ -528,7 +535,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-136">0.10.3 (2016-11-19)</h2>
|
||||
<h2 id = "link-137">0.10.3 (2016-11-19)</h2>
|
||||
<ul>
|
||||
<li>Building:<ul>
|
||||
<li>Crowbook now requires rustc >= 1.13.0 to build.</li>
|
||||
|
|
@ -549,7 +556,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-137">0.10.2 (2016-10-21)</h2>
|
||||
<h2 id = "link-138">0.10.2 (2016-10-21)</h2>
|
||||
<p id = "para-276">Only minor changes in this version:</p>
|
||||
<ul>
|
||||
<li>Options:<ul>
|
||||
|
|
@ -565,9 +572,9 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-138">0.10.1 (2016-10-18)</h2>
|
||||
<h2 id = "link-139">0.10.1 (2016-10-18)</h2>
|
||||
<p id = "para-277">Fixed a bug in <code>fr.po</code> translation that prevented building from fresh install.</p>
|
||||
<h2 id = "link-139">0.10.0 (2016-10-18)</h2>
|
||||
<h2 id = "link-140">0.10.0 (2016-10-18)</h2>
|
||||
<p id = "para-278">This release contains some breaking changes (mostly for the API, which has been split in separate libraries). It alse features some internationalization support, and the program should now be tranlated if your <code>LANG</code> environment variable is set to french.</p>
|
||||
<ul>
|
||||
<li><b>Breaking changes</b>:<ul>
|
||||
|
|
@ -604,7 +611,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-140">0.9.1 (2016-09-29)</h2>
|
||||
<h2 id = "link-141">0.9.1 (2016-09-29)</h2>
|
||||
<p id = "para-279">This release mainly introduces generation of proofreading copies, allowing, if they are set (and <code>crowbook</code> was compiled with the <code>proofread</code> feature) to generate proofreading copies, using tools to check grammar and detect repetitions. These features are currently experimental.</p>
|
||||
<ul>
|
||||
<li>New options:<ul>
|
||||
|
|
@ -635,7 +642,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-141">0.9.0 (2016-09-23)</h2>
|
||||
<h2 id = "link-142">0.9.0 (2016-09-23)</h2>
|
||||
<p id = "para-280">The main objective of this release is to clean public interfaces, in order to limit breaking changes in the future. <em>Ideally</em>, all pre-1.0 releases should thus be 0.9.x. Concretely, this meant three things:</p>
|
||||
<ul>
|
||||
<li>reducing the surface of Crowbook’s library API;</li>
|
||||
|
|
@ -700,7 +707,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-142">0.8.0 (2016-09-19)</h2>
|
||||
<h2 id = "link-143">0.8.0 (2016-09-19)</h2>
|
||||
<p id = "para-281">This release adds support for syntax higlighting in code blocks, customized top and footer blocks for HTML rendering, and the special <code>import_config</code> option that allows to import options from another book file. It also provides (hopefully) better error messages.</p>
|
||||
<ul>
|
||||
<li>New options:<ul>
|
||||
|
|
@ -740,7 +747,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-143">0.7.0 (2016-09-11)</h2>
|
||||
<h2 id = "link-144">0.7.0 (2016-09-11)</h2>
|
||||
<p id = "para-282">This releases renders images differently when they are on a standalone paragraph or inside a paragraph.</p>
|
||||
<ul>
|
||||
<li>Internal/API:<ul>
|
||||
|
|
@ -754,7 +761,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-144">0.6.0 (2016-09-09)</h2>
|
||||
<h2 id = "link-145">0.6.0 (2016-09-09)</h2>
|
||||
<ul>
|
||||
<li>Deprecated options:<ul>
|
||||
<li><code>nb_char</code>: since it was only used for french cleaner and for typography reasons it’s better to use different non breaking spaces according to context, this option was not really useful anymore.</li>
|
||||
|
|
@ -781,7 +788,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-145">0.5.1 (2016-04-14)</h2>
|
||||
<h2 id = "link-146">0.5.1 (2016-04-14)</h2>
|
||||
<p id = "para-283">Mostly rendering fixes:</p>
|
||||
<ul>
|
||||
<li>Epub:<ul>
|
||||
|
|
@ -807,7 +814,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-146">0.5.0 (2016-04-02)</h2>
|
||||
<h2 id = "link-147">0.5.0 (2016-04-02)</h2>
|
||||
<ul>
|
||||
<li>Crowbook now requires Rustc 1.7.0.</li>
|
||||
<li>It is now possible to render HTML in multiple files:<ul>
|
||||
|
|
@ -846,7 +853,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-147">0.4.0 (2016-03-01)</h2>
|
||||
<h2 id = "link-148">0.4.0 (2016-03-01)</h2>
|
||||
<ul>
|
||||
<li>Crowbook now internally uses a true YAML parser, <code>yaml_rust</code>, for its options. Since the “old” Crowbooks’s config format was similar, but had some subtle differences, this is somewhat of a breaking change:<ul>
|
||||
<li>strings should now be escaped with “” in some cases (e.g. if it contains special characters). On the other hand, it <em>allows</em> to optionally escape a string with these quotes, which wasn’t possible until then and might be useful in some cases.</li>
|
||||
|
|
@ -866,7 +873,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-148">0.3.0 (2016-02-27)</h2>
|
||||
<h2 id = "link-149">0.3.0 (2016-02-27)</h2>
|
||||
<ul>
|
||||
<li>Crowbook now tries to convert local links. That is, if you link to a Markdown file that is used in the book. (e.g. <a href = "chapter_000.html">README.md</a>), it <em>should</em> link to an appropriate inner reference inside the book.</li>
|
||||
<li>Latex renderer now supports (local) images.</li>
|
||||
|
|
@ -884,14 +891,14 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-149">0.2.2 (2016-02-25)</h2>
|
||||
<h2 id = "link-150">0.2.2 (2016-02-25)</h2>
|
||||
<ul>
|
||||
<li>Bugfixes:<ul>
|
||||
<li>French cleaner now correctly replaces space after — (in e.g. dialogs) with “em space”.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-150">0.2.1 (2016-02-25)</h2>
|
||||
<h2 id = "link-151">0.2.1 (2016-02-25)</h2>
|
||||
<ul>
|
||||
<li>Bugfixes:<ul>
|
||||
<li>HTML/Epub rendering no longer incorrectly increment chapter count for unnumbered chapters.</li>
|
||||
|
|
@ -903,7 +910,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-151">0.2.0 (2016-02-25)</h2>
|
||||
<h2 id = "link-152">0.2.0 (2016-02-25)</h2>
|
||||
<ul>
|
||||
<li>Command line arguments:<ul>
|
||||
<li>New argument <code>--print-template</code> now allows to print a built-in template to stdout.</li>
|
||||
|
|
@ -928,7 +935,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-152">0.1.0 (2016-02-21)</h2>
|
||||
<h2 id = "link-153">0.1.0 (2016-02-21)</h2>
|
||||
<ul>
|
||||
<li>initial release</li>
|
||||
</ul>
|
||||
|
|
@ -939,7 +946,7 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-363">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-363">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ function toggle() {
|
|||
"@type": "Book",
|
||||
"author": "Élisabeth Henry",
|
||||
"name": "Crowbook User Guide",
|
||||
"version": "0.14.0",
|
||||
"version": "0.14.1",
|
||||
|
||||
|
||||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||||
|
|
@ -75,134 +75,135 @@ function toggle() {
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
</script>
|
||||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-23">1.11. License</a></li>
|
||||
<li><a href="chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href="chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href="chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href="chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href = "chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href="chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href="chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href="chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href = "chapter_009.html#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "chapter_009.html#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "chapter_009.html#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_009.html#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_009.html#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_009.html#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_009.html#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_009.html#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_009.html#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_009.html#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_009.html#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href="chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href="chapter_009.html#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="chapter_009.html#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="chapter_009.html#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="chapter_009.html#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="chapter_009.html#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="chapter_009.html#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="chapter_009.html#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="chapter_009.html#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="chapter_009.html#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="chapter_009.html#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="chapter_009.html#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="chapter_009.html#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_010.html#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="chapter_010.html#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-366">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-366">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -216,7 +217,7 @@ function toggle() {
|
|||
« ChangeLog
|
||||
</a>
|
||||
</p>
|
||||
<h1 id = 'link-153'>GNU LESSER GENERAL PUBLIC LICENSE</h1><pre><span style="color:#839496;"> Version 2.1, February 1999
|
||||
<h1 id = 'link-154'>GNU LESSER GENERAL PUBLIC LICENSE</h1><pre><span style="color:#839496;"> Version 2.1, February 1999
|
||||
</span></pre><p id = "para-284">Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.</p>
|
||||
<p id = "para-285">[This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.]</p>
|
||||
<pre><span style="color:#839496;"> Preamble
|
||||
|
|
@ -402,7 +403,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|||
|
||||
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-365">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-365">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -63,128 +63,129 @@ function toggle() {
|
|||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-23">1.11. License</a></li>
|
||||
<li><a href="chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href="chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href="chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href="chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href="chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href = "chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
<li><a href="chapter_001.html#link-24">2. Arguments</a>
|
||||
<ul><li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||||
<li><a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a></li>
|
||||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||||
<li><a href="chapter_001.html#link-35">2.10. <code>--to</code></a></li>
|
||||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||||
<li><a href="chapter_001.html#link-38">2.12. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href = "chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href = "chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href = "chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href = "chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
<li><a href="chapter_002.html#link-40">3. The configuration file</a>
|
||||
<ul><li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||||
<li><a href="chapter_002.html#link-42">3.2. The list of files</a></li>
|
||||
<li><a href="chapter_002.html#link-45">3.3. Crowbook options</a></li>
|
||||
<li><a href="chapter_002.html#link-60">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href = "chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href = "chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href = "chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href = "chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href = "chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
<li><a href="chapter_003.html#link-77">4. Markdown format</a>
|
||||
<ul><li><a href="chapter_003.html#link-78">4.1. Tables</a></li>
|
||||
<li><a href="chapter_003.html#link-79">4.2. Footnotes</a></li>
|
||||
<li><a href="chapter_003.html#link-80">4.3. Superscript and subscript</a></li>
|
||||
<li><a href="chapter_003.html#link-81">4.4. “Standalone” images</a></li>
|
||||
<li><a href="chapter_003.html#link-82">4.5. Interactive fiction</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href = "chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href = "chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href = "chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
<li><a href="chapter_004.html#link-83">5. Templates</a>
|
||||
<ul><li><a href="chapter_004.html#link-84">5.1. Create and edit template</a></li>
|
||||
<li><a href="chapter_004.html#link-88">5.2. List of templates</a></li>
|
||||
<li><a href="chapter_004.html#link-102">5.3. List of accessible variables</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href = "chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href = "chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href = "chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
<li><a href="chapter_005.html#link-106">6. Proofreading with Crowbook</a>
|
||||
<ul><li><a href="chapter_005.html#link-107">6.1. Enabling proofreading</a></li>
|
||||
<li><a href="chapter_005.html#link-108">6.2. Repetition detection</a></li>
|
||||
<li><a href="chapter_005.html#link-109">6.3. Grammar checking</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href = "chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href = "chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href = "chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href = "chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href = "chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href = "chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
<li><a href="chapter_006.html#link-112">7. Interactive fiction</a>
|
||||
<ul><li><a href="chapter_006.html#link-113">7.1. Basics</a></li>
|
||||
<li><a href="chapter_006.html#link-114">7.2. The interactive fiction renderer</a></li>
|
||||
<li><a href="chapter_006.html#link-115">7.3. Using Javascript in your interactive fiction</a></li>
|
||||
<li><a href="chapter_006.html#link-116">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||||
<li><a href="chapter_006.html#link-117">7.5. Conditional blocks</a></li>
|
||||
<li><a href="chapter_006.html#link-118">7.6. Interactive fiction options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href = "chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
<li><a href="chapter_007.html#link-119">8. Tips and tricks</a>
|
||||
<ul><li><a href="chapter_007.html#link-120">8.1. Using Crowbook with Emacs’ markdown mode</a></li>
|
||||
<li><a href="chapter_007.html#link-122">8.2. Embedding fonts in an EPUB file</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href = "chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
<li><a href="chapter_008.html#link-123">9. Contributing</a>
|
||||
<ul><li><a href="chapter_008.html#link-124">9.1. Internationalization</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href = "chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href = "chapter_009.html#link-127">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href = "chapter_009.html#link-128">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-129">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-130">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-131">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-132">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-133">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href = "chapter_009.html#link-134">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href = "chapter_009.html#link-135">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_009.html#link-136">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-137">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_009.html#link-138">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-139">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_009.html#link-140">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_009.html#link-141">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_009.html#link-142">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_009.html#link-143">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_009.html#link-144">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_009.html#link-145">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_009.html#link-146">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_009.html#link-147">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_009.html#link-148">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_009.html#link-149">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-150">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-151">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_009.html#link-152">0.1.0 (2016-02-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-125">ChangeLog</a>
|
||||
<ul><li><a href="chapter_009.html#link-126">unreleased</a></li>
|
||||
<li><a href="chapter_009.html#link-127">0.14.0 (2017-11-26)</a></li>
|
||||
<li><a href="chapter_009.html#link-128">0.14.0-beta (2017-10-08)</a></li>
|
||||
<li><a href="chapter_009.html#link-129">0.13.0 (2017-07-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-130">0.12.0 (2017-06-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-131">0.11.4 (2017-03-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-132">0.11.3 (2017-03-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-133">0.11.2 (2017-03-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-134">0.11.1 (2017-01-05)</a></li>
|
||||
<li><a href="chapter_009.html#link-135">0.11.0 (2016-12-31)</a></li>
|
||||
<li><a href="chapter_009.html#link-136">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href="chapter_009.html#link-137">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-138">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href="chapter_009.html#link-139">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-140">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href="chapter_009.html#link-141">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href="chapter_009.html#link-142">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href="chapter_009.html#link-143">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href="chapter_009.html#link-144">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href="chapter_009.html#link-145">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href="chapter_009.html#link-146">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href="chapter_009.html#link-147">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href="chapter_009.html#link-148">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href="chapter_009.html#link-149">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href="chapter_009.html#link-150">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-151">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-152">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href="chapter_009.html#link-153">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_010.html#link-153">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
<li><a href="chapter_010.html#link-154">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-367">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-367">Crowbook User Guide 0.14.1</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -209,7 +210,7 @@ function toggle() {
|
|||
</p>
|
||||
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-368">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.0</p>
|
||||
<footer id = "footer"><p id = "para-368">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.14.1</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
Loading…
Reference in New Issue