2016-09-29 02:47:48 +02:00
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta name="generator" content="crowbook">
|
|
|
|
|
<meta name="author" content="Élisabeth Henry">
|
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
|
|
|
<title>Crowbook User Guide</title>
|
|
|
|
|
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
|
|
|
|
|
/>
|
|
|
|
|
<link rel = "stylesheet" href = "highlight.css" type = "text/css"
|
|
|
|
|
/>
|
|
|
|
|
<script src = "highlight.js"></script>
|
|
|
|
|
<script>
|
|
|
|
|
hljs.initHighlightingOnLoad();
|
|
|
|
|
</script>
|
|
|
|
|
<link rel = "stylesheet" href = "print.css" type = "text/css"
|
|
|
|
|
media = "print" />
|
|
|
|
|
<script>
|
|
|
|
|
function on(name) {
|
|
|
|
|
var elements = document.getElementsByClassName(name);
|
|
|
|
|
for (var i = 0; i < elements.length; i++) {
|
|
|
|
|
var elem = elements[i];
|
|
|
|
|
elem.style.backgroundColor = "pink";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
function off(name) {
|
|
|
|
|
var elements = document.getElementsByClassName(name);
|
|
|
|
|
for (var i = 0; i < elements.length; i++) {
|
|
|
|
|
var elem = elements[i];
|
|
|
|
|
elem.style.backgroundColor = "white";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var display_menu = false;
|
|
|
|
|
function toggle() {
|
|
|
|
|
if (display_menu == true) {
|
|
|
|
|
display_menu = false;
|
2016-12-15 01:00:50 +01:00
|
|
|
|
document.getElementById("nav").style.left = "-21%";
|
2016-09-29 02:47:48 +02:00
|
|
|
|
document.getElementById("content").style.marginLeft = "10%";
|
|
|
|
|
document.getElementById("menu").style.left = "1em";
|
|
|
|
|
if(document.getElementById("top")) {
|
|
|
|
|
document.getElementById("top").style.left = "0";
|
|
|
|
|
}
|
|
|
|
|
if(document.getElementById("footer")) {
|
|
|
|
|
document.getElementById("footer").style.marginLeft = "0%";
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
display_menu = true;
|
|
|
|
|
document.getElementById("nav").style.left = "0";
|
|
|
|
|
document.getElementById("content").style.marginLeft = "30%";
|
|
|
|
|
document.getElementById("menu").style.left = "20%";
|
|
|
|
|
if(document.getElementById("top")) {
|
|
|
|
|
document.getElementById("top").style.left = "20%";
|
|
|
|
|
}
|
|
|
|
|
if(document.getElementById("footer")) {
|
|
|
|
|
document.getElementById("footer").style.marginLeft = "20%";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<nav id = "nav">
|
|
|
|
|
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
|
|
|
|
<ul>
|
2016-10-18 00:50:17 +02:00
|
|
|
|
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
<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>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_000.html#link-8">1.5. Current features</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_000.html#link-19">1.9. Library</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_000.html#link-20">1.10. License</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_001.html#link-21">2. Arguments</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
<ul>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_001.html#link-22">2.1. <code>--create</code></a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_001.html#link-24">2.2. <code>--single</code></a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_001.html#link-25">2.3. <code>--set</code></a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_001.html#link-27">2.4. <code>--proofread</code></a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_001.html#link-28">2.5. <code>--list-options</code></a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_001.html#link-29">2.6. <code>--print-template</code></a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_001.html#link-30">2.7. <code>--verbose</code></a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_001.html#link-31">2.8. <code>--to</code></a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_001.html#link-33">2.9. <code>--output</code></a>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href = "chapter_001.html#link-34">2.10. <code>--lang</code></a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_002.html#link-36">3. The configuration file</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
<ul>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_002.html#link-37">3.1. Configuration in an inline YAML block (<code>crowbook --single</code>)</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_002.html#link-38">3.2. The list of files</a>
|
2016-10-21 19:37:25 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_002.html#link-39">3.3. Crowbook options</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_003.html#link-67">4. Templates</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
<ul>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_003.html#link-68">4.1. Create and edit template</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_003.html#link-72">4.2. List of templates</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_003.html#link-87">4.3. List of accessible variables</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_004.html#link-91">5. Proofreading with Crowbook</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
<ul>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_004.html#link-92">5.1. Enabling proofreading</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_004.html#link-93">5.2. Repetition detection</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_004.html#link-94">5.3. Grammar checking</a>
|
2016-10-21 22:10:47 +02:00
|
|
|
|
</li>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<li><a href = "chapter_004.html#link-95">5.4. Highlighting non-breaking spaces</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2016-10-21 22:10:47 +02:00
|
|
|
|
<li><a href = "chapter_005.html#link-96">6. Tips and tricks</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
<ul>
|
2016-10-21 22:10:47 +02:00
|
|
|
|
<li><a href = "chapter_005.html#link-97">6.1. Using Crowbook with Emacs’ markdown mode</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-10-21 22:10:47 +02:00
|
|
|
|
<li><a href = "chapter_005.html#link-100">6.2. Embedding fonts in an EPUB file</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-10-06 23:12:14 +02:00
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2016-10-21 22:10:47 +02:00
|
|
|
|
<li><a href = "chapter_006.html#link-101">ChangeLog</a>
|
2016-10-06 23:12:14 +02:00
|
|
|
|
<ul>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-102">unreleased</a>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-103">0.10.3 (2016-11-19)</a>
|
2016-10-06 23:12:14 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-104">0.10.2 (2016-10-21)</a>
|
2016-10-06 23:12:14 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-105">0.10.1 (2016-10-18)</a>
|
2016-10-06 23:12:14 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-106">0.10.0 (2016-10-18)</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-107">0.9.1 (2016-09-29)</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-108">0.9.0 (2016-09-23)</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-109">0.8.0 (2016-09-19)</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-110">0.7.0 (2016-09-11)</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-111">0.6.0 (2016-09-09)</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-112">0.5.1 (2016-04-14)</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-113">0.5.0 (2016-04-02)</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-114">0.4.0 (2016-03-01)</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-115">0.3.0 (2016-02-27)</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-116">0.2.2 (2016-02-25)</a>
|
2016-10-20 21:33:43 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-117">0.2.1 (2016-02-25)</a>
|
2016-10-20 21:33:43 +02:00
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_006.html#link-118">0.2.0 (2016-02-25)</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href = "chapter_006.html#link-119">0.1.0 (2016-02-21)</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<li><a href = "chapter_007.html#link-120">GNU LESSER GENERAL PUBLIC LICENSE</a>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<div id = "content">
|
|
|
|
|
<div id = "page">
|
|
|
|
|
<header>
|
2016-11-19 02:13:42 +01:00
|
|
|
|
<div id = "top"><p id = "para-309">Crowbook User Guide 0.10.3</p>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</div>
|
|
|
|
|
<div id = "menu">
|
|
|
|
|
<img id = "menu-button" onclick="toggle();"
|
|
|
|
|
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h1 class = "title">Crowbook User Guide</h1>
|
|
|
|
|
<h2 class = "author">Élisabeth Henry</h2>
|
|
|
|
|
</header>
|
|
|
|
|
<div id = "cover">
|
|
|
|
|
<img class = "cover" alt = "Crowbook User Guide" src = "images/image_0.png" />
|
|
|
|
|
</div><p class = "next_chapter">
|
|
|
|
|
<a href = "chapter_000.html">
|
2016-10-18 00:50:17 +02:00
|
|
|
|
1. Crowbook »
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</a>
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2016-12-15 01:00:50 +01:00
|
|
|
|
<footer id = "footer"><p id = "para-310">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.10.4-pre</p>
|
2016-09-29 02:47:48 +02:00
|
|
|
|
</footer>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|