1
0
Fork 0
mirror of https://github.com/lise-henry/crowbook synced 2024-05-28 14:06:29 +02:00

Update docs dir

This commit is contained in:
Elisabeth Henry 2017-03-21 01:34:47 +01:00
parent 8a2d5be603
commit 4853a75530
15 changed files with 523 additions and 454 deletions

Binary file not shown.

View File

@ -94,10 +94,16 @@ h2.author {
width: 100%;
}
.image img {
.image {
margin: auto;
width: 80%;
}
.image img {
width: 100%;
max-height: 100%;
}
.rule {
text-align: center;
margin-top: 1em;
@ -544,7 +550,7 @@ function toggle() {
<h2><a href = "#link-0">Crowbook User Guide</a></h2>
</div>
<ul>
<li><a href = "#link-1">1. Crowbook</a>
<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>
@ -559,7 +565,7 @@ function toggle() {
</ul>
</li>
<li><a href = "#link-22">2. Arguments</a>
<li><a href = "#link-22">2\. Arguments</a>
<ul><li><a href = "#link-23">2.1. <code>--create</code></a></li>
<li><a href = "#link-25">2.2. <code>--single</code></a></li>
<li><a href = "#link-26">2.3. <code>--set</code></a></li>
@ -573,7 +579,7 @@ function toggle() {
</ul>
</li>
<li><a href = "#link-37">3. The configuration file</a>
<li><a href = "#link-37">3\. The configuration file</a>
<ul><li><a href = "#link-38">3.1. Configuration in an inline YAML block</a></li>
<li><a href = "#link-39">3.2. The list of files</a></li>
<li><a href = "#link-41">3.3. Crowbook options</a></li>
@ -581,14 +587,14 @@ function toggle() {
</ul>
</li>
<li><a href = "#link-71">4. Templates</a>
<li><a href = "#link-71">4\. Templates</a>
<ul><li><a href = "#link-72">4.1. Create and edit template</a></li>
<li><a href = "#link-76">4.2. List of templates</a></li>
<li><a href = "#link-90">4.3. List of accessible variables</a></li>
</ul>
</li>
<li><a href = "#link-94">5. Proofreading with Crowbook</a>
<li><a href = "#link-94">5\. Proofreading with Crowbook</a>
<ul><li><a href = "#link-95">5.1. Enabling proofreading</a></li>
<li><a href = "#link-96">5.2. Repetition detection</a></li>
<li><a href = "#link-97">5.3. Grammar checking</a></li>
@ -596,51 +602,52 @@ function toggle() {
</ul>
</li>
<li><a href = "#link-99">6. Tips and tricks</a>
<li><a href = "#link-99">6\. Tips and tricks</a>
<ul><li><a href = "#link-100">6.1. Using Crowbook with Emacs markdown mode</a></li>
<li><a href = "#link-103">6.2. Embedding fonts in an EPUB file</a></li>
</ul>
</li>
<li><a href = "#link-104">7. Contributing</a>
<li><a href = "#link-104">7\. Contributing</a>
<ul><li><a href = "#link-105">7.1. Internationalization</a></li>
</ul>
</li>
<li><a href = "#link-106">ChangeLog</a>
<ul><li><a href = "#link-107">unreleased</a></li>
<li><a href = "#link-108">0.11.2 (2017-03-05)</a></li>
<li><a href = "#link-109">0.11.1 (2017-01-05)</a></li>
<li><a href = "#link-110">0.11.0 (2016-12-31)</a></li>
<li><a href = "#link-111">0.10.4 (2016-12-16)</a></li>
<li><a href = "#link-112">0.10.3 (2016-11-19)</a></li>
<li><a href = "#link-113">0.10.2 (2016-10-21)</a></li>
<li><a href = "#link-114">0.10.1 (2016-10-18)</a></li>
<li><a href = "#link-115">0.10.0 (2016-10-18)</a></li>
<li><a href = "#link-116">0.9.1 (2016-09-29)</a></li>
<li><a href = "#link-117">0.9.0 (2016-09-23)</a></li>
<li><a href = "#link-118">0.8.0 (2016-09-19)</a></li>
<li><a href = "#link-119">0.7.0 (2016-09-11)</a></li>
<li><a href = "#link-120">0.6.0 (2016-09-09)</a></li>
<li><a href = "#link-121">0.5.1 (2016-04-14)</a></li>
<li><a href = "#link-122">0.5.0 (2016-04-02)</a></li>
<li><a href = "#link-123">0.4.0 (2016-03-01)</a></li>
<li><a href = "#link-124">0.3.0 (2016-02-27)</a></li>
<li><a href = "#link-125">0.2.2 (2016-02-25)</a></li>
<li><a href = "#link-126">0.2.1 (2016-02-25)</a></li>
<li><a href = "#link-127">0.2.0 (2016-02-25)</a></li>
<li><a href = "#link-128">0.1.0 (2016-02-21)</a></li>
<ul><li><a href = "#link-107">0.11.4 (2017-03-21)</a></li>
<li><a href = "#link-108">0.11.3 (2017-03-19)</a></li>
<li><a href = "#link-109">0.11.2 (2017-03-05)</a></li>
<li><a href = "#link-110">0.11.1 (2017-01-05)</a></li>
<li><a href = "#link-111">0.11.0 (2016-12-31)</a></li>
<li><a href = "#link-112">0.10.4 (2016-12-16)</a></li>
<li><a href = "#link-113">0.10.3 (2016-11-19)</a></li>
<li><a href = "#link-114">0.10.2 (2016-10-21)</a></li>
<li><a href = "#link-115">0.10.1 (2016-10-18)</a></li>
<li><a href = "#link-116">0.10.0 (2016-10-18)</a></li>
<li><a href = "#link-117">0.9.1 (2016-09-29)</a></li>
<li><a href = "#link-118">0.9.0 (2016-09-23)</a></li>
<li><a href = "#link-119">0.8.0 (2016-09-19)</a></li>
<li><a href = "#link-120">0.7.0 (2016-09-11)</a></li>
<li><a href = "#link-121">0.6.0 (2016-09-09)</a></li>
<li><a href = "#link-122">0.5.1 (2016-04-14)</a></li>
<li><a href = "#link-123">0.5.0 (2016-04-02)</a></li>
<li><a href = "#link-124">0.4.0 (2016-03-01)</a></li>
<li><a href = "#link-125">0.3.0 (2016-02-27)</a></li>
<li><a href = "#link-126">0.2.2 (2016-02-25)</a></li>
<li><a href = "#link-127">0.2.1 (2016-02-25)</a></li>
<li><a href = "#link-128">0.2.0 (2016-02-25)</a></li>
<li><a href = "#link-129">0.1.0 (2016-02-21)</a></li>
</ul>
</li>
<li><a href = "#link-129">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
<li><a href = "#link-130">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
</ul>
</nav>
<div id = "content">
<div id = "top"><p id = "para-296">Crowbook User Guide 0.11.2</p>
<div id = "top"><p id = "para-296">Crowbook User Guide 0.11.4</p>
</div>
<div id = "page">
<header>
@ -655,8 +662,8 @@ function toggle() {
</header>
<div id = "chapter-0" class = "chapter">
<h1 id = "link-1">1. Crowbook</h1>
<p id = "para-1"><a href = "https://travis-ci.org/lise-henry/crowbook"><img src = "https://travis-ci.org/lise-henry/crowbook.svg?branch=master" title = "" alt = "Build Status" /></a></p>
<h1 id = "link-1">1\. Crowbook</h1>
<p id = "para-1"><a href = "https://travis-ci.org/lise-henry/crowbook"><img src = "https://travis-ci.org/lise-henry/crowbook.svg?branch=master" title = "" alt = "Travis status" /></a> <a href = "https://ci.appveyor.com/project/lise-henry/crowbook"><img src = "https://ci.appveyor.com/api/projects/status/bnj1rg76khth0aia?svg=true" title = "" alt = "Appveyor status" /></a></p>
<p id = "para-2">Render a book written in markdown to HTML, EPUB and/or PDF.</p>
<p id = "para-3">Crowbooks purpose is to allow you to automatically generate multiple output formats from a book written in Markdown. Its focus is novels, and the default settings should (hopefully) generate readable books with correct typography without requiring you to worry about it.</p>
<h2 id = "link-2">1.1. Example</h2>
@ -769,7 +776,7 @@ function toggle() {
</blockquote>
</div><div id = "chapter-1" class = "chapter">
<h1 id = "link-22">2. Arguments</h1>
<h1 id = "link-22">2\. Arguments</h1>
<p id = "para-44">Crowbook can take a number of arguments:</p>
<pre><span style="color:#839496;">Render a Markdown book in EPUB, PDF or HTML.
@ -897,7 +904,7 @@ $ crowbook my.book --</span><span style="color:#859900;">set</span><span style="
</blockquote>
</div><div id = "chapter-2" class = "chapter">
<h1 id = "link-37">3. The configuration file</h1>
<h1 id = "link-37">3\. The configuration file</h1>
<p id = "para-90">If you want to use Crowbook for your book, this configuration file is all youll have to add (assuming you already have the book in Markdown files; if you dont, youll also have to write a book first, but thats besides the scope of this document).</p>
<p id = "para-91">The format is not very complicated. This is an example of it:</p>
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> metadata
@ -1645,12 +1652,6 @@ lang: en
<li>Command to use to zip files (for EPUB/ODT)</li>
</ul>
</li>
<li><b><code>crowbook.verbose</code></b><ul>
<li><b>type</b>: boolean</li>
<li><b>default value</b>: <code>false</code></li>
<li>Make Crowbook display more messages</li>
</ul>
</li>
</ul>
<h3 id = "link-69">Output options (for proofreading)</h3>
<ul>
@ -1733,7 +1734,7 @@ lang: en
<p id = "para-153">Note that these options have a type, which in most case should be pretty straightforward (a boolean can be <code>true</code> or <code>false</code>, an integer must be composed by a number, a string is, well, any string). The <code>path</code> type might puzzle you a bit, but its equivalent to a string, except Crowbook will consider it relatively to the book file. The <code>template path</code> type is just the <code>path</code> of a template. Metadata are just strings.</p>
</div><div id = "chapter-3" class = "chapter">
<h1 id = "link-71">4. Templates</h1>
<h1 id = "link-71">4\. Templates</h1>
<p id = "para-155">Crowbook allows the user to specify a number of templates.<a href = "#note-dest-1"><sup id = "note-source-1">[1]</sup></a></p>
<p id = "para-156">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;">
@ -1831,7 +1832,7 @@ Foo does not exist
<li><code>date</code>;</li>
<li>any option <code>metadata.foo</code> defined in the book configuration file will also be exported as <code>metadata_foo</code>.</li>
</ul>
<p id = "para-190">These metadata can contain Markdown, which will be rendered. E.g., setting <code>date: “20th of **september**”</code> will render <code>september</code> in bold, using <code>&lt;b&gt;</code> tag for HTML or <code>\textbf</code> for LaTeX. (It might be a bad idea to insert Markdown into <code>author</code> or <code>title</code> fields, and it certainly is for <code>lang</code>, but it can be useful for custom metadata or for fields like <code>description</code>).</p>
<p id = "para-190">These metadata can contain Markdown, which will be rendered. E.g., setting <code>date: “20th of **september**”</code> will render <code>september</code> in bold, using <code>&lt;b&gt;</code> tag for HTML or <code>\textbf</code> for LaTeX. If you need to use these data in places that dont support formatted text (e.g. in meta tags), you can use the raw content by accessing <code>xxx_raw</code> instead (e.g., <code>author_raw</code>, <code>title_raw</code>, ...). (Note that the content of the raw metadata is <em>not</em> HTML-escaped, so in this case you might want to use <code>{{xxx_raw}}</code> instead of <code>{{{xxx_raw}}}</code>.)</p>
<p id = "para-191">For each metadata <code>foo</code> that is set, Crowbook also inserts a <code>has_foo</code> bool set to true. This allows to use Mustaches section for some logic, e.g.:</p>
<pre><span style="color:#839496;">{{{title}}}
{{#has_version}}, version {{{version}}}{{/has_version}}
@ -1845,8 +1846,16 @@ Foo does not exist
<tr>
<td> <code>loc_toc</code> </td><td> Table of contents </td></tr>
<tr>
<td> <code>loc_cover</code> </td><td> Cover </td></tr>
<tr>
<td> <code>loc_title</code> </td><td> Title </td></tr>
<tr>
<td> <code>loc_chapter</code> </td><td> Chapter </td></tr>
<tr>
<td> <code>loc_part</code> </td><td> Part </td></tr>
<tr>
<td> <code>loc_notes</code> </td><td> Notes </td></tr>
<tr>
<td> <code>loc_display_all</code> </td><td> Display all chapters </td></tr>
<tr>
<td> <code>loc_display_one</code> </td><td> Display one chapter </td></tr>
@ -1880,6 +1889,8 @@ Foo does not exist
<tr>
<td> <code>chapter_title</code> </td><td> The title of current chapter </td><td> <code>html.dir.template</code>, <code>epub.chapter.xhtml</code>, <code>rendering.chapter.template</code> </td></tr>
<tr>
<td> <code>chapter_title_raw</code> </td><td> The title of current chapter (raw text without HTML formatting) </td><td> <code>html.dir.template</code>, <code>epub.chapter.xhtml</code>, <code>rendering.chapter.template</code> </td></tr>
<tr>
<td> <code>highlight_code</code> </td><td> True if <code>html.highlight_code</code> is true </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code> </td></tr>
<tr>
<td> <code>highlight_css</code> </td><td> The content of <code>html.highlight.css</code> </td><td> <code>html.standalone.template</code> </td></tr>
@ -1922,7 +1933,7 @@ Foo does not exist
</div>
</div><div id = "chapter-4" class = "chapter">
<h1 id = "link-94">5. Proofreading with Crowbook</h1>
<h1 id = "link-94">5\. Proofreading with Crowbook</h1>
<p id = "para-195">Since version 0.9.1, Crowbook includes some proofreading features, that can be enabled if you set one of the</p>
<ul>
<li><code>output.proofread.html</code></li>
@ -1984,7 +1995,7 @@ proofread.languagetool.port: 8081
<p id = "para-212">The last proofreading feature is a bit less important, but it can be useful in some cases. It is is dis/activated by setting <code>proofread.nb_spaces</code> to “true” or “false”, and it will highlight different sort of non-breaking spaces in HTML proofreading output files. This can be useful in some cases, but it is mostly a debugging feature to check that the french cleaner of Crowbook correctly replaces spaces with correct non-breaking spaces in the relevant places.</p>
</div><div id = "chapter-5" class = "chapter">
<h1 id = "link-99">6. Tips and tricks</h1>
<h1 id = "link-99">6\. Tips and tricks</h1>
<h2 id = "link-100">6.1. Using Crowbook with Emacs markdown mode</h2>
<p id = "para-213">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-214">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>
@ -2025,7 +2036,7 @@ title: Some title
</span></pre><p id = "para-222">(Note that youll have to repeat the process 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-6" class = "chapter">
<h1 id = "link-104">7. Contributing</h1>
<h1 id = "link-104">7\. Contributing</h1>
<p id = "para-223">Crowbook is a free software, and you can contribute to it. There are some things that can be accessible even if you dont know anything about programming.</p>
<h2 id = "link-105">7.1. Internationalization</h2>
<p id = "para-224">Crowbook aims to support multiple languages. However, unfortunately, currently only english, french, and (in a more limited way) spanish are currently supported. If you want to have better support for the language you write in, there are easy things you can do:</p>
@ -2037,11 +2048,30 @@ title: Some title
</div><div id = "chapter-7" class = "chapter">
<h1 id = "link-106">ChangeLog</h1>
<h2 id = "link-107">unreleased</h2>
<h2 id = "link-107">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>
<li>HTML/EPUB: use raw (not HTML rendered) metadata in the places where HTML code is not appropriate. Templates can use this metadata with the <code>foo_raw</code> value.</li>
<li>HTML/EPUB: fix double-escaping/rendering issues in titles.</li>
<li>EPUB:<ul>
<li>Escape title and author before feeding them to epub-builder.</li>
<li>Fix content.opf issue by not rendering first chapters title (marked as beginning of document) in <code>&lt;guide&gt;</code>.</li>
</ul>
</li>
</ul>
</li>
<li>Rendering:<ul>
<li>HTML/EPUB: standalone images are now displayed centered.</li>
</ul>
</li>
</ul>
<h2 id = "link-108">0.11.3 (2017-03-19)</h2>
<ul>
<li>When crowbook parses the books 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>
<li>The LaTeX and HTML/EPUB renderers only initialize <code>syntect</code> (which can take some time) if code blocks are used in the document.</li>
<li>The LaTeX renderer only requires LaTeX packages that are actually used in the document.</li>
</ul>
</li>
<li>Command-line interface:<ul>
@ -2055,7 +2085,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-108">0.11.2 (2017-03-05)</h2>
<h2 id = "link-109">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>
@ -2091,7 +2121,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-109">0.11.1 (2017-01-05)</h2>
<h2 id = "link-110">0.11.1 (2017-01-05)</h2>
<ul>
<li>Rendering:<ul>
<li>Avoid page break before or after a separating rule.</li>
@ -2123,7 +2153,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-110">0.11.0 (2016-12-31)</h2>
<h2 id = "link-111">0.11.0 (2016-12-31)</h2>
<p id = "para-225">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>
@ -2187,7 +2217,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-111">0.10.4 (2016-12-16)</h2>
<h2 id = "link-112">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>
@ -2209,7 +2239,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-112">0.10.3 (2016-11-19)</h2>
<h2 id = "link-113">0.10.3 (2016-11-19)</h2>
<ul>
<li>Building:<ul>
<li>Crowbook now requires rustc &gt;= 1.13.0 to build.</li>
@ -2230,7 +2260,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-113">0.10.2 (2016-10-21)</h2>
<h2 id = "link-114">0.10.2 (2016-10-21)</h2>
<p id = "para-226">Only minor changes in this version:</p>
<ul>
<li>Options:<ul>
@ -2246,9 +2276,9 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-114">0.10.1 (2016-10-18)</h2>
<h2 id = "link-115">0.10.1 (2016-10-18)</h2>
<p id = "para-227">Fixed a bug in <code>fr.po</code> translation that prevented building from fresh install.</p>
<h2 id = "link-115">0.10.0 (2016-10-18)</h2>
<h2 id = "link-116">0.10.0 (2016-10-18)</h2>
<p id = "para-228">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>
@ -2285,7 +2315,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-116">0.9.1 (2016-09-29)</h2>
<h2 id = "link-117">0.9.1 (2016-09-29)</h2>
<p id = "para-229">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>
@ -2316,7 +2346,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-117">0.9.0 (2016-09-23)</h2>
<h2 id = "link-118">0.9.0 (2016-09-23)</h2>
<p id = "para-230">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 Crowbooks library API;</li>
@ -2381,7 +2411,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-118">0.8.0 (2016-09-19)</h2>
<h2 id = "link-119">0.8.0 (2016-09-19)</h2>
<p id = "para-231">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>
@ -2421,7 +2451,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-119">0.7.0 (2016-09-11)</h2>
<h2 id = "link-120">0.7.0 (2016-09-11)</h2>
<p id = "para-232">This releases renders images differently when they are on a standalone paragraph or inside a paragraph.</p>
<ul>
<li>Internal/API:<ul>
@ -2435,7 +2465,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-120">0.6.0 (2016-09-09)</h2>
<h2 id = "link-121">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 its better to use different non breaking spaces according to context, this option was not really useful anymore.</li>
@ -2462,7 +2492,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-121">0.5.1 (2016-04-14)</h2>
<h2 id = "link-122">0.5.1 (2016-04-14)</h2>
<p id = "para-233">Mostly rendering fixes:</p>
<ul>
<li>Epub:<ul>
@ -2488,7 +2518,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-122">0.5.0 (2016-04-02)</h2>
<h2 id = "link-123">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>
@ -2527,7 +2557,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-123">0.4.0 (2016-03-01)</h2>
<h2 id = "link-124">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” Crowbookss 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 wasnt possible until then and might be useful in some cases.</li>
@ -2547,7 +2577,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-124">0.3.0 (2016-02-27)</h2>
<h2 id = "link-125">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>
@ -2565,14 +2595,14 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-125">0.2.2 (2016-02-25)</h2>
<h2 id = "link-126">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-126">0.2.1 (2016-02-25)</h2>
<h2 id = "link-127">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>
@ -2584,7 +2614,7 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-127">0.2.0 (2016-02-25)</h2>
<h2 id = "link-128">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>
@ -2609,13 +2639,13 @@ title: Some title
</ul>
</li>
</ul>
<h2 id = "link-128">0.1.0 (2016-02-21)</h2>
<h2 id = "link-129">0.1.0 (2016-02-21)</h2>
<ul>
<li>initial release</li>
</ul>
</div><div id = "chapter-8" class = "chapter">
<h1 id = "link-129">GNU LESSER GENERAL PUBLIC LICENSE</h1>
<h1 id = "link-130">GNU LESSER GENERAL PUBLIC LICENSE</h1>
<pre><span style="color:#839496;"> Version 2.1, February 1999
</span></pre><p id = "para-234">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-235">[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>
@ -2848,7 +2878,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
</div>
<footer id = "footer"><p id = "para-295">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.3-pre</p>
<footer id = "footer"><p id = "para-295">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.4</p>
</footer>
</div>
</body>

Binary file not shown.

Binary file not shown.

View File

@ -6,7 +6,7 @@
<meta name="author" content="Élisabeth Henry">
<meta name="viewport" content="width=device-width">
<link rel = "icon" href = "images/image_0.svg">
<title>Crowbook User Guide 1. Crowbook</title>
<title>Crowbook User Guide - 1\. Crowbook</title>
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
/>
<link rel = "stylesheet" href = "print.css" type = "text/css"
@ -63,7 +63,7 @@ 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>
<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>
@ -78,7 +78,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_001.html#link-22">2. Arguments</a>
<li><a href = "chapter_001.html#link-22">2\. Arguments</a>
<ul><li><a href = "chapter_001.html#link-23">2.1. <code>--create</code></a></li>
<li><a href = "chapter_001.html#link-25">2.2. <code>--single</code></a></li>
<li><a href = "chapter_001.html#link-26">2.3. <code>--set</code></a></li>
@ -92,7 +92,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_002.html#link-37">3. The configuration file</a>
<li><a href = "chapter_002.html#link-37">3\. The configuration file</a>
<ul><li><a href = "chapter_002.html#link-38">3.1. Configuration in an inline YAML block</a></li>
<li><a href = "chapter_002.html#link-39">3.2. The list of files</a></li>
<li><a href = "chapter_002.html#link-41">3.3. Crowbook options</a></li>
@ -100,14 +100,14 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_003.html#link-71">4. Templates</a>
<li><a href = "chapter_003.html#link-71">4\. Templates</a>
<ul><li><a href = "chapter_003.html#link-72">4.1. Create and edit template</a></li>
<li><a href = "chapter_003.html#link-76">4.2. List of templates</a></li>
<li><a href = "chapter_003.html#link-90">4.3. List of accessible variables</a></li>
</ul>
</li>
<li><a href = "chapter_004.html#link-94">5. Proofreading with Crowbook</a>
<li><a href = "chapter_004.html#link-94">5\. Proofreading with Crowbook</a>
<ul><li><a href = "chapter_004.html#link-95">5.1. Enabling proofreading</a></li>
<li><a href = "chapter_004.html#link-96">5.2. Repetition detection</a></li>
<li><a href = "chapter_004.html#link-97">5.3. Grammar checking</a></li>
@ -115,51 +115,52 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_005.html#link-99">6. Tips and tricks</a>
<li><a href = "chapter_005.html#link-99">6\. Tips and tricks</a>
<ul><li><a href = "chapter_005.html#link-100">6.1. Using Crowbook with Emacs markdown mode</a></li>
<li><a href = "chapter_005.html#link-103">6.2. Embedding fonts in an EPUB file</a></li>
</ul>
</li>
<li><a href = "chapter_006.html#link-104">7. Contributing</a>
<li><a href = "chapter_006.html#link-104">7\. Contributing</a>
<ul><li><a href = "chapter_006.html#link-105">7.1. Internationalization</a></li>
</ul>
</li>
<li><a href = "chapter_007.html#link-106">ChangeLog</a>
<ul><li><a href = "chapter_007.html#link-107">unreleased</a></li>
<li><a href = "chapter_007.html#link-108">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-111">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-118">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-119">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-120">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-121">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-123">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-124">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-125">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.1.0 (2016-02-21)</a></li>
<ul><li><a href = "chapter_007.html#link-107">0.11.4 (2017-03-21)</a></li>
<li><a href = "chapter_007.html#link-108">0.11.3 (2017-03-19)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-111">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-118">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-119">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-120">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-121">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-123">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-124">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-125">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-129">0.1.0 (2016-02-21)</a></li>
</ul>
</li>
<li><a href = "chapter_008.html#link-129">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
<li><a href = "chapter_008.html#link-130">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
</ul>
</nav>
<div id = "content">
<div id = "top"><p id = "para-296">Crowbook User Guide 0.11.2</p>
<div id = "top"><p id = "para-296">Crowbook User Guide 0.11.4</p>
</div>
<div id = "page">
<header>
@ -169,8 +170,8 @@ function toggle() {
</div>
</header>
<h1 id = "link-1">1. Crowbook</h1>
<p id = "para-1"><a href = "https://travis-ci.org/lise-henry/crowbook"><img src = "https://travis-ci.org/lise-henry/crowbook.svg?branch=master" title = "" alt = "Build Status" /></a></p>
<h1 id = "link-1">1\. Crowbook</h1>
<p id = "para-1"><a href = "https://travis-ci.org/lise-henry/crowbook"><img src = "https://travis-ci.org/lise-henry/crowbook.svg?branch=master" title = "" alt = "Travis status" /></a> <a href = "https://ci.appveyor.com/project/lise-henry/crowbook"><img src = "https://ci.appveyor.com/api/projects/status/bnj1rg76khth0aia?svg=true" title = "" alt = "Appveyor status" /></a></p>
<p id = "para-2">Render a book written in markdown to HTML, EPUB and/or PDF.</p>
<p id = "para-3">Crowbooks purpose is to allow you to automatically generate multiple output formats from a book written in Markdown. Its focus is novels, and the default settings should (hopefully) generate readable books with correct typography without requiring you to worry about it.</p>
<h2 id = "link-2">1.1. Example</h2>
@ -284,11 +285,11 @@ function toggle() {
<p class = "next_chapter">
<a href = "chapter_001.html">
2. Arguments »
2\. Arguments »
</a>
</p>
</div>
<footer id = "footer"><p id = "para-295">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.3-pre</p>
<footer id = "footer"><p id = "para-295">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.4</p>
</footer>
</div>
</body>

View File

@ -6,7 +6,7 @@
<meta name="author" content="Élisabeth Henry">
<meta name="viewport" content="width=device-width">
<link rel = "icon" href = "images/image_0.svg">
<title>Crowbook User Guide 2. Arguments</title>
<title>Crowbook User Guide - 2\. Arguments</title>
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
/>
<link rel = "stylesheet" href = "print.css" type = "text/css"
@ -63,7 +63,7 @@ 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>
<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>
@ -78,7 +78,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_001.html#link-22">2. Arguments</a>
<li><a href = "chapter_001.html#link-22">2\. Arguments</a>
<ul><li><a href = "chapter_001.html#link-23">2.1. <code>--create</code></a></li>
<li><a href = "chapter_001.html#link-25">2.2. <code>--single</code></a></li>
<li><a href = "chapter_001.html#link-26">2.3. <code>--set</code></a></li>
@ -92,7 +92,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_002.html#link-37">3. The configuration file</a>
<li><a href = "chapter_002.html#link-37">3\. The configuration file</a>
<ul><li><a href = "chapter_002.html#link-38">3.1. Configuration in an inline YAML block</a></li>
<li><a href = "chapter_002.html#link-39">3.2. The list of files</a></li>
<li><a href = "chapter_002.html#link-41">3.3. Crowbook options</a></li>
@ -100,14 +100,14 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_003.html#link-71">4. Templates</a>
<li><a href = "chapter_003.html#link-71">4\. Templates</a>
<ul><li><a href = "chapter_003.html#link-72">4.1. Create and edit template</a></li>
<li><a href = "chapter_003.html#link-76">4.2. List of templates</a></li>
<li><a href = "chapter_003.html#link-90">4.3. List of accessible variables</a></li>
</ul>
</li>
<li><a href = "chapter_004.html#link-94">5. Proofreading with Crowbook</a>
<li><a href = "chapter_004.html#link-94">5\. Proofreading with Crowbook</a>
<ul><li><a href = "chapter_004.html#link-95">5.1. Enabling proofreading</a></li>
<li><a href = "chapter_004.html#link-96">5.2. Repetition detection</a></li>
<li><a href = "chapter_004.html#link-97">5.3. Grammar checking</a></li>
@ -115,51 +115,52 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_005.html#link-99">6. Tips and tricks</a>
<li><a href = "chapter_005.html#link-99">6\. Tips and tricks</a>
<ul><li><a href = "chapter_005.html#link-100">6.1. Using Crowbook with Emacs markdown mode</a></li>
<li><a href = "chapter_005.html#link-103">6.2. Embedding fonts in an EPUB file</a></li>
</ul>
</li>
<li><a href = "chapter_006.html#link-104">7. Contributing</a>
<li><a href = "chapter_006.html#link-104">7\. Contributing</a>
<ul><li><a href = "chapter_006.html#link-105">7.1. Internationalization</a></li>
</ul>
</li>
<li><a href = "chapter_007.html#link-106">ChangeLog</a>
<ul><li><a href = "chapter_007.html#link-107">unreleased</a></li>
<li><a href = "chapter_007.html#link-108">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-111">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-118">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-119">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-120">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-121">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-123">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-124">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-125">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.1.0 (2016-02-21)</a></li>
<ul><li><a href = "chapter_007.html#link-107">0.11.4 (2017-03-21)</a></li>
<li><a href = "chapter_007.html#link-108">0.11.3 (2017-03-19)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-111">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-118">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-119">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-120">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-121">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-123">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-124">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-125">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-129">0.1.0 (2016-02-21)</a></li>
</ul>
</li>
<li><a href = "chapter_008.html#link-129">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
<li><a href = "chapter_008.html#link-130">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
</ul>
</nav>
<div id = "content">
<div id = "top"><p id = "para-298">Crowbook User Guide 0.11.2</p>
<div id = "top"><p id = "para-298">Crowbook User Guide 0.11.4</p>
</div>
<div id = "page">
<header>
@ -170,10 +171,10 @@ function toggle() {
</header>
<p class = "prev_chapter">
<a href = "chapter_000.html">
« 1. Crowbook
« 1\. Crowbook
</a>
</p>
<h1 id = "link-22">2. Arguments</h1>
<h1 id = "link-22">2\. Arguments</h1>
<p id = "para-44">Crowbook can take a number of arguments:</p>
<pre><span style="color:#839496;">Render a Markdown book in EPUB, PDF or HTML.
@ -302,11 +303,11 @@ $ crowbook my.book --</span><span style="color:#859900;">set</span><span style="
<p class = "next_chapter">
<a href = "chapter_002.html">
3. The configuration file »
3\. The configuration file »
</a>
</p>
</div>
<footer id = "footer"><p id = "para-297">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.3-pre</p>
<footer id = "footer"><p id = "para-297">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.4</p>
</footer>
</div>
</body>

View File

@ -6,7 +6,7 @@
<meta name="author" content="Élisabeth Henry">
<meta name="viewport" content="width=device-width">
<link rel = "icon" href = "images/image_0.svg">
<title>Crowbook User Guide 3. The configuration file</title>
<title>Crowbook User Guide - 3\. The configuration file</title>
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
/>
<link rel = "stylesheet" href = "print.css" type = "text/css"
@ -63,7 +63,7 @@ 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>
<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>
@ -78,7 +78,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_001.html#link-22">2. Arguments</a>
<li><a href = "chapter_001.html#link-22">2\. Arguments</a>
<ul><li><a href = "chapter_001.html#link-23">2.1. <code>--create</code></a></li>
<li><a href = "chapter_001.html#link-25">2.2. <code>--single</code></a></li>
<li><a href = "chapter_001.html#link-26">2.3. <code>--set</code></a></li>
@ -92,7 +92,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_002.html#link-37">3. The configuration file</a>
<li><a href = "chapter_002.html#link-37">3\. The configuration file</a>
<ul><li><a href = "chapter_002.html#link-38">3.1. Configuration in an inline YAML block</a></li>
<li><a href = "chapter_002.html#link-39">3.2. The list of files</a></li>
<li><a href = "chapter_002.html#link-41">3.3. Crowbook options</a></li>
@ -100,14 +100,14 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_003.html#link-71">4. Templates</a>
<li><a href = "chapter_003.html#link-71">4\. Templates</a>
<ul><li><a href = "chapter_003.html#link-72">4.1. Create and edit template</a></li>
<li><a href = "chapter_003.html#link-76">4.2. List of templates</a></li>
<li><a href = "chapter_003.html#link-90">4.3. List of accessible variables</a></li>
</ul>
</li>
<li><a href = "chapter_004.html#link-94">5. Proofreading with Crowbook</a>
<li><a href = "chapter_004.html#link-94">5\. Proofreading with Crowbook</a>
<ul><li><a href = "chapter_004.html#link-95">5.1. Enabling proofreading</a></li>
<li><a href = "chapter_004.html#link-96">5.2. Repetition detection</a></li>
<li><a href = "chapter_004.html#link-97">5.3. Grammar checking</a></li>
@ -115,51 +115,52 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_005.html#link-99">6. Tips and tricks</a>
<li><a href = "chapter_005.html#link-99">6\. Tips and tricks</a>
<ul><li><a href = "chapter_005.html#link-100">6.1. Using Crowbook with Emacs markdown mode</a></li>
<li><a href = "chapter_005.html#link-103">6.2. Embedding fonts in an EPUB file</a></li>
</ul>
</li>
<li><a href = "chapter_006.html#link-104">7. Contributing</a>
<li><a href = "chapter_006.html#link-104">7\. Contributing</a>
<ul><li><a href = "chapter_006.html#link-105">7.1. Internationalization</a></li>
</ul>
</li>
<li><a href = "chapter_007.html#link-106">ChangeLog</a>
<ul><li><a href = "chapter_007.html#link-107">unreleased</a></li>
<li><a href = "chapter_007.html#link-108">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-111">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-118">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-119">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-120">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-121">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-123">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-124">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-125">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.1.0 (2016-02-21)</a></li>
<ul><li><a href = "chapter_007.html#link-107">0.11.4 (2017-03-21)</a></li>
<li><a href = "chapter_007.html#link-108">0.11.3 (2017-03-19)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-111">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-118">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-119">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-120">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-121">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-123">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-124">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-125">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-129">0.1.0 (2016-02-21)</a></li>
</ul>
</li>
<li><a href = "chapter_008.html#link-129">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
<li><a href = "chapter_008.html#link-130">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
</ul>
</nav>
<div id = "content">
<div id = "top"><p id = "para-300">Crowbook User Guide 0.11.2</p>
<div id = "top"><p id = "para-300">Crowbook User Guide 0.11.4</p>
</div>
<div id = "page">
<header>
@ -170,10 +171,10 @@ function toggle() {
</header>
<p class = "prev_chapter">
<a href = "chapter_001.html">
« 2. Arguments
« 2\. Arguments
</a>
</p>
<h1 id = "link-37">3. The configuration file</h1>
<h1 id = "link-37">3\. The configuration file</h1>
<p id = "para-90">If you want to use Crowbook for your book, this configuration file is all youll have to add (assuming you already have the book in Markdown files; if you dont, youll also have to write a book first, but thats besides the scope of this document).</p>
<p id = "para-91">The format is not very complicated. This is an example of it:</p>
<pre><span style="color:#586e75;">#</span><span style="color:#586e75;"> metadata
@ -921,12 +922,6 @@ lang: en
<li>Command to use to zip files (for EPUB/ODT)</li>
</ul>
</li>
<li><b><code>crowbook.verbose</code></b><ul>
<li><b>type</b>: boolean</li>
<li><b>default value</b>: <code>false</code></li>
<li>Make Crowbook display more messages</li>
</ul>
</li>
</ul>
<h3 id = "link-69">Output options (for proofreading)</h3>
<ul>
@ -1010,11 +1005,11 @@ lang: en
<p class = "next_chapter">
<a href = "chapter_003.html">
4. Templates »
4\. Templates »
</a>
</p>
</div>
<footer id = "footer"><p id = "para-299">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.3-pre</p>
<footer id = "footer"><p id = "para-299">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.4</p>
</footer>
</div>
</body>

View File

@ -6,7 +6,7 @@
<meta name="author" content="Élisabeth Henry">
<meta name="viewport" content="width=device-width">
<link rel = "icon" href = "images/image_0.svg">
<title>Crowbook User Guide 4. Templates</title>
<title>Crowbook User Guide - 4\. Templates</title>
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
/>
<link rel = "stylesheet" href = "print.css" type = "text/css"
@ -63,7 +63,7 @@ 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>
<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>
@ -78,7 +78,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_001.html#link-22">2. Arguments</a>
<li><a href = "chapter_001.html#link-22">2\. Arguments</a>
<ul><li><a href = "chapter_001.html#link-23">2.1. <code>--create</code></a></li>
<li><a href = "chapter_001.html#link-25">2.2. <code>--single</code></a></li>
<li><a href = "chapter_001.html#link-26">2.3. <code>--set</code></a></li>
@ -92,7 +92,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_002.html#link-37">3. The configuration file</a>
<li><a href = "chapter_002.html#link-37">3\. The configuration file</a>
<ul><li><a href = "chapter_002.html#link-38">3.1. Configuration in an inline YAML block</a></li>
<li><a href = "chapter_002.html#link-39">3.2. The list of files</a></li>
<li><a href = "chapter_002.html#link-41">3.3. Crowbook options</a></li>
@ -100,14 +100,14 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_003.html#link-71">4. Templates</a>
<li><a href = "chapter_003.html#link-71">4\. Templates</a>
<ul><li><a href = "chapter_003.html#link-72">4.1. Create and edit template</a></li>
<li><a href = "chapter_003.html#link-76">4.2. List of templates</a></li>
<li><a href = "chapter_003.html#link-90">4.3. List of accessible variables</a></li>
</ul>
</li>
<li><a href = "chapter_004.html#link-94">5. Proofreading with Crowbook</a>
<li><a href = "chapter_004.html#link-94">5\. Proofreading with Crowbook</a>
<ul><li><a href = "chapter_004.html#link-95">5.1. Enabling proofreading</a></li>
<li><a href = "chapter_004.html#link-96">5.2. Repetition detection</a></li>
<li><a href = "chapter_004.html#link-97">5.3. Grammar checking</a></li>
@ -115,51 +115,52 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_005.html#link-99">6. Tips and tricks</a>
<li><a href = "chapter_005.html#link-99">6\. Tips and tricks</a>
<ul><li><a href = "chapter_005.html#link-100">6.1. Using Crowbook with Emacs markdown mode</a></li>
<li><a href = "chapter_005.html#link-103">6.2. Embedding fonts in an EPUB file</a></li>
</ul>
</li>
<li><a href = "chapter_006.html#link-104">7. Contributing</a>
<li><a href = "chapter_006.html#link-104">7\. Contributing</a>
<ul><li><a href = "chapter_006.html#link-105">7.1. Internationalization</a></li>
</ul>
</li>
<li><a href = "chapter_007.html#link-106">ChangeLog</a>
<ul><li><a href = "chapter_007.html#link-107">unreleased</a></li>
<li><a href = "chapter_007.html#link-108">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-111">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-118">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-119">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-120">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-121">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-123">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-124">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-125">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.1.0 (2016-02-21)</a></li>
<ul><li><a href = "chapter_007.html#link-107">0.11.4 (2017-03-21)</a></li>
<li><a href = "chapter_007.html#link-108">0.11.3 (2017-03-19)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-111">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-118">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-119">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-120">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-121">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-123">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-124">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-125">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-129">0.1.0 (2016-02-21)</a></li>
</ul>
</li>
<li><a href = "chapter_008.html#link-129">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
<li><a href = "chapter_008.html#link-130">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
</ul>
</nav>
<div id = "content">
<div id = "top"><p id = "para-302">Crowbook User Guide 0.11.2</p>
<div id = "top"><p id = "para-302">Crowbook User Guide 0.11.4</p>
</div>
<div id = "page">
<header>
@ -170,10 +171,10 @@ function toggle() {
</header>
<p class = "prev_chapter">
<a href = "chapter_002.html">
« 3. The configuration file
« 3\. The configuration file
</a>
</p>
<h1 id = "link-71">4. Templates</h1>
<h1 id = "link-71">4\. Templates</h1>
<p id = "para-155">Crowbook allows the user to specify a number of templates.<a href = "#note-dest-1"><sup id = "note-source-1">[1]</sup></a></p>
<p id = "para-156">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;">
@ -271,7 +272,7 @@ Foo does not exist
<li><code>date</code>;</li>
<li>any option <code>metadata.foo</code> defined in the book configuration file will also be exported as <code>metadata_foo</code>.</li>
</ul>
<p id = "para-190">These metadata can contain Markdown, which will be rendered. E.g., setting <code>date: “20th of **september**”</code> will render <code>september</code> in bold, using <code>&lt;b&gt;</code> tag for HTML or <code>\textbf</code> for LaTeX. (It might be a bad idea to insert Markdown into <code>author</code> or <code>title</code> fields, and it certainly is for <code>lang</code>, but it can be useful for custom metadata or for fields like <code>description</code>).</p>
<p id = "para-190">These metadata can contain Markdown, which will be rendered. E.g., setting <code>date: “20th of **september**”</code> will render <code>september</code> in bold, using <code>&lt;b&gt;</code> tag for HTML or <code>\textbf</code> for LaTeX. If you need to use these data in places that dont support formatted text (e.g. in meta tags), you can use the raw content by accessing <code>xxx_raw</code> instead (e.g., <code>author_raw</code>, <code>title_raw</code>, ...). (Note that the content of the raw metadata is <em>not</em> HTML-escaped, so in this case you might want to use <code>{{xxx_raw}}</code> instead of <code>{{{xxx_raw}}}</code>.)</p>
<p id = "para-191">For each metadata <code>foo</code> that is set, Crowbook also inserts a <code>has_foo</code> bool set to true. This allows to use Mustaches section for some logic, e.g.:</p>
<pre><span style="color:#839496;">{{{title}}}
{{#has_version}}, version {{{version}}}{{/has_version}}
@ -285,8 +286,16 @@ Foo does not exist
<tr>
<td> <code>loc_toc</code> </td><td> Table of contents </td></tr>
<tr>
<td> <code>loc_cover</code> </td><td> Cover </td></tr>
<tr>
<td> <code>loc_title</code> </td><td> Title </td></tr>
<tr>
<td> <code>loc_chapter</code> </td><td> Chapter </td></tr>
<tr>
<td> <code>loc_part</code> </td><td> Part </td></tr>
<tr>
<td> <code>loc_notes</code> </td><td> Notes </td></tr>
<tr>
<td> <code>loc_display_all</code> </td><td> Display all chapters </td></tr>
<tr>
<td> <code>loc_display_one</code> </td><td> Display one chapter </td></tr>
@ -320,6 +329,8 @@ Foo does not exist
<tr>
<td> <code>chapter_title</code> </td><td> The title of current chapter </td><td> <code>html.dir.template</code>, <code>epub.chapter.xhtml</code>, <code>rendering.chapter.template</code> </td></tr>
<tr>
<td> <code>chapter_title_raw</code> </td><td> The title of current chapter (raw text without HTML formatting) </td><td> <code>html.dir.template</code>, <code>epub.chapter.xhtml</code>, <code>rendering.chapter.template</code> </td></tr>
<tr>
<td> <code>highlight_code</code> </td><td> True if <code>html.highlight_code</code> is true </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code> </td></tr>
<tr>
<td> <code>highlight_css</code> </td><td> The content of <code>html.highlight.css</code> </td><td> <code>html.standalone.template</code> </td></tr>
@ -408,11 +419,11 @@ Foo does not exist
<p class = "next_chapter">
<a href = "chapter_004.html">
5. Proofreading with Crowbook »
5\. Proofreading with Crowbook »
</a>
</p>
</div>
<footer id = "footer"><p id = "para-301">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.3-pre</p>
<footer id = "footer"><p id = "para-301">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.4</p>
</footer>
</div>
</body>

View File

@ -6,7 +6,7 @@
<meta name="author" content="Élisabeth Henry">
<meta name="viewport" content="width=device-width">
<link rel = "icon" href = "images/image_0.svg">
<title>Crowbook User Guide 5. Proofreading with Crowbook</title>
<title>Crowbook User Guide - 5\. Proofreading with Crowbook</title>
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
/>
<link rel = "stylesheet" href = "print.css" type = "text/css"
@ -63,7 +63,7 @@ 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>
<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>
@ -78,7 +78,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_001.html#link-22">2. Arguments</a>
<li><a href = "chapter_001.html#link-22">2\. Arguments</a>
<ul><li><a href = "chapter_001.html#link-23">2.1. <code>--create</code></a></li>
<li><a href = "chapter_001.html#link-25">2.2. <code>--single</code></a></li>
<li><a href = "chapter_001.html#link-26">2.3. <code>--set</code></a></li>
@ -92,7 +92,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_002.html#link-37">3. The configuration file</a>
<li><a href = "chapter_002.html#link-37">3\. The configuration file</a>
<ul><li><a href = "chapter_002.html#link-38">3.1. Configuration in an inline YAML block</a></li>
<li><a href = "chapter_002.html#link-39">3.2. The list of files</a></li>
<li><a href = "chapter_002.html#link-41">3.3. Crowbook options</a></li>
@ -100,14 +100,14 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_003.html#link-71">4. Templates</a>
<li><a href = "chapter_003.html#link-71">4\. Templates</a>
<ul><li><a href = "chapter_003.html#link-72">4.1. Create and edit template</a></li>
<li><a href = "chapter_003.html#link-76">4.2. List of templates</a></li>
<li><a href = "chapter_003.html#link-90">4.3. List of accessible variables</a></li>
</ul>
</li>
<li><a href = "chapter_004.html#link-94">5. Proofreading with Crowbook</a>
<li><a href = "chapter_004.html#link-94">5\. Proofreading with Crowbook</a>
<ul><li><a href = "chapter_004.html#link-95">5.1. Enabling proofreading</a></li>
<li><a href = "chapter_004.html#link-96">5.2. Repetition detection</a></li>
<li><a href = "chapter_004.html#link-97">5.3. Grammar checking</a></li>
@ -115,51 +115,52 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_005.html#link-99">6. Tips and tricks</a>
<li><a href = "chapter_005.html#link-99">6\. Tips and tricks</a>
<ul><li><a href = "chapter_005.html#link-100">6.1. Using Crowbook with Emacs markdown mode</a></li>
<li><a href = "chapter_005.html#link-103">6.2. Embedding fonts in an EPUB file</a></li>
</ul>
</li>
<li><a href = "chapter_006.html#link-104">7. Contributing</a>
<li><a href = "chapter_006.html#link-104">7\. Contributing</a>
<ul><li><a href = "chapter_006.html#link-105">7.1. Internationalization</a></li>
</ul>
</li>
<li><a href = "chapter_007.html#link-106">ChangeLog</a>
<ul><li><a href = "chapter_007.html#link-107">unreleased</a></li>
<li><a href = "chapter_007.html#link-108">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-111">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-118">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-119">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-120">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-121">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-123">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-124">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-125">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.1.0 (2016-02-21)</a></li>
<ul><li><a href = "chapter_007.html#link-107">0.11.4 (2017-03-21)</a></li>
<li><a href = "chapter_007.html#link-108">0.11.3 (2017-03-19)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-111">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-118">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-119">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-120">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-121">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-123">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-124">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-125">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-129">0.1.0 (2016-02-21)</a></li>
</ul>
</li>
<li><a href = "chapter_008.html#link-129">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
<li><a href = "chapter_008.html#link-130">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
</ul>
</nav>
<div id = "content">
<div id = "top"><p id = "para-304">Crowbook User Guide 0.11.2</p>
<div id = "top"><p id = "para-304">Crowbook User Guide 0.11.4</p>
</div>
<div id = "page">
<header>
@ -170,10 +171,10 @@ function toggle() {
</header>
<p class = "prev_chapter">
<a href = "chapter_003.html">
« 4. Templates
« 4\. Templates
</a>
</p>
<h1 id = "link-94">5. Proofreading with Crowbook</h1>
<h1 id = "link-94">5\. Proofreading with Crowbook</h1>
<p id = "para-195">Since version 0.9.1, Crowbook includes some proofreading features, that can be enabled if you set one of the</p>
<ul>
<li><code>output.proofread.html</code></li>
@ -236,11 +237,11 @@ proofread.languagetool.port: 8081
<p class = "next_chapter">
<a href = "chapter_005.html">
6. Tips and tricks »
6\. Tips and tricks »
</a>
</p>
</div>
<footer id = "footer"><p id = "para-303">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.3-pre</p>
<footer id = "footer"><p id = "para-303">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.4</p>
</footer>
</div>
</body>

View File

@ -6,7 +6,7 @@
<meta name="author" content="Élisabeth Henry">
<meta name="viewport" content="width=device-width">
<link rel = "icon" href = "images/image_0.svg">
<title>Crowbook User Guide 6. Tips and tricks</title>
<title>Crowbook User Guide - 6\. Tips and tricks</title>
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
/>
<link rel = "stylesheet" href = "print.css" type = "text/css"
@ -63,7 +63,7 @@ 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>
<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>
@ -78,7 +78,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_001.html#link-22">2. Arguments</a>
<li><a href = "chapter_001.html#link-22">2\. Arguments</a>
<ul><li><a href = "chapter_001.html#link-23">2.1. <code>--create</code></a></li>
<li><a href = "chapter_001.html#link-25">2.2. <code>--single</code></a></li>
<li><a href = "chapter_001.html#link-26">2.3. <code>--set</code></a></li>
@ -92,7 +92,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_002.html#link-37">3. The configuration file</a>
<li><a href = "chapter_002.html#link-37">3\. The configuration file</a>
<ul><li><a href = "chapter_002.html#link-38">3.1. Configuration in an inline YAML block</a></li>
<li><a href = "chapter_002.html#link-39">3.2. The list of files</a></li>
<li><a href = "chapter_002.html#link-41">3.3. Crowbook options</a></li>
@ -100,14 +100,14 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_003.html#link-71">4. Templates</a>
<li><a href = "chapter_003.html#link-71">4\. Templates</a>
<ul><li><a href = "chapter_003.html#link-72">4.1. Create and edit template</a></li>
<li><a href = "chapter_003.html#link-76">4.2. List of templates</a></li>
<li><a href = "chapter_003.html#link-90">4.3. List of accessible variables</a></li>
</ul>
</li>
<li><a href = "chapter_004.html#link-94">5. Proofreading with Crowbook</a>
<li><a href = "chapter_004.html#link-94">5\. Proofreading with Crowbook</a>
<ul><li><a href = "chapter_004.html#link-95">5.1. Enabling proofreading</a></li>
<li><a href = "chapter_004.html#link-96">5.2. Repetition detection</a></li>
<li><a href = "chapter_004.html#link-97">5.3. Grammar checking</a></li>
@ -115,51 +115,52 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_005.html#link-99">6. Tips and tricks</a>
<li><a href = "chapter_005.html#link-99">6\. Tips and tricks</a>
<ul><li><a href = "chapter_005.html#link-100">6.1. Using Crowbook with Emacs markdown mode</a></li>
<li><a href = "chapter_005.html#link-103">6.2. Embedding fonts in an EPUB file</a></li>
</ul>
</li>
<li><a href = "chapter_006.html#link-104">7. Contributing</a>
<li><a href = "chapter_006.html#link-104">7\. Contributing</a>
<ul><li><a href = "chapter_006.html#link-105">7.1. Internationalization</a></li>
</ul>
</li>
<li><a href = "chapter_007.html#link-106">ChangeLog</a>
<ul><li><a href = "chapter_007.html#link-107">unreleased</a></li>
<li><a href = "chapter_007.html#link-108">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-111">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-118">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-119">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-120">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-121">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-123">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-124">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-125">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.1.0 (2016-02-21)</a></li>
<ul><li><a href = "chapter_007.html#link-107">0.11.4 (2017-03-21)</a></li>
<li><a href = "chapter_007.html#link-108">0.11.3 (2017-03-19)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-111">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-118">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-119">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-120">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-121">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-123">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-124">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-125">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-129">0.1.0 (2016-02-21)</a></li>
</ul>
</li>
<li><a href = "chapter_008.html#link-129">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
<li><a href = "chapter_008.html#link-130">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
</ul>
</nav>
<div id = "content">
<div id = "top"><p id = "para-306">Crowbook User Guide 0.11.2</p>
<div id = "top"><p id = "para-306">Crowbook User Guide 0.11.4</p>
</div>
<div id = "page">
<header>
@ -170,10 +171,10 @@ function toggle() {
</header>
<p class = "prev_chapter">
<a href = "chapter_004.html">
« 5. Proofreading with Crowbook
« 5\. Proofreading with Crowbook
</a>
</p>
<h1 id = "link-99">6. Tips and tricks</h1>
<h1 id = "link-99">6\. Tips and tricks</h1>
<h2 id = "link-100">6.1. Using Crowbook with Emacs markdown mode</h2>
<p id = "para-213">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-214">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>
@ -215,11 +216,11 @@ title: Some title
<p class = "next_chapter">
<a href = "chapter_006.html">
7. Contributing »
7\. Contributing »
</a>
</p>
</div>
<footer id = "footer"><p id = "para-305">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.3-pre</p>
<footer id = "footer"><p id = "para-305">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.4</p>
</footer>
</div>
</body>

View File

@ -6,7 +6,7 @@
<meta name="author" content="Élisabeth Henry">
<meta name="viewport" content="width=device-width">
<link rel = "icon" href = "images/image_0.svg">
<title>Crowbook User Guide 7. Contributing</title>
<title>Crowbook User Guide - 7\. Contributing</title>
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
/>
<link rel = "stylesheet" href = "print.css" type = "text/css"
@ -63,7 +63,7 @@ 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>
<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>
@ -78,7 +78,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_001.html#link-22">2. Arguments</a>
<li><a href = "chapter_001.html#link-22">2\. Arguments</a>
<ul><li><a href = "chapter_001.html#link-23">2.1. <code>--create</code></a></li>
<li><a href = "chapter_001.html#link-25">2.2. <code>--single</code></a></li>
<li><a href = "chapter_001.html#link-26">2.3. <code>--set</code></a></li>
@ -92,7 +92,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_002.html#link-37">3. The configuration file</a>
<li><a href = "chapter_002.html#link-37">3\. The configuration file</a>
<ul><li><a href = "chapter_002.html#link-38">3.1. Configuration in an inline YAML block</a></li>
<li><a href = "chapter_002.html#link-39">3.2. The list of files</a></li>
<li><a href = "chapter_002.html#link-41">3.3. Crowbook options</a></li>
@ -100,14 +100,14 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_003.html#link-71">4. Templates</a>
<li><a href = "chapter_003.html#link-71">4\. Templates</a>
<ul><li><a href = "chapter_003.html#link-72">4.1. Create and edit template</a></li>
<li><a href = "chapter_003.html#link-76">4.2. List of templates</a></li>
<li><a href = "chapter_003.html#link-90">4.3. List of accessible variables</a></li>
</ul>
</li>
<li><a href = "chapter_004.html#link-94">5. Proofreading with Crowbook</a>
<li><a href = "chapter_004.html#link-94">5\. Proofreading with Crowbook</a>
<ul><li><a href = "chapter_004.html#link-95">5.1. Enabling proofreading</a></li>
<li><a href = "chapter_004.html#link-96">5.2. Repetition detection</a></li>
<li><a href = "chapter_004.html#link-97">5.3. Grammar checking</a></li>
@ -115,51 +115,52 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_005.html#link-99">6. Tips and tricks</a>
<li><a href = "chapter_005.html#link-99">6\. Tips and tricks</a>
<ul><li><a href = "chapter_005.html#link-100">6.1. Using Crowbook with Emacs markdown mode</a></li>
<li><a href = "chapter_005.html#link-103">6.2. Embedding fonts in an EPUB file</a></li>
</ul>
</li>
<li><a href = "chapter_006.html#link-104">7. Contributing</a>
<li><a href = "chapter_006.html#link-104">7\. Contributing</a>
<ul><li><a href = "chapter_006.html#link-105">7.1. Internationalization</a></li>
</ul>
</li>
<li><a href = "chapter_007.html#link-106">ChangeLog</a>
<ul><li><a href = "chapter_007.html#link-107">unreleased</a></li>
<li><a href = "chapter_007.html#link-108">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-111">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-118">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-119">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-120">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-121">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-123">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-124">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-125">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.1.0 (2016-02-21)</a></li>
<ul><li><a href = "chapter_007.html#link-107">0.11.4 (2017-03-21)</a></li>
<li><a href = "chapter_007.html#link-108">0.11.3 (2017-03-19)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-111">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-118">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-119">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-120">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-121">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-123">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-124">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-125">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-129">0.1.0 (2016-02-21)</a></li>
</ul>
</li>
<li><a href = "chapter_008.html#link-129">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
<li><a href = "chapter_008.html#link-130">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
</ul>
</nav>
<div id = "content">
<div id = "top"><p id = "para-308">Crowbook User Guide 0.11.2</p>
<div id = "top"><p id = "para-308">Crowbook User Guide 0.11.4</p>
</div>
<div id = "page">
<header>
@ -170,10 +171,10 @@ function toggle() {
</header>
<p class = "prev_chapter">
<a href = "chapter_005.html">
« 6. Tips and tricks
« 6\. Tips and tricks
</a>
</p>
<h1 id = "link-104">7. Contributing</h1>
<h1 id = "link-104">7\. Contributing</h1>
<p id = "para-223">Crowbook is a free software, and you can contribute to it. There are some things that can be accessible even if you dont know anything about programming.</p>
<h2 id = "link-105">7.1. Internationalization</h2>
<p id = "para-224">Crowbook aims to support multiple languages. However, unfortunately, currently only english, french, and (in a more limited way) spanish are currently supported. If you want to have better support for the language you write in, there are easy things you can do:</p>
@ -189,7 +190,7 @@ function toggle() {
</a>
</p>
</div>
<footer id = "footer"><p id = "para-307">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.3-pre</p>
<footer id = "footer"><p id = "para-307">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.4</p>
</footer>
</div>
</body>

View File

@ -6,7 +6,7 @@
<meta name="author" content="Élisabeth Henry">
<meta name="viewport" content="width=device-width">
<link rel = "icon" href = "images/image_0.svg">
<title>Crowbook User Guide ChangeLog</title>
<title>Crowbook User Guide - ChangeLog</title>
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
/>
<link rel = "stylesheet" href = "print.css" type = "text/css"
@ -63,7 +63,7 @@ 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>
<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>
@ -78,7 +78,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_001.html#link-22">2. Arguments</a>
<li><a href = "chapter_001.html#link-22">2\. Arguments</a>
<ul><li><a href = "chapter_001.html#link-23">2.1. <code>--create</code></a></li>
<li><a href = "chapter_001.html#link-25">2.2. <code>--single</code></a></li>
<li><a href = "chapter_001.html#link-26">2.3. <code>--set</code></a></li>
@ -92,7 +92,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_002.html#link-37">3. The configuration file</a>
<li><a href = "chapter_002.html#link-37">3\. The configuration file</a>
<ul><li><a href = "chapter_002.html#link-38">3.1. Configuration in an inline YAML block</a></li>
<li><a href = "chapter_002.html#link-39">3.2. The list of files</a></li>
<li><a href = "chapter_002.html#link-41">3.3. Crowbook options</a></li>
@ -100,14 +100,14 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_003.html#link-71">4. Templates</a>
<li><a href = "chapter_003.html#link-71">4\. Templates</a>
<ul><li><a href = "chapter_003.html#link-72">4.1. Create and edit template</a></li>
<li><a href = "chapter_003.html#link-76">4.2. List of templates</a></li>
<li><a href = "chapter_003.html#link-90">4.3. List of accessible variables</a></li>
</ul>
</li>
<li><a href = "chapter_004.html#link-94">5. Proofreading with Crowbook</a>
<li><a href = "chapter_004.html#link-94">5\. Proofreading with Crowbook</a>
<ul><li><a href = "chapter_004.html#link-95">5.1. Enabling proofreading</a></li>
<li><a href = "chapter_004.html#link-96">5.2. Repetition detection</a></li>
<li><a href = "chapter_004.html#link-97">5.3. Grammar checking</a></li>
@ -115,51 +115,52 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_005.html#link-99">6. Tips and tricks</a>
<li><a href = "chapter_005.html#link-99">6\. Tips and tricks</a>
<ul><li><a href = "chapter_005.html#link-100">6.1. Using Crowbook with Emacs markdown mode</a></li>
<li><a href = "chapter_005.html#link-103">6.2. Embedding fonts in an EPUB file</a></li>
</ul>
</li>
<li><a href = "chapter_006.html#link-104">7. Contributing</a>
<li><a href = "chapter_006.html#link-104">7\. Contributing</a>
<ul><li><a href = "chapter_006.html#link-105">7.1. Internationalization</a></li>
</ul>
</li>
<li><a href = "chapter_007.html#link-106">ChangeLog</a>
<ul><li><a href = "chapter_007.html#link-107">unreleased</a></li>
<li><a href = "chapter_007.html#link-108">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-111">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-118">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-119">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-120">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-121">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-123">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-124">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-125">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.1.0 (2016-02-21)</a></li>
<ul><li><a href = "chapter_007.html#link-107">0.11.4 (2017-03-21)</a></li>
<li><a href = "chapter_007.html#link-108">0.11.3 (2017-03-19)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-111">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-118">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-119">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-120">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-121">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-123">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-124">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-125">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-129">0.1.0 (2016-02-21)</a></li>
</ul>
</li>
<li><a href = "chapter_008.html#link-129">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
<li><a href = "chapter_008.html#link-130">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
</ul>
</nav>
<div id = "content">
<div id = "top"><p id = "para-310">Crowbook User Guide 0.11.2</p>
<div id = "top"><p id = "para-310">Crowbook User Guide 0.11.4</p>
</div>
<div id = "page">
<header>
@ -170,15 +171,34 @@ function toggle() {
</header>
<p class = "prev_chapter">
<a href = "chapter_006.html">
« 7. Contributing
« 7\. Contributing
</a>
</p>
<h1 id = "link-106">ChangeLog</h1>
<h2 id = "link-107">unreleased</h2>
<h2 id = "link-107">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>
<li>HTML/EPUB: use raw (not HTML rendered) metadata in the places where HTML code is not appropriate. Templates can use this metadata with the <code>foo_raw</code> value.</li>
<li>HTML/EPUB: fix double-escaping/rendering issues in titles.</li>
<li>EPUB:<ul>
<li>Escape title and author before feeding them to epub-builder.</li>
<li>Fix content.opf issue by not rendering first chapters title (marked as beginning of document) in <code>&lt;guide&gt;</code>.</li>
</ul>
</li>
</ul>
</li>
<li>Rendering:<ul>
<li>HTML/EPUB: standalone images are now displayed centered.</li>
</ul>
</li>
</ul>
<h2 id = "link-108">0.11.3 (2017-03-19)</h2>
<ul>
<li>When crowbook parses the books 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>
<li>The LaTeX and HTML/EPUB renderers only initialize <code>syntect</code> (which can take some time) if code blocks are used in the document.</li>
<li>The LaTeX renderer only requires LaTeX packages that are actually used in the document.</li>
</ul>
</li>
<li>Command-line interface:<ul>
@ -192,7 +212,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-108">0.11.2 (2017-03-05)</h2>
<h2 id = "link-109">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>
@ -228,7 +248,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-109">0.11.1 (2017-01-05)</h2>
<h2 id = "link-110">0.11.1 (2017-01-05)</h2>
<ul>
<li>Rendering:<ul>
<li>Avoid page break before or after a separating rule.</li>
@ -260,7 +280,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-110">0.11.0 (2016-12-31)</h2>
<h2 id = "link-111">0.11.0 (2016-12-31)</h2>
<p id = "para-225">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>
@ -324,7 +344,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-111">0.10.4 (2016-12-16)</h2>
<h2 id = "link-112">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>
@ -346,7 +366,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-112">0.10.3 (2016-11-19)</h2>
<h2 id = "link-113">0.10.3 (2016-11-19)</h2>
<ul>
<li>Building:<ul>
<li>Crowbook now requires rustc &gt;= 1.13.0 to build.</li>
@ -367,7 +387,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-113">0.10.2 (2016-10-21)</h2>
<h2 id = "link-114">0.10.2 (2016-10-21)</h2>
<p id = "para-226">Only minor changes in this version:</p>
<ul>
<li>Options:<ul>
@ -383,9 +403,9 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-114">0.10.1 (2016-10-18)</h2>
<h2 id = "link-115">0.10.1 (2016-10-18)</h2>
<p id = "para-227">Fixed a bug in <code>fr.po</code> translation that prevented building from fresh install.</p>
<h2 id = "link-115">0.10.0 (2016-10-18)</h2>
<h2 id = "link-116">0.10.0 (2016-10-18)</h2>
<p id = "para-228">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>
@ -422,7 +442,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-116">0.9.1 (2016-09-29)</h2>
<h2 id = "link-117">0.9.1 (2016-09-29)</h2>
<p id = "para-229">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>
@ -453,7 +473,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-117">0.9.0 (2016-09-23)</h2>
<h2 id = "link-118">0.9.0 (2016-09-23)</h2>
<p id = "para-230">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 Crowbooks library API;</li>
@ -518,7 +538,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-118">0.8.0 (2016-09-19)</h2>
<h2 id = "link-119">0.8.0 (2016-09-19)</h2>
<p id = "para-231">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>
@ -558,7 +578,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-119">0.7.0 (2016-09-11)</h2>
<h2 id = "link-120">0.7.0 (2016-09-11)</h2>
<p id = "para-232">This releases renders images differently when they are on a standalone paragraph or inside a paragraph.</p>
<ul>
<li>Internal/API:<ul>
@ -572,7 +592,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-120">0.6.0 (2016-09-09)</h2>
<h2 id = "link-121">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 its better to use different non breaking spaces according to context, this option was not really useful anymore.</li>
@ -599,7 +619,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-121">0.5.1 (2016-04-14)</h2>
<h2 id = "link-122">0.5.1 (2016-04-14)</h2>
<p id = "para-233">Mostly rendering fixes:</p>
<ul>
<li>Epub:<ul>
@ -625,7 +645,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-122">0.5.0 (2016-04-02)</h2>
<h2 id = "link-123">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>
@ -664,7 +684,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-123">0.4.0 (2016-03-01)</h2>
<h2 id = "link-124">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” Crowbookss 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 wasnt possible until then and might be useful in some cases.</li>
@ -684,7 +704,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-124">0.3.0 (2016-02-27)</h2>
<h2 id = "link-125">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>
@ -702,14 +722,14 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-125">0.2.2 (2016-02-25)</h2>
<h2 id = "link-126">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-126">0.2.1 (2016-02-25)</h2>
<h2 id = "link-127">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>
@ -721,7 +741,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-127">0.2.0 (2016-02-25)</h2>
<h2 id = "link-128">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>
@ -746,7 +766,7 @@ function toggle() {
</ul>
</li>
</ul>
<h2 id = "link-128">0.1.0 (2016-02-21)</h2>
<h2 id = "link-129">0.1.0 (2016-02-21)</h2>
<ul>
<li>initial release</li>
</ul>
@ -757,7 +777,7 @@ function toggle() {
</a>
</p>
</div>
<footer id = "footer"><p id = "para-309">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.3-pre</p>
<footer id = "footer"><p id = "para-309">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.4</p>
</footer>
</div>
</body>

View File

@ -6,7 +6,7 @@
<meta name="author" content="Élisabeth Henry">
<meta name="viewport" content="width=device-width">
<link rel = "icon" href = "images/image_0.svg">
<title>Crowbook User Guide GNU LESSER GENERAL PUBLIC LICENSE</title>
<title>Crowbook User Guide - GNU LESSER GENERAL PUBLIC LICENSE</title>
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
/>
<link rel = "stylesheet" href = "print.css" type = "text/css"
@ -63,7 +63,7 @@ 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>
<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>
@ -78,7 +78,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_001.html#link-22">2. Arguments</a>
<li><a href = "chapter_001.html#link-22">2\. Arguments</a>
<ul><li><a href = "chapter_001.html#link-23">2.1. <code>--create</code></a></li>
<li><a href = "chapter_001.html#link-25">2.2. <code>--single</code></a></li>
<li><a href = "chapter_001.html#link-26">2.3. <code>--set</code></a></li>
@ -92,7 +92,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_002.html#link-37">3. The configuration file</a>
<li><a href = "chapter_002.html#link-37">3\. The configuration file</a>
<ul><li><a href = "chapter_002.html#link-38">3.1. Configuration in an inline YAML block</a></li>
<li><a href = "chapter_002.html#link-39">3.2. The list of files</a></li>
<li><a href = "chapter_002.html#link-41">3.3. Crowbook options</a></li>
@ -100,14 +100,14 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_003.html#link-71">4. Templates</a>
<li><a href = "chapter_003.html#link-71">4\. Templates</a>
<ul><li><a href = "chapter_003.html#link-72">4.1. Create and edit template</a></li>
<li><a href = "chapter_003.html#link-76">4.2. List of templates</a></li>
<li><a href = "chapter_003.html#link-90">4.3. List of accessible variables</a></li>
</ul>
</li>
<li><a href = "chapter_004.html#link-94">5. Proofreading with Crowbook</a>
<li><a href = "chapter_004.html#link-94">5\. Proofreading with Crowbook</a>
<ul><li><a href = "chapter_004.html#link-95">5.1. Enabling proofreading</a></li>
<li><a href = "chapter_004.html#link-96">5.2. Repetition detection</a></li>
<li><a href = "chapter_004.html#link-97">5.3. Grammar checking</a></li>
@ -115,51 +115,52 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_005.html#link-99">6. Tips and tricks</a>
<li><a href = "chapter_005.html#link-99">6\. Tips and tricks</a>
<ul><li><a href = "chapter_005.html#link-100">6.1. Using Crowbook with Emacs markdown mode</a></li>
<li><a href = "chapter_005.html#link-103">6.2. Embedding fonts in an EPUB file</a></li>
</ul>
</li>
<li><a href = "chapter_006.html#link-104">7. Contributing</a>
<li><a href = "chapter_006.html#link-104">7\. Contributing</a>
<ul><li><a href = "chapter_006.html#link-105">7.1. Internationalization</a></li>
</ul>
</li>
<li><a href = "chapter_007.html#link-106">ChangeLog</a>
<ul><li><a href = "chapter_007.html#link-107">unreleased</a></li>
<li><a href = "chapter_007.html#link-108">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-111">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-118">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-119">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-120">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-121">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-123">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-124">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-125">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.1.0 (2016-02-21)</a></li>
<ul><li><a href = "chapter_007.html#link-107">0.11.4 (2017-03-21)</a></li>
<li><a href = "chapter_007.html#link-108">0.11.3 (2017-03-19)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-111">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-118">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-119">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-120">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-121">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-123">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-124">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-125">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-129">0.1.0 (2016-02-21)</a></li>
</ul>
</li>
<li><a href = "chapter_008.html#link-129">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
<li><a href = "chapter_008.html#link-130">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
</ul>
</nav>
<div id = "content">
<div id = "top"><p id = "para-312">Crowbook User Guide 0.11.2</p>
<div id = "top"><p id = "para-312">Crowbook User Guide 0.11.4</p>
</div>
<div id = "page">
<header>
@ -173,7 +174,7 @@ function toggle() {
« ChangeLog
</a>
</p>
<h1 id = "link-129">GNU LESSER GENERAL PUBLIC LICENSE</h1>
<h1 id = "link-130">GNU LESSER GENERAL PUBLIC LICENSE</h1>
<pre><span style="color:#839496;"> Version 2.1, February 1999
</span></pre><p id = "para-234">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-235">[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>
@ -360,7 +361,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
</div>
<footer id = "footer"><p id = "para-311">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.3-pre</p>
<footer id = "footer"><p id = "para-311">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.4</p>
</footer>
</div>
</body>

View File

@ -6,7 +6,7 @@
<meta name="author" content="Élisabeth Henry">
<meta name="viewport" content="width=device-width">
<link rel = "icon" href = "images/image_0.svg">
<title></title>
<title>Crowbook User Guide - </title>
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
/>
<link rel = "stylesheet" href = "print.css" type = "text/css"
@ -63,7 +63,7 @@ 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>
<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>
@ -78,7 +78,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_001.html#link-22">2. Arguments</a>
<li><a href = "chapter_001.html#link-22">2\. Arguments</a>
<ul><li><a href = "chapter_001.html#link-23">2.1. <code>--create</code></a></li>
<li><a href = "chapter_001.html#link-25">2.2. <code>--single</code></a></li>
<li><a href = "chapter_001.html#link-26">2.3. <code>--set</code></a></li>
@ -92,7 +92,7 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_002.html#link-37">3. The configuration file</a>
<li><a href = "chapter_002.html#link-37">3\. The configuration file</a>
<ul><li><a href = "chapter_002.html#link-38">3.1. Configuration in an inline YAML block</a></li>
<li><a href = "chapter_002.html#link-39">3.2. The list of files</a></li>
<li><a href = "chapter_002.html#link-41">3.3. Crowbook options</a></li>
@ -100,14 +100,14 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_003.html#link-71">4. Templates</a>
<li><a href = "chapter_003.html#link-71">4\. Templates</a>
<ul><li><a href = "chapter_003.html#link-72">4.1. Create and edit template</a></li>
<li><a href = "chapter_003.html#link-76">4.2. List of templates</a></li>
<li><a href = "chapter_003.html#link-90">4.3. List of accessible variables</a></li>
</ul>
</li>
<li><a href = "chapter_004.html#link-94">5. Proofreading with Crowbook</a>
<li><a href = "chapter_004.html#link-94">5\. Proofreading with Crowbook</a>
<ul><li><a href = "chapter_004.html#link-95">5.1. Enabling proofreading</a></li>
<li><a href = "chapter_004.html#link-96">5.2. Repetition detection</a></li>
<li><a href = "chapter_004.html#link-97">5.3. Grammar checking</a></li>
@ -115,51 +115,52 @@ function toggle() {
</ul>
</li>
<li><a href = "chapter_005.html#link-99">6. Tips and tricks</a>
<li><a href = "chapter_005.html#link-99">6\. Tips and tricks</a>
<ul><li><a href = "chapter_005.html#link-100">6.1. Using Crowbook with Emacs markdown mode</a></li>
<li><a href = "chapter_005.html#link-103">6.2. Embedding fonts in an EPUB file</a></li>
</ul>
</li>
<li><a href = "chapter_006.html#link-104">7. Contributing</a>
<li><a href = "chapter_006.html#link-104">7\. Contributing</a>
<ul><li><a href = "chapter_006.html#link-105">7.1. Internationalization</a></li>
</ul>
</li>
<li><a href = "chapter_007.html#link-106">ChangeLog</a>
<ul><li><a href = "chapter_007.html#link-107">unreleased</a></li>
<li><a href = "chapter_007.html#link-108">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-111">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-118">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-119">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-120">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-121">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-123">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-124">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-125">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.1.0 (2016-02-21)</a></li>
<ul><li><a href = "chapter_007.html#link-107">0.11.4 (2017-03-21)</a></li>
<li><a href = "chapter_007.html#link-108">0.11.3 (2017-03-19)</a></li>
<li><a href = "chapter_007.html#link-109">0.11.2 (2017-03-05)</a></li>
<li><a href = "chapter_007.html#link-110">0.11.1 (2017-01-05)</a></li>
<li><a href = "chapter_007.html#link-111">0.11.0 (2016-12-31)</a></li>
<li><a href = "chapter_007.html#link-112">0.10.4 (2016-12-16)</a></li>
<li><a href = "chapter_007.html#link-113">0.10.3 (2016-11-19)</a></li>
<li><a href = "chapter_007.html#link-114">0.10.2 (2016-10-21)</a></li>
<li><a href = "chapter_007.html#link-115">0.10.1 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-116">0.10.0 (2016-10-18)</a></li>
<li><a href = "chapter_007.html#link-117">0.9.1 (2016-09-29)</a></li>
<li><a href = "chapter_007.html#link-118">0.9.0 (2016-09-23)</a></li>
<li><a href = "chapter_007.html#link-119">0.8.0 (2016-09-19)</a></li>
<li><a href = "chapter_007.html#link-120">0.7.0 (2016-09-11)</a></li>
<li><a href = "chapter_007.html#link-121">0.6.0 (2016-09-09)</a></li>
<li><a href = "chapter_007.html#link-122">0.5.1 (2016-04-14)</a></li>
<li><a href = "chapter_007.html#link-123">0.5.0 (2016-04-02)</a></li>
<li><a href = "chapter_007.html#link-124">0.4.0 (2016-03-01)</a></li>
<li><a href = "chapter_007.html#link-125">0.3.0 (2016-02-27)</a></li>
<li><a href = "chapter_007.html#link-126">0.2.2 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-127">0.2.1 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-128">0.2.0 (2016-02-25)</a></li>
<li><a href = "chapter_007.html#link-129">0.1.0 (2016-02-21)</a></li>
</ul>
</li>
<li><a href = "chapter_008.html#link-129">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
<li><a href = "chapter_008.html#link-130">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
</ul>
</nav>
<div id = "content">
<div id = "top"><p id = "para-313">Crowbook User Guide 0.11.2</p>
<div id = "top"><p id = "para-313">Crowbook User Guide 0.11.4</p>
</div>
<div id = "page">
<header>
@ -173,12 +174,12 @@ function toggle() {
<img class = "cover" alt = "Crowbook User Guide" src = "images/image_1.png" />
</div><p class = "next_chapter">
<a href = "chapter_000.html">
1. Crowbook »
1\. Crowbook »
</a>
</p>
</div>
<footer id = "footer"><p id = "para-314">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.3-pre</p>
<footer id = "footer"><p id = "para-314">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.4</p>
</footer>
</div>
</body>

View File

@ -84,10 +84,16 @@ h2.author {
width: 100%;
}
.image img {
.image {
margin: auto;
width: 80%;
}
.image img {
width: 100%;
max-height: 100%;
}
.rule {
text-align: center;
margin-top: 1em;