mirror of
https://github.com/lise-henry/crowbook
synced 2024-06-06 06:26:09 +02:00
Update docs/ dir
This commit is contained in:
Elisabeth Henry
parent
2374591050
commit
cc5bf349ac
Binary file not shown.
1427
docs/book/book.html
1427
docs/book/book.html
File diff suppressed because one or more lines are too long
Binary file not shown.
Binary file not shown.
|
|
@ -38,25 +38,25 @@ function toggle() {
|
|||
if (display_menu == true) {
|
||||
display_menu = false;
|
||||
document.getElementById("nav").style.left = "-21%";
|
||||
document.getElementById("content").style.marginLeft = "10%";
|
||||
document.getElementById("content").style.marginLeft = "0%";
|
||||
document.getElementById("menu").style.left = "1em";
|
||||
if(document.getElementById("top")) {
|
||||
/* 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("content").style.marginLeft = "20%";
|
||||
document.getElementById("menu").style.left = "20%";
|
||||
if(document.getElementById("top")) {
|
||||
/* if(document.getElementById("top")) {
|
||||
document.getElementById("top").style.left = "20%";
|
||||
}
|
||||
if(document.getElementById("footer")) {
|
||||
document.getElementById("footer").style.marginLeft = "20%";
|
||||
}
|
||||
}*/
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -69,159 +69,108 @@ function toggle() {
|
|||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-2">1.1. Example</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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 (<code>crowbook --single</code>)</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-40">3.3. Crowbook options</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-68">4. Templates</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_003.html#link-69">4.1. Create and edit template</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-73">4.2. List of templates</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-88">4.3. List of accessible variables</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-92">5. Proofreading with Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_004.html#link-93">5.1. Enabling proofreading</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-94">5.2. Repetition detection</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-95">5.3. Grammar checking</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-96">5.4. Highlighting non-breaking spaces</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-97">6. Tips and tricks</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_005.html#link-98">6.1. Using Crowbook with Emacs’ markdown mode</a>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-101">6.2. Embedding fonts in an EPUB file</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-102">7. Contributing</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_006.html#link-103">7.1. Internationalization</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-104">ChangeLog</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_007.html#link-105">unreleased</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-106">0.10.4 (2016-12-16)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-107">0.10.3 (2016-11-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.2 (2016-10-21)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.1 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.0 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-111">0.9.1 (2016-09-29)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-112">0.9.0 (2016-09-23)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-113">0.8.0 (2016-09-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-114">0.7.0 (2016-09-11)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-115">0.6.0 (2016-09-09)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-116">0.5.1 (2016-04-14)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-117">0.5.0 (2016-04-02)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-118">0.4.0 (2016-03-01)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">0.3.0 (2016-02-27)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-120">0.2.2 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-121">0.2.1 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.0 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-123">0.1.0 (2016-02-21)</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-124">GNU LESSER GENERAL PUBLIC LICENSE</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_002.html#link-55">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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>
|
||||
<li><a href = "chapter_004.html#link-98">5.4. Highlighting non-breaking spaces</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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">0.11.0 (???)</a></li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_007.html#link-111">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-112">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-113">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_007.html#link-114">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_007.html#link-115">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-116">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_007.html#link-117">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_007.html#link-118">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_007.html#link-119">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_007.html#link-120">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_007.html#link-121">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-123">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-124">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-125">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-126">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-296">Crowbook User Guide 0.11.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
<div id = "top"><p id = "para-296">Crowbook User Guide 0.10.5</p>
|
||||
</div>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</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>
|
||||
|
|
@ -307,6 +256,7 @@ title: My title
|
|||
<li><a href = "https://crates.io/crates/lazy_static">lazy_static</a></li>
|
||||
<li><a href = "https://crates.io/crates/regex">regex</a></li>
|
||||
<li><a href = "https://crates.io/crates/term">term</a></li>
|
||||
<li><a href = "https://crates.io/crates/numerals">numerals</a></li>
|
||||
</ul>
|
||||
<p id = "para-29">It also embeds <a href = "https://highlightjs.org/">Highlight.js</a> in HTML output to enable syntax highlighting for code blocks.</p>
|
||||
<p id = "para-30">It also uses configuration files from <a href = "https://github.com/japaric/rust-everywhere">rust-everywhere</a> to use <a href = "https://travis-ci.org/">Travis</a> and <a href = "http://www.appveyor.com/">Appveyor</a> to generate binaries for various platforms on each release.</p>
|
||||
|
|
@ -344,8 +294,8 @@ title: My title
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-295">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.10.5-pre</p>
|
||||
<footer id = "footer"><p id = "para-295">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.0-pre</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -38,25 +38,25 @@ function toggle() {
|
|||
if (display_menu == true) {
|
||||
display_menu = false;
|
||||
document.getElementById("nav").style.left = "-21%";
|
||||
document.getElementById("content").style.marginLeft = "10%";
|
||||
document.getElementById("content").style.marginLeft = "0%";
|
||||
document.getElementById("menu").style.left = "1em";
|
||||
if(document.getElementById("top")) {
|
||||
/* 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("content").style.marginLeft = "20%";
|
||||
document.getElementById("menu").style.left = "20%";
|
||||
if(document.getElementById("top")) {
|
||||
/* if(document.getElementById("top")) {
|
||||
document.getElementById("top").style.left = "20%";
|
||||
}
|
||||
if(document.getElementById("footer")) {
|
||||
document.getElementById("footer").style.marginLeft = "20%";
|
||||
}
|
||||
}*/
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -69,159 +69,108 @@ function toggle() {
|
|||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-2">1.1. Example</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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 (<code>crowbook --single</code>)</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-40">3.3. Crowbook options</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-68">4. Templates</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_003.html#link-69">4.1. Create and edit template</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-73">4.2. List of templates</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-88">4.3. List of accessible variables</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-92">5. Proofreading with Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_004.html#link-93">5.1. Enabling proofreading</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-94">5.2. Repetition detection</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-95">5.3. Grammar checking</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-96">5.4. Highlighting non-breaking spaces</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-97">6. Tips and tricks</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_005.html#link-98">6.1. Using Crowbook with Emacs’ markdown mode</a>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-101">6.2. Embedding fonts in an EPUB file</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-102">7. Contributing</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_006.html#link-103">7.1. Internationalization</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-104">ChangeLog</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_007.html#link-105">unreleased</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-106">0.10.4 (2016-12-16)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-107">0.10.3 (2016-11-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.2 (2016-10-21)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.1 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.0 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-111">0.9.1 (2016-09-29)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-112">0.9.0 (2016-09-23)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-113">0.8.0 (2016-09-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-114">0.7.0 (2016-09-11)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-115">0.6.0 (2016-09-09)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-116">0.5.1 (2016-04-14)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-117">0.5.0 (2016-04-02)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-118">0.4.0 (2016-03-01)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">0.3.0 (2016-02-27)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-120">0.2.2 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-121">0.2.1 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.0 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-123">0.1.0 (2016-02-21)</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-124">GNU LESSER GENERAL PUBLIC LICENSE</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_002.html#link-55">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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>
|
||||
<li><a href = "chapter_004.html#link-98">5.4. Highlighting non-breaking spaces</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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">0.11.0 (???)</a></li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_007.html#link-111">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-112">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-113">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_007.html#link-114">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_007.html#link-115">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-116">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_007.html#link-117">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_007.html#link-118">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_007.html#link-119">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_007.html#link-120">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_007.html#link-121">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-123">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-124">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-125">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-126">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-298">Crowbook User Guide 0.11.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
<div id = "top"><p id = "para-298">Crowbook User Guide 0.10.5</p>
|
||||
</div>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<p class = "prev_chapter">
|
||||
<a href = "chapter_000.html">
|
||||
« 1. Crowbook
|
||||
|
|
@ -253,19 +202,15 @@ OPTIONS:
|
|||
ARGS:
|
||||
<BOOK> File containing the book configuration file, or a Markdown file when called with --single
|
||||
</code></pre>
|
||||
<p id = "para-45">Note that Crowbook generates output files relatively to the directory where <BOOK> is:</p>
|
||||
<pre><code class = "language-bash">$ crowbook foo/bar.book --to pdf --output baz.pdf
|
||||
</code></pre>
|
||||
<p id = "para-46">will thus generate “baz.pdf” in directory “foo” and not in the current directory.</p>
|
||||
<p id = "para-47">The most important option is obviously <BOOK>, i.e. the book configuration file. It is mandatory in most cases: if you don’t pass it, Crowbook will simply display this help message. In a normal use case this is the only argument you’ll need to pass, and Crowbook will generate the book in all formats specified in the configuration file.</p>
|
||||
<p id = "para-48">It is, however, possible to pass more arguments to <code>crowbook</code>:</p>
|
||||
<p id = "para-45">The most important option is obviously <BOOK>, i.e. the book configuration file. It is mandatory in most cases: if you don’t pass it, Crowbook will simply display this help message. In a normal use case this is the only argument you’ll need to pass, and Crowbook will generate the book in all formats specified in the configuration file.</p>
|
||||
<p id = "para-46">It is, however, possible to pass more arguments to <code>crowbook</code>:</p>
|
||||
<h2 id = "link-23">2.1. <code>--create</code></h2>
|
||||
<p id = "para-49"><b>Usage</b>: <code>crowbook [BOOK] --create file_1.md file_2.md ...</code></p>
|
||||
<p id = "para-50">Creates a new book from a list of Markdown files. It will generate a book configuration file with all file names specified as chapters. It either prints the result to stdout (if <code>BOOK</code> is not specified) or generate the file <code>BOOK</code> (or abort if it already exists).</p>
|
||||
<p id = "para-47"><b>Usage</b>: <code>crowbook [BOOK] --create file_1.md file_2.md ...</code></p>
|
||||
<p id = "para-48">Creates a new book from a list of Markdown files. It will generate a book configuration file with all file names specified as chapters. It either prints the result to stdout (if <code>BOOK</code> is not specified) or generate the file <code>BOOK</code> (or abort if it already exists).</p>
|
||||
<h3 id = "link-24">Examples</h3>
|
||||
<pre><code class = "language-bash">crowbook foo.book --create README.md ChangeLog.md LICENSE.md
|
||||
</code></pre>
|
||||
<p id = "para-51">will generate a file <code>foo.book</code> containing:</p>
|
||||
<p id = "para-49">will generate a file <code>foo.book</code> containing:</p>
|
||||
<pre><code class = "language-yaml">author: Your name
|
||||
title: Your title
|
||||
lang: en
|
||||
|
|
@ -283,14 +228,14 @@ lang: en
|
|||
+ ChangeLog.md
|
||||
+ LICENSE.md
|
||||
</code></pre>
|
||||
<p id = "para-52">while</p>
|
||||
<p id = "para-50">while</p>
|
||||
<pre><code class = "language-bash">crowbook --create README.md ChangeLog.md LICENSE.md
|
||||
</code></pre>
|
||||
<p id = "para-53">will print the same result, but to stdout (without creating a file).</p>
|
||||
<p id = "para-54">When <code>crowbook</code> is runned with <code>--create</code>, it can also use the keys/values set by <code>--set</code> (see below):</p>
|
||||
<p id = "para-51">will print the same result, but to stdout (without creating a file).</p>
|
||||
<p id = "para-52">When <code>crowbook</code> is run with <code>--create</code>, it can also use the keys/values set by <code>--set</code> (see below):</p>
|
||||
<pre><code class = "language-bash">$ crowbook foo.book --create file1.md file2.md --set author "Pierre Dupont" title "Mon œuvre" lang fr
|
||||
</code></pre>
|
||||
<p id = "para-55">will generate a <code>foo.book</code> file containing:</p>
|
||||
<p id = "para-53">will generate a <code>foo.book</code> file containing:</p>
|
||||
<pre><code class = "language-yaml">author: Pierre Dupont
|
||||
title: Mon œuvre
|
||||
lang: fr
|
||||
|
|
@ -300,33 +245,35 @@ lang: fr
|
|||
+ file2.md
|
||||
</code></pre>
|
||||
<h2 id = "link-25">2.2. <code>--single</code></h2>
|
||||
<p id = "para-56"><b>usage</b>: <code>crowbook --single <FILE></code></p>
|
||||
<p id = "para-57">(or <code>crowbook -s <FILE></code>)</p>
|
||||
<p id = "para-58">This argument allows to give <code>crowbook</code> a single Markdown file. This file can contain an inline YAML block to set some book options. Inline YAML blocks must start and end with a line with <code>---</code> (three dashes). E.g:</p>
|
||||
<p id = "para-54"><b>usage</b>: <code>crowbook --single <FILE></code></p>
|
||||
<p id = "para-55">(or <code>crowbook -s <FILE></code>)</p>
|
||||
<p id = "para-56">This argument allows to give <code>crowbook</code> a single Markdown file. This file can contain an inline YAML block to set some book options. Inline YAML blocks must start and end with a line containing only <code>---</code> (three dashes). E.g:</p>
|
||||
<pre><code class = "language-yaml">---
|
||||
author: Joan Doe
|
||||
title: A short story
|
||||
output.html: short.html
|
||||
---
|
||||
</code></pre>
|
||||
<p id = "para-59">If this YAML block is not at the beginning of a file, it must also be preceded by a blank line.</p>
|
||||
<p id = "para-60">This allows to not have to write a <code>.book</code> configuration file for a short story or an article. <code>crowbook --single foo.md</code> is rougly equivalent to having a book configuration file containing:</p>
|
||||
<p id = "para-57">If this YAML block is not at the beginning of a file, it must also be preceded by a blank line.</p>
|
||||
<p id = "para-58">This allows to not have to write a <code>.book</code> configuration file for a short story or an article. <code>crowbook -s foo.md</code> is rougly equivalent to having a book configuration file containing:</p>
|
||||
<pre><code class = "language-yaml">! foo.md
|
||||
</code></pre>
|
||||
<p id = "para-61">That is, the chapter heading (if any) won’t be displayed in the output documents (though they still appear in the TOC).</p>
|
||||
<blockquote><p id = "para-62">Note that by default, using <code>--single</code> sets the default LaTeX class of the book to <code>article</code> instead of <code>book</code>.</p>
|
||||
<p id = "para-59">That is, the chapter heading (if any) won’t be displayed in the output documents (though they still appear in the TOC).</p>
|
||||
<blockquote><p id = "para-60">Note that by default, using <code>--single</code> or <code>-s</code> sets the default LaTeX class of the book to <code>article</code> instead of <code>book</code>.</p>
|
||||
</blockquote>
|
||||
<h2 id = "link-26">2.3. <code>--set</code></h2>
|
||||
<p id = "para-63"><b>usage</b>: <code>crowbook <BOOK> --set [KEY] [VALUE]...</code></p>
|
||||
<p id = "para-64">This argument takes a list of <code>KEY</code> <code>VALUE</code> pairs and allows setting or overriding a book configuration option. All valid options in the configuration files are valid as keys. For more information, see <a href = "chapter_002.html">the configuration file</a>.</p>
|
||||
<p id = "para-61"><b>usage</b>: <code>crowbook <BOOK> --set [KEY] [VALUE]...</code></p>
|
||||
<p id = "para-62">This argument takes a list of <code>KEY</code> <code>VALUE</code> pairs and allows setting or overriding a book configuration option. All valid options in the configuration files are valid as keys. For more information, see <a href = "chapter_002.html">the configuration file</a>.</p>
|
||||
<h3 id = "link-27">Examples</h3>
|
||||
<pre><code class = "language-bash">$ crowbook foo.book --set html.css style.css
|
||||
</code></pre>
|
||||
<p id = "para-65">will override the CSS for HTML generation (the <code>html.css</code> key) to the file <code>style.css</code>.</p>
|
||||
<p id = "para-63">will override the CSS for HTML generation (the <code>html.css</code> key) to the file <code>style.css</code>.</p>
|
||||
<pre><code class = "language-bash">$ crowbook foo.book --set author Foo title Bar
|
||||
</code></pre>
|
||||
<p id = "para-66">will override the book title to <code>Bar</code> and its author to <code>Foo</code>.</p>
|
||||
<p id = "para-64">will override the book title to <code>Bar</code> and its author to <code>Foo</code>.</p>
|
||||
<h2 id = "link-28">2.4. <code>--proofread</code></h2>
|
||||
<p id = "para-65"><b>usage</b>: <code>crowbook --proofread <BOOK></code></p>
|
||||
<p id = "para-66">(or <code>crowbook -p <BOOK></code>)</p>
|
||||
<p id = "para-67">Equivalent to <code>--set proofread true</code>. Enable proofreading. See <a href = "chapter_004.html">Proofreading</a>.</p>
|
||||
<h2 id = "link-29">2.5. <code>--list-options</code></h2>
|
||||
<p id = "para-68"><b>usage</b>: <code>crowbook --list-options</code></p>
|
||||
|
|
@ -340,43 +287,33 @@ output.html: short.html
|
|||
$ crowbook my.book --set html.css my_style.css
|
||||
# or add "html.css: my_style.css" in my.book
|
||||
</code></pre>
|
||||
<p id = "para-73">Note that it is possible to use this option in conjonction with <code>--set</code>, though it is currently only useful for EPUB template:</p>
|
||||
<pre><code class = "language-bash">$ crowbook --print-template epub.template --set epub.version 2
|
||||
# Returns the template for Epub 2 (currently it is the default one)
|
||||
$ crowbook --print-template epub.template --set epub.version 3
|
||||
# Returns the template for Epub 3
|
||||
</code></pre>
|
||||
<h2 id = "link-31">2.7. <code>--verbose</code></h2>
|
||||
<p id = "para-74"><b>usage</b>: <code>crowbook <BOOK> --verbose</code></p>
|
||||
<p id = "para-75">If this flag is set, Crowbook will print the warnings it detects while parsing and rendering. These warnings are typically related to the inclusion of non-local images, linking to Markdown files that are not part of the book, and so on.</p>
|
||||
<p id = "para-73"><b>usage</b>: <code>crowbook <BOOK> --verbose</code></p>
|
||||
<p id = "para-74">If this flag is set, Crowbook will print the warnings it detects while parsing and rendering. These warnings are typically related to the inclusion of non-local images, linking to Markdown files that are not part of the book, and so on.</p>
|
||||
<h2 id = "link-32">2.8. <code>--to</code></h2>
|
||||
<p id = "para-76"><b>usage</b>: <code>crowbook <BOOK>--to [FORMAT]</code></p>
|
||||
<p id = "para-77">(or <code>crowbook <BOOK> -t [FORMAT]</code>)</p>
|
||||
<p id = "para-78">Generate only the specified format. <code>FORMAT</code> must be either <code>epub</code>, <code>pdf</code>, <code>html</code>, <code>odt</code> or <code>tex</code>.</p>
|
||||
<p id = "para-79">If an output file for the format is not specified in the book configuration file, <code>crowbook</code> will fail to render PDF, ODT and EPUB, whereas it will print HTML and TeX files on stdout. It is, however, possible to specify a file with the <code>--output</code> option.</p>
|
||||
<p id = "para-75"><b>usage</b>: <code>crowbook <BOOK>--to [FORMAT]</code></p>
|
||||
<p id = "para-76">(or <code>crowbook <BOOK> -t [FORMAT]</code>)</p>
|
||||
<p id = "para-77">Generate only the specified format. <code>FORMAT</code> must be either <code>epub</code>, <code>pdf</code>, <code>html</code>, <code>html.dir</code>, <code>odt</code> or <code>tex</code>.</p>
|
||||
<p id = "para-78">If an output file for the format is not specified in the book configuration file, <code>crowbook</code> will fail to render PDF, ODT and EPUB, whereas it will print HTML and TeX files on stdout. It is, however, possible to specify a file with the <code>--output</code> option.</p>
|
||||
<h3 id = "link-33">Examples</h3>
|
||||
<pre><code class = "language-bash">crowbook --to html foo.book
|
||||
</code></pre>
|
||||
<p id = "para-80">will generate some HTML, and prints it either to the file specified by <code>output.html</code> in <code>foo.book</code>, or to stdout if it is not specified.</p>
|
||||
<p id = "para-79">will generate some HTML, and prints it either to the file specified by <code>output.html</code> in <code>foo.book</code>, or to stdout if it is not specified.</p>
|
||||
<pre><code class = "language-bash">crowbook --to pdf --output foo.pdf foo.book
|
||||
</code></pre>
|
||||
<p id = "para-81">will generate a <code>foo.pdf</code> file.</p>
|
||||
<p id = "para-80">will generate a <code>foo.pdf</code> file.</p>
|
||||
<h2 id = "link-34">2.9. <code>--output</code></h2>
|
||||
<p id = "para-82"><b>usage</b>: <code>crowbook <BOOK> --to <FORMAT> --output <FILE></code></p>
|
||||
<p id = "para-83">(or <code>crowbook -t <FORMAT> -o <FILE> <BOOK></code>)</p>
|
||||
<p id = "para-84">Specifies an output file. Only valid when <code>--to</code> is used.</p>
|
||||
<p id = "para-85">Note that Crowbook generates output files relatively to the directory where <code>BOOK</code> is (unless the option <code>output.base_path</code> is set):</p>
|
||||
<pre><code class = "language-bash">$ crowbook foo/bar.book --to pdf --output baz.pdf
|
||||
</code></pre>
|
||||
<p id = "para-86">will thus generate <code>baz.pdf</code> in directory <code>foo</code> and not in current directory.</p>
|
||||
<p id = "para-81"><b>usage</b>: <code>crowbook <BOOK> --to <FORMAT> --output <FILE></code></p>
|
||||
<p id = "para-82">(or <code>crowbook -t <FORMAT> -o <FILE> <BOOK></code>)</p>
|
||||
<p id = "para-83">Specifies an output file. Only valid when <code>--to</code> is used.</p>
|
||||
<h2 id = "link-35">2.10. <code>--lang</code></h2>
|
||||
<p id = "para-87"><b>usage</b>: <code>crowbook --lang <LANG></code></p>
|
||||
<p id = "para-88">(or <code>crowbook -L <LANG></code>)</p>
|
||||
<p id = "para-89">Set the runtime language used by Crowbook. Currently, only a french translation is available. By default, Crowbook uses the <code>LANG</code> environment variable to determine which language to use, but this option allows to override it (e.g. for operating systems that don’t use such an option, such as Windows).</p>
|
||||
<p id = "para-84"><b>usage</b>: <code>crowbook --lang <LANG></code></p>
|
||||
<p id = "para-85">(or <code>crowbook -L <LANG></code>)</p>
|
||||
<p id = "para-86">Set the runtime language used by Crowbook. Currently, only a french translation is available. By default, Crowbook uses the <code>LANG</code> environment variable to determine which language to use, but this option allows to override it (e.g. for operating systems that don’t use such an option, such as Windows).</p>
|
||||
<h3 id = "link-36">Example</h3>
|
||||
<p id = "para-90"><code>$ crowbook --lang fr --help</code></p>
|
||||
<p id = "para-91">will display Crowbook’s help messages in french.</p>
|
||||
<blockquote><p id = "para-92">Note that this argument has nothing to do with the <code>lang</code> option that you can set in the book configuration file, which specifies the language <em>of the book</em>. This argument specifies the language of the text messages that Crowbook will display while running.</p>
|
||||
<p id = "para-87"><code>$ crowbook --lang fr --help</code></p>
|
||||
<p id = "para-88">will display Crowbook’s help messages in french.</p>
|
||||
<blockquote><p id = "para-89">Note that this argument has nothing to do with the <code>lang</code> option that you can set in the book configuration file, which specifies the language <em>of the book</em>. This argument specifies the language of the text messages that Crowbook will display while running.</p>
|
||||
</blockquote>
|
||||
|
||||
<p class = "next_chapter">
|
||||
|
|
@ -385,8 +322,8 @@ $ crowbook --print-template epub.template --set epub.version 3
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-297">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.10.5-pre</p>
|
||||
<footer id = "footer"><p id = "para-297">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.0-pre</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -38,25 +38,25 @@ function toggle() {
|
|||
if (display_menu == true) {
|
||||
display_menu = false;
|
||||
document.getElementById("nav").style.left = "-21%";
|
||||
document.getElementById("content").style.marginLeft = "10%";
|
||||
document.getElementById("content").style.marginLeft = "0%";
|
||||
document.getElementById("menu").style.left = "1em";
|
||||
if(document.getElementById("top")) {
|
||||
/* 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("content").style.marginLeft = "20%";
|
||||
document.getElementById("menu").style.left = "20%";
|
||||
if(document.getElementById("top")) {
|
||||
/* if(document.getElementById("top")) {
|
||||
document.getElementById("top").style.left = "20%";
|
||||
}
|
||||
if(document.getElementById("footer")) {
|
||||
document.getElementById("footer").style.marginLeft = "20%";
|
||||
}
|
||||
}*/
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -69,167 +69,116 @@ function toggle() {
|
|||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-2">1.1. Example</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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 (<code>crowbook --single</code>)</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-40">3.3. Crowbook options</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-68">4. Templates</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_003.html#link-69">4.1. Create and edit template</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-73">4.2. List of templates</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-88">4.3. List of accessible variables</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-92">5. Proofreading with Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_004.html#link-93">5.1. Enabling proofreading</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-94">5.2. Repetition detection</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-95">5.3. Grammar checking</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-96">5.4. Highlighting non-breaking spaces</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-97">6. Tips and tricks</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_005.html#link-98">6.1. Using Crowbook with Emacs’ markdown mode</a>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-101">6.2. Embedding fonts in an EPUB file</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-102">7. Contributing</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_006.html#link-103">7.1. Internationalization</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-104">ChangeLog</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_007.html#link-105">unreleased</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-106">0.10.4 (2016-12-16)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-107">0.10.3 (2016-11-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.2 (2016-10-21)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.1 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.0 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-111">0.9.1 (2016-09-29)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-112">0.9.0 (2016-09-23)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-113">0.8.0 (2016-09-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-114">0.7.0 (2016-09-11)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-115">0.6.0 (2016-09-09)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-116">0.5.1 (2016-04-14)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-117">0.5.0 (2016-04-02)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-118">0.4.0 (2016-03-01)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">0.3.0 (2016-02-27)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-120">0.2.2 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-121">0.2.1 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.0 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-123">0.1.0 (2016-02-21)</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-124">GNU LESSER GENERAL PUBLIC LICENSE</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_002.html#link-55">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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>
|
||||
<li><a href = "chapter_004.html#link-98">5.4. Highlighting non-breaking spaces</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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">0.11.0 (???)</a></li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_007.html#link-111">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-112">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-113">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_007.html#link-114">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_007.html#link-115">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-116">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_007.html#link-117">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_007.html#link-118">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_007.html#link-119">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_007.html#link-120">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_007.html#link-121">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-123">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-124">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-125">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-126">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-300">Crowbook User Guide 0.11.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
<div id = "top"><p id = "para-300">Crowbook User Guide 0.10.5</p>
|
||||
</div>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<p class = "prev_chapter">
|
||||
<a href = "chapter_001.html">
|
||||
« 2. Arguments
|
||||
</a>
|
||||
</p>
|
||||
<h1 id = "link-37">3. The configuration file</h1>
|
||||
<p id = "para-93">If you want to use Crowbook for your book, this configuration file is all you’ll have to add (assuming you already have the book in Markdown files; if you don’t, you’ll also have to write a book first, but that’s besides the scope of this document).</p>
|
||||
<p id = "para-94">The format is not very complicated. This is an example of it:</p>
|
||||
<p id = "para-90">If you want to use Crowbook for your book, this configuration file is all you’ll have to add (assuming you already have the book in Markdown files; if you don’t, you’ll also have to write a book first, but that’s 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><code class = "language-yaml"># metadata
|
||||
author: Joan Doe
|
||||
title: Some book
|
||||
|
|
@ -245,14 +194,14 @@ output.html: some_book.html
|
|||
+ chapter_4.md
|
||||
- epilogue.md
|
||||
</code></pre>
|
||||
<p id = "para-95">Basically, it is divided in two parts:</p>
|
||||
<p id = "para-92">Basically, it is divided in two parts:</p>
|
||||
<ul>
|
||||
<li>a list of options, under the form <code>key: value</code>, following YAML syntax.</li>
|
||||
<li>a list of Markdown files.</li>
|
||||
</ul>
|
||||
<p id = "para-96">Lines starting with the <code>#</code> characters are comments and are discarded.</p>
|
||||
<h2 id = "link-38">3.1. Configuration in an inline YAML block (<code>crowbook --single</code>)</h2>
|
||||
<p id = "para-97">Sometimes, you only have one Markdown file and might not want to have a separate configuration file. In this case, you can specify options at the beginning of your Markdown file, using an inline YAML block, separated by two lines containing only <code>---</code>:</p>
|
||||
<p id = "para-93">Lines starting with the <code>#</code> characters are comments and are discarded.</p>
|
||||
<h2 id = "link-38">3.1. Configuration in an inline YAML block</h2>
|
||||
<p id = "para-94">Sometimes, you only have one Markdown file and might not want to have a separate configuration file. In this case, you can specify options at the beginning of your Markdown file, using an inline YAML block, separated by two lines containing only <code>---</code>:</p>
|
||||
<pre><code class = "language-markdown">---
|
||||
author: Joan Doe
|
||||
title: Some (short) book
|
||||
|
|
@ -265,22 +214,23 @@ output.html: some_book.html
|
|||
|
||||
The book content, formatted in Markdown.
|
||||
</code></pre>
|
||||
<p id = "para-98">This method only allows to set up options: you can’t include a list of chapters in this way, since the only “chapter” that will be included is this Markdown file itself.</p>
|
||||
<p id = "para-99">You can then use</p>
|
||||
<pre><code class = "language-bash">crowbook --single some_book.md
|
||||
<p id = "para-95">This method only allows to set up options: you can’t include a list of chapters in this way, since the only “chapter” that will be included is this Markdown file itself.</p>
|
||||
<p id = "para-96">You can then use</p>
|
||||
<pre><code class = "language-bash">crowbook -s some_book.md
|
||||
</code></pre>
|
||||
<p id = "para-100">to generate output formats from this Markdown file.</p>
|
||||
<blockquote><p id = "para-101">By default (unless <code>input.yaml_blocks</code> is set to true), Crowboook will only read those inline blocks when it is runned with <code>crowbook --single</code> (or <code>crowbook -s</code>).</p>
|
||||
<p id = "para-97">to generate output formats from this Markdown file.</p>
|
||||
<blockquote><p id = "para-98">By default (unless <code>input.yaml_blocks</code> is set to true), Crowboook will only read those inline blocks when it is runned with <code>crowbook --single</code> (or <code>crowbook -s</code>).</p>
|
||||
</blockquote>
|
||||
<h2 id = "link-39">3.2. The list of files</h2>
|
||||
<p id = "para-102">There are various options to include a Markdown file.</p>
|
||||
<p id = "para-99">There are various options to include a Markdown file.</p>
|
||||
<ul>
|
||||
<li><code>+ file_name.md</code> includes a numbered chapter.</li>
|
||||
<li><code>- file_name.md</code> includes an unnumbered chapter.</li>
|
||||
<li><code>! file_name.md</code> includes a chapter whose title won’t be displayed (except in the table of contents); this is useful for e.g. including a copyright at the beginning or the book, or for short stories where there is only one chapter.</li>
|
||||
<li><code>42. file_name.md</code> specifies the number for a chapter.</li>
|
||||
<li><code>@</code> includes a part instead of a chapter.</li>
|
||||
</ul>
|
||||
<p id = "para-103">So a typical usage might look like this:</p>
|
||||
<p id = "para-100">So a typical usage might look like this:</p>
|
||||
<pre><code class = "language-yaml">! copyright.md
|
||||
- preface.md
|
||||
0. chapter_0.md # We want to start at chapter 0 instead of 1
|
||||
|
|
@ -289,45 +239,215 @@ The book content, formatted in Markdown.
|
|||
+ chapter_2.md
|
||||
...
|
||||
</code></pre>
|
||||
<p id = "para-104">There are two important things to note:</p>
|
||||
<p id = "para-101">There are two important things to note:</p>
|
||||
<ol>
|
||||
<li>you must <em>not</em> use quotes around the file names.</li>
|
||||
<li>the path of these files are relative to the directory where your configuration file is. This means you can run <code>crowbook books/my_trilogy/first_book/config.book</code> without being in the book’s directory.</li>
|
||||
</ol>
|
||||
<p id = "para-105">Also note that you don’t have to specify a title. This is because the title of the chapter is inferred from the Markdown document. To go back to our previous example:</p>
|
||||
<p id = "para-102">Also note that you don’t have to specify a title. This is because the title of the chapter is inferred from the Markdown document. To go back to our previous example:</p>
|
||||
<pre><code>+ chapter_1.md
|
||||
</code></pre>
|
||||
<p id = "para-106">does not specify a chapter title, because it will read it directly in <code>chapter_1.md</code>, e.g.:</p>
|
||||
<pre><code class = "language-markdown">The day I was born
|
||||
==================
|
||||
|
||||
<p id = "para-103">does not specify a chapter title, because it will read it directly in <code>chapter_1.md</code>, e.g.:</p>
|
||||
<pre><code class = "language-markdown"># The day I was born #
|
||||
...
|
||||
</code></pre>
|
||||
<p id = "para-107">You should have one and only one level-one header (i.e. chapter title) in each markdown file.</p>
|
||||
<p id = "para-108">If you have more than one, Crowbook will print a warning and treat it as another chapter (numbered according to the scheme specified for including the file). It might however mess the table of contents in some cases (e.g. for Epub).</p>
|
||||
<p id = "para-109">If you do <em>not</em> have a level-1 header in a markdown file:</p>
|
||||
<p id = "para-104">You should have one and only one level-one header (i.e. chapter title) in each Markdown file.</p>
|
||||
<p id = "para-105">If you have more than one, Crowbook will print a warning and treat it as another chapter (numbered according to the scheme specified for including the file). It might however mess the table of contents in some cases (e.g. for EPUB).</p>
|
||||
<p id = "para-106">If you do <em>not</em> have a level-1 header in a markdown file:</p>
|
||||
<ul>
|
||||
<li>if it is a numbered chapter, Crowbook will infer a chapter name from the numbering scheme;</li>
|
||||
<li>if it is not numbered, chapter’s title will default to the empty string and won’t be displayed in the TOC.</li>
|
||||
<li>if it is not numbered, chapter’s title will default to the empty string.</li>
|
||||
</ul>
|
||||
<h2 id = "link-40">3.3. Crowbook options</h2>
|
||||
<p id = "para-110">The first part of the configuration file is dedicated to pass options to Crowbook. This is <a href = "https://en.wikipedia.org/wiki/YAML">YAML syntax</a>, so each line should be of the form <code>key: value</code>. Note that in most cases you don’t have to put string in quotes, e.g.:</p>
|
||||
<h3 id = "link-40">Parts</h3>
|
||||
<p id = "para-107">Parts are included using the <code>@</code> character, followed by the same characters than for chapters:</p>
|
||||
<pre><code>@+ numbered_part.md
|
||||
+ chapter_01.md
|
||||
+ chapter_02.md
|
||||
@- unnumbered_part.md
|
||||
+ chapter_03.md
|
||||
+ chapter_04.md
|
||||
@42. part_with_number_42.md
|
||||
+ chapter_05.md
|
||||
</code></pre>
|
||||
<p id = "para-108">However, you usually don’t really want to have a content directly below the part, only chapters (though it can be useful to add an introduction before the first chapter of this part), so there is also a more straighforward way to use parts, using only the <code>@</code> character followed by the (markdown-formatted) title of this part:</p>
|
||||
<pre><code>@ Beginning
|
||||
+ chapter_01.md
|
||||
+ chapter_02.md
|
||||
@ Middle
|
||||
+ chapter_03.md
|
||||
+ chapter_04.md
|
||||
@ Appendix
|
||||
- notes.md
|
||||
</code></pre>
|
||||
<p id = "para-109">With this shortcut, parts are always numbered. So</p>
|
||||
<pre><code>@ Beginning
|
||||
</code></pre>
|
||||
<p id = "para-110">is equivalent to</p>
|
||||
<pre><code>@+ some_file.md
|
||||
</code></pre>
|
||||
<p id = "para-111">with <code>some_file.md</code> containing only a title:</p>
|
||||
<pre><code class = "language-markdown"># Beginning
|
||||
</code></pre>
|
||||
<h2 id = "link-41">3.3. Crowbook options</h2>
|
||||
<p id = "para-112">The first part of the configuration file is dedicated to pass options to Crowbook. This is <a href = "https://en.wikipedia.org/wiki/YAML">YAML syntax</a>, so each line should be of the form <code>key: value</code>. Note that in most cases you don’t have to put string in quotes, e.g.:</p>
|
||||
<pre><code class = "language-yaml">title: My title
|
||||
</code></pre>
|
||||
<p id = "para-111">It is however possible (and sometimes necessary) to escape some characters to use quotes around strings:</p>
|
||||
<p id = "para-113">It is however possible (and sometimes necessary) to escape some characters to use quotes around strings:</p>
|
||||
<pre><code class = "language-yaml">title: "My: title!"
|
||||
</code></pre>
|
||||
<p id = "para-112">It is possible to use multiline strings with <code>>-</code> and then indenting the lines that are part of the string:</p>
|
||||
<p id = "para-114">It is possible to use multiline strings with <code>>-</code> and then indenting the lines that are part of the string:</p>
|
||||
<pre><code class = "language-yaml">title: >-
|
||||
A
|
||||
long
|
||||
title
|
||||
author: Joan Doe
|
||||
</code></pre>
|
||||
<p id = "para-113">will set <code>title</code> to <code>“A long title”</code>. See <a href = "https://en.wikipedia.org/wiki/YAML#Block_literals">block literals in YAML</a> for more information on the various way to insert multiline strings (which mostly change the way newlines will or won’t be inserted).</p>
|
||||
<p id = "para-114">A final note on the syntax: all options must be set <em>before</em> the first chapter inclusion (that is, a line beginning with ‘+’, ‘-’, ‘x.’ (where <code>x</code> is a number) or ‘!’).</p>
|
||||
<p id = "para-115">Here is the complete list of options, with a short description. The usage of some of them is detailed later on.</p>
|
||||
<h3 id = "link-41">Metadata</h3>
|
||||
<p id = "para-115">will set <code>title</code> to <code>“A long title”</code>. See <a href = "https://en.wikipedia.org/wiki/YAML#Block_literals">block literals in YAML</a> for more information on the various way to insert multiline strings (which mostly change the way newlines will or won’t be inserted).</p>
|
||||
<p id = "para-116">A final note on the syntax: all options must be set <em>before</em> the first chapter inclusion (that is, a line beginning with ‘+’, ‘-’, ‘x.’ (where <code>x</code> is a number) or ‘!’).</p>
|
||||
<h3 id = "link-42">Metadata</h3>
|
||||
<p id = "para-117">Metadata are data about the book. Except for <code>cover</code>, which points to an image file, all its fields are strings. The main metadata are:</p>
|
||||
<ul>
|
||||
<li><code>author</code>: the author(s) of the book.</li>
|
||||
<li><code>title</code>: the title of the book.</li>
|
||||
<li><code>lang</code>: the language of the book. The unicode language code should be used, e.g. <code>en_GB</code> or <code>en</code>, <code>fr_FR</code>, ...</li>
|
||||
<li><code>cover</code>: path to an image file for the cover of the book (not displayed in all output formats).</li>
|
||||
</ul>
|
||||
<p id = "para-118">There are also additional metadata:</p>
|
||||
<ul>
|
||||
<li><code>subject</code></li>
|
||||
<li><code>description</code></li>
|
||||
<li><code>license</code></li>
|
||||
<li><code>version</code></li>
|
||||
<li><code>date</code></li>
|
||||
</ul>
|
||||
<p id = "para-119">You can define your own metadata by starting an option name with <code>metadata.foo</code>.</p>
|
||||
<p id = "para-120">All metadata are accessible from templates, see <a href = "chapter_003.html">Templates</a>.</p>
|
||||
<h3 id = "link-43">The <code>import</code> special option</h3>
|
||||
<p id = "para-121">The special <code>import</code> option allows you to include the options of another book configuration file. E.g., assuming that you want some common options to be applied to both <code>foo.book</code> and <code>bar.book</code>, you can create a <code>common.book</code> file:</p>
|
||||
<pre><code class = "language-yaml">author: Joan Doe
|
||||
lang: en
|
||||
license: "Copyright (C) Joan Doe. All rights reserved."
|
||||
|
||||
html.header: "[Joan Doe's website](http://joan-doe.com)"
|
||||
tex.template: my_template.tex
|
||||
</code></pre>
|
||||
<p id = "para-122">You can then include this file in <code>foo.book</code>:</p>
|
||||
<pre><code class = "language-yaml">import: common.book
|
||||
title: Foo
|
||||
|
||||
+ foo_01.md
|
||||
+ foo_02.md
|
||||
</code></pre>
|
||||
<p id = "para-123">Or include it in <code>bar.book</code>, but override some of its features:</p>
|
||||
<pre><code class = "language-yaml">import: common.book
|
||||
title: Bar
|
||||
license: CC-BY-SA # Override the license from common.book
|
||||
|
||||
+ bar_01.md
|
||||
</code></pre>
|
||||
<h3 id = "link-44">Output options</h3>
|
||||
<p id = "para-124">These options specify which files to generate.</p>
|
||||
<p id = "para-125">Note that all file paths are relative to the directory where the config file is, not to the one where you run <code>crowbook</code>. So if you set</p>
|
||||
<pre><code class = "language-yaml">output.epub: foo.epub
|
||||
</code></pre>
|
||||
<p id = "para-126">and runs</p>
|
||||
<pre><code class = "language-bash">$ crowbook some/dir/config.book
|
||||
</code></pre>
|
||||
<p id = "para-127"><code>foo.epub</code> will be generated in <code>some/dir</code>, not in your current directory.</p>
|
||||
<p id = "para-128">Crowbook will try to generate each of the <code>output.xxx</code> files that are specified. That means that you’ll have to set at least one of those if you want a call to</p>
|
||||
<pre><code class = "language-bash">$ crowbook my.book
|
||||
</code></pre>
|
||||
<p id = "para-129">to generate anything. (It’s still possible to generate a specific format, and only this one, by using the <code>--to</code> and <code>--output</code> argument on the command line).</p>
|
||||
<p id = "para-130">Note that some formats depend on some commands being installed on your system. Most notably, Crowbook depends on LaTeX (<code>xelatex</code> by default, though you can specify the command to use with <code>tex.command</code>) to generate a PDF file, so PDF rendering won’t work if it is not installed on your system. Crowbook also uses the <code>zip</code> command to generate the EPUB and ODT files.</p>
|
||||
<p id = "para-131">Current output options are:</p>
|
||||
<ul>
|
||||
<li><code>output.html</code>: renders a standalone HTML file.</li>
|
||||
<li><code>output.html.dir</code>: render a HTML directory with one page by chapter.</li>
|
||||
<li><code>output.epub</code>: renders an EPUB file.</li>
|
||||
<li><code>output.tex</code>: renders a LaTeX file.</li>
|
||||
<li><code>output.pdf</code>: renders a PDF file (using <code>tex.command</code>).</li>
|
||||
</ul>
|
||||
<p id = "para-132">(There are other output options for generating proofreading files, see <a href = "chapter_004.html">Proofreading</a>.)</p>
|
||||
<h4 id = "link-45"><code>output.base_path</code></h4>
|
||||
<p id = "para-133">Additionally, the <code>output.base_path</code> option allows you to set where the output files will be written (relatively to the book configuration file). E.g.,</p>
|
||||
<pre><code class = "language-yaml">output.base_path: docs/book
|
||||
output.epub: book.epub
|
||||
</code></pre>
|
||||
<p id = "para-134">will render the EPUB file in <code>docs/book/book.epub</code>.</p>
|
||||
<h3 id = "link-46">Input options</h3>
|
||||
<p id = "para-135">Crowbook does its best to improve the typography of your text. Default settings should be good enough for most usages, but you can enable/disable specific options:</p>
|
||||
<ul>
|
||||
<li><code>input.clean</code>: if set to <code>false</code>, will disable all typographic “cleaning” (default: <code>true</code>). The <code>clean</code> algorithm is dependent on the language, though currently there is only a variant implemented for <code>fr</code> (french), dealing with the specific non-breaking spaces rules for this language.</li>
|
||||
<li><code>input.clean.smart_quotes</code>: if set to <code>false</code>, disable the “smart quote” feature, that (tries to) replace straight quotes with curly ones. As it is an heuristics and can’t be perfect, you might want to disable it in some circumstances (default: <code>true</code>).</li>
|
||||
<li><code>input.clean.ligature_dashes</code>: if set to <code>true</code>, will convert <code>--</code> to en dash (<code>–</code>) and <code>---</code> to em dash (<code>—</code>). This can be useful if you want to use these characters but can’t access them easily on your keymap; however, as it can also cause problems if you <em>do</em> want to have two successive dashes, it is disabled by default.</li>
|
||||
<li><code>input.clean.ligature_guillemets</code> is a similar feature for french ‘guilemets’, replacing <code><<</code> and <code>>></code> to <code>«</code> and <code>»</code>. For the same reason, it is also disabled by default.</li>
|
||||
</ul>
|
||||
<h3 id = "link-47">Generic options for rendering</h3>
|
||||
<p id = "para-136">These options allow to configure the rendering; they are used (or at least should be) for all formats.</p>
|
||||
<ul>
|
||||
<li><code>rendering.num_depth</code>: an integer that represents the maximum level of numbering for your book. E.g., <code>1</code> will only number chapters, while <code>2</code> will number chapters, sections, but not anything below that. <code>6</code> is the maximum level and turns numbering on for all headers. (Default is <code>1</code>.)</li>
|
||||
<li><code>rendering.chapter.template</code> and <code>rendering.part.template</code>: the strings that will be used for chapter and part titles. It is possible to include Markdown formatting in this template, but it isn’t advised, because it might cause problems for some formats (e.g. your EPUB file might not be correct anymore).</li>
|
||||
<li><code>rendering.part.roman_numerals</code> and <code>rendering.chapter.roman_numerals</code>: these two booleans allow you to specify if you want roman numerals for part or chapter numbers (default is <code>true</code> for part numbers, and <code>false</code> for chapter numbers).</li>
|
||||
<li><code>rendering.inline_toc</code>: if set to true, Crowbook will include a table of contents at the beginning of the document.</li>
|
||||
<li><code>rendering.inline_toc.name</code>: the name of this table of contents as it should be displayed in the document.</li>
|
||||
<li><code>rendering.initials</code>: if set to true, Crowbook will use initials, or “lettrines”, displaying the first letter of each chapter bigger than the others.</li>
|
||||
<li><code>rendering.part.reset_counter</code>: set it to <code>false</code> if you don’t want your chapter numbers to start again at 1 at each part.</li>
|
||||
</ul>
|
||||
<h3 id = "link-48">HTML Options</h3>
|
||||
<p id = "para-137">These options allow you to customize the HTML rendering (used both by the default HTML standalone renderer and the HTML multifile renderer):</p>
|
||||
<ul>
|
||||
<li><code>html.icon</code>: allows to set a <code>favicon</code> for the page.</li>
|
||||
<li><code>html.header</code> and <code>html.footer</code> allow to set a custom (Markdown) string at the top and at the bottom of the HTML page. This is actually a template, so you can access metadata, such as <code>{{{author}}}</code>, <code>{{{title}}}</code>, or <code>{{{version}}}</code> in it. See the <a href = "chapter_003.html">template</a> chapter for more information on the fields you can use.</li>
|
||||
<li><code>html.css</code> allow to set up a custom CSS file. You can also redefine the colours in a file and set it using <code>html.css.colours</code>.</li>
|
||||
</ul>
|
||||
<h4 id = "link-49">Options for standalone HTML</h4>
|
||||
<p id = "para-138">There are a few options specific to the standalone HTML renderer (default, set with <code>output.html</code>):</p>
|
||||
<ul>
|
||||
<li><code>html.standalone.one_chapter</code>, if set to true, will only display one chapter at a time (using Javascript), making it look similarly to the multifile HTML.</li>
|
||||
<li><code>html.standalone.template</code> allows you to change or modify the HTML template for standalone HTML.</li>
|
||||
</ul>
|
||||
<h3 id = "link-50">Options for LaTeX/PDF rendering</h3>
|
||||
<p id = "para-139">These options allow you to customize the LaTeX renderer (and, thus, the generated PDF documents):</p>
|
||||
<ul>
|
||||
<li><code>tex.template</code> specifies a different LaTeX template.</li>
|
||||
<li><code>tex.class</code> changes the LaTeX class used.</li>
|
||||
<li><code>tex.paper_size</code> and <code>tex.font.size</code> (default <code>a5paper</code> and <code>10pt</code>) allows to modify the page and font size .</li>
|
||||
<li><code>tex.links_as_footnotes</code> can be set to <code>false</code> if you don’t want links to also appear as footnotes (which means losing them if it is actually printed).</li>
|
||||
</ul>
|
||||
<h3 id = "link-51">Options for EPUB rendering</h3>
|
||||
<p id = "para-140">There are also options specific to the EPUB format:</p>
|
||||
<ul>
|
||||
<li><code>epub.version</code> can be set to 2 or 3 (default 2).</li>
|
||||
<li><code>epub.css</code> can be useful if you want to specify a customized stylesheet.</li>
|
||||
</ul>
|
||||
<h3 id = "link-52">Resources options</h3>
|
||||
<p id = "para-141">These options allow to embed additional files for some formats (currently, only EPUB). This can be useful for embedding fonts.</p>
|
||||
<h4 id = "link-53">resources.files</h4>
|
||||
<p id = "para-142">A list of files or directories that should be added. It’s a whitespace-separated list, so it can be, e.g.:</p>
|
||||
<pre><code class = "language-yaml">resources.files: font1.otf font2.otf
|
||||
</code></pre>
|
||||
<p id = "para-143">It is also possible to specify a directory (or multiple directories). So if you have a <code>fonts</code> directories containing <code>font1.otf</code> and <code>font2.otf</code>,</p>
|
||||
<pre><code class = "language-yaml">resources.files: fonts
|
||||
</code></pre>
|
||||
<p id = "para-144">will be equivalent to:</p>
|
||||
<pre><code class = "language-yaml">resources.files: fonts/font1.otf fonts/font2.otf
|
||||
</code></pre>
|
||||
<p id = "para-145"><b>default</b>: not set</p>
|
||||
<h4 id = "link-54">resources.out_path</h4>
|
||||
<p id = "para-146">This option determine where (in which directory), <em>in the resulting document</em>, those files will be copied. The default is <code>data</code>, so by default the <code>resources.files</code> in the first example above will search <code>font1.otf</code> and <code>font2.otf</code> <em>in the same directory than the <code>.book</code> file</em>, and will copy them to <code>data/font1.otf</code> and <code>data/font2.otf</code> <em>in the EPUB file</em>. This is therefore this last path that you should use if you want to access those files e.g. in a custom CSS stylesheet.</p>
|
||||
<p id = "para-147">Note that if you pass directories to <code>resources.files</code>, the whole directory would be copied. So assuming <code>fonts/</code> contains <code>font1.otf</code> and <code>font2.otf</code></p>
|
||||
<pre><code class = "language-yaml">resources.files: fonts
|
||||
resources.path: data
|
||||
</code></pre>
|
||||
<p id = "para-148">will copy these two files to <code>data/fonts/font1.otf</code> and <code>data/fonts/font2.otf</code> (and not <code>data/font1.otf</code> and <code>data/font2.otf</code>).</p>
|
||||
<p id = "para-149">Similarly, the whole path of <code>resources.files</code> is copied, so</p>
|
||||
<pre><code class = "language-yaml">resources.files: fonts/font1.otf fonts/font2.otf
|
||||
</code></pre>
|
||||
<p id = "para-150">will yield the same result.</p>
|
||||
<p id = "para-151"><b>default</b>: <code>data</code></p>
|
||||
<h2 id = "link-55">3.4. Full list of options</h2>
|
||||
<p id = "para-152">Here is the complete list of options. You can always look at it by running <code>crowbook --list-options</code> or <code>crowbook -l</code>.</p>
|
||||
<h3 id = "link-56">Metadata</h3>
|
||||
<ul>
|
||||
<li><b><code>author</code></b><ul>
|
||||
<li><b>type</b>: metadata</li>
|
||||
|
|
@ -366,7 +486,7 @@ author: Joan Doe
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-42">Additional metadata</h3>
|
||||
<h3 id = "link-57">Additional metadata</h3>
|
||||
<ul>
|
||||
<li><b><code>license</code></b><ul>
|
||||
<li><b>type</b>: metadata</li>
|
||||
|
|
@ -387,7 +507,7 @@ author: Joan Doe
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-43">Output options</h3>
|
||||
<h3 id = "link-58">Output options</h3>
|
||||
<ul>
|
||||
<li><b><code>output.epub</code></b><ul>
|
||||
<li><b>type</b>: path</li>
|
||||
|
|
@ -401,7 +521,7 @@ author: Joan Doe
|
|||
<li>Output file name for HTML rendering</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b><code>output.html_dir</code></b><ul>
|
||||
<li><b><code>output.html.dir</code></b><ul>
|
||||
<li><b>type</b>: path</li>
|
||||
<li><b>default value</b>: <code>not set</code></li>
|
||||
<li>Output directory name for HTML rendering</li>
|
||||
|
|
@ -432,7 +552,7 @@ author: Joan Doe
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-44">Rendering options</h3>
|
||||
<h3 id = "link-59">Rendering options</h3>
|
||||
<ul>
|
||||
<li><b><code>rendering.initials</code></b><ul>
|
||||
<li><b>type</b>: boolean</li>
|
||||
|
|
@ -458,23 +578,47 @@ author: Joan Doe
|
|||
<li>The maximum heading levels that should be numbered (0: no numbering, 1: only chapters, ..., 6: all)</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b><code>rendering.chapter_template</code></b><ul>
|
||||
<li><b><code>rendering.chapter.template</code></b><ul>
|
||||
<li><b>type</b>: string</li>
|
||||
<li><b>default value</b>: <code>“{{{number}}}\\. {{{chapter_title}}}”</code></li>
|
||||
<li>Naming scheme of chapters</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b><code>rendering.chapter.roman_numerals</code></b><ul>
|
||||
<li><b>type</b>: boolean</li>
|
||||
<li><b>default value</b>: <code>false</code></li>
|
||||
<li>If set to true, display chapter number with roman numerals</li>
|
||||
</ul>
|
||||
<h3 id = "link-45">Special option</h3>
|
||||
</li>
|
||||
<li><b><code>rendering.part.template</code></b><ul>
|
||||
<li><b>type</b>: string</li>
|
||||
<li><b>default value</b>: <code>“{{{loc_part}}} {{{number}}}”</code></li>
|
||||
<li>Naming scheme of parts</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b><code>rendering.part.roman_numerals</code></b><ul>
|
||||
<li><b>type</b>: boolean</li>
|
||||
<li><b>default value</b>: <code>true</code></li>
|
||||
<li>If set to true, display part number with roman numerals</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b><code>rendering.part.reset_counter</code></b><ul>
|
||||
<li><b>type</b>: boolean</li>
|
||||
<li><b>default value</b>: <code>true</code></li>
|
||||
<li>If set to true, reset chapter number at each part</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-60">Special option</h3>
|
||||
<ul>
|
||||
<li><b><code>import_config</code></b><ul>
|
||||
<li><b><code>import</code></b><ul>
|
||||
<li><b>type</b>: path</li>
|
||||
<li><b>default value</b>: <code>not set</code></li>
|
||||
<li>Import another book configuration file</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-46">HTML options</h3>
|
||||
<h3 id = "link-61">HTML options</h3>
|
||||
<ul>
|
||||
<li><b><code>html.icon</code></b><ul>
|
||||
<li><b>type</b>: path</li>
|
||||
|
|
@ -555,43 +699,37 @@ author: Joan Doe
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-47">Standalone HTML options</h3>
|
||||
<h3 id = "link-62">Standalone HTML options</h3>
|
||||
<ul>
|
||||
<li><b><code>html_single.one_chapter</code></b><ul>
|
||||
<li><b><code>html.standalone.template</code></b><ul>
|
||||
<li><b>type</b>: template path</li>
|
||||
<li><b>default value</b>: <code>not set</code></li>
|
||||
<li>Path of an HTML template for standalone HTML</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b><code>html.standalone.one_chapter</code></b><ul>
|
||||
<li><b>type</b>: boolean</li>
|
||||
<li><b>default value</b>: <code>false</code></li>
|
||||
<li>Display only one chapter at a time (with a button to display all)</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b><code>html_single.html</code></b><ul>
|
||||
<li><b>type</b>: template path</li>
|
||||
<li><b>default value</b>: <code>not set</code></li>
|
||||
<li>Path of an HTML template</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b><code>html_single.js</code></b><ul>
|
||||
<li><b><code>html.standalone.js</code></b><ul>
|
||||
<li><b>type</b>: template path</li>
|
||||
<li><b>default value</b>: <code>not set</code></li>
|
||||
<li>Path of a javascript file</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-48">Multifile HTML options</h3>
|
||||
<h3 id = "link-63">Multifile HTML options</h3>
|
||||
<ul>
|
||||
<li><b><code>html_dir.index.html</code></b><ul>
|
||||
<li><b><code>html.dir.template</code></b><ul>
|
||||
<li><b>type</b>: template path</li>
|
||||
<li><b>default value</b>: <code>not set</code></li>
|
||||
<li>Path of index.html template</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b><code>html_dir.chapter.html</code></b><ul>
|
||||
<li><b>type</b>: template path</li>
|
||||
<li><b>default value</b>: <code>not set</code></li>
|
||||
<li>Path of a chapter.html template</li>
|
||||
<li>Path of a HTML template for multifile HTML</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-49">EPUB options</h3>
|
||||
<h3 id = "link-64">EPUB options</h3>
|
||||
<ul>
|
||||
<li><b><code>epub.version</code></b><ul>
|
||||
<li><b>type</b>: integer</li>
|
||||
|
|
@ -617,8 +755,20 @@ author: Joan Doe
|
|||
<li>Path of an xhtml template for each chapter</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b><code>epub.toc.extras</code></b><ul>
|
||||
<li><b>type</b>: boolean</li>
|
||||
<li><b>default value</b>: <code>true</code></li>
|
||||
<li>Add ‘Title’ and (if set) ‘Cover’ in the EPUB table of contents</li>
|
||||
</ul>
|
||||
<h3 id = "link-50">LaTeX options</h3>
|
||||
</li>
|
||||
<li><b><code>epub.escape_nb_spaces</code></b><ul>
|
||||
<li><b>type</b>: boolean</li>
|
||||
<li><b>default value</b>: <code>false</code></li>
|
||||
<li>Replace unicode non breaking spaces with HTML entities and CSS</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-65">LaTeX options</h3>
|
||||
<ul>
|
||||
<li><b><code>tex.links_as_footnotes</code></b><ul>
|
||||
<li><b>type</b>: boolean</li>
|
||||
|
|
@ -659,17 +809,17 @@ author: Joan Doe
|
|||
<li><b><code>tex.title</code></b><ul>
|
||||
<li><b>type</b>: boolean</li>
|
||||
<li><b>default value</b>: <code>true</code></li>
|
||||
<li>If true, generate a title with maketitle</li>
|
||||
<li>If true, generate a title with \maketitle</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b><code>tex.font_size</code></b><ul>
|
||||
<li><b><code>tex.font.size</code></b><ul>
|
||||
<li><b>type</b>: integer</li>
|
||||
<li><b>default value</b>: <code>not set</code></li>
|
||||
<li>Specify latex font size (in pt, 10 (default), 11, or 12 are accepted)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-51">Resources option</h3>
|
||||
<h3 id = "link-66">Resources option</h3>
|
||||
<ul>
|
||||
<li><b><code>resources.files</code></b><ul>
|
||||
<li><b>type</b>: string</li>
|
||||
|
|
@ -714,7 +864,7 @@ author: Joan Doe
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-52">Input options</h3>
|
||||
<h3 id = "link-67">Input options</h3>
|
||||
<ul>
|
||||
<li><b><code>input.clean</code></b><ul>
|
||||
<li><b>type</b>: boolean</li>
|
||||
|
|
@ -747,7 +897,7 @@ author: Joan Doe
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-53">Crowbook options</h3>
|
||||
<h3 id = "link-68">Crowbook options</h3>
|
||||
<ul>
|
||||
<li><b><code>crowbook.temp_dir</code></b><ul>
|
||||
<li><b>type</b>: path</li>
|
||||
|
|
@ -768,7 +918,7 @@ author: Joan Doe
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-54">Output options (for proofreading)</h3>
|
||||
<h3 id = "link-69">Output options (for proofreading)</h3>
|
||||
<ul>
|
||||
<li><b><code>output.proofread.html</code></b><ul>
|
||||
<li><b>type</b>: path</li>
|
||||
|
|
@ -776,7 +926,7 @@ author: Joan Doe
|
|||
<li>Output file name for HTML rendering with proofread features</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><b><code>output.proofread.html_dir</code></b><ul>
|
||||
<li><b><code>output.proofread.html.dir</code></b><ul>
|
||||
<li><b>type</b>: path</li>
|
||||
<li><b>default value</b>: <code>not set</code></li>
|
||||
<li>Output directory name for HTML rendering with proofread features</li>
|
||||
|
|
@ -789,7 +939,7 @@ author: Joan Doe
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id = "link-55">Proofreading options (only for output.proofread.* targets)</h3>
|
||||
<h3 id = "link-70">Proofreading options (only for output.proofread.* targets)</h3>
|
||||
<ul>
|
||||
<li><b><code>proofread</code></b><ul>
|
||||
<li><b>type</b>: boolean</li>
|
||||
|
|
@ -852,132 +1002,7 @@ author: Joan Doe
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p id = "para-116">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 it’s 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>
|
||||
<h3 id = "link-56">Metadata</h3>
|
||||
<p id = "para-117">Metadata are data about the book. Except for <code>cover</code>, which points to an image file, all its fields are strings. The main metadata are:</p>
|
||||
<ul>
|
||||
<li><code>author</code>: the author(s) of the book.</li>
|
||||
<li><code>title</code>: the title of the book.</li>
|
||||
<li><code>lang</code>: the language of the book. The unicode language code should be used, e.g. <code>en_GB</code> or <code>en</code>, <code>fr_FR</code>, ...</li>
|
||||
<li><code>cover</code>: path to an image file for the cover of the book (not displayed in all output formats).</li>
|
||||
</ul>
|
||||
<p id = "para-118">There are also additional metadata:</p>
|
||||
<ul>
|
||||
<li><code>subject</code></li>
|
||||
<li><code>description</code></li>
|
||||
<li><code>license</code></li>
|
||||
<li><code>version</code></li>
|
||||
<li><code>date</code></li>
|
||||
</ul>
|
||||
<p id = "para-119">You can define your own metadata by starting an option name with <code>metadata.foo</code>.</p>
|
||||
<p id = "para-120">All metadata are accessible from templates, see <a href = "chapter_003.html">Templates</a>.</p>
|
||||
<h3 id = "link-57">The <code>import_config</code> special option</h3>
|
||||
<p id = "para-121">The special <code>import_config</code> option allows you to include the options of another book configuration file. E.g., assuming that you want some common options to be applied to both <code>foo.book</code> and <code>bar.book</code>, you can create a <code>common.book</code> file:</p>
|
||||
<pre><code class = "language-yaml">author: Joan Doe
|
||||
lang: en
|
||||
license: "Copyright (C) Joan Doe. All rights reserved."
|
||||
|
||||
html.header: "[Joan Doe's website](http://joan-doe.com)"
|
||||
tex.template: my_template.tex
|
||||
</code></pre>
|
||||
<p id = "para-122">You can then include this file in <code>foo.book</code>:</p>
|
||||
<pre><code class = "language-yaml">import_config: common.book
|
||||
title: Foo
|
||||
|
||||
+ foo_01.md
|
||||
+ foo_02.md
|
||||
</code></pre>
|
||||
<p id = "para-123">Or include it in <code>bar.book</code>, but override some of its features:</p>
|
||||
<pre><code class = "language-yaml">import_config: common.book
|
||||
title: Bar
|
||||
license: CC-BY-SA # Override the license from common.book
|
||||
|
||||
+ bar_01.md
|
||||
</code></pre>
|
||||
<h3 id = "link-58">Output options</h3>
|
||||
<p id = "para-124">These options specify which files to generate.</p>
|
||||
<p id = "para-125">Recall that all file paths are relative to the directory where the config file is, not to the one where you run <code>crowbook</code>. So if you set</p>
|
||||
<pre><code class = "language-yaml">output.epub: foo.epub
|
||||
</code></pre>
|
||||
<p id = "para-126">and runs</p>
|
||||
<pre><code class = "language-bash">$ crowbook some/dir/config.book
|
||||
</code></pre>
|
||||
<p id = "para-127"><code>foo.epub</code> will be generated in <code>some/dir</code>, not in your current directory.</p>
|
||||
<p id = "para-128">Crowbook will try to generate each of the <code>output.xxx</code> files that are specified. That means that you’ll have to set at least one of those if you want a call to</p>
|
||||
<pre><code class = "language-bash">$ crowbook my.book
|
||||
</code></pre>
|
||||
<p id = "para-129">to generate anything. (It’s still possible to generate a specific format, and only this one, by using the <code>--to</code> argument on the command line).</p>
|
||||
<p id = "para-130">Note that some formats depend on some commands being installed on your system. Most notably, Crowbook depends on LaTeX (<code>xelatex</code> by default, though you can specify the command to use with <code>tex.command</code>) to generate a PDF file, so PDF rendering won’t work if it is not installed on your system. Crowbook also uses the <code>zip</code> command to generate the EPUB and ODT files.</p>
|
||||
<p id = "para-131">Current output options are:</p>
|
||||
<ul>
|
||||
<li><code>output.html</code>: renders a standalone HTML file.</li>
|
||||
<li><code>output.html_dir</code>: render a HTML directory with one page by chapter.</li>
|
||||
<li><code>output.epub</code>: renders an EPUB file.</li>
|
||||
<li><code>output.tex</code>: renders a LaTeX file.</li>
|
||||
<li><code>output.pdf</code>: renders a PDF file (using <code>tex.command</code>).</li>
|
||||
</ul>
|
||||
<p id = "para-132">(There are other output options for generating proofreading files, see <a href = "chapter_004.html">Proofreading</a>.)</p>
|
||||
<h4 id = "link-59"><code>output.base_path</code></h4>
|
||||
<p id = "para-133">Additionally, the <code>output.base_path</code> option allows you to set where the output files will be written (relatively to the book configuration file). E.g.,</p>
|
||||
<pre><code class = "language-yaml">output.base_path: docs/book
|
||||
output.epub: book.epub
|
||||
</code></pre>
|
||||
<p id = "para-134">will render the EPUB file in <code>docs/book/book.epub</code>.</p>
|
||||
<h3 id = "link-60">Input options</h3>
|
||||
<p id = "para-135">Crowbook does its best to improve the typography of your text. Default settings should be good enough for most usages, but you can enable/disable specific options:</p>
|
||||
<ul>
|
||||
<li><code>input.clean</code>: if set to <code>false</code>, will disable all typographic “cleaning” (default: <code>true</code>). The <code>clean</code> algorithm is dependent on the language, though currently there is only a variant implemented for <code>fr</code> (french), dealing with the specific non-breaking spaces rules for this language.</li>
|
||||
<li><code>input.clean.smart_quotes</code>: if set to <code>false</code>, disable the “smart quote” feature, that (tries to) replace straight quotes with curly ones. As it is an heuristics and can’t be perfect, you might want to disable it in some circumstances (default: <code>true</code>).</li>
|
||||
<li><code>input.clean.ligature_dashes</code>: if set to <code>true</code>, will convert <code>--</code> to en dash (<code>–</code>) and <code>---</code> to em dash (<code>—</code>). This can be useful if you want to use these characters but can’t access them easily on your keymap; however, as it can also cause problems if you <em>do</em> want to have two successive dashes, it is disabled by default.</li>
|
||||
<li><code>input.clean.ligature_guillemets</code> is a similar feature for french ‘guilemets’, replacing <code><<</code> and <code>>></code> to <code>«</code> and <code>»</code>. For the same reason, it is also disabled by default.</li>
|
||||
</ul>
|
||||
<h3 id = "link-61">Generic options for rendering</h3>
|
||||
<p id = "para-136">These options allow to configure the rendering; they are used (or at least should be) for all formats.</p>
|
||||
<h4 id = "link-62">rendering.num_depth</h4>
|
||||
<p id = "para-137">An integer that represents the maximum level of numbering for your book. E.g., <code>1</code> will only number chapters, while <code>2</code> will number chapters, sections, but not anything below that. <code>6</code> is the maximum level and turns numbering on for all headers.</p>
|
||||
<p id = "para-138"><b>default</b>: <code>1</code></p>
|
||||
<h4 id = "link-63">rendering.chapter_template</h4>
|
||||
<p id = "para-139">A string that will be used for chapter titles. You can use <code>{{{number}}}</code> and <code>{{{title}}}</code> in this string, e.g.:</p>
|
||||
<pre><code class = "language-yaml">numbering_template: "Chapter {{{number}} {{title}}}"
|
||||
</code></pre>
|
||||
<p id = "para-140">Note that:</p>
|
||||
<ul>
|
||||
<li>in this case, quoting is necessary because <code>{</code> and <code>}</code> have special meaning in YAML;</li>
|
||||
<li>this string won’t be used for unnumbered chapters;</li>
|
||||
<li>this string isn’t currently used by LaTeX, either.</li>
|
||||
</ul>
|
||||
<p id = "para-141">It is possible to include Markdown formatting in this template, but it isn’t advised, because it might cause problems for some formats (e.g. your EPUB file might not be correct anymore).</p>
|
||||
<h4 id = "link-64">Other rendering options</h4>
|
||||
<ul>
|
||||
<li><code>rendering.inline_toc</code>: if set to true, Crowbook will include a table of contents at the beginning of the document.</li>
|
||||
<li><code>rendering.inline_toc.name</code>: the name of this table of contents as it should be displayed in the document.</li>
|
||||
<li><code>rendering.initials</code>: if set to true, Crowbook will use initials, or “lettrines”, displaying the first letter of each chapter bigger than the others.</li>
|
||||
</ul>
|
||||
<h3 id = "link-65">Resources options</h3>
|
||||
<p id = "para-142">These options allow to embed additional files for some formats (currently, only EPUB). This can be useful for embedding fonts.</p>
|
||||
<h4 id = "link-66">resources.files</h4>
|
||||
<p id = "para-143">A list of files or directories that should be added. It’s a whitespace-separated list, so it can be, e.g.:</p>
|
||||
<pre><code class = "language-yaml">resources.files: font1.otf font2.otf
|
||||
</code></pre>
|
||||
<p id = "para-144">It is also possible to specify a directory (or multiple directories). So if you have a <code>fonts</code> directories containing <code>font1.otf</code> and <code>font2.otf</code>,</p>
|
||||
<pre><code class = "language-yaml">resources.files: fonts
|
||||
</code></pre>
|
||||
<p id = "para-145">will be equivalent to:</p>
|
||||
<pre><code class = "language-yaml">resources.files: fonts/font1.otf fonts/font2.otf
|
||||
</code></pre>
|
||||
<p id = "para-146"><b>default</b>: not set</p>
|
||||
<h4 id = "link-67">resources.out_path</h4>
|
||||
<p id = "para-147">This option determine where (in which directory), <em>in the resulting document</em>, those files will be copied. The default is <code>data</code>, so by default the <code>resources.files</code> in the first example above will search <code>font1.otf</code> and <code>font2.otf</code> <em>in the same directory than the <code>.book</code> file</em>, and will copy them to <code>data/font1.otf</code> and <code>data/font2.otf</code> <em>in the EPUB file</em>. This is therefore this last path that you should use if you want to access those files e.g. in a custom CSS stylesheet.</p>
|
||||
<p id = "para-148">Note that if you pass directories to <code>resources.files</code>, the whole directory would be copied. So assuming <code>fonts/</code> contains <code>font1.otf</code> and <code>font2.otf</code></p>
|
||||
<pre><code class = "language-yaml">resources.files: fonts
|
||||
resources.path: data
|
||||
</code></pre>
|
||||
<p id = "para-149">will copy these two files to <code>data/fonts/font1.otf</code> and <code>data/fonts/font2.otf</code> (and not <code>data/font1.otf</code> and <code>data/font2.otf</code>).</p>
|
||||
<p id = "para-150">Similarly, the whole path of <code>resources.files</code> is copied, so</p>
|
||||
<pre><code class = "language-yaml">resources.files: fonts/font1.otf fonts/font2.otf
|
||||
</code></pre>
|
||||
<p id = "para-151">will yield the same result.</p>
|
||||
<p id = "para-152"><b>default</b>: <code>data</code></p>
|
||||
<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 it’s 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>
|
||||
|
||||
<p class = "next_chapter">
|
||||
<a href = "chapter_003.html">
|
||||
|
|
@ -985,8 +1010,8 @@ resources.path: data
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-299">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.10.5-pre</p>
|
||||
<footer id = "footer"><p id = "para-299">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.0-pre</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -38,25 +38,25 @@ function toggle() {
|
|||
if (display_menu == true) {
|
||||
display_menu = false;
|
||||
document.getElementById("nav").style.left = "-21%";
|
||||
document.getElementById("content").style.marginLeft = "10%";
|
||||
document.getElementById("content").style.marginLeft = "0%";
|
||||
document.getElementById("menu").style.left = "1em";
|
||||
if(document.getElementById("top")) {
|
||||
/* 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("content").style.marginLeft = "20%";
|
||||
document.getElementById("menu").style.left = "20%";
|
||||
if(document.getElementById("top")) {
|
||||
/* if(document.getElementById("top")) {
|
||||
document.getElementById("top").style.left = "20%";
|
||||
}
|
||||
if(document.getElementById("footer")) {
|
||||
document.getElementById("footer").style.marginLeft = "20%";
|
||||
}
|
||||
}*/
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -69,196 +69,145 @@ function toggle() {
|
|||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-2">1.1. Example</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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 (<code>crowbook --single</code>)</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-40">3.3. Crowbook options</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-68">4. Templates</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_003.html#link-69">4.1. Create and edit template</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-73">4.2. List of templates</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-88">4.3. List of accessible variables</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-92">5. Proofreading with Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_004.html#link-93">5.1. Enabling proofreading</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-94">5.2. Repetition detection</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-95">5.3. Grammar checking</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-96">5.4. Highlighting non-breaking spaces</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-97">6. Tips and tricks</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_005.html#link-98">6.1. Using Crowbook with Emacs’ markdown mode</a>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-101">6.2. Embedding fonts in an EPUB file</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-102">7. Contributing</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_006.html#link-103">7.1. Internationalization</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-104">ChangeLog</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_007.html#link-105">unreleased</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-106">0.10.4 (2016-12-16)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-107">0.10.3 (2016-11-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.2 (2016-10-21)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.1 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.0 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-111">0.9.1 (2016-09-29)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-112">0.9.0 (2016-09-23)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-113">0.8.0 (2016-09-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-114">0.7.0 (2016-09-11)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-115">0.6.0 (2016-09-09)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-116">0.5.1 (2016-04-14)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-117">0.5.0 (2016-04-02)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-118">0.4.0 (2016-03-01)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">0.3.0 (2016-02-27)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-120">0.2.2 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-121">0.2.1 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.0 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-123">0.1.0 (2016-02-21)</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-124">GNU LESSER GENERAL PUBLIC LICENSE</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_002.html#link-55">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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>
|
||||
<li><a href = "chapter_004.html#link-98">5.4. Highlighting non-breaking spaces</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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">0.11.0 (???)</a></li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_007.html#link-111">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-112">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-113">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_007.html#link-114">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_007.html#link-115">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-116">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_007.html#link-117">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_007.html#link-118">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_007.html#link-119">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_007.html#link-120">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_007.html#link-121">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-123">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-124">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-125">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-126">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-302">Crowbook User Guide 0.11.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
<div id = "top"><p id = "para-302">Crowbook User Guide 0.10.5</p>
|
||||
</div>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<p class = "prev_chapter">
|
||||
<a href = "chapter_002.html">
|
||||
« 3. The configuration file
|
||||
</a>
|
||||
</p>
|
||||
<h1 id = "link-68">4. Templates</h1>
|
||||
<p id = "para-154">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-155">Each of this template can be overriden by a custom one, by setting e.g.:</p>
|
||||
<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><code class = "language-yaml">html.css: my_template.css
|
||||
</code></pre>
|
||||
<p id = "para-156">in the book configuration file. The templates that you are most susceptible to modify are the following:</p>
|
||||
<p id = "para-157">in the book configuration file. The templates that you are most susceptible to modify are the following:</p>
|
||||
<ul>
|
||||
<li><code>html.css</code>: stylesheet for HTML output;</li>
|
||||
<li><code>epub.css</code>: stylesheet for EPUB output;</li>
|
||||
<li><code>tex.template</code>: template of a LaTeX file.</li>
|
||||
</ul>
|
||||
<h2 id = "link-69">4.1. Create and edit template</h2>
|
||||
<p id = "para-157">Except for inline templates, which are set directly in the book configuration file:</p>
|
||||
<pre><code class = "language-yaml">rendering.chapter_template: "{{{loc_chapter}}} {{{number}}}: {{{chapter_title}}}"
|
||||
<h2 id = "link-72">4.1. Create and edit template</h2>
|
||||
<p id = "para-158">Except for inline templates, which are set directly in the book configuration file:</p>
|
||||
<pre><code class = "language-yaml">rendering.chapter.template: "{{{loc_chapter}}} {{{number}}}: {{{chapter_title}}}"
|
||||
</code></pre>
|
||||
<p id = "para-158">most templates must be in a separate file:</p>
|
||||
<p id = "para-159">most templates must be in a separate file:</p>
|
||||
<pre><code class = "language-yaml">tex.template: my_template.tex
|
||||
</code></pre>
|
||||
<h3 id = "link-70"><code>--print-template</code></h3>
|
||||
<p id = "para-159">The easiest way to create a new template is to start with the default one. In order to do so, you can use the <code>--print-template</code> argument:</p>
|
||||
<h3 id = "link-73"><code>--print-template</code></h3>
|
||||
<p id = "para-160">The easiest way to create a new template is to start with the default one. In order to do so, you can use the <code>--print-template</code> argument:</p>
|
||||
<pre><code class = "language-bash">$ crowbook --print-template tex.template > my_template.tex
|
||||
</code></pre>
|
||||
<p id = "para-160">In order to get the <code>chapter.xhtml</code> template for EPUB3, you’ll also have to use <code>--set epub.version 3</code>:</p>
|
||||
<p id = "para-161">In order to get the <code>chapter.xhtml</code> template for EPUB3, you’ll also have to use <code>--set epub.version 3</code>:</p>
|
||||
<pre><code class = "language-bash">$ crowbook --print-template epub.chapter.xhtml --set epub.version 3 > my_epub3_template.xhtml
|
||||
</code></pre>
|
||||
<h3 id = "link-71">Mustache syntax</h3>
|
||||
<p id = "para-161">Crowbook uses <a href = "https://crates.io/crates/mustache">rust-mustache</a> as its templating engine, which allows to use <a href = "http://mustache.github.io/">Mustache</a> syntax in the templates.</p>
|
||||
<p id = "para-163">It mainly boils down to using <code>{{{foo}}}</code><a href = "#note-dest-2"><sup id = "note-source-2">[2]</sup></a> to insert the value of variable <code>foo</code> in the document:</p>
|
||||
<h3 id = "link-74">Mustache syntax</h3>
|
||||
<p id = "para-162">Crowbook uses <a href = "https://crates.io/crates/mustache">rust-mustache</a> as its templating engine, which allows to use <a href = "http://mustache.github.io/">Mustache</a> syntax in the templates.</p>
|
||||
<p id = "para-164">It mainly boils down to using <code>{{{foo}}}</code><a href = "#note-dest-2"><sup id = "note-source-2">[2]</sup></a> to insert the value of variable <code>foo</code> in the document:</p>
|
||||
<pre><code class = "language-html"><h1 class = "title" >{{{title}}}<h1>
|
||||
<h2 class = "author">{{{author}}}</h2>
|
||||
</code></pre>
|
||||
<p id = "para-164">Mustache also provides the possibility of checking whether a variable is set:</p>
|
||||
<p id = "para-165">Mustache also provides the possibility of checking whether a variable is set:</p>
|
||||
<pre><code>{{#foo}}
|
||||
Foo exists
|
||||
{{/foo}}
|
||||
|
|
@ -266,7 +215,7 @@ Foo exists
|
|||
Foo does not exist
|
||||
{{^foo}}
|
||||
</code></pre>
|
||||
<p id = "para-165">Crowbook uses this and sets some variables to <code>true</code> to allow templates to conditionally include some portions. E.g., in <code>html.css</code>:</p>
|
||||
<p id = "para-166">Crowbook uses this and sets some variables to <code>true</code> to allow templates to conditionally include some portions. E.g., in <code>html.css</code>:</p>
|
||||
<pre><code class = "language-css">{{#lang_fr}}
|
||||
/* Make list displays '–' instead of bullets */
|
||||
ul li {
|
||||
|
|
@ -275,55 +224,53 @@ ul li {
|
|||
}
|
||||
{{/lang_fr}}
|
||||
</code></pre>
|
||||
<p id = "para-166">In this case, Crowbook sets a variable whose name is equal to <code>lang_foo</code> to <code>true</code>, allowing to have different styles for some elements according to the language.</p>
|
||||
<p id = "para-167">For more information about Mustache syntax, see <a href = "http://mustache.github.io/mustache.5.html">Mustache manual</a>.</p>
|
||||
<h4 id = "link-72">Syntax in LaTeX</h4>
|
||||
<p id = "para-169">Since LaTeX already uses a lot of curly brackets, the default template sets an altenative syntax to access variables, with <code><<&foo>></code><a href = "#note-dest-3"><sup id = "note-source-3">[3]</sup></a>:</p>
|
||||
<p id = "para-167">In this case, Crowbook sets a variable whose name is equal to <code>lang_foo</code> to <code>true</code>, allowing to have different styles for some elements according to the language.</p>
|
||||
<p id = "para-168">For more information about Mustache syntax, see <a href = "http://mustache.github.io/mustache.5.html">Mustache manual</a>.</p>
|
||||
<h4 id = "link-75">Syntax in LaTeX</h4>
|
||||
<p id = "para-170">Since LaTeX already uses a lot of curly brackets, the default template sets an altenative syntax to access variables, with <code><<&foo>></code><a href = "#note-dest-3"><sup id = "note-source-3">[3]</sup></a>:</p>
|
||||
<pre><code class = "language-latex">\title{<<&title>>}
|
||||
\author{<<&author>>}
|
||||
<<#has_date>>\date{<<&date>>}<</has_date>
|
||||
</code></pre>
|
||||
<h2 id = "link-73">4.2. List of templates</h2>
|
||||
<h3 id = "link-74">html.js</h3>
|
||||
<p id = "para-170">The javascript file used by both the standalone HTML renderer and the multiple files HTML renderer.</p>
|
||||
<p id = "para-171">This is not currently an actual template, just a plain javascript file which cannot contain <code>mustache</code> tags.</p>
|
||||
<h3 id = "link-75">html.css</h3>
|
||||
<p id = "para-172">The main CSS file used by both the standalone HTML renderer and the multiple files HTML renderer.</p>
|
||||
<h3 id = "link-76">html.css.colours</h3>
|
||||
<p id = "para-173">A CSS file containing only colour settings. Used by <code>html.css</code>.</p>
|
||||
<p id = "para-174">This is not currently an actual template, just a plain CSS file which cannot contain <code>mustache</code> tags.</p>
|
||||
<h3 id = "link-77">html.css.print</h3>
|
||||
<p id = "para-175">An additional CSS file used by both the standalone HTML renderer and the multiple files HTML renderer. Its purpose is to provide CSS instructions for printing (i.e., when the user clicks the <code>print</code> button in her browser).</p>
|
||||
<p id = "para-176">This is not currently an actual template, just a plain CSS file which cannot contain <code>mustache</code> tags.</p>
|
||||
<h3 id = "link-78">html.highlight.js</h3>
|
||||
<p id = "para-177">A javascript file used by both HTML renderers to highlight codes in code blocks. It should be a variant of <a href = "https://highlightjs.org/">highlight.js</a>.</p>
|
||||
<p id = "para-178">This is not an actual template, just a plain javascript file.</p>
|
||||
<h3 id = "link-79">html.highlight.css</h3>
|
||||
<p id = "para-179">A CSS file used by both HTML renderers to set the theme of <a href = "https://highlightjs.org/">highlight.js</a>. It should, though, be an highlight.js theme.</p>
|
||||
<p id = "para-180">This is not an actual template, just a plain CSS file.</p>
|
||||
<h3 id = "link-80">html_single.js</h3>
|
||||
<p id = "para-181">A javascript file used only by the standalone HTML renderer. Its main purpose is to handle the displaying of a single chapter at a time when <code>one_chapter</code> is set to true.</p>
|
||||
<h3 id = "link-81">html_single.html</h3>
|
||||
<p id = "para-182">The main template for standalone HTML renderer.</p>
|
||||
<h3 id = "link-82">html_dir.chapter.html</h3>
|
||||
<p id = "para-183">The main template for multiple files HTML renderer. It is the template for rendering each chapter.</p>
|
||||
<h3 id = "link-83">html_dir.index.html</h3>
|
||||
<p id = "para-184">The template used by multiple files HTML renderer to render the <code>index.html</code> file.</p>
|
||||
<h3 id = "link-84">tex.template</h3>
|
||||
<h2 id = "link-76">4.2. List of templates</h2>
|
||||
<h3 id = "link-77">html.js</h3>
|
||||
<p id = "para-171">The javascript file used by both the standalone HTML renderer and the multiple files HTML renderer.</p>
|
||||
<p id = "para-172">This is not currently an actual template, just a plain javascript file which cannot contain <code>mustache</code> tags.</p>
|
||||
<h3 id = "link-78">html.css</h3>
|
||||
<p id = "para-173">The main CSS file used by both the standalone HTML renderer and the multiple files HTML renderer.</p>
|
||||
<h3 id = "link-79">html.css.colours</h3>
|
||||
<p id = "para-174">A CSS file containing only colour settings. Used by <code>html.css</code>.</p>
|
||||
<p id = "para-175">This is not currently an actual template, just a plain CSS file which cannot contain <code>mustache</code> tags.</p>
|
||||
<h3 id = "link-80">html.css.print</h3>
|
||||
<p id = "para-176">An additional CSS file used by both the standalone HTML renderer and the multiple files HTML renderer. Its purpose is to provide CSS instructions for printing (i.e., when the user clicks the <code>print</code> button in her browser).</p>
|
||||
<p id = "para-177">This is not currently an actual template, just a plain CSS file which cannot contain <code>mustache</code> tags.</p>
|
||||
<h3 id = "link-81">html.highlight.js</h3>
|
||||
<p id = "para-178">A javascript file used by both HTML renderers to highlight codes in code blocks. It should be a variant of <a href = "https://highlightjs.org/">highlight.js</a>.</p>
|
||||
<p id = "para-179">This is not an actual template, just a plain javascript file.</p>
|
||||
<h3 id = "link-82">html.highlight.css</h3>
|
||||
<p id = "para-180">A CSS file used by both HTML renderers to set the theme of <a href = "https://highlightjs.org/">highlight.js</a>. It should, though, be an highlight.js theme.</p>
|
||||
<p id = "para-181">This is not an actual template, just a plain CSS file.</p>
|
||||
<h3 id = "link-83">html.standalone.js</h3>
|
||||
<p id = "para-182">A javascript file used only by the standalone HTML renderer. Its main purpose is to handle the displaying of a single chapter at a time when <code>one_chapter</code> is set to true.</p>
|
||||
<h3 id = "link-84">html.standalone.template</h3>
|
||||
<p id = "para-183">The main HTML template for standalone HTML renderer.</p>
|
||||
<h3 id = "link-85">html.dir.template</h3>
|
||||
<p id = "para-184">The main HTML template for multiple files HTML renderer.</p>
|
||||
<h3 id = "link-86">tex.template</h3>
|
||||
<p id = "para-185">The main (and currently only) template used by the LaTeX renderer.</p>
|
||||
<h3 id = "link-85">epub.chapter.xhtml</h3>
|
||||
<h3 id = "link-87">epub.chapter.xhtml</h3>
|
||||
<p id = "para-186">This template is the main template used by the Epub renderer. It contains the XHTML template that will be used for each chapter.</p>
|
||||
<h3 id = "link-86">epub.css</h3>
|
||||
<h3 id = "link-88">epub.css</h3>
|
||||
<p id = "para-187">This template is used by the Epub renderer and contains the style sheet.</p>
|
||||
<h3 id = "link-87">Inline templates</h3>
|
||||
<h3 id = "link-89">Inline templates</h3>
|
||||
<p id = "para-188">Crowbook also has some inline templates, that are set in the book configuration file:</p>
|
||||
<ul>
|
||||
<li><code>tex.template.add</code>, <code>html.css.add</code> and <code>epub.css.add</code> allow to specify some LaTeX or CSS code directly in the book configuration file. This code will be added respectively to <code>tex.template</code>, <code>html.css</code> or <code>epub.css</code> template. For CSS template, this code is inserted at the end of the template (allowing to redefine rules that are set by the template); for the LaTeX template, the code is inserted at the end of the preambule, just before the <code>\begin{document}</code> tag.</li>
|
||||
<li><code>tex.template.add</code>, <code>html.css.add</code> and <code>epub.css.add</code> allow to specify some LaTeX or CSS code directly in the book configuration file. This code will be added respectively to <code>tex.template</code>, <code>html.css</code> or <code>epub.css</code> template. For CSS templates, this code is inserted at the end of the template (allowing to redefine rules that are set by the template); for the LaTeX template, the code is inserted at the end of the preambule, just before the <code>\begin{document}</code> tag.</li>
|
||||
<li><code>rendering.inline_toc.name</code> sets the name of the inline table of content, if it is displayed. By default, is is set to <code>{{{loc_toc}}}</code>, that is, a localised version of “Table of Contents”.</li>
|
||||
<li><code>rendering.chapter_template</code> sets the naming scheme for chapters.</li>
|
||||
<li><code>rendering.chapter.template</code> sets the naming scheme for chapters, while <code>rendering.part.template</code> does the same for part.</li>
|
||||
</ul>
|
||||
<h2 id = "link-88">4.3. List of accessible variables</h2>
|
||||
<h3 id = "link-89">Metadata</h3>
|
||||
<h2 id = "link-90">4.3. List of accessible variables</h2>
|
||||
<h3 id = "link-91">Metadata</h3>
|
||||
<p id = "para-189">For every template, Crowbook exports all of the metadata:</p>
|
||||
<ul>
|
||||
<li><code>author</code>;</li>
|
||||
|
|
@ -342,7 +289,7 @@ ul li {
|
|||
{{#has_version}}, version {{{version}}}{{/has_version}}
|
||||
</code></pre>
|
||||
<p id = "para-192">will avoid rendering “, version” when <code>version</code> is not set.</p>
|
||||
<h3 id = "link-90">Localisation strings</h3>
|
||||
<h3 id = "link-92">Localisation strings</h3>
|
||||
<p id = "para-193">For all templates, Crowbook also exports some localisation strings <code>loc_foo</code>. They currently include:</p>
|
||||
<div class = "table">
|
||||
<table>
|
||||
|
|
@ -359,54 +306,54 @@ ul li {
|
|||
|
||||
</table>
|
||||
</div>
|
||||
<h3 id = "link-91">Template-dependent values</h3>
|
||||
<h3 id = "link-93">Template-dependent values</h3>
|
||||
<p id = "para-194">Crowbook also exports some additional fields for some templates, see below.</p>
|
||||
<div class = "table">
|
||||
<table>
|
||||
<tr>
|
||||
<th> Mustache tag </th><th> Value </th><th> Available in... </th></tr>
|
||||
<tr>
|
||||
<td> <code>content</code> </td><td> A rendered version of the book or chapter’s content </td><td> <code>html_single.html</code>, <code>html_dir.index.html</code>, <code>html_dir.chapter.html</code>, <code>tex.template</code>, <code>epub.chapter.xhtml</code> </td></tr>
|
||||
<td> <code>content</code> </td><td> A rendered version of the book or chapter’s content </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code>, <code>tex.template</code>, <code>epub.chapter.xhtml</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>toc</code> </td><td> A rendered version of the table of contents </td><td> <code>html_single.html</code>, <code>html_dir.chapter.html</code>, <code>html_dir.index.html</code> </td></tr>
|
||||
<td> <code>toc</code> </td><td> A rendered version of the table of contents </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>has_toc</code></td><td> Set to <code>true</code> if the table of contents is not empty </td><td> <code>html_single.html</code> </td></tr>
|
||||
<td> <code>has_toc</code></td><td> Set to <code>true</code> if the table of contents is not empty </td><td> <code>html.standalone.template</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>colours</code></td><td> The content of <code>html.css.colours</code> </td><td> <code>html.css</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>footer</code> </td><td> The content of <code>html.footer</code> </td><td> <code>html_single.html</code>, <code>html_dir.index.html</code>, <code>html_dir.chapter.html</code> </td></tr>
|
||||
<td> <code>footer</code> </td><td> The content of <code>html.footer</code> </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>header</code> </td><td> The content of <code>html.header</code> </td><td> <code>html_single.html</code>, <code>html_dir.index.html</code>, <code>html_dir.chapter.html</code> </td></tr>
|
||||
<td> <code>header</code> </td><td> The content of <code>html.header</code> </td><td> <code>html.standalone.template</code>, <code>html.dirtemplate</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>script</code> </td><td> The javascript file for this HTML document </td><td> <code>html_single.html</code>, <code>html_dir.index.html</code>, <code>html_dir.chapter.html</code> </td></tr>
|
||||
<td> <code>script</code> </td><td> The javascript file for this HTML document </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>style</code> </td><td> The CSS file for this HTML<span class = "nbsp"> </span>document, that is, a rendered version of <code>html.css</code> </td><td> <code>html_single.html</code> </td></tr>
|
||||
<td> <code>style</code> </td><td> The CSS file for this HTML<span class = "nbsp"> </span>document, that is, a rendered version of <code>html.css</code> </td><td> <code>html.standalone.template</code> </td></tr>
|
||||
<tr>
|
||||
<td> A variable whose name corresponds to <code>lang</code> in book options (e.g. <code>lang_en</code> if lang is set to “en”, <code>lang_fr</code> if it is set to “fr”, ...) </td><td> <code>true</code> </td><td> <code>html.css</code>, <code>epub.css</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>chapter_title</code> </td><td> The title of current chapter </td><td> <code>html_dir.chapter.html</code>, <code>epub.chapter.xhtml</code>, <code>rendering.chapter_template</code> </td></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>highlight_code</code> </td><td> True if <code>html.highlight_code</code> is true </td><td> <code>html_single.html</code>, <code>html_dir.chapter.html</code> </td></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_single.html</code> </td></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>
|
||||
<tr>
|
||||
<td> <code>highlight_js</code> </td><td> The base64-encoded content of <code>html.highlight.js</code> </td><td> <code>html_single.html</code> </td></tr>
|
||||
<td> <code>highlight_js</code> </td><td> The base64-encoded content of <code>html.highlight.js</code> </td><td> <code>html.standalone.tempate</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>common_script</code> </td><td> The content of <code>html.js</code> </td><td> <code>html_single.js</code> </td></tr>
|
||||
<td> <code>common_script</code> </td><td> The content of <code>html.js</code> </td><td> <code>html.single.js</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>one_chapter</code> </td><td> True if <code>html_single.one_chapter</code> is true, else not present </td><td> <code>html_single.html</code>, <code>html_single.js</code> </td></tr>
|
||||
<td> <code>one_chapter</code> </td><td> True if <code>html.standalone.one_chapter</code> is true, else not present </td><td> <code>html.standalone.template</code>, <code>html.standalone.js</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>book.svg</code> </td><td> The base64-encoded image of the button to display all chapters </td><td> <code>html_single.js</code>, <code>html_single.html</code> </td></tr>
|
||||
<td> <code>book.svg</code> </td><td> The base64-encoded image of the button to display all chapters </td><td> <code>html.standalone.js</code>, <code>html.standalone.template</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>pages.svg</code> </td><td> The base64-encoded image of the button to display one chapter at a time </td><td> <code>html_single.js</code>, <code>html_single.html</code> </td></tr>
|
||||
<td> <code>pages.svg</code> </td><td> The base64-encoded image of the button to display one chapter at a time </td><td> <code>html.standalone.js</code>, <code>html.standalone.template</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>favicon</code> </td><td> The <code><link rel = “icon” ...></code> tag if <code>html.icon</code> is set </td><td> <code>html_single.html</code>, <code>html_dir.chapter.html</code>, <code>html_dir.index.html</code> </td></tr>
|
||||
<td> <code>favicon</code> </td><td> The <code><link rel = “icon” ...></code> tag if <code>html.icon</code> is set </td><td> <code>html.standalone.template</code>, <code>html.dir.template</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>menu_svg</code> </td><td> The base64-encoded image of the hamburger menu image </td><td> <code>html_single.html</code> </td></tr>
|
||||
<td> <code>menu_svg</code> </td><td> The base64-encoded image of the hamburger menu image </td><td> <code>html.standalone.template</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>prev_chapter</code> </td><td> Title and a link of previous chapter </td><td> <code>html_dir.chapter.html</code> </td></tr>
|
||||
<td> <code>prev_chapter</code> </td><td> Title and a link of previous chapter </td><td> <code>html.dir.template</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>next_chapter</code> </td><td> Title and a link of nexts chapter </td><td> <code>html_dir.chapter.html</code> </td></tr>
|
||||
<td> <code>next_chapter</code> </td><td> Title and a link of nexts chapter </td><td> <code>html.dir.template</code> </td></tr>
|
||||
<tr>
|
||||
<td> <code>class</code> </td><td> The content of <code>tex.class</code> </td><td> <code>tex.template</code> </td></tr>
|
||||
<tr>
|
||||
|
|
@ -437,7 +384,7 @@ ul li {
|
|||
|
||||
</td>
|
||||
<td class = "note">
|
||||
<aside id = "note-dest-1"><p id = "para-153">Some of them, though, are not “real” templates, they are just files that are inserted, but can’t contain mustache tags. This will probably evolve in future versions.</p>
|
||||
<aside id = "note-dest-1"><p id = "para-154">Some of them, though, are not “real” templates, they are just files that are inserted, but can’t contain mustache tags. This will probably evolve in future versions.</p>
|
||||
</aside>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -449,7 +396,7 @@ ul li {
|
|||
|
||||
</td>
|
||||
<td class = "note">
|
||||
<aside id = "note-dest-2"><p id = "para-162">Mustache also provides the <code>{{foo}}</code> variant, which HTML-escapes the content of the variable. You should not use this, as Crowbook already renders and correctly escapes the variables it sets for use in templates.</p>
|
||||
<aside id = "note-dest-2"><p id = "para-163">Mustache also provides the <code>{{foo}}</code> variant, which HTML-escapes the content of the variable. You should not use this, as Crowbook already renders and correctly escapes the variables it sets for use in templates.</p>
|
||||
</aside>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -461,7 +408,7 @@ ul li {
|
|||
|
||||
</td>
|
||||
<td class = "note">
|
||||
<aside id = "note-dest-3"><p id = "para-168"><code><<foo>></code> might also work, but the ampersand is required to prevent mustache HTML-escaping the value. This is not good because:</p>
|
||||
<aside id = "note-dest-3"><p id = "para-169"><code><<foo>></code> might also work, but the ampersand is required to prevent mustache HTML-escaping the value. This is not good because:</p>
|
||||
<ol>
|
||||
<li>escaping is already done by Crowbook before setting variable content;</li>
|
||||
<li>escaping HTML in a LaTeX document won’t probably look good.</li>
|
||||
|
|
@ -478,8 +425,8 @@ ul li {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-301">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.10.5-pre</p>
|
||||
<footer id = "footer"><p id = "para-301">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.0-pre</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -38,25 +38,25 @@ function toggle() {
|
|||
if (display_menu == true) {
|
||||
display_menu = false;
|
||||
document.getElementById("nav").style.left = "-21%";
|
||||
document.getElementById("content").style.marginLeft = "10%";
|
||||
document.getElementById("content").style.marginLeft = "0%";
|
||||
document.getElementById("menu").style.left = "1em";
|
||||
if(document.getElementById("top")) {
|
||||
/* 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("content").style.marginLeft = "20%";
|
||||
document.getElementById("menu").style.left = "20%";
|
||||
if(document.getElementById("top")) {
|
||||
/* if(document.getElementById("top")) {
|
||||
document.getElementById("top").style.left = "20%";
|
||||
}
|
||||
if(document.getElementById("footer")) {
|
||||
document.getElementById("footer").style.marginLeft = "20%";
|
||||
}
|
||||
}*/
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -69,165 +69,114 @@ function toggle() {
|
|||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-2">1.1. Example</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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 (<code>crowbook --single</code>)</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-40">3.3. Crowbook options</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-68">4. Templates</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_003.html#link-69">4.1. Create and edit template</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-73">4.2. List of templates</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-88">4.3. List of accessible variables</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-92">5. Proofreading with Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_004.html#link-93">5.1. Enabling proofreading</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-94">5.2. Repetition detection</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-95">5.3. Grammar checking</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-96">5.4. Highlighting non-breaking spaces</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-97">6. Tips and tricks</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_005.html#link-98">6.1. Using Crowbook with Emacs’ markdown mode</a>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-101">6.2. Embedding fonts in an EPUB file</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-102">7. Contributing</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_006.html#link-103">7.1. Internationalization</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-104">ChangeLog</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_007.html#link-105">unreleased</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-106">0.10.4 (2016-12-16)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-107">0.10.3 (2016-11-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.2 (2016-10-21)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.1 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.0 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-111">0.9.1 (2016-09-29)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-112">0.9.0 (2016-09-23)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-113">0.8.0 (2016-09-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-114">0.7.0 (2016-09-11)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-115">0.6.0 (2016-09-09)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-116">0.5.1 (2016-04-14)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-117">0.5.0 (2016-04-02)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-118">0.4.0 (2016-03-01)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">0.3.0 (2016-02-27)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-120">0.2.2 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-121">0.2.1 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.0 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-123">0.1.0 (2016-02-21)</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-124">GNU LESSER GENERAL PUBLIC LICENSE</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_002.html#link-55">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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>
|
||||
<li><a href = "chapter_004.html#link-98">5.4. Highlighting non-breaking spaces</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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">0.11.0 (???)</a></li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_007.html#link-111">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-112">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-113">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_007.html#link-114">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_007.html#link-115">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-116">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_007.html#link-117">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_007.html#link-118">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_007.html#link-119">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_007.html#link-120">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_007.html#link-121">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-123">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-124">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-125">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-126">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-304">Crowbook User Guide 0.11.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
<div id = "top"><p id = "para-304">Crowbook User Guide 0.10.5</p>
|
||||
</div>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<p class = "prev_chapter">
|
||||
<a href = "chapter_003.html">
|
||||
« 4. Templates
|
||||
</a>
|
||||
</p>
|
||||
<h1 id = "link-92">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>
|
||||
|
|
@ -241,7 +190,7 @@ function toggle() {
|
|||
<li>grammar check;</li>
|
||||
<li>highlighting non-breaking spaces.</li>
|
||||
</ul>
|
||||
<h2 id = "link-93">5.1. Enabling proofreading</h2>
|
||||
<h2 id = "link-95">5.1. Enabling proofreading</h2>
|
||||
<p id = "para-198">Since proofreading can take quite a lot of time, particularly for a long book, it is disabled by default. You’ll have to run</p>
|
||||
<pre><code class = "language-bash">$ crowbook --proofread my.book
|
||||
</code></pre>
|
||||
|
|
@ -252,7 +201,7 @@ function toggle() {
|
|||
<pre><code class = "language-yaml">proofread: true
|
||||
</code></pre>
|
||||
<p id = "para-201">in the book configuration file.</p>
|
||||
<h2 id = "link-94">5.2. Repetition detection</h2>
|
||||
<h2 id = "link-96">5.2. Repetition detection</h2>
|
||||
<p id = "para-202">Repetition detection is enabled with:</p>
|
||||
<pre><code class = "language-yaml">proofread.repetitions: true
|
||||
</code></pre>
|
||||
|
|
@ -277,7 +226,7 @@ proofread.repetitions.fuzzy.threshold: 0.2
|
|||
<p id = "para-204">For more information, see <a href = "https://github.com/lise-henry/caribon">Caribon</a>’s documentation.</p>
|
||||
<blockquote><p id = "para-205">Currently, repetitions are not displayed in PDF proofreading output.</p>
|
||||
</blockquote>
|
||||
<h2 id = "link-95">5.3. Grammar checking</h2>
|
||||
<h2 id = "link-97">5.3. Grammar checking</h2>
|
||||
<p id = "para-206">Crowbook can also use <a href = "https://languagetool.org/">LanguageTool</a> to detect grammar errors in your text. It is, however, a bit more complex to activate.</p>
|
||||
<p id = "para-207">First, you’ll have to activate this feature in your book configuration file:</p>
|
||||
<pre><code class = "language-yaml"># Activate language tool support
|
||||
|
|
@ -292,7 +241,7 @@ proofread.languagetool.port: 8081
|
|||
<p id = "para-210">You can then run Crowbook, and it will highlight grammar errors in HTML or PDF proofreading output files.</p>
|
||||
<blockquote><p id = "para-211">Note: running a grammar check on a long book (like a novel) can take up to a few minutes.</p>
|
||||
</blockquote>
|
||||
<h2 id = "link-96">5.4. Highlighting non-breaking spaces</h2>
|
||||
<h2 id = "link-98">5.4. Highlighting non-breaking spaces</h2>
|
||||
<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>
|
||||
|
||||
<p class = "next_chapter">
|
||||
|
|
@ -301,8 +250,8 @@ proofread.languagetool.port: 8081
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-303">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.10.5-pre</p>
|
||||
<footer id = "footer"><p id = "para-303">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.0-pre</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -38,25 +38,25 @@ function toggle() {
|
|||
if (display_menu == true) {
|
||||
display_menu = false;
|
||||
document.getElementById("nav").style.left = "-21%";
|
||||
document.getElementById("content").style.marginLeft = "10%";
|
||||
document.getElementById("content").style.marginLeft = "0%";
|
||||
document.getElementById("menu").style.left = "1em";
|
||||
if(document.getElementById("top")) {
|
||||
/* 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("content").style.marginLeft = "20%";
|
||||
document.getElementById("menu").style.left = "20%";
|
||||
if(document.getElementById("top")) {
|
||||
/* if(document.getElementById("top")) {
|
||||
document.getElementById("top").style.left = "20%";
|
||||
}
|
||||
if(document.getElementById("footer")) {
|
||||
document.getElementById("footer").style.marginLeft = "20%";
|
||||
}
|
||||
}*/
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -69,200 +69,148 @@ function toggle() {
|
|||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-2">1.1. Example</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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 (<code>crowbook --single</code>)</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-40">3.3. Crowbook options</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-68">4. Templates</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_003.html#link-69">4.1. Create and edit template</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-73">4.2. List of templates</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-88">4.3. List of accessible variables</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-92">5. Proofreading with Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_004.html#link-93">5.1. Enabling proofreading</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-94">5.2. Repetition detection</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-95">5.3. Grammar checking</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-96">5.4. Highlighting non-breaking spaces</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-97">6. Tips and tricks</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_005.html#link-98">6.1. Using Crowbook with Emacs’ markdown mode</a>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-101">6.2. Embedding fonts in an EPUB file</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-102">7. Contributing</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_006.html#link-103">7.1. Internationalization</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-104">ChangeLog</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_007.html#link-105">unreleased</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-106">0.10.4 (2016-12-16)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-107">0.10.3 (2016-11-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.2 (2016-10-21)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.1 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.0 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-111">0.9.1 (2016-09-29)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-112">0.9.0 (2016-09-23)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-113">0.8.0 (2016-09-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-114">0.7.0 (2016-09-11)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-115">0.6.0 (2016-09-09)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-116">0.5.1 (2016-04-14)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-117">0.5.0 (2016-04-02)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-118">0.4.0 (2016-03-01)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">0.3.0 (2016-02-27)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-120">0.2.2 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-121">0.2.1 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.0 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-123">0.1.0 (2016-02-21)</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-124">GNU LESSER GENERAL PUBLIC LICENSE</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_002.html#link-55">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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>
|
||||
<li><a href = "chapter_004.html#link-98">5.4. Highlighting non-breaking spaces</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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">0.11.0 (???)</a></li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_007.html#link-111">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-112">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-113">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_007.html#link-114">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_007.html#link-115">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-116">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_007.html#link-117">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_007.html#link-118">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_007.html#link-119">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_007.html#link-120">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_007.html#link-121">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-123">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-124">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-125">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-126">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-306">Crowbook User Guide 0.11.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
<div id = "top"><p id = "para-306">Crowbook User Guide 0.10.5</p>
|
||||
</div>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<p class = "prev_chapter">
|
||||
<a href = "chapter_004.html">
|
||||
« 5. Proofreading with Crowbook
|
||||
</a>
|
||||
</p>
|
||||
<h1 id = "link-97">6. Tips and tricks</h1>
|
||||
<h2 id = "link-98">6.1. Using Crowbook with Emacs’ markdown mode</h2>
|
||||
<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>
|
||||
<pre><code class = "language-lisp">(custom-set-variables
|
||||
'(markdown-command "crowbook -qs --to html --output /dev/stdout")
|
||||
'(markdown-command-needs-filename t))
|
||||
'(markdown-command "crowbook - -qs --to html --output -"))
|
||||
</code></pre>
|
||||
<p id = "para-215">You can then use <code>markdown-preview</code> (or <code>C-c C-c p</code>) to run Crowbook on this file and preview it in your browser, or run <code>markdown-live-preview-mode</code> to see a live preview (updated each time you save you file) in Emacs’ integrated browser.</p>
|
||||
<h3 id = "link-99">Some explanations if it looks a bit cryptic to you</h3>
|
||||
<h3 id = "link-101">Some explanations if it looks a bit cryptic to you</h3>
|
||||
<p id = "para-216">We set <code>markdown-command</code> to <code>crowbook</code>, the reason for this is a bit obvious. The arguments we give to crowbook might be a bit less obvious:</p>
|
||||
<ul>
|
||||
<li>the fist argument, <code>-</code>, is actually the book file: it tells <code>crowbook</code> to read it from standard input.</li>
|
||||
<li><code>-qs</code> or <code>--quiet --single</code> tells Crowbook that is a a standalone markdown file, and not a book configuration file, and to be a bit quiet on error/info messages;</li>
|
||||
<li><code>--to html</code> specifies that HTML must be generated;</li>
|
||||
<li><code>--output /dev/stdout</code> forces Crowbook to display the result on the stdout, even if you set <code>output.html</code> to <code>some_file.html</code>.</li>
|
||||
<li><code>--output -</code> tells Crowbook to display the result on the stdout, even if you set <code>output.html</code> to <code>some_file.html</code>.</li>
|
||||
</ul>
|
||||
<p id = "para-217">Also, <code>(markdown-command-needs-filename t)</code> is because at this point Crowbook can’t read from the stdin and must be specified a file.</p>
|
||||
<h3 id = "link-100">Limitations</h3>
|
||||
<p id = "para-218">While it renders correctly, this only works really nicely on standalone Markdown files where you have specified, e.g.:</p>
|
||||
<h3 id = "link-102">Limitations</h3>
|
||||
<p id = "para-217">While it renders correctly, this only works really nicely on standalone Markdown files where you have specified, e.g.:</p>
|
||||
<pre><code class = "language-markdown">---
|
||||
author: Your name
|
||||
title: Some title
|
||||
---
|
||||
</code></pre>
|
||||
<p id = "para-219">Else, it will sets <code>author</code> and <code>title</code> to the default values.</p>
|
||||
<h2 id = "link-101">6.2. Embedding fonts in an EPUB file</h2>
|
||||
<p id = "para-220">In order to embed fonts in an EPUB file, you’ll first have to edit the stylesheet, which you can first obtain with:</p>
|
||||
<p id = "para-218">Else, it will sets <code>author</code> and <code>title</code> to the default values.</p>
|
||||
<h2 id = "link-103">6.2. Embedding fonts in an EPUB file</h2>
|
||||
<p id = "para-219">In order to embed fonts in an EPUB file, you’ll first have to edit the stylesheet, which you can first obtain with:</p>
|
||||
<pre><code class = "language-bash">$ crowbook --print-template epub.css > my_epub_stylesheet.css
|
||||
</code></pre>
|
||||
<p id = "para-221">You’ll need to use the <a href = "https://developer.mozilla.org/fr/docs/Web/CSS/@font-face"><code>@font-face</code> attribute</a>:</p>
|
||||
<p id = "para-220">You’ll need to use the <a href = "https://developer.mozilla.org/fr/docs/Web/CSS/@font-face"><code>@font-face</code> attribute</a>:</p>
|
||||
<pre><code class = "language-css">@font-face {
|
||||
font-family: MyFont;
|
||||
src: url(data/my_font.ttf);
|
||||
}
|
||||
</code></pre>
|
||||
<p id = "para-222">Then you can add <code>my_font.ttf</code> to the files that need to be added to the EPUB zip file:</p>
|
||||
<p id = "para-221">Then you can add <code>my_font.ttf</code> to the files that need to be added to the EPUB zip file:</p>
|
||||
<pre><code class = "language-yaml">title: My Book
|
||||
author: Me
|
||||
|
||||
|
|
@ -271,7 +219,7 @@ output.epub: book.epub
|
|||
|
||||
resources.files: my_font.ttf
|
||||
</code></pre>
|
||||
<p id = "para-223">(Note that you’ll 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>
|
||||
<p id = "para-222">(Note that you’ll 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>
|
||||
|
||||
<p class = "next_chapter">
|
||||
<a href = "chapter_006.html">
|
||||
|
|
@ -279,8 +227,8 @@ resources.files: my_font.ttf
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-305">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.10.5-pre</p>
|
||||
<footer id = "footer"><p id = "para-305">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.0-pre</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -38,25 +38,25 @@ function toggle() {
|
|||
if (display_menu == true) {
|
||||
display_menu = false;
|
||||
document.getElementById("nav").style.left = "-21%";
|
||||
document.getElementById("content").style.marginLeft = "10%";
|
||||
document.getElementById("content").style.marginLeft = "0%";
|
||||
document.getElementById("menu").style.left = "1em";
|
||||
if(document.getElementById("top")) {
|
||||
/* 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("content").style.marginLeft = "20%";
|
||||
document.getElementById("menu").style.left = "20%";
|
||||
if(document.getElementById("top")) {
|
||||
/* if(document.getElementById("top")) {
|
||||
document.getElementById("top").style.left = "20%";
|
||||
}
|
||||
if(document.getElementById("footer")) {
|
||||
document.getElementById("footer").style.marginLeft = "20%";
|
||||
}
|
||||
}*/
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -69,168 +69,117 @@ function toggle() {
|
|||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-2">1.1. Example</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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 (<code>crowbook --single</code>)</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-40">3.3. Crowbook options</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-68">4. Templates</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_003.html#link-69">4.1. Create and edit template</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-73">4.2. List of templates</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-88">4.3. List of accessible variables</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-92">5. Proofreading with Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_004.html#link-93">5.1. Enabling proofreading</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-94">5.2. Repetition detection</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-95">5.3. Grammar checking</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-96">5.4. Highlighting non-breaking spaces</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-97">6. Tips and tricks</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_005.html#link-98">6.1. Using Crowbook with Emacs’ markdown mode</a>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-101">6.2. Embedding fonts in an EPUB file</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-102">7. Contributing</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_006.html#link-103">7.1. Internationalization</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-104">ChangeLog</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_007.html#link-105">unreleased</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-106">0.10.4 (2016-12-16)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-107">0.10.3 (2016-11-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.2 (2016-10-21)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.1 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.0 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-111">0.9.1 (2016-09-29)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-112">0.9.0 (2016-09-23)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-113">0.8.0 (2016-09-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-114">0.7.0 (2016-09-11)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-115">0.6.0 (2016-09-09)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-116">0.5.1 (2016-04-14)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-117">0.5.0 (2016-04-02)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-118">0.4.0 (2016-03-01)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">0.3.0 (2016-02-27)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-120">0.2.2 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-121">0.2.1 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.0 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-123">0.1.0 (2016-02-21)</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-124">GNU LESSER GENERAL PUBLIC LICENSE</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_002.html#link-55">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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>
|
||||
<li><a href = "chapter_004.html#link-98">5.4. Highlighting non-breaking spaces</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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">0.11.0 (???)</a></li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_007.html#link-111">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-112">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-113">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_007.html#link-114">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_007.html#link-115">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-116">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_007.html#link-117">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_007.html#link-118">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_007.html#link-119">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_007.html#link-120">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_007.html#link-121">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-123">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-124">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-125">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-126">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-308">Crowbook User Guide 0.11.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
<div id = "top"><p id = "para-308">Crowbook User Guide 0.10.5</p>
|
||||
</div>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<p class = "prev_chapter">
|
||||
<a href = "chapter_005.html">
|
||||
« 6. Tips and tricks
|
||||
</a>
|
||||
</p>
|
||||
<h1 id = "link-102">7. Contributing</h1>
|
||||
<p id = "para-224">Crowbook is a free software, and you can contribute to it. There are some things that can be accessible even if you don’t know anything about programming.</p>
|
||||
<h2 id = "link-103">7.1. Internationalization</h2>
|
||||
<p id = "para-225">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>
|
||||
<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 don’t 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>
|
||||
<ul>
|
||||
<li>Provide a translation for the few strings that Crowbook insert into the rendered documents. This is really easy, as there are currently less than a dozen of them, and you just need to create a new variant of the <a href = "https://github.com/lise-henry/crowbook/blob/master/lang/en.yaml"><code>lang/en.yaml</code></a> file.</li>
|
||||
<li>Open an <a href = "https://github.com/lise-henry/crowbook/issues">issue</a> about the typographic rules in your language, if Crowbook doesn’t cover them.</li>
|
||||
|
|
@ -243,8 +192,8 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-307">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.10.5-pre</p>
|
||||
<footer id = "footer"><p id = "para-307">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.0-pre</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -38,25 +38,25 @@ function toggle() {
|
|||
if (display_menu == true) {
|
||||
display_menu = false;
|
||||
document.getElementById("nav").style.left = "-21%";
|
||||
document.getElementById("content").style.marginLeft = "10%";
|
||||
document.getElementById("content").style.marginLeft = "0%";
|
||||
document.getElementById("menu").style.left = "1em";
|
||||
if(document.getElementById("top")) {
|
||||
/* 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("content").style.marginLeft = "20%";
|
||||
document.getElementById("menu").style.left = "20%";
|
||||
if(document.getElementById("top")) {
|
||||
/* if(document.getElementById("top")) {
|
||||
document.getElementById("top").style.left = "20%";
|
||||
}
|
||||
if(document.getElementById("footer")) {
|
||||
document.getElementById("footer").style.marginLeft = "20%";
|
||||
}
|
||||
}*/
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -69,169 +69,155 @@ function toggle() {
|
|||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-2">1.1. Example</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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 (<code>crowbook --single</code>)</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-40">3.3. Crowbook options</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-68">4. Templates</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_003.html#link-69">4.1. Create and edit template</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-73">4.2. List of templates</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-88">4.3. List of accessible variables</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-92">5. Proofreading with Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_004.html#link-93">5.1. Enabling proofreading</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-94">5.2. Repetition detection</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-95">5.3. Grammar checking</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-96">5.4. Highlighting non-breaking spaces</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-97">6. Tips and tricks</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_005.html#link-98">6.1. Using Crowbook with Emacs’ markdown mode</a>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-101">6.2. Embedding fonts in an EPUB file</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-102">7. Contributing</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_006.html#link-103">7.1. Internationalization</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-104">ChangeLog</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_007.html#link-105">unreleased</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-106">0.10.4 (2016-12-16)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-107">0.10.3 (2016-11-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.2 (2016-10-21)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.1 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.0 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-111">0.9.1 (2016-09-29)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-112">0.9.0 (2016-09-23)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-113">0.8.0 (2016-09-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-114">0.7.0 (2016-09-11)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-115">0.6.0 (2016-09-09)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-116">0.5.1 (2016-04-14)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-117">0.5.0 (2016-04-02)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-118">0.4.0 (2016-03-01)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">0.3.0 (2016-02-27)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-120">0.2.2 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-121">0.2.1 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.0 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-123">0.1.0 (2016-02-21)</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-124">GNU LESSER GENERAL PUBLIC LICENSE</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_002.html#link-55">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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>
|
||||
<li><a href = "chapter_004.html#link-98">5.4. Highlighting non-breaking spaces</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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">0.11.0 (???)</a></li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_007.html#link-111">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-112">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-113">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_007.html#link-114">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_007.html#link-115">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-116">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_007.html#link-117">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_007.html#link-118">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_007.html#link-119">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_007.html#link-120">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_007.html#link-121">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-123">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-124">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-125">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-126">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-310">Crowbook User Guide 0.11.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
<div id = "top"><p id = "para-310">Crowbook User Guide 0.10.5</p>
|
||||
</div>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<p class = "prev_chapter">
|
||||
<a href = "chapter_006.html">
|
||||
« 7. Contributing
|
||||
</a>
|
||||
</p>
|
||||
<h1 id = "link-104">ChangeLog</h1>
|
||||
<h2 id = "link-105">unreleased</h2>
|
||||
<h1 id = "link-106">ChangeLog</h1>
|
||||
<h2 id = "link-107">0.11.0 (???)</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>
|
||||
<li>Crowbook now supports parts (above the “chapter” level), using the ‘@’ character in the book configuration file.</li>
|
||||
<li>Command-line interface:<ul>
|
||||
<li>Behaviour of <code>--to</code> should now be consistent for all output formats.</li>
|
||||
<li>If <code>--output</code> is set to <code>-</code>, prints to stdout.</li>
|
||||
<li>Conversely, if <code><BOOK></code> is set to <code>-</code>, reads from stdin.</li>
|
||||
<li>Path specified by <code>--output</code> is now interpreted relatively to current directory (and not depending on where <code><BOOK></code> is or its options).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Rendering:<ul>
|
||||
<li>EPUB: the toc.ncx now displays links to “title” and (if set) “cover”</li>
|
||||
<li>Chapters with no titles now have an empty title added (so it can at least display e.g. “Chapter X”).</li>
|
||||
<li>EPUB:<ul>
|
||||
<li>The <code>toc.ncx</code> file now displays links to “title” and (if set) “cover” (can be deactivated, see below).</li>
|
||||
<li>The <code>toc.ncx</code> file now displays toc levels below chapter.</li>
|
||||
<li>The table of contents is now displayed inline if <code>rendering.inline_toc</code> is set to <code>true</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>New options:<ul>
|
||||
<li><code>epub.toc.extras</code>, set to <code>true</code> by default, will add links to the title and the cover (if it is set) in the table of contents.</li>
|
||||
<li><code>epub.escape_nb_spaces</code>, similar to <code>html.escape_nb_spaces</code> and set to false by default since at least Kobo reader don’t seem to be able to understand the CSS to escape those nb spaces...</li>
|
||||
<li><code>rendering.chapter.roman_numerals</code>, if set to <code>true</code>, will display chapter numbers using roman numerals.</li>
|
||||
<li><code>rendering.part.roman_numerals</code>, if set to <code>true</code> (it is by default) will display part numbers using roman numerals.</li>
|
||||
<li><code>rendering.part.template</code> specifies the numbering scheme of parts.</li>
|
||||
<li><code>rendering.part.reset_counter</code>, if set to <code>true</code> (it is by default), resets chapter number to zero after a part.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Renamed options:<ul>
|
||||
<li><code>import_config</code> renamed to <code>import</code>.</li>
|
||||
<li><code>rendering.chapter_template</code> renamed to <code>rendering.chapter.template</code>.</li>
|
||||
<li><code>html_single.html</code> renamed to <code>html.standalone.template</code>.</li>
|
||||
<li><code>html_single.js</code> renamed to <code>html.standalone.js</code>.</li>
|
||||
<li><code>html_single.one_chapter</code> renamed to <code>html.standalone.one_chapter</code>.</li>
|
||||
<li><code>output.html_dir</code> renamed to <code>output.html.dir</code>.</li>
|
||||
<li><code>output.proofread.html_dir</code> renamed to <code>output.proofread.html.dir</code>.</li>
|
||||
<li><code>html_dir.index.html</code> and <code>html.dir.chapter.html</code> have been merged and both renamed to <code>html.dir.template</code>.</li>
|
||||
<li><code>tex.font_size</code> renamed to <code>tex.font.size</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Bugfixes:<ul>
|
||||
|
|
@ -239,6 +225,15 @@ function toggle() {
|
|||
<li>Fix duplicate HTML escaping (resulting in e.g. "&" instead of "&").</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>HTML directory:<ul>
|
||||
<li>Fix panic when trying to generate html directory in “../xxx” (<a href = "https://github.com/lise-henry/crowbook/issues/23">#23</a>).</li>
|
||||
<li>Fix “previous chapter” links that were not displayed when “html.header” was set.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>HTML:<ul>
|
||||
<li>Fix the way initial letter is displayed if <code>rendering.initials</code> is true.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Internationalization:<ul>
|
||||
|
|
@ -246,7 +241,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-106">0.10.4 (2016-12-16)</h2>
|
||||
<h2 id = "link-108">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>
|
||||
|
|
@ -268,7 +263,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-107">0.10.3 (2016-11-19)</h2>
|
||||
<h2 id = "link-109">0.10.3 (2016-11-19)</h2>
|
||||
<ul>
|
||||
<li>Building:<ul>
|
||||
<li>Crowbook now requires rustc >= 1.13.0 to build.</li>
|
||||
|
|
@ -289,7 +284,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-108">0.10.2 (2016-10-21)</h2>
|
||||
<h2 id = "link-110">0.10.2 (2016-10-21)</h2>
|
||||
<p id = "para-226">Only minor changes in this version:</p>
|
||||
<ul>
|
||||
<li>Options:<ul>
|
||||
|
|
@ -305,9 +300,9 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-109">0.10.1 (2016-10-18)</h2>
|
||||
<h2 id = "link-111">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-110">0.10.0 (2016-10-18)</h2>
|
||||
<h2 id = "link-112">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>
|
||||
|
|
@ -344,7 +339,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-111">0.9.1 (2016-09-29)</h2>
|
||||
<h2 id = "link-113">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>
|
||||
|
|
@ -375,7 +370,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-112">0.9.0 (2016-09-23)</h2>
|
||||
<h2 id = "link-114">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 Crowbook’s library API;</li>
|
||||
|
|
@ -440,7 +435,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-113">0.8.0 (2016-09-19)</h2>
|
||||
<h2 id = "link-115">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>
|
||||
|
|
@ -480,7 +475,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-114">0.7.0 (2016-09-11)</h2>
|
||||
<h2 id = "link-116">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>
|
||||
|
|
@ -494,7 +489,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-115">0.6.0 (2016-09-09)</h2>
|
||||
<h2 id = "link-117">0.6.0 (2016-09-09)</h2>
|
||||
<ul>
|
||||
<li>Deprecated options:<ul>
|
||||
<li><code>nb_char</code>: since it was only used for french cleaner and for typography reasons it’s better to use different non breaking spaces according to context, this option was not really useful anymore.</li>
|
||||
|
|
@ -521,7 +516,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-116">0.5.1 (2016-04-14)</h2>
|
||||
<h2 id = "link-118">0.5.1 (2016-04-14)</h2>
|
||||
<p id = "para-233">Mostly rendering fixes:</p>
|
||||
<ul>
|
||||
<li>Epub:<ul>
|
||||
|
|
@ -547,7 +542,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-117">0.5.0 (2016-04-02)</h2>
|
||||
<h2 id = "link-119">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>
|
||||
|
|
@ -586,7 +581,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-118">0.4.0 (2016-03-01)</h2>
|
||||
<h2 id = "link-120">0.4.0 (2016-03-01)</h2>
|
||||
<ul>
|
||||
<li>Crowbook now internally uses a true YAML parser, <code>yaml_rust</code>, for its options. Since the “old” Crowbooks’s config format was similar, but had some subtle differences, this is somewhat of a breaking change:<ul>
|
||||
<li>strings should now be escaped with “” in some cases (e.g. if it contains special characters). On the other hand, it <em>allows</em> to optionally escape a string with these quotes, which wasn’t possible until then and might be useful in some cases.</li>
|
||||
|
|
@ -606,7 +601,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-119">0.3.0 (2016-02-27)</h2>
|
||||
<h2 id = "link-121">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>
|
||||
|
|
@ -624,14 +619,14 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-120">0.2.2 (2016-02-25)</h2>
|
||||
<h2 id = "link-122">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-121">0.2.1 (2016-02-25)</h2>
|
||||
<h2 id = "link-123">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>
|
||||
|
|
@ -643,7 +638,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-122">0.2.0 (2016-02-25)</h2>
|
||||
<h2 id = "link-124">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>
|
||||
|
|
@ -668,7 +663,7 @@ function toggle() {
|
|||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-123">0.1.0 (2016-02-21)</h2>
|
||||
<h2 id = "link-125">0.1.0 (2016-02-21)</h2>
|
||||
<ul>
|
||||
<li>initial release</li>
|
||||
</ul>
|
||||
|
|
@ -679,8 +674,8 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-309">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.10.5-pre</p>
|
||||
<footer id = "footer"><p id = "para-309">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.0-pre</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -38,25 +38,25 @@ function toggle() {
|
|||
if (display_menu == true) {
|
||||
display_menu = false;
|
||||
document.getElementById("nav").style.left = "-21%";
|
||||
document.getElementById("content").style.marginLeft = "10%";
|
||||
document.getElementById("content").style.marginLeft = "0%";
|
||||
document.getElementById("menu").style.left = "1em";
|
||||
if(document.getElementById("top")) {
|
||||
/* 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("content").style.marginLeft = "20%";
|
||||
document.getElementById("menu").style.left = "20%";
|
||||
if(document.getElementById("top")) {
|
||||
/* if(document.getElementById("top")) {
|
||||
document.getElementById("top").style.left = "20%";
|
||||
}
|
||||
if(document.getElementById("footer")) {
|
||||
document.getElementById("footer").style.marginLeft = "20%";
|
||||
}
|
||||
}*/
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -69,165 +69,114 @@ function toggle() {
|
|||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-2">1.1. Example</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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 (<code>crowbook --single</code>)</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-40">3.3. Crowbook options</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-68">4. Templates</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_003.html#link-69">4.1. Create and edit template</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-73">4.2. List of templates</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-88">4.3. List of accessible variables</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-92">5. Proofreading with Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_004.html#link-93">5.1. Enabling proofreading</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-94">5.2. Repetition detection</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-95">5.3. Grammar checking</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-96">5.4. Highlighting non-breaking spaces</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-97">6. Tips and tricks</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_005.html#link-98">6.1. Using Crowbook with Emacs’ markdown mode</a>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-101">6.2. Embedding fonts in an EPUB file</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-102">7. Contributing</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_006.html#link-103">7.1. Internationalization</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-104">ChangeLog</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_007.html#link-105">unreleased</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-106">0.10.4 (2016-12-16)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-107">0.10.3 (2016-11-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.2 (2016-10-21)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.1 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.0 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-111">0.9.1 (2016-09-29)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-112">0.9.0 (2016-09-23)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-113">0.8.0 (2016-09-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-114">0.7.0 (2016-09-11)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-115">0.6.0 (2016-09-09)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-116">0.5.1 (2016-04-14)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-117">0.5.0 (2016-04-02)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-118">0.4.0 (2016-03-01)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">0.3.0 (2016-02-27)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-120">0.2.2 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-121">0.2.1 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.0 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-123">0.1.0 (2016-02-21)</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-124">GNU LESSER GENERAL PUBLIC LICENSE</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_002.html#link-55">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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>
|
||||
<li><a href = "chapter_004.html#link-98">5.4. Highlighting non-breaking spaces</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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">0.11.0 (???)</a></li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_007.html#link-111">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-112">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-113">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_007.html#link-114">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_007.html#link-115">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-116">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_007.html#link-117">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_007.html#link-118">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_007.html#link-119">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_007.html#link-120">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_007.html#link-121">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-123">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-124">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-125">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-126">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-312">Crowbook User Guide 0.11.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
<div id = "top"><p id = "para-312">Crowbook User Guide 0.10.5</p>
|
||||
</div>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
src="menu.svg" alt = "Table of contents" title = "Table of contents" />
|
||||
</div>
|
||||
</header>
|
||||
<p class = "prev_chapter">
|
||||
<a href = "chapter_007.html">
|
||||
« ChangeLog
|
||||
</a>
|
||||
</p>
|
||||
<h1 id = "link-124">GNU LESSER GENERAL PUBLIC LICENSE</h1>
|
||||
<h1 id = "link-126">GNU LESSER GENERAL PUBLIC LICENSE</h1>
|
||||
<pre><code> Version 2.1, February 1999
|
||||
</code></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>
|
||||
|
|
@ -422,8 +371,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-311">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.10.5-pre</p>
|
||||
<footer id = "footer"><p id = "para-311">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.0-pre</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -6,17 +6,17 @@
|
|||
<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</title>
|
||||
<title></title>
|
||||
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
|
||||
/>
|
||||
<link rel = "stylesheet" href = "print.css" type = "text/css"
|
||||
media = "print" />
|
||||
<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);
|
||||
|
|
@ -38,25 +38,25 @@ function toggle() {
|
|||
if (display_menu == true) {
|
||||
display_menu = false;
|
||||
document.getElementById("nav").style.left = "-21%";
|
||||
document.getElementById("content").style.marginLeft = "10%";
|
||||
document.getElementById("content").style.marginLeft = "0%";
|
||||
document.getElementById("menu").style.left = "1em";
|
||||
if(document.getElementById("top")) {
|
||||
/* 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("content").style.marginLeft = "20%";
|
||||
document.getElementById("menu").style.left = "20%";
|
||||
if(document.getElementById("top")) {
|
||||
/* if(document.getElementById("top")) {
|
||||
document.getElementById("top").style.left = "20%";
|
||||
}
|
||||
if(document.getElementById("footer")) {
|
||||
document.getElementById("footer").style.marginLeft = "20%";
|
||||
}
|
||||
}*/
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -69,162 +69,109 @@ function toggle() {
|
|||
<nav id = "nav">
|
||||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_000.html#link-2">1.1. Example</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a>
|
||||
</li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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 (<code>crowbook --single</code>)</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-40">3.3. Crowbook options</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-68">4. Templates</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_003.html#link-69">4.1. Create and edit template</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-73">4.2. List of templates</a>
|
||||
</li>
|
||||
<li><a href = "chapter_003.html#link-88">4.3. List of accessible variables</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-92">5. Proofreading with Crowbook</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_004.html#link-93">5.1. Enabling proofreading</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-94">5.2. Repetition detection</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-95">5.3. Grammar checking</a>
|
||||
</li>
|
||||
<li><a href = "chapter_004.html#link-96">5.4. Highlighting non-breaking spaces</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-97">6. Tips and tricks</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_005.html#link-98">6.1. Using Crowbook with Emacs’ markdown mode</a>
|
||||
</li>
|
||||
<li><a href = "chapter_005.html#link-101">6.2. Embedding fonts in an EPUB file</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_006.html#link-102">7. Contributing</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_006.html#link-103">7.1. Internationalization</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-104">ChangeLog</a>
|
||||
<ul>
|
||||
<li><a href = "chapter_007.html#link-105">unreleased</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-106">0.10.4 (2016-12-16)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-107">0.10.3 (2016-11-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.2 (2016-10-21)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.1 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.0 (2016-10-18)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-111">0.9.1 (2016-09-29)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-112">0.9.0 (2016-09-23)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-113">0.8.0 (2016-09-19)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-114">0.7.0 (2016-09-11)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-115">0.6.0 (2016-09-09)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-116">0.5.1 (2016-04-14)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-117">0.5.0 (2016-04-02)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-118">0.4.0 (2016-03-01)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-119">0.3.0 (2016-02-27)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-120">0.2.2 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-121">0.2.1 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.0 (2016-02-25)</a>
|
||||
</li>
|
||||
<li><a href = "chapter_007.html#link-123">0.1.0 (2016-02-21)</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-124">GNU LESSER GENERAL PUBLIC LICENSE</a>
|
||||
</li>
|
||||
<li><a href = "chapter_000.html#link-1">1. Crowbook</a>
|
||||
<ul><li><a href = "chapter_000.html#link-2">1.1. Example</a></li>
|
||||
<li><a href = "chapter_000.html#link-3">1.2. Installing</a></li>
|
||||
<li><a href = "chapter_000.html#link-6">1.3. Dependencies</a></li>
|
||||
<li><a href = "chapter_000.html#link-7">1.4. Quick tour</a></li>
|
||||
<li><a href = "chapter_000.html#link-8">1.5. Current features</a></li>
|
||||
<li><a href = "chapter_000.html#link-16">1.6. Contributors</a></li>
|
||||
<li><a href = "chapter_000.html#link-17">1.7. Acknowledgements</a></li>
|
||||
<li><a href = "chapter_000.html#link-18">1.8. ChangeLog</a></li>
|
||||
<li><a href = "chapter_000.html#link-19">1.9. Contributing</a></li>
|
||||
<li><a href = "chapter_000.html#link-20">1.10. Library</a></li>
|
||||
<li><a href = "chapter_000.html#link-21">1.11. License</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_001.html#link-28">2.4. <code>--proofread</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-29">2.5. <code>--list-options</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-30">2.6. <code>--print-template</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-31">2.7. <code>--verbose</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-32">2.8. <code>--to</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-34">2.9. <code>--output</code></a></li>
|
||||
<li><a href = "chapter_001.html#link-35">2.10. <code>--lang</code></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href = "chapter_002.html#link-55">3.4. Full list of options</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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>
|
||||
<li><a href = "chapter_004.html#link-98">5.4. Highlighting non-breaking spaces</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<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">0.11.0 (???)</a></li>
|
||||
<li><a href = "chapter_007.html#link-108">0.10.4 (2016-12-16)</a></li>
|
||||
<li><a href = "chapter_007.html#link-109">0.10.3 (2016-11-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-110">0.10.2 (2016-10-21)</a></li>
|
||||
<li><a href = "chapter_007.html#link-111">0.10.1 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-112">0.10.0 (2016-10-18)</a></li>
|
||||
<li><a href = "chapter_007.html#link-113">0.9.1 (2016-09-29)</a></li>
|
||||
<li><a href = "chapter_007.html#link-114">0.9.0 (2016-09-23)</a></li>
|
||||
<li><a href = "chapter_007.html#link-115">0.8.0 (2016-09-19)</a></li>
|
||||
<li><a href = "chapter_007.html#link-116">0.7.0 (2016-09-11)</a></li>
|
||||
<li><a href = "chapter_007.html#link-117">0.6.0 (2016-09-09)</a></li>
|
||||
<li><a href = "chapter_007.html#link-118">0.5.1 (2016-04-14)</a></li>
|
||||
<li><a href = "chapter_007.html#link-119">0.5.0 (2016-04-02)</a></li>
|
||||
<li><a href = "chapter_007.html#link-120">0.4.0 (2016-03-01)</a></li>
|
||||
<li><a href = "chapter_007.html#link-121">0.3.0 (2016-02-27)</a></li>
|
||||
<li><a href = "chapter_007.html#link-122">0.2.2 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-123">0.2.1 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-124">0.2.0 (2016-02-25)</a></li>
|
||||
<li><a href = "chapter_007.html#link-125">0.1.0 (2016-02-21)</a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href = "chapter_008.html#link-126">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-313">Crowbook User Guide 0.11.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
<div id = "top"><p id = "para-313">Crowbook User Guide 0.10.5</p>
|
||||
</div>
|
||||
<div id = "menu">
|
||||
<img id = "menu-button" onclick="toggle();"
|
||||
<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_1.png" />
|
||||
</div><p class = "next_chapter">
|
||||
|
|
@ -232,9 +179,10 @@ function toggle() {
|
|||
1. Crowbook »
|
||||
</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-314">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.10.5-pre</p>
|
||||
<footer id = "footer"><p id = "para-314">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.11.0-pre</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -43,6 +43,18 @@ h1, h2, h3, h4, h5, h6 {
|
|||
font-variant: small-caps;
|
||||
}
|
||||
|
||||
/* Title of a part */
|
||||
h1.part {
|
||||
font-size: 250%;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
/* The `Part X` section of a part */
|
||||
h2.part {
|
||||
font-size: 175%;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
/* Title of the book */
|
||||
h1.title {
|
||||
text-align: center;
|
||||
|
|
@ -241,10 +253,6 @@ footer a:hover, #top a:hover {
|
|||
}
|
||||
|
||||
|
||||
span.initial {
|
||||
all: initial;
|
||||
}
|
||||
|
||||
p.first-para:first-letter {
|
||||
font-size: 300%;
|
||||
float: left;
|
||||
|
|
@ -339,10 +347,11 @@ nav {
|
|||
|
||||
/* The main content of the book */
|
||||
#content {
|
||||
/* position: absolute;*/
|
||||
overflow-y: auto;
|
||||
margin-left: 10%;
|
||||
margin-right: 10%;
|
||||
margin-left: 0;
|
||||
margin-right: 0;
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
transition: margin-left 1s;
|
||||
}
|
||||
|
||||
|
|
@ -403,32 +412,27 @@ blockquote {
|
|||
cursor: pointer;
|
||||
}
|
||||
|
||||
footer {
|
||||
margin-top: 2em;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
#top {
|
||||
position: absolute;
|
||||
z-index: 1;
|
||||
top: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
height: 2em;
|
||||
width: auto;
|
||||
text-align: center;
|
||||
transition: left 1s;
|
||||
margin-top: 0;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
#top p {
|
||||
margin-top: 0.5em;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
width: 70%;
|
||||
text-align: center;
|
||||
font-family: "Linux Biolinum";
|
||||
font-weight: bold;
|
||||
font-variant: small-caps;
|
||||
}
|
||||
|
||||
footer {
|
||||
margin-top: 2em;
|
||||
footer, #top {
|
||||
padding-top: .25em;
|
||||
padding-bottom: .25em;
|
||||
margin-left: 0;
|
||||
margin-right: 0;
|
||||
text-align: center;
|
||||
transition: margin-left 1s;
|
||||
}
|
||||
|
|
@ -437,12 +441,12 @@ footer a, #top a {
|
|||
text-decoration: none;
|
||||
}
|
||||
|
||||
footer p {
|
||||
footer p, #top p {
|
||||
text-indent: 0;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
margin-bottom: 0.5em;
|
||||
margin-top: 0.5em;
|
||||
width: 70%;
|
||||
max-width: 33em;
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue