mirror of
https://github.com/lise-henry/crowbook
synced 2024-05-18 04:06:15 +02:00
1915 lines
94 KiB
HTML
1915 lines
94 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="generator" content="crowbook">
|
||
<meta name="author" content="Élisabeth Henry">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel = "icon" href = "images/image_1.svg">
|
||
<title>Crowbook User Guide - 3. The configuration file</title>
|
||
<link rel = "stylesheet" href = "stylesheet.css" type = "text/css"
|
||
/>
|
||
<link rel = "stylesheet" href = "print.css" type = "text/css"
|
||
media = "print" />
|
||
<script>
|
||
function on(name) {
|
||
var elements = document.getElementsByClassName(name);
|
||
for (var i = 0; i < elements.length; i++) {
|
||
var elem = elements[i];
|
||
elem.style.backgroundColor = "pink";
|
||
}
|
||
}
|
||
function off(name) {
|
||
var elements = document.getElementsByClassName(name);
|
||
for (var i = 0; i < elements.length; i++) {
|
||
var elem = elements[i];
|
||
elem.style.backgroundColor = "white";
|
||
}
|
||
}
|
||
|
||
var display_menu = false;
|
||
function toggle() {
|
||
if (display_menu == true) {
|
||
display_menu = false;
|
||
document.getElementById("nav").style.left = "-21%";
|
||
document.getElementById("content").style.marginLeft = "0%";
|
||
document.getElementById("menu").style.left = "1em";
|
||
/* if(document.getElementById("top")) {
|
||
document.getElementById("top").style.left = "0";
|
||
}
|
||
if(document.getElementById("footer")) {
|
||
document.getElementById("footer").style.marginLeft = "0%";
|
||
}*/
|
||
} else {
|
||
display_menu = true;
|
||
document.getElementById("nav").style.left = "0";
|
||
document.getElementById("content").style.marginLeft = "20%";
|
||
document.getElementById("menu").style.left = "20%";
|
||
/* if(document.getElementById("top")) {
|
||
document.getElementById("top").style.left = "20%";
|
||
}
|
||
if(document.getElementById("footer")) {
|
||
document.getElementById("footer").style.marginLeft = "20%";
|
||
}*/
|
||
}
|
||
}
|
||
|
||
</script>
|
||
|
||
|
||
</head>
|
||
<body>
|
||
|
||
<script type = 'application/ld+json'>
|
||
{
|
||
"@context": "http://schema.org/",
|
||
"@type": "Book",
|
||
"author": "Élisabeth Henry",
|
||
"name": "Crowbook User Guide",
|
||
"version": "0.15.0",
|
||
|
||
|
||
"license": "This guide is published under the Creative Commons Attribution-ShareAlike 4.0-International license.",
|
||
"about": "Crowbook allows to render a book written in Markdown in various formats. This is some kind of manual for it, and a way to demonstrate and test it.",
|
||
"inLanguage": "en"
|
||
|
||
|
||
|
||
|
||
}
|
||
</script>
|
||
<nav id = "nav">
|
||
<h2><a href = "index.html">Crowbook User Guide</a></h2>
|
||
<ul>
|
||
<li>
|
||
<a href="chapter_000.html#link-1">1. Crowbook</a>
|
||
<ul>
|
||
<li><a href="chapter_000.html#link-2">1.1. Example</a></li>
|
||
<li>
|
||
<a href="chapter_000.html#link-3">1.2. Installing</a>
|
||
<ul>
|
||
<li><a href="chapter_000.html#link-4">1.2.1. Binaries</a></li>
|
||
<li><a href="chapter_000.html#link-5">1.2.2. Using Cargo</a></li>
|
||
</ul>
|
||
</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>
|
||
<ul>
|
||
<li><a href="chapter_000.html#link-9">1.5.1. Output formats</a></li>
|
||
<li><a href="chapter_000.html#link-10">1.5.2. Input format</a></li>
|
||
<li><a href="chapter_000.html#link-11">1.5.3. Typographic “cleaning”</a></li>
|
||
<li><a href="chapter_000.html#link-12">1.5.4. Links handling</a></li>
|
||
<li><a href="chapter_000.html#link-13">1.5.5. Inline YAML blocks</a></li>
|
||
<li><a href="chapter_000.html#link-14">1.5.6. Proofreading</a></li>
|
||
<li><a href="chapter_000.html#link-15">1.5.7. Interactive fiction</a></li>
|
||
<li><a href="chapter_000.html#link-16">1.5.8. Customization</a></li>
|
||
<li><a href="chapter_000.html#link-17">1.5.9. Bugs</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="chapter_000.html#link-18">1.6. Contributors</a></li>
|
||
<li><a href="chapter_000.html#link-19">1.7. Acknowledgements</a></li>
|
||
<li><a href="chapter_000.html#link-20">1.8. ChangeLog</a></li>
|
||
<li><a href="chapter_000.html#link-21">1.9. Contributing</a></li>
|
||
<li><a href="chapter_000.html#link-22">1.10. Library</a></li>
|
||
<li><a href="chapter_000.html#link-23">1.11. License</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_001.html#link-24">2. Arguments</a>
|
||
<ul>
|
||
<li><a href="chapter_001.html#link-25">2.1. <code>--create</code></a></li>
|
||
<li><a href="chapter_001.html#link-26">2.2. <code>--single</code></a></li>
|
||
<li><a href="chapter_001.html#link-27">2.3. <code>--set</code></a></li>
|
||
<li><a href="chapter_001.html#link-28">2.4. <code>--list-options</code></a></li>
|
||
<li><a href="chapter_001.html#link-29">2.5. <code>--print-template</code></a></li>
|
||
<li><a href="chapter_001.html#link-30">2.6. <code>--stats</code></a></li>
|
||
<li><a href="chapter_001.html#link-31">2.7. <code>--proofread</code></a></li>
|
||
<li>
|
||
<a href="chapter_001.html#link-32">2.8. <code>--autograph</code></a>
|
||
<ul>
|
||
<li><a href="chapter_001.html#link-33">2.8.1. Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="chapter_001.html#link-34">2.9. <code>--verbose</code></a></li>
|
||
<li>
|
||
<a href="chapter_001.html#link-35">2.10. <code>--to</code></a>
|
||
<ul>
|
||
<li><a href="chapter_001.html#link-36">2.10.1. Examples</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="chapter_001.html#link-37">2.11. <code>--output</code></a></li>
|
||
<li>
|
||
<a href="chapter_001.html#link-38">2.12. <code>--lang</code></a>
|
||
<ul>
|
||
<li><a href="chapter_001.html#link-39">2.12.1. Example</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-40">3. The configuration file</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-41">3.1. Configuration in an inline YAML block</a></li>
|
||
<li>
|
||
<a href="chapter_002.html#link-42">3.2. The list of files</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-43">3.2.1. Parts</a></li>
|
||
<li><a href="chapter_002.html#link-44">3.2.2. Subchapters</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-45">3.3. Crowbook options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-46">3.3.1. Metadata</a></li>
|
||
<li><a href="chapter_002.html#link-47">3.3.2. The <code>import</code> special option</a></li>
|
||
<li>
|
||
<a href="chapter_002.html#link-48">3.3.3. Output options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-49">3.3.3.1. The <code>output</code> option</a></li>
|
||
<li><a href="chapter_002.html#link-50">3.3.3.2. <code>output.base_path</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="chapter_002.html#link-51">3.3.4. Input options</a></li>
|
||
<li><a href="chapter_002.html#link-52">3.3.5. Generic options for rendering</a></li>
|
||
<li>
|
||
<a href="chapter_002.html#link-53">3.3.6. HTML Options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-54">3.3.6.1. Options for standalone HTML</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="chapter_002.html#link-55">3.3.7. Options for LaTeX/PDF rendering</a></li>
|
||
<li><a href="chapter_002.html#link-56">3.3.8. Options for EPUB rendering</a></li>
|
||
<li>
|
||
<a href="chapter_002.html#link-57">3.3.9. Resources options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-58">3.3.9.1. <code>resources.files</code></a></li>
|
||
<li><a href="chapter_002.html#link-59">3.3.9.2. <code>resources.out_path</code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-60">3.4. Full list of options</a>
|
||
<ul>
|
||
<li>
|
||
<a href="chapter_002.html#link-61">3.4.1. Metadata</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-62">3.4.1.1. <code>author</code></a></li>
|
||
<li><a href="chapter_002.html#link-63">3.4.1.2. <code>title</code></a></li>
|
||
<li><a href="chapter_002.html#link-64">3.4.1.3. <code>lang</code></a></li>
|
||
<li><a href="chapter_002.html#link-65">3.4.1.4. <code>subject</code></a></li>
|
||
<li><a href="chapter_002.html#link-66">3.4.1.5. <code>description</code></a></li>
|
||
<li><a href="chapter_002.html#link-67">3.4.1.6. <code>cover</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-68">3.4.2. Additional metadata</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-69">3.4.2.1. <code>subtitle</code></a></li>
|
||
<li><a href="chapter_002.html#link-70">3.4.2.2. <code>license</code></a></li>
|
||
<li><a href="chapter_002.html#link-71">3.4.2.3. <code>version</code></a></li>
|
||
<li><a href="chapter_002.html#link-72">3.4.2.4. <code>date</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-73">3.4.3. Output options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-74">3.4.3.1. <code>output</code></a></li>
|
||
<li><a href="chapter_002.html#link-75">3.4.3.2. <code>output.epub</code></a></li>
|
||
<li><a href="chapter_002.html#link-76">3.4.3.3. <code>output.html</code></a></li>
|
||
<li><a href="chapter_002.html#link-77">3.4.3.4. <code>output.html.dir</code></a></li>
|
||
<li><a href="chapter_002.html#link-78">3.4.3.5. <code>output.tex</code></a></li>
|
||
<li><a href="chapter_002.html#link-79">3.4.3.6. <code>output.pdf</code></a></li>
|
||
<li><a href="chapter_002.html#link-80">3.4.3.7. <code>output.odt</code></a></li>
|
||
<li><a href="chapter_002.html#link-81">3.4.3.8. <code>output.html.if</code></a></li>
|
||
<li><a href="chapter_002.html#link-82">3.4.3.9. <code>output.base_path</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-83">3.4.4. Rendering options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-84">3.4.4.1. <code>rendering.highlight</code></a></li>
|
||
<li><a href="chapter_002.html#link-85">3.4.4.2. <code>rendering.highlight.theme</code></a></li>
|
||
<li><a href="chapter_002.html#link-86">3.4.4.3. <code>rendering.initials</code></a></li>
|
||
<li><a href="chapter_002.html#link-87">3.4.4.4. <code>rendering.inline_toc</code></a></li>
|
||
<li><a href="chapter_002.html#link-88">3.4.4.5. <code>rendering.inline_toc.name</code></a></li>
|
||
<li><a href="chapter_002.html#link-89">3.4.4.6. <code>rendering.num_depth</code></a></li>
|
||
<li><a href="chapter_002.html#link-90">3.4.4.7. <code>rendering.chapter</code></a></li>
|
||
<li><a href="chapter_002.html#link-91">3.4.4.8. <code>rendering.part</code></a></li>
|
||
<li><a href="chapter_002.html#link-92">3.4.4.9. <code>rendering.chapter.roman_numerals</code></a></li>
|
||
<li><a href="chapter_002.html#link-93">3.4.4.10. <code>rendering.part.roman_numerals</code></a></li>
|
||
<li><a href="chapter_002.html#link-94">3.4.4.11. <code>rendering.part.reset_counter</code></a></li>
|
||
<li><a href="chapter_002.html#link-95">3.4.4.12. <code>rendering.chapter.template</code></a></li>
|
||
<li><a href="chapter_002.html#link-96">3.4.4.13. <code>rendering.part.template</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-97">3.4.5. Special option</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-98">3.4.5.1. <code>import</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-99">3.4.6. HTML options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-100">3.4.6.1. <code>html.icon</code></a></li>
|
||
<li><a href="chapter_002.html#link-101">3.4.6.2. <code>html.highlight.theme</code></a></li>
|
||
<li><a href="chapter_002.html#link-102">3.4.6.3. <code>html.header</code></a></li>
|
||
<li><a href="chapter_002.html#link-103">3.4.6.4. <code>html.footer</code></a></li>
|
||
<li><a href="chapter_002.html#link-104">3.4.6.5. <code>html.css</code></a></li>
|
||
<li><a href="chapter_002.html#link-105">3.4.6.6. <code>html.css.add</code></a></li>
|
||
<li><a href="chapter_002.html#link-106">3.4.6.7. <code>html.css.colors</code></a></li>
|
||
<li><a href="chapter_002.html#link-107">3.4.6.8. <code>html.js</code></a></li>
|
||
<li><a href="chapter_002.html#link-108">3.4.6.9. <code>html.css.print</code></a></li>
|
||
<li><a href="chapter_002.html#link-109">3.4.6.10. <code>html.highlight.js</code></a></li>
|
||
<li><a href="chapter_002.html#link-110">3.4.6.11. <code>html.highlight.css</code></a></li>
|
||
<li><a href="chapter_002.html#link-111">3.4.6.12. <code>html.side_notes</code></a></li>
|
||
<li><a href="chapter_002.html#link-112">3.4.6.13. <code>html.escape_nb_spaces</code></a></li>
|
||
<li><a href="chapter_002.html#link-113">3.4.6.14. <code>html.chapter.template</code></a></li>
|
||
<li><a href="chapter_002.html#link-114">3.4.6.15. <code>html.part.template</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-115">3.4.7. Standalone HTML options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-116">3.4.7.1. <code>html.standalone.template</code></a></li>
|
||
<li><a href="chapter_002.html#link-117">3.4.7.2. <code>html.standalone.one_chapter</code></a></li>
|
||
<li><a href="chapter_002.html#link-118">3.4.7.3. <code>html.standalone.js</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-119">3.4.8. Multifile HTML options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-120">3.4.8.1. <code>html.dir.template</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-121">3.4.9. Interactive fiction HTML options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-122">3.4.9.1. <code>html.if.js</code></a></li>
|
||
<li><a href="chapter_002.html#link-123">3.4.9.2. <code>html.if.new_turn</code></a></li>
|
||
<li><a href="chapter_002.html#link-124">3.4.9.3. <code>html.if.end_turn</code></a></li>
|
||
<li><a href="chapter_002.html#link-125">3.4.9.4. <code>html.if.new_game</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-126">3.4.10. EPUB options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-127">3.4.10.1. <code>epub.version</code></a></li>
|
||
<li><a href="chapter_002.html#link-128">3.4.10.2. <code>epub.highlight.theme</code></a></li>
|
||
<li><a href="chapter_002.html#link-129">3.4.10.3. <code>epub.css</code></a></li>
|
||
<li><a href="chapter_002.html#link-130">3.4.10.4. <code>epub.css.add</code></a></li>
|
||
<li><a href="chapter_002.html#link-131">3.4.10.5. <code>epub.chapter.xhtml</code></a></li>
|
||
<li><a href="chapter_002.html#link-132">3.4.10.6. <code>epub.toc.extras</code></a></li>
|
||
<li><a href="chapter_002.html#link-133">3.4.10.7. <code>epub.escape_nb_spaces</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-134">3.4.11. LaTeX options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-135">3.4.11.1. <code>tex.highlight.theme</code></a></li>
|
||
<li><a href="chapter_002.html#link-136">3.4.11.2. <code>tex.links_as_footnotes</code></a></li>
|
||
<li><a href="chapter_002.html#link-137">3.4.11.3. <code>tex.command</code></a></li>
|
||
<li><a href="chapter_002.html#link-138">3.4.11.4. <code>tex.template</code></a></li>
|
||
<li><a href="chapter_002.html#link-139">3.4.11.5. <code>tex.template.add</code></a></li>
|
||
<li><a href="chapter_002.html#link-140">3.4.11.6. <code>tex.class</code></a></li>
|
||
<li><a href="chapter_002.html#link-141">3.4.11.7. <code>tex.paper.size</code></a></li>
|
||
<li><a href="chapter_002.html#link-142">3.4.11.8. <code>tex.margin.left</code></a></li>
|
||
<li><a href="chapter_002.html#link-143">3.4.11.9. <code>tex.margin.right</code></a></li>
|
||
<li><a href="chapter_002.html#link-144">3.4.11.10. <code>tex.margin.top</code></a></li>
|
||
<li><a href="chapter_002.html#link-145">3.4.11.11. <code>tex.margin.bottom</code></a></li>
|
||
<li><a href="chapter_002.html#link-146">3.4.11.12. <code>tex.title</code></a></li>
|
||
<li><a href="chapter_002.html#link-147">3.4.11.13. <code>tex.font.size</code></a></li>
|
||
<li><a href="chapter_002.html#link-148">3.4.11.14. <code>tex.hyperref</code></a></li>
|
||
<li><a href="chapter_002.html#link-149">3.4.11.15. <code>tex.stdpage</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-150">3.4.12. Resources option</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-151">3.4.12.1. <code>resources.files</code></a></li>
|
||
<li><a href="chapter_002.html#link-152">3.4.12.2. <code>resources.out_path</code></a></li>
|
||
<li><a href="chapter_002.html#link-153">3.4.12.3. <code>resources.base_path</code></a></li>
|
||
<li><a href="chapter_002.html#link-154">3.4.12.4. <code>resources.base_path.links</code></a></li>
|
||
<li><a href="chapter_002.html#link-155">3.4.12.5. <code>resources.base_path.images</code></a></li>
|
||
<li><a href="chapter_002.html#link-156">3.4.12.6. <code>resources.base_path.files</code></a></li>
|
||
<li><a href="chapter_002.html#link-157">3.4.12.7. <code>resources.base_path.templates</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-158">3.4.13. Input options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-159">3.4.13.1. <code>input.clean</code></a></li>
|
||
<li><a href="chapter_002.html#link-160">3.4.13.2. <code>input.clean.smart_quotes</code></a></li>
|
||
<li><a href="chapter_002.html#link-161">3.4.13.3. <code>input.clean.ligature.dashes</code></a></li>
|
||
<li><a href="chapter_002.html#link-162">3.4.13.4. <code>input.clean.ligature.guillemets</code></a></li>
|
||
<li><a href="chapter_002.html#link-163">3.4.13.5. <code>input.yaml_blocks</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-164">3.4.14. Crowbook options</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-165">3.4.14.1. <code>crowbook.html_as_text</code></a></li>
|
||
<li><a href="chapter_002.html#link-166">3.4.14.2. <code>crowbook.markdown.superscript</code></a></li>
|
||
<li><a href="chapter_002.html#link-167">3.4.14.3. <code>crowbook.temp_dir</code></a></li>
|
||
<li><a href="chapter_002.html#link-168">3.4.14.4. <code>crowbook.zip.command</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-169">3.4.15. Output options (for proofreading)</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-170">3.4.15.1. <code>output.proofread.html</code></a></li>
|
||
<li><a href="chapter_002.html#link-171">3.4.15.2. <code>output.proofread.html.dir</code></a></li>
|
||
<li><a href="chapter_002.html#link-172">3.4.15.3. <code>output.proofread.pdf</code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_002.html#link-173">3.4.16. Proofreading options (only for <code>output.proofread.*</code> targets)</a>
|
||
<ul>
|
||
<li><a href="chapter_002.html#link-174">3.4.16.1. <code>proofread</code></a></li>
|
||
<li><a href="chapter_002.html#link-175">3.4.16.2. <code>proofread.languagetool</code></a></li>
|
||
<li><a href="chapter_002.html#link-176">3.4.16.3. <code>proofread.languagetool.port</code></a></li>
|
||
<li><a href="chapter_002.html#link-177">3.4.16.4. <code>proofread.grammalecte</code></a></li>
|
||
<li><a href="chapter_002.html#link-178">3.4.16.5. <code>proofread.grammalecte.port</code></a></li>
|
||
<li><a href="chapter_002.html#link-179">3.4.16.6. <code>proofread.repetitions</code></a></li>
|
||
<li><a href="chapter_002.html#link-180">3.4.16.7. <code>proofread.repetitions.max_distance</code></a></li>
|
||
<li><a href="chapter_002.html#link-181">3.4.16.8. <code>proofread.repetitions.fuzzy</code></a></li>
|
||
<li><a href="chapter_002.html#link-182">3.4.16.9. <code>proofread.repetitions.fuzzy.threshold</code></a></li>
|
||
<li><a href="chapter_002.html#link-183">3.4.16.10. <code>proofread.repetitions.ignore_proper</code></a></li>
|
||
<li><a href="chapter_002.html#link-184">3.4.16.11. <code>proofread.repetitions.threshold</code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_003.html#link-185">4. Markdown format</a>
|
||
<ul>
|
||
<li><a href="chapter_003.html#link-186">4.1. Tables</a></li>
|
||
<li><a href="chapter_003.html#link-187">4.2. Footnotes</a></li>
|
||
<li><a href="chapter_003.html#link-188">4.3. Superscript and subscript</a></li>
|
||
<li><a href="chapter_003.html#link-189">4.4. “Standalone” images</a></li>
|
||
<li><a href="chapter_003.html#link-190">4.5. Interactive fiction</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_004.html#link-191">5. Templates</a>
|
||
<ul>
|
||
<li>
|
||
<a href="chapter_004.html#link-192">5.1. Create and edit template</a>
|
||
<ul>
|
||
<li><a href="chapter_004.html#link-193">5.1.1. <code>--print-template</code></a></li>
|
||
<li>
|
||
<a href="chapter_004.html#link-194">5.1.2. Mustache syntax</a>
|
||
<ul>
|
||
<li><a href="chapter_004.html#link-195">5.1.2.1. Syntax in LaTeX</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_004.html#link-196">5.2. List of templates</a>
|
||
<ul>
|
||
<li><a href="chapter_004.html#link-197">5.2.1. html.js</a></li>
|
||
<li><a href="chapter_004.html#link-198">5.2.2. html.css</a></li>
|
||
<li><a href="chapter_004.html#link-199">5.2.3. html.css.colors</a></li>
|
||
<li><a href="chapter_004.html#link-200">5.2.4. html.css.print</a></li>
|
||
<li><a href="chapter_004.html#link-201">5.2.5. html.highlight.js</a></li>
|
||
<li><a href="chapter_004.html#link-202">5.2.6. html.highlight.css</a></li>
|
||
<li><a href="chapter_004.html#link-203">5.2.7. html.standalone.js</a></li>
|
||
<li><a href="chapter_004.html#link-204">5.2.8. html.standalone.template</a></li>
|
||
<li><a href="chapter_004.html#link-205">5.2.9. html.dir.template</a></li>
|
||
<li><a href="chapter_004.html#link-206">5.2.10. tex.template</a></li>
|
||
<li><a href="chapter_004.html#link-207">5.2.11. epub.chapter.xhtml</a></li>
|
||
<li><a href="chapter_004.html#link-208">5.2.12. epub.titlepage.xhtml</a></li>
|
||
<li><a href="chapter_004.html#link-209">5.2.13. epub.css</a></li>
|
||
<li><a href="chapter_004.html#link-210">5.2.14. Inline templates</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_004.html#link-211">5.3. List of accessible variables</a>
|
||
<ul>
|
||
<li><a href="chapter_004.html#link-212">5.3.1. Metadata</a></li>
|
||
<li><a href="chapter_004.html#link-213">5.3.2. Localisation strings</a></li>
|
||
<li><a href="chapter_004.html#link-214">5.3.3. Template-dependent values</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_005.html#link-215">6. Proofreading with Crowbook</a>
|
||
<ul>
|
||
<li><a href="chapter_005.html#link-216">6.1. Enabling proofreading</a></li>
|
||
<li><a href="chapter_005.html#link-217">6.2. Repetition detection</a></li>
|
||
<li>
|
||
<a href="chapter_005.html#link-218">6.3. Grammar checking</a>
|
||
<ul>
|
||
<li><a href="chapter_005.html#link-219">6.3.1. With Languagetool</a></li>
|
||
<li><a href="chapter_005.html#link-220">6.3.2. With Grammalecte</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_006.html#link-221">7. Interactive fiction</a>
|
||
<ul>
|
||
<li><a href="chapter_006.html#link-222">7.1. Basics</a></li>
|
||
<li><a href="chapter_006.html#link-223">7.2. The interactive fiction renderer</a></li>
|
||
<li><a href="chapter_006.html#link-224">7.3. Using Javascript in your interactive fiction</a></li>
|
||
<li><a href="chapter_006.html#link-225">7.4. Embedding Makdown in your Javascript code embedded in your Markdown</a></li>
|
||
<li><a href="chapter_006.html#link-226">7.5. Conditional blocks</a></li>
|
||
<li><a href="chapter_006.html#link-227">7.6. Interactive fiction options</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_007.html#link-228">8. Tips and tricks</a>
|
||
<ul>
|
||
<li>
|
||
<a href="chapter_007.html#link-229">8.1. Using Crowbook with Emacs’ markdown mode</a>
|
||
<ul>
|
||
<li><a href="chapter_007.html#link-230">8.1.1. Some explanations if it looks a bit cryptic to you</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="chapter_007.html#link-231">8.2. Embedding fonts in an EPUB file</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_008.html#link-232">9. Contributing</a>
|
||
<ul>
|
||
<li><a href="chapter_008.html#link-233">9.1. Internationalization</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="chapter_009.html#link-234">ChangeLog</a>
|
||
<ul>
|
||
<li><a href="chapter_009.html#link-235">0.16.1 (???)</a></li>
|
||
<li><a href="chapter_009.html#link-236">0.16.0 (2023-07-27)</a></li>
|
||
<li><a href="chapter_009.html#link-237">0.15.2 (2020-07-07)</a></li>
|
||
<li><a href="chapter_009.html#link-238">0.15.1 (2020-07-07)</a></li>
|
||
<li><a href="chapter_009.html#link-239">0.15.0 (2019-07-18)</a></li>
|
||
<li><a href="chapter_009.html#link-240">0.14.1 (2018-06-01)</a></li>
|
||
<li><a href="chapter_009.html#link-241">0.14.0 (2017-11-26)</a></li>
|
||
<li><a href="chapter_009.html#link-242">0.14.0-beta (2017-10-08)</a></li>
|
||
<li><a href="chapter_009.html#link-243">0.13.0 (2017-07-14)</a></li>
|
||
<li><a href="chapter_009.html#link-244">0.12.0 (2017-06-05)</a></li>
|
||
<li><a href="chapter_009.html#link-245">0.11.4 (2017-03-21)</a></li>
|
||
<li><a href="chapter_009.html#link-246">0.11.3 (2017-03-19)</a></li>
|
||
<li><a href="chapter_009.html#link-247">0.11.2 (2017-03-05)</a></li>
|
||
<li><a href="chapter_009.html#link-248">0.11.1 (2017-01-05)</a></li>
|
||
<li><a href="chapter_009.html#link-249">0.11.0 (2016-12-31)</a></li>
|
||
<li><a href="chapter_009.html#link-250">0.10.4 (2016-12-16)</a></li>
|
||
<li><a href="chapter_009.html#link-251">0.10.3 (2016-11-19)</a></li>
|
||
<li><a href="chapter_009.html#link-252">0.10.2 (2016-10-21)</a></li>
|
||
<li><a href="chapter_009.html#link-253">0.10.1 (2016-10-18)</a></li>
|
||
<li><a href="chapter_009.html#link-254">0.10.0 (2016-10-18)</a></li>
|
||
<li><a href="chapter_009.html#link-255">0.9.1 (2016-09-29)</a></li>
|
||
<li><a href="chapter_009.html#link-256">0.9.0 (2016-09-23)</a></li>
|
||
<li><a href="chapter_009.html#link-257">0.8.0 (2016-09-19)</a></li>
|
||
<li><a href="chapter_009.html#link-258">0.7.0 (2016-09-11)</a></li>
|
||
<li><a href="chapter_009.html#link-259">0.6.0 (2016-09-09)</a></li>
|
||
<li><a href="chapter_009.html#link-260">0.5.1 (2016-04-14)</a></li>
|
||
<li><a href="chapter_009.html#link-261">0.5.0 (2016-04-02)</a></li>
|
||
<li><a href="chapter_009.html#link-262">0.4.0 (2016-03-01)</a></li>
|
||
<li><a href="chapter_009.html#link-263">0.3.0 (2016-02-27)</a></li>
|
||
<li><a href="chapter_009.html#link-264">0.2.2 (2016-02-25)</a></li>
|
||
<li><a href="chapter_009.html#link-265">0.2.1 (2016-02-25)</a></li>
|
||
<li><a href="chapter_009.html#link-266">0.2.0 (2016-02-25)</a></li>
|
||
<li><a href="chapter_009.html#link-267">0.1.0 (2016-02-21)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="chapter_010.html#link-268">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
|
||
</ul>
|
||
</nav>
|
||
|
||
<div id = "content">
|
||
<div id = "top"><p id = "para-1198">Crowbook User Guide 0.15.0</p>
|
||
</div>
|
||
<div id = "page">
|
||
<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-40'><span class = 'chapter-header'>Chapter 3</span><br />The configuration file</h1><p id = "para-100">If you want to use Crowbook for your book, this configuration file is all you’ll have to add, beside the Markdown files containing the text of your book.</p>
|
||
<p id = "para-101">The format is not very complicated. This is an example of it:</p>
|
||
<pre><span style="color:#586e75;"># metadata</span>
|
||
<span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#2aa198;">Joan Doe</span>
|
||
<span style="color:#268bd2;">title</span><span style="color:#839496;">: </span><span style="color:#2aa198;">Some book</span>
|
||
<span style="color:#268bd2;">lang</span><span style="color:#839496;">: </span><span style="color:#2aa198;">en</span>
|
||
|
||
<span style="color:#268bd2;">output</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">html</span><span style="color:#839496;">, </span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">]</span>
|
||
|
||
<span style="color:#586e75;"># list of chapters</span>
|
||
<span style="color:#839496;">- </span><span style="color:#2aa198;">preface.md</span>
|
||
<span style="color:#2aa198;">+ chapter_1.md</span>
|
||
<span style="color:#2aa198;">+ chapter_2.md</span>
|
||
<span style="color:#2aa198;">+ chapter_3.md</span>
|
||
<span style="color:#2aa198;">+ chapter_4.md</span>
|
||
<span style="color:#839496;">- </span><span style="color:#2aa198;">epilogue.md</span>
|
||
|
||
</pre><p id = "para-102">Basically, it is divided in two parts:</p>
|
||
<ul>
|
||
<li><p id = "para-103">a list of options, under the form <code>key: value</code>, following YAML syntax.</p>
|
||
</li>
|
||
<li><p id = "para-104">a list of Markdown files.</p>
|
||
</li>
|
||
</ul>
|
||
<p id = "para-105">Lines starting with the <code>#</code> characters are comments and are discarded.</p>
|
||
<h2 id = "link-41">3.1. Configuration in an inline YAML block</h2>
|
||
<p id = "para-106">Sometimes, you only have one Markdown file and might not want to have a separate configuration file. In this case, you can specify options at the beginning of your Markdown file, using an inline YAML block, separated by two lines containing only <code>---</code>:</p>
|
||
<pre><span style="color:#839496;">---</span>
|
||
<span style="color:#839496;">author: Joan Doe</span>
|
||
<span style="color:#839496;">title: Some (short) book</span>
|
||
<span style="color:#839496;">lang: en</span>
|
||
|
||
<span style="color:#839496;">output: [html, pdf, epub]</span>
|
||
<span style="color:#b58900;">---</span>
|
||
|
||
<span style="color:#b58900;"># </span><span style="color:#cb4b16;">Some (short) book</span>
|
||
|
||
<span style="color:#839496;">The book content, formatted in Markdown.</span>
|
||
|
||
</pre><p id = "para-107">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-108">You can then use</p>
|
||
<pre><span style="color:#b58900;">crowbook</span><span style="color:#268bd2;"> -s</span><span style="color:#839496;"> some_book.md</span>
|
||
|
||
</pre><p id = "para-109">to generate output formats from this Markdown file.</p>
|
||
<blockquote><p id = "para-110">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-42">3.2. The list of files</h2>
|
||
<p id = "para-111">There are various options to include a Markdown file.</p>
|
||
<ul>
|
||
<li><p id = "para-112"><code>+ file_name.md</code> includes a numbered chapter.</p>
|
||
</li>
|
||
<li><p id = "para-113"><code>- file_name.md</code> includes an unnumbered chapter.</p>
|
||
</li>
|
||
<li><p id = "para-114"><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.</p>
|
||
</li>
|
||
<li><p id = "para-115"><code>42. file_name.md</code> specifies the number for a chapter.</p>
|
||
</li>
|
||
<li><p id = "para-116"><code>@</code> includes a part instead of a chapter.</p>
|
||
</li>
|
||
</ul>
|
||
<p id = "para-117">So a typical usage might look like this:</p>
|
||
<pre><span style="color:#268bd2;">! </span><span style="color:#2aa198;">copyright.md</span>
|
||
<span style="color:#839496;">- </span><span style="color:#2aa198;">preface.md</span>
|
||
<span style="color:#2aa198;">0. chapter_0.md </span><span style="color:#586e75;"># We want to start at chapter 0 instead of 1</span>
|
||
<span style="color:#586e75;"># Next chapters can be numbered automatically</span>
|
||
<span style="color:#2aa198;">+ chapter_1.md</span>
|
||
<span style="color:#2aa198;">+ chapter_2.md</span>
|
||
<span style="color:#839496;">...</span>
|
||
|
||
</pre><p id = "para-118">There are two important things to note:</p>
|
||
<ol>
|
||
<li><p id = "para-119">you must <em>not</em> use quotes around the file names.</p>
|
||
</li>
|
||
<li><p id = "para-120">the paths 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.</p>
|
||
</li>
|
||
</ol>
|
||
<p id = "para-121">Also note that you don’t have to specify a title. This is because the title of the chapter is inferred from the Markdown document. To go back to our previous example:</p>
|
||
<pre><span style="color:#839496;">+ chapter_1.md</span>
|
||
|
||
</pre><p id = "para-122">does not specify a chapter title, because it will read it directly in <code>chapter_1.md</code>, e.g.:</p>
|
||
<pre><span style="color:#b58900;"># </span><span style="color:#cb4b16;">The day I was born </span><span style="color:#b58900;">#</span>
|
||
<span style="color:#839496;">...</span>
|
||
|
||
</pre><p id = "para-123">Ideally, you should have one and only one level-one header (i.e. chapter title) in each Markdown file. If you have more than one, it might mess with the table of contents in some cases (e.g. for EPUB).</p>
|
||
<h3 id = "link-43">3.2.1. Parts</h3>
|
||
<p id = "para-124">Parts are included using the <code>@</code> character, followed by the same characters than for chapters:</p>
|
||
<pre><span style="color:#839496;">@+ numbered_part.md</span>
|
||
<span style="color:#839496;">+ chapter_01.md</span>
|
||
<span style="color:#839496;">+ chapter_02.md</span>
|
||
<span style="color:#839496;">@- unnumbered_part.md</span>
|
||
<span style="color:#839496;">+ chapter_03.md</span>
|
||
<span style="color:#839496;">+ chapter_04.md</span>
|
||
<span style="color:#839496;">@42. part_with_number_42.md</span>
|
||
<span style="color:#839496;">+ chapter_05.md</span>
|
||
|
||
</pre><p id = "para-125">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><span style="color:#839496;">@ Beginning</span>
|
||
<span style="color:#839496;">+ chapter_01.md</span>
|
||
<span style="color:#839496;">+ chapter_02.md</span>
|
||
<span style="color:#839496;">@ Middle</span>
|
||
<span style="color:#839496;">+ chapter_03.md</span>
|
||
<span style="color:#839496;">+ chapter_04.md</span>
|
||
<span style="color:#839496;">@ Appendix</span>
|
||
<span style="color:#839496;">- notes.md</span>
|
||
|
||
</pre><p id = "para-126">With this shortcut, parts are always numbered.</p>
|
||
<h3 id = "link-44">3.2.2. Subchapters</h3>
|
||
<p id = "para-127">If you write your book to be rendered by <code>crowbook</code>, it is better to have one Markdown file per chapter. It is, however, possible to work with divisions at lower levels. In order to properly include these files, you can use the following syntax:</p>
|
||
<pre><span style="color:#839496;">-- section.md</span>
|
||
<span style="color:#839496;">--- subsection.md</span>
|
||
<span style="color:#839496;">---- subsubsection.md</span>
|
||
|
||
</pre><blockquote><p id = "para-128">Note that there isn’t different syntax for numbered or unnumbered sections/subsections: you can only change the numbering scheme at the chapter level.</p>
|
||
</blockquote>
|
||
<p id = "para-129">When including those files, Crowbook will include them in the table of content as part of the previous chapter (or section for subsections, and so on). It will also adjust the header levels of the Markdown files, so, in the previous example, a level-1 header in <code>section.md</code> will be displayed as a level-2 header in the book, and a level-1 header in <code>subsection.md</code> as a level-3 header.</p>
|
||
<blockquote><p id = "para-130">This can cause issues as only six levels of headers are supported; hence, if you include a level-5 header in <code>subsubsection.md</code>, it will cause an error.</p>
|
||
</blockquote>
|
||
<h2 id = "link-45">3.3. Crowbook options</h2>
|
||
<p id = "para-131">The first part of the configuration file is dedicated to pass options to Crowbook. This is <a href = "https://en.wikipedia.org/wiki/YAML">YAML syntax</a>, so each line should be of the form <code>key: value</code>. Note that in most cases you don’t have to put string in quotes, e.g.:</p>
|
||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">: </span><span style="color:#2aa198;">My title</span>
|
||
|
||
</pre><p id = "para-132">It is however possible (and sometimes necessary) to escape some characters using quotes around strings:</p>
|
||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">My: title!</span><span style="color:#839496;">"</span>
|
||
|
||
</pre><p id = "para-133">It is possible to use multiline strings with <code>>-</code> and then indenting the lines that are part of the string:</p>
|
||
<pre><span style="color:#268bd2;">title</span><span style="color:#839496;">: </span><span style="color:#859900;">></span><span style="color:#93a1a1;">-</span>
|
||
<span style="color:#2aa198;"> A</span>
|
||
<span style="color:#2aa198;"> long</span>
|
||
<span style="color:#2aa198;"> title</span>
|
||
<span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#2aa198;">Joan Doe</span>
|
||
|
||
</pre><p id = "para-134">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-135">A final note on the syntax: all options must be set <em>before</em> the first chapter inclusion (that is, a line beginning with <code>+</code>, <code>-</code>, <code>x.</code> (where <code>x</code> is a number) or <code>!</code>).</p>
|
||
<h3 id = "link-46">3.3.1. Metadata</h3>
|
||
<p id = "para-136">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><p id = "para-137"><code>author</code></p>
|
||
</li>
|
||
<li><p id = "para-138"><code>title</code></p>
|
||
</li>
|
||
<li><p id = "para-139"><code>subtitle</code></p>
|
||
</li>
|
||
<li><p id = "para-140"><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>, or <code>fr</code>...</p>
|
||
</li>
|
||
<li><p id = "para-141"><code>cover</code>, a path to an image file for the cover of the book (not displayed in all output formats).</p>
|
||
</li>
|
||
</ul>
|
||
<p id = "para-142">There are also additional metadata:</p>
|
||
<ul>
|
||
<li><p id = "para-143"><code>subject</code></p>
|
||
</li>
|
||
<li><p id = "para-144"><code>description</code></p>
|
||
</li>
|
||
<li><p id = "para-145"><code>license</code></p>
|
||
</li>
|
||
<li><p id = "para-146"><code>version</code></p>
|
||
</li>
|
||
<li><p id = "para-147"><code>date</code></p>
|
||
</li>
|
||
</ul>
|
||
<p id = "para-148">You can define your own metadata by starting an option name with <code>metadata.foo</code>.</p>
|
||
<p id = "para-149">All metadata are accessible from templates, see <a href = "chapter_004.html">Templates</a>.</p>
|
||
<h3 id = "link-47">3.3.2. The <code>import</code> special option</h3>
|
||
<p id = "para-150">The special <code>import</code> option allows you to include the options of another book configuration file. E.g., assuming that you want some common options to be applied to both <code>foo.book</code> and <code>bar.book</code>, you can create a <code>common.book</code> file:</p>
|
||
<pre><span style="color:#268bd2;">author</span><span style="color:#839496;">: </span><span style="color:#2aa198;">Joan Doe</span>
|
||
<span style="color:#268bd2;">lang</span><span style="color:#839496;">: </span><span style="color:#2aa198;">en</span>
|
||
<span style="color:#268bd2;">license</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">Copyright (C) Joan Doe. All rights reserved.</span><span style="color:#839496;">"</span>
|
||
|
||
<span style="color:#268bd2;">html.header</span><span style="color:#839496;">: "</span><span style="color:#2aa198;">[Joan Doe's website](http://joan-doe.com)</span><span style="color:#839496;">"</span>
|
||
<span style="color:#268bd2;">tex.template</span><span style="color:#839496;">: </span><span style="color:#2aa198;">my_template.tex</span>
|
||
|
||
</pre><p id = "para-151">You can then include this file in <code>foo.book</code>:</p>
|
||
<pre><span style="color:#268bd2;">import</span><span style="color:#839496;">: </span><span style="color:#2aa198;">common.book</span>
|
||
<span style="color:#268bd2;">title</span><span style="color:#839496;">: </span><span style="color:#2aa198;">Foo</span>
|
||
|
||
<span style="color:#2aa198;">+ foo_01.md</span>
|
||
<span style="color:#2aa198;">+ foo_02.md</span>
|
||
|
||
</pre><p id = "para-152">Or include it in <code>bar.book</code>, but override some of its features:</p>
|
||
<pre><span style="color:#268bd2;">import</span><span style="color:#839496;">: </span><span style="color:#2aa198;">common.book</span>
|
||
<span style="color:#268bd2;">title</span><span style="color:#839496;">: </span><span style="color:#2aa198;">Bar</span>
|
||
<span style="color:#268bd2;">license</span><span style="color:#839496;">: </span><span style="color:#2aa198;">CC-BY-SA </span><span style="color:#586e75;"># Override the license from common.book</span>
|
||
|
||
<span style="color:#2aa198;">+ bar_01.md</span>
|
||
|
||
</pre><h3 id = "link-48">3.3.3. Output options</h3>
|
||
<p id = "para-153">These options specify which files to generate.</p>
|
||
<p id = "para-154">Note that all file paths are relative to the directory where the configuration file is, not to the one where you run <code>crowbook</code>. So if you set:</p>
|
||
<pre><span style="color:#268bd2;">output.epub</span><span style="color:#839496;">: </span><span style="color:#2aa198;">foo.epub</span>
|
||
|
||
</pre><p id = "para-155">and run</p>
|
||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook some/dir/config.book</span>
|
||
|
||
</pre><p id = "para-156"><code>foo.epub</code> will be generated in <code>some/dir</code>, not in your current directory.</p>
|
||
<p id = "para-157">Crowbook will try to generate each of the <code>output.xxx</code> files that are specified. That means that you’ll have to set at least one of those if you want a call to</p>
|
||
<pre><span style="color:#b58900;">$</span><span style="color:#839496;"> crowbook my.book</span>
|
||
|
||
</pre><p id = "para-158">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-159">Note that some formats depend on some commands being installed on your system. Most notably, Crowbook depends on LaTeX (<code>xelatex</code> by default, though you can specify another command to use with <code>tex.command</code>) to generate a PDF file, so PDF rendering won’t work if it is not installed on your system. Crowbook also uses the <code>zip</code> command to generate the EPUB and ODT files.</p>
|
||
<p id = "para-160">Current output options are:</p>
|
||
<ul>
|
||
<li><p id = "para-161"><code>output.html</code>: renders a standalone HTML file.</p>
|
||
</li>
|
||
<li><p id = "para-162"><code>output.html.dir</code>: renders a HTML directory with one page by chapter.</p>
|
||
</li>
|
||
<li><p id = "para-163"><code>output.epub</code>: renders an EPUB file.</p>
|
||
</li>
|
||
<li><p id = "para-164"><code>output.tex</code>: renders a LaTeX file.</p>
|
||
</li>
|
||
<li><p id = "para-165"><code>output.pdf</code>: renders a PDF file (using <code>tex.command</code>).</p>
|
||
</li>
|
||
</ul>
|
||
<p id = "para-166">(There are other output options for generating proofreading files, see <a href = "chapter_005.html">Proofreading</a>, and interactive fiction, see <a href = "chapter_006.html">Interactive fiction</a>.)</p>
|
||
<h4 id = "link-49">3.3.3.1. The <code>output</code> option</h4>
|
||
<p id = "para-167">Setting output file names manually can be a bit tedious, and is not always necessary. You can also specify a list of output formats with the <code>output</code> option:</p>
|
||
<pre><span style="color:#268bd2;">output</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">pdf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">epub</span><span style="color:#839496;">, </span><span style="color:#2aa198;">html</span><span style="color:#839496;">]</span>
|
||
|
||
</pre><p id = "para-168">This is similar to the alternative syntax for YAML list:</p>
|
||
<pre><span style="color:#268bd2;">output</span><span style="color:#839496;">:</span>
|
||
<span style="color:#839496;"> - </span><span style="color:#2aa198;">pdf</span>
|
||
<span style="color:#839496;"> - </span><span style="color:#2aa198;">epub</span>
|
||
<span style="color:#839496;"> - </span><span style="color:#2aa198;">html</span>
|
||
|
||
</pre><p id = "para-169">This option will set default output path for PDF, EPUB and HTML according to the book configuration file name. So, if your book is <code>my_book.book</code> (or <code>my_book.md</code>), it will generate <code>my_book.pdf</code>, <code>my_book.html</code> and <code>my_book.epub</code>.</p>
|
||
<blockquote><p id = "para-170">You can also infer the output file name by specifying “auto” to e.g. <code>output.html</code>. The previous example is thus equivalent to</p>
|
||
<pre><span style="color:#268bd2;">output.pdf</span><span style="color:#839496;">: </span><span style="color:#2aa198;">auto</span>
|
||
<span style="color:#268bd2;">output.epub</span><span style="color:#839496;">: </span><span style="color:#2aa198;">auto</span>
|
||
<span style="color:#268bd2;">output.html</span><span style="color:#839496;">: </span><span style="color:#2aa198;">auto</span>
|
||
|
||
</pre></blockquote>
|
||
<h4 id = "link-50">3.3.3.2. <code>output.base_path</code></h4>
|
||
<p id = "para-171">Additionally, the <code>output.base_path</code> option allows you to set where the output files will be written (relatively to the book configuration file). E.g.,</p>
|
||
<pre><span style="color:#268bd2;">output.base_path</span><span style="color:#839496;">: </span><span style="color:#2aa198;">docs/book</span>
|
||
<span style="color:#268bd2;">output.epub</span><span style="color:#839496;">: </span><span style="color:#2aa198;">book.epub</span>
|
||
|
||
</pre><p id = "para-172">will render the EPUB file in <code>docs/book/book.epub</code>.</p>
|
||
<h3 id = "link-51">3.3.4. Input options</h3>
|
||
<p id = "para-173">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><p id = "para-174"><code>input.clean</code> (default: <code>true</code>): if set to <code>false</code>, will disable all typographic “cleaning”. The 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.</p>
|
||
</li>
|
||
<li><p id = "para-175"><code>input.clean.smart_quotes</code> (default: <code>true</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.</p>
|
||
</li>
|
||
<li><p id = "para-176"><code>input.clean.ligature_dashes</code> (default: <code>false</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.</p>
|
||
</li>
|
||
<li><p id = "para-177"><code>input.clean.ligature_guillemets</code> (default: <code>false</code>): is a similar feature for french ‘guillemets’, replacing <code><<</code> and <code>>></code> to <code>«</code> and <code>»</code>.</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-52">3.3.5. Generic options for rendering</h3>
|
||
<p id = "para-178">These options allow to configure the rendering; they are used (or at least should be) for all formats.</p>
|
||
<ul>
|
||
<li><p id = "para-179"><code>rendering.highlight</code> (default: <code>syntect</code>): specify if and how to perform syntax highlighting for code blocks. Valid values are:</p>
|
||
<ul>
|
||
<li><p id = "para-180"><code>syntect</code>: uses the <a href = "https://crates.io/crates/syntect">syntect</a> library to perform syntax highlighting. This has the advantage of also enabling syntax highlighting for LaTeX/PDF and EPUB formats; however syntect support doesn’t seem to work on Windows.</p>
|
||
</li>
|
||
<li><p id = "para-181"><code>highlight.js</code>: this will use (and embed) <a href = "https://highlightjs.org/"><code>highlight.js</code></a> for HTML rendering, and will not perform any syntax highlighting for other output formats.</p>
|
||
</li>
|
||
<li><p id = "para-182"><code>none</code>: disable syntax highlighting.</p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p id = "para-183">If your version of <code>crowbook</code> (as is the case for Windows builds) isn’t built with <code>syntect</code> support, it will default to <code>none</code> if you try to use it.</p>
|
||
<ul>
|
||
<li><p id = "para-184"><code>rendering.highlight.theme</code>: only used if <code>rendering.highlight</code> is set to <code>syntect</code>, selects the theme to use for syntax highlighting. Default is “InspiredGitHub”. Valid theme names are:</p>
|
||
<ul>
|
||
<li><p id = "para-185">“InspiredGitHub”</p>
|
||
</li>
|
||
<li><p id = "para-186">“Solarized (dark)”</p>
|
||
</li>
|
||
<li><p id = "para-187">“Solarized (light)”</p>
|
||
</li>
|
||
<li><p id = "para-188">“base16-eighties.dark”</p>
|
||
</li>
|
||
<li><p id = "para-189">“base16-mocha.dark”</p>
|
||
</li>
|
||
<li><p id = "para-190">“base16-ocean.dark”</p>
|
||
</li>
|
||
<li><p id = "para-191">and “base16-ocean.light”.</p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p id = "para-192"><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>.) This also affects what levels will be displayed in the table of contents.</p>
|
||
</li>
|
||
<li><p id = "para-193"><code>rendering.chapter</code> and <code>rendering.part</code>: the strings that will be used to design chapter and part. E.g., if you want your parts to show as “Book III” instead of “Part III”, you can set <code>rendering.part: Book</code>.</p>
|
||
</li>
|
||
<li><p id = "para-194"><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).</p>
|
||
</li>
|
||
<li><p id = "para-195"><code>rendering.inline_toc</code>: if set to true, Crowbook will include a table of contents at the beginning of the document.</p>
|
||
</li>
|
||
<li><p id = "para-196"><code>rendering.inline_toc.name</code>: the name of this table of contents as it should be displayed in the document.</p>
|
||
</li>
|
||
<li><p id = "para-197"><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.</p>
|
||
</li>
|
||
<li><p id = "para-198"><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.</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-53">3.3.6. HTML Options</h3>
|
||
<p id = "para-199">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><p id = "para-200"><code>html.icon</code>: allows to set a <code>favicon</code> for the page.</p>
|
||
</li>
|
||
<li><p id = "para-201"><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_004.html">template</a> chapter for more information on the fields you can use.</p>
|
||
</li>
|
||
<li><p id = "para-202"><code>html.css</code>: allows to set up a custom CSS file. You can also redefine the colors in a file and set it using <code>html.css.colors</code>.</p>
|
||
</li>
|
||
<li><p id = "para-203"><code>html.css.add</code>: allows you to add some specific lines of CSS in your book configuration file, that will be appended after the default CSS template.</p>
|
||
</li>
|
||
<li><p id = "para-204"><code>html.highlight.theme</code>: is similar to <code>rendering.highlight.theme</code> but only sets the theme for HTML output.</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-54">3.3.6.1. Options for standalone HTML</h4>
|
||
<p id = "para-205">There are a few options specific to the standalone HTML renderer (default, set with <code>output.html</code>):</p>
|
||
<ul>
|
||
<li><p id = "para-206"><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.</p>
|
||
</li>
|
||
<li><p id = "para-207"><code>html.standalone.template</code>: allows you to change or modify the HTML template for standalone HTML.</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-55">3.3.7. Options for LaTeX/PDF rendering</h3>
|
||
<p id = "para-208">These options allow you to customize the LaTeX renderer (and, thus, the generated PDF documents):</p>
|
||
<ul>
|
||
<li><p id = "para-209"><code>tex.template</code>: specifies a different LaTeX template.</p>
|
||
</li>
|
||
<li><p id = "para-210"><code>tex.class</code>: changes the LaTeX class used.</p>
|
||
</li>
|
||
<li><p id = "para-211"><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.</p>
|
||
</li>
|
||
<li><p id = "para-212"><code>tex.margin.left</code>, <code>tex.margin.right</code>, <code>tex.margin.top</code> and <code>tex.margin.bottom</code>: specify the margin of the page.</p>
|
||
</li>
|
||
<li><p id = "para-213"><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).</p>
|
||
</li>
|
||
<li><p id = "para-214"><code>tex.highlight.theme</code>: similar to <code>rendering.highlight.theme</code>, but only sets the theme for LaTeX/PDF rendering.</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-56">3.3.8. Options for EPUB rendering</h3>
|
||
<p id = "para-215">There are also options specific to the EPUB format:</p>
|
||
<ul>
|
||
<li><p id = "para-216"><code>epub.version</code>: can be set to 2 or 3 (default 2).</p>
|
||
</li>
|
||
<li><p id = "para-217"><code>epub.css</code>: can be useful if you want to specify a customized stylesheet.</p>
|
||
</li>
|
||
<li><p id = "para-218"><code>epub.highlight.theme</code>: similar to <code>rendering.highlight.theme</code> but only sets a theme for EPUB output.</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-57">3.3.9. Resources options</h3>
|
||
<p id = "para-219">These options allow to embed additional files for some formats (currently, only EPUB). This can be useful for embedding fonts.</p>
|
||
<h4 id = "link-58">3.3.9.1. <code>resources.files</code></h4>
|
||
<p id = "para-220">A list of files or directories that should be added.</p>
|
||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">font1.otf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">font2.otf</span><span style="color:#839496;">]</span>
|
||
|
||
</pre><p id = "para-221">It is also possible to specify a directory (or multiple directories). So if you have a <code>fonts</code> directories containing <code>font1.otf</code> and <code>font2.otf</code>,</p>
|
||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">fonts</span><span style="color:#839496;">]</span>
|
||
|
||
</pre><p id = "para-222">will be equivalent to:</p>
|
||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">fonts/font1.otf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">fonts/font2.otf</span><span style="color:#839496;">]</span>
|
||
|
||
</pre><p id = "para-223"><b>default</b>: not set</p>
|
||
<h4 id = "link-59">3.3.9.2. <code>resources.out_path</code></h4>
|
||
<p id = "para-224">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-225">Note that if you pass directories to <code>resources.files</code>, the whole directory would be copied. So assuming <code>fonts/</code> contains <code>font1.otf</code> and <code>font2.otf</code></p>
|
||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">fonts</span><span style="color:#839496;">]</span>
|
||
<span style="color:#268bd2;">resources.path</span><span style="color:#839496;">: </span><span style="color:#2aa198;">data</span>
|
||
|
||
</pre><p id = "para-226">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-227">Similarly, the whole path of <code>resources.files</code> is copied, so</p>
|
||
<pre><span style="color:#268bd2;">resources.files</span><span style="color:#839496;">: [</span><span style="color:#2aa198;">fonts/font1.otf</span><span style="color:#839496;">, </span><span style="color:#2aa198;">fonts/font2.otf</span><span style="color:#839496;">]</span>
|
||
|
||
</pre><p id = "para-228">will yield the same result.</p>
|
||
<p id = "para-229"><b>default</b>: <code>data</code></p>
|
||
<h2 id = "link-60">3.4. Full list of options</h2>
|
||
<p id = "para-230">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>
|
||
<p id = "para-231">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 (note that you might need to use quotes if it includes some characters that may lead the YAML parser to read it as an array, an integer or a list), and a list of strings is a list containing only strings, see <a href = "https://en.wikipedia.org/wiki/YAML#Basic_components">YAML syntax</a>). 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-61">3.4.1. Metadata</h3>
|
||
<h4 id = "link-62">3.4.1.1. <code>author</code></h4>
|
||
<ul>
|
||
<li><p id = "para-232"><b>type</b>: metadata</p>
|
||
</li>
|
||
<li><p id = "para-233"><b>default value</b>: <code>""</code></p>
|
||
</li>
|
||
<li><p id = "para-234">Author of the book</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-63">3.4.1.2. <code>title</code></h4>
|
||
<ul>
|
||
<li><p id = "para-235"><b>type</b>: metadata</p>
|
||
</li>
|
||
<li><p id = "para-236"><b>default value</b>: <code>""</code></p>
|
||
</li>
|
||
<li><p id = "para-237">Title of the book</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-64">3.4.1.3. <code>lang</code></h4>
|
||
<ul>
|
||
<li><p id = "para-238"><b>type</b>: metadata</p>
|
||
</li>
|
||
<li><p id = "para-239"><b>default value</b>: <code>en</code></p>
|
||
</li>
|
||
<li><p id = "para-240">Language of the book</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-65">3.4.1.4. <code>subject</code></h4>
|
||
<ul>
|
||
<li><p id = "para-241"><b>type</b>: metadata</p>
|
||
</li>
|
||
<li><p id = "para-242"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-243">Subject of the book (used for EPUB metadata)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-66">3.4.1.5. <code>description</code></h4>
|
||
<ul>
|
||
<li><p id = "para-244"><b>type</b>: metadata</p>
|
||
</li>
|
||
<li><p id = "para-245"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-246">Description of the book (used for EPUB metadata)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-67">3.4.1.6. <code>cover</code></h4>
|
||
<ul>
|
||
<li><p id = "para-247"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-248"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-249">Path to the cover of the book</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-68">3.4.2. Additional metadata</h3>
|
||
<h4 id = "link-69">3.4.2.1. <code>subtitle</code></h4>
|
||
<ul>
|
||
<li><p id = "para-250"><b>type</b>: metadata</p>
|
||
</li>
|
||
<li><p id = "para-251"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-252">Subtitle of the book</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-70">3.4.2.2. <code>license</code></h4>
|
||
<ul>
|
||
<li><p id = "para-253"><b>type</b>: metadata</p>
|
||
</li>
|
||
<li><p id = "para-254"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-255">License of the book. This information will be displayed on PDF documents</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-71">3.4.2.3. <code>version</code></h4>
|
||
<ul>
|
||
<li><p id = "para-256"><b>type</b>: metadata</p>
|
||
</li>
|
||
<li><p id = "para-257"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-258">Version of the book</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-72">3.4.2.4. <code>date</code></h4>
|
||
<ul>
|
||
<li><p id = "para-259"><b>type</b>: metadata</p>
|
||
</li>
|
||
<li><p id = "para-260"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-261">Date the book was revised</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-73">3.4.3. Output options</h3>
|
||
<h4 id = "link-74">3.4.3.1. <code>output</code></h4>
|
||
<ul>
|
||
<li><p id = "para-262"><b>type</b>: list of strings</p>
|
||
</li>
|
||
<li><p id = "para-263"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-264">Specify a list of output formats to render</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-75">3.4.3.2. <code>output.epub</code></h4>
|
||
<ul>
|
||
<li><p id = "para-265"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-266"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-267">Output file name for EPUB rendering</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-76">3.4.3.3. <code>output.html</code></h4>
|
||
<ul>
|
||
<li><p id = "para-268"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-269"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-270">Output file name for HTML rendering</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-77">3.4.3.4. <code>output.html.dir</code></h4>
|
||
<ul>
|
||
<li><p id = "para-271"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-272"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-273">Output directory name for HTML rendering</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-78">3.4.3.5. <code>output.tex</code></h4>
|
||
<ul>
|
||
<li><p id = "para-274"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-275"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-276">Output file name for LaTeX rendering</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-79">3.4.3.6. <code>output.pdf</code></h4>
|
||
<ul>
|
||
<li><p id = "para-277"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-278"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-279">Output file name for PDF rendering</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-80">3.4.3.7. <code>output.odt</code></h4>
|
||
<ul>
|
||
<li><p id = "para-280"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-281"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-282">Output file name for ODT rendering</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-81">3.4.3.8. <code>output.html.if</code></h4>
|
||
<ul>
|
||
<li><p id = "para-283"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-284"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-285">Output file name for HTML (interactive fiction) rendering</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-82">3.4.3.9. <code>output.base_path</code></h4>
|
||
<ul>
|
||
<li><p id = "para-286"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-287"><b>default value</b>: <code>""</code></p>
|
||
</li>
|
||
<li><p id = "para-288">Directory where those output files will we written</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-83">3.4.4. Rendering options</h3>
|
||
<h4 id = "link-84">3.4.4.1. <code>rendering.highlight</code></h4>
|
||
<ul>
|
||
<li><p id = "para-289"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-290"><b>default value</b>: <code>syntect</code></p>
|
||
</li>
|
||
<li><p id = "para-291">If/how highligh code blocks. Possible values: “syntect” (default, performed at runtime), “highlight.js” (HTML-only, uses Javascript), “none”</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-85">3.4.4.2. <code>rendering.highlight.theme</code></h4>
|
||
<ul>
|
||
<li><p id = "para-292"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-293"><b>default value</b>: <code>InspiredGitHub</code></p>
|
||
</li>
|
||
<li><p id = "para-294">Theme for syntax highlighting (if rendering.highlight is set to ‘syntect’)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-86">3.4.4.3. <code>rendering.initials</code></h4>
|
||
<ul>
|
||
<li><p id = "para-295"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-296"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-297">Use initials (‘lettrines’) for first letter of a chapter (experimental)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-87">3.4.4.4. <code>rendering.inline_toc</code></h4>
|
||
<ul>
|
||
<li><p id = "para-298"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-299"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-300">Display a table of content in the document</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-88">3.4.4.5. <code>rendering.inline_toc.name</code></h4>
|
||
<ul>
|
||
<li><p id = "para-301"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-302"><b>default value</b>: <code>"{{{loc_toc}}}"</code></p>
|
||
</li>
|
||
<li><p id = "para-303">Name of the table of contents if it is displayed in document</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-89">3.4.4.6. <code>rendering.num_depth</code></h4>
|
||
<ul>
|
||
<li><p id = "para-304"><b>type</b>: integer</p>
|
||
</li>
|
||
<li><p id = "para-305"><b>default value</b>: <code>1</code></p>
|
||
</li>
|
||
<li><p id = "para-306">The maximum heading levels that should be numbered (0: no numbering, 1: only chapters, ..., 6: all)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-90">3.4.4.7. <code>rendering.chapter</code></h4>
|
||
<ul>
|
||
<li><p id = "para-307"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-308"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-309">How to call chapters</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-91">3.4.4.8. <code>rendering.part</code></h4>
|
||
<ul>
|
||
<li><p id = "para-310"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-311"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-312">How to call parts (or ‘books’, ‘episodes’, ...</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-92">3.4.4.9. <code>rendering.chapter.roman_numerals</code></h4>
|
||
<ul>
|
||
<li><p id = "para-313"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-314"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-315">If set to true, display chapter number with roman numerals</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-93">3.4.4.10. <code>rendering.part.roman_numerals</code></h4>
|
||
<ul>
|
||
<li><p id = "para-316"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-317"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-318">If set to true, display part number with roman numerals</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-94">3.4.4.11. <code>rendering.part.reset_counter</code></h4>
|
||
<ul>
|
||
<li><p id = "para-319"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-320"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-321">If set to true, reset chapter number at each part</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-95">3.4.4.12. <code>rendering.chapter.template</code></h4>
|
||
<ul>
|
||
<li><p id = "para-322"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-323"><b>default value</b>: <code>"{{{number}}}. {{{chapter_title}}}"</code></p>
|
||
</li>
|
||
<li><p id = "para-324">Naming scheme of chapters, for TOC</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-96">3.4.4.13. <code>rendering.part.template</code></h4>
|
||
<ul>
|
||
<li><p id = "para-325"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-326"><b>default value</b>: <code>"{{{number}}}. {{{part_title}}}"</code></p>
|
||
</li>
|
||
<li><p id = "para-327">Naming scheme of parts, for TOC</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-97">3.4.5. Special option</h3>
|
||
<h4 id = "link-98">3.4.5.1. <code>import</code></h4>
|
||
<ul>
|
||
<li><p id = "para-328"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-329"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-330">Import another book configuration file</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-99">3.4.6. HTML options</h3>
|
||
<h4 id = "link-100">3.4.6.1. <code>html.icon</code></h4>
|
||
<ul>
|
||
<li><p id = "para-331"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-332"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-333">Path to an icon to be used for the HTML files(s)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-101">3.4.6.2. <code>html.highlight.theme</code></h4>
|
||
<ul>
|
||
<li><p id = "para-334"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-335"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-336">If set, set theme for syntax highlighting for HTML output (syntect only)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-102">3.4.6.3. <code>html.header</code></h4>
|
||
<ul>
|
||
<li><p id = "para-337"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-338"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-339">Custom header to display at the beginning of html file(s)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-103">3.4.6.4. <code>html.footer</code></h4>
|
||
<ul>
|
||
<li><p id = "para-340"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-341"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-342">Custom footer to display at the end of HTML file(s)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-104">3.4.6.5. <code>html.css</code></h4>
|
||
<ul>
|
||
<li><p id = "para-343"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-344"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-345">Path of a stylesheet for HTML rendering</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-105">3.4.6.6. <code>html.css.add</code></h4>
|
||
<ul>
|
||
<li><p id = "para-346"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-347"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-348">Some inline CSS added to the stylesheet template</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-106">3.4.6.7. <code>html.css.colors</code></h4>
|
||
<ul>
|
||
<li><p id = "para-349"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-350"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-351">Path of a stylesheet for the colors for HTML</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-107">3.4.6.8. <code>html.js</code></h4>
|
||
<ul>
|
||
<li><p id = "para-352"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-353"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-354">Path of a javascript file</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-108">3.4.6.9. <code>html.css.print</code></h4>
|
||
<ul>
|
||
<li><p id = "para-355"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-356"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-357">Path of a media print stylesheet for HTML rendering</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-109">3.4.6.10. <code>html.highlight.js</code></h4>
|
||
<ul>
|
||
<li><p id = "para-358"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-359"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-360">Set another highlight.js version than the bundled one</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-110">3.4.6.11. <code>html.highlight.css</code></h4>
|
||
<ul>
|
||
<li><p id = "para-361"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-362"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-363">Set another highlight.js CSS theme than the default one</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-111">3.4.6.12. <code>html.side_notes</code></h4>
|
||
<ul>
|
||
<li><p id = "para-364"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-365"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-366">Display footnotes as side notes in HTML/Epub (experimental)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-112">3.4.6.13. <code>html.escape_nb_spaces</code></h4>
|
||
<ul>
|
||
<li><p id = "para-367"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-368"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-369">Replace unicode non breaking spaces with HTML entities and CSS</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-113">3.4.6.14. <code>html.chapter.template</code></h4>
|
||
<ul>
|
||
<li><p id = "para-370"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-371"><b>default value</b>: <code>"<h1 id = 'link-{{{link}}}'>{{#has_number}}<span class = 'chapter-header'>{{{header}}} {{{number}}}</span>{{#has_title}}<br />{{/has_title}}{{/has_number}}{{{title}}}</h1>"</code></p>
|
||
</li>
|
||
<li><p id = "para-372">Inline template for HTML chapter formatting</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-114">3.4.6.15. <code>html.part.template</code></h4>
|
||
<ul>
|
||
<li><p id = "para-373"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-374"><b>default value</b>: <code>"<h2 class = 'part'>{{{header}}} {{{number}}}</h2> <h1 id = 'link-{{{link}}}' class = 'part'>{{{title}}}</h1>"</code></p>
|
||
</li>
|
||
<li><p id = "para-375">Inline template for HTML part formatting</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-115">3.4.7. Standalone HTML options</h3>
|
||
<h4 id = "link-116">3.4.7.1. <code>html.standalone.template</code></h4>
|
||
<ul>
|
||
<li><p id = "para-376"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-377"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-378">Path of an HTML template for standalone HTML</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-117">3.4.7.2. <code>html.standalone.one_chapter</code></h4>
|
||
<ul>
|
||
<li><p id = "para-379"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-380"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-381">Display only one chapter at a time (with a button to display all)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-118">3.4.7.3. <code>html.standalone.js</code></h4>
|
||
<ul>
|
||
<li><p id = "para-382"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-383"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-384">Path of a javascript file</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-119">3.4.8. Multifile HTML options</h3>
|
||
<h4 id = "link-120">3.4.8.1. <code>html.dir.template</code></h4>
|
||
<ul>
|
||
<li><p id = "para-385"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-386"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-387">Path of a HTML template for multifile HTML</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-121">3.4.9. Interactive fiction HTML options</h3>
|
||
<h4 id = "link-122">3.4.9.1. <code>html.if.js</code></h4>
|
||
<ul>
|
||
<li><p id = "para-388"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-389"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-390">Path of a javascript file</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-123">3.4.9.2. <code>html.if.new_turn</code></h4>
|
||
<ul>
|
||
<li><p id = "para-391"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-392"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-393">Javascript code that will be run at the beginning of each segment</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-124">3.4.9.3. <code>html.if.end_turn</code></h4>
|
||
<ul>
|
||
<li><p id = "para-394"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-395"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-396">Javascript code that will be run at the end of each segment</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-125">3.4.9.4. <code>html.if.new_game</code></h4>
|
||
<ul>
|
||
<li><p id = "para-397"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-398"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-399">Javascript code that will be run at the beginning of a ‘game’</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-126">3.4.10. EPUB options</h3>
|
||
<h4 id = "link-127">3.4.10.1. <code>epub.version</code></h4>
|
||
<ul>
|
||
<li><p id = "para-400"><b>type</b>: integer</p>
|
||
</li>
|
||
<li><p id = "para-401"><b>default value</b>: <code>2</code></p>
|
||
</li>
|
||
<li><p id = "para-402">EPUB version to generate (2 or 3)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-128">3.4.10.2. <code>epub.highlight.theme</code></h4>
|
||
<ul>
|
||
<li><p id = "para-403"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-404"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-405">If set, set theme for syntax highlighting for EPUB output (syntect only)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-129">3.4.10.3. <code>epub.css</code></h4>
|
||
<ul>
|
||
<li><p id = "para-406"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-407"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-408">Path of a stylesheet for EPUB</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-130">3.4.10.4. <code>epub.css.add</code></h4>
|
||
<ul>
|
||
<li><p id = "para-409"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-410"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-411">Inline CSS added to the EPUB stylesheet template</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-131">3.4.10.5. <code>epub.chapter.xhtml</code></h4>
|
||
<ul>
|
||
<li><p id = "para-412"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-413"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-414">Path of an xhtml template for each chapter</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-132">3.4.10.6. <code>epub.toc.extras</code></h4>
|
||
<ul>
|
||
<li><p id = "para-415"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-416"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-417">Add ‘Title’ and (if set) ‘Cover’ in the EPUB table of contents</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-133">3.4.10.7. <code>epub.escape_nb_spaces</code></h4>
|
||
<ul>
|
||
<li><p id = "para-418"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-419"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-420">Replace unicode non breaking spaces with HTML entities and CSS</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-134">3.4.11. LaTeX options</h3>
|
||
<h4 id = "link-135">3.4.11.1. <code>tex.highlight.theme</code></h4>
|
||
<ul>
|
||
<li><p id = "para-421"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-422"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-423">If set, set theme for syntax highlighting for LaTeX/PDF output (syntect only)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-136">3.4.11.2. <code>tex.links_as_footnotes</code></h4>
|
||
<ul>
|
||
<li><p id = "para-424"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-425"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-426">Add foontotes to URL of links so they are readable when printed</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-137">3.4.11.3. <code>tex.command</code></h4>
|
||
<ul>
|
||
<li><p id = "para-427"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-428"><b>default value</b>: <code>xelatex</code></p>
|
||
</li>
|
||
<li><p id = "para-429">LaTeX command to use for generating PDF</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-138">3.4.11.4. <code>tex.template</code></h4>
|
||
<ul>
|
||
<li><p id = "para-430"><b>type</b>: template path</p>
|
||
</li>
|
||
<li><p id = "para-431"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-432">Path of a LaTeX template file</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-139">3.4.11.5. <code>tex.template.add</code></h4>
|
||
<ul>
|
||
<li><p id = "para-433"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-434"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-435">Inline code added in the LaTeX template</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-140">3.4.11.6. <code>tex.class</code></h4>
|
||
<ul>
|
||
<li><p id = "para-436"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-437"><b>default value</b>: <code>book</code></p>
|
||
</li>
|
||
<li><p id = "para-438">LaTeX class to use</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-141">3.4.11.7. <code>tex.paper.size</code></h4>
|
||
<ul>
|
||
<li><p id = "para-439"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-440"><b>default value</b>: <code>a5paper</code></p>
|
||
</li>
|
||
<li><p id = "para-441">Specifies the size of the page.</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-142">3.4.11.8. <code>tex.margin.left</code></h4>
|
||
<ul>
|
||
<li><p id = "para-442"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-443"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-444">Specifies left margin (note that with book class left and right margins are reversed for odd pages, thus the default value is 1.5cm for book class and 2cm else)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-143">3.4.11.9. <code>tex.margin.right</code></h4>
|
||
<ul>
|
||
<li><p id = "para-445"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-446"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-447">Specifies right margin(note that with book class left and right margins are reversed for odd pages, thus the default value is 2.5cm for book class and 2cm else)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-144">3.4.11.10. <code>tex.margin.top</code></h4>
|
||
<ul>
|
||
<li><p id = "para-448"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-449"><b>default value</b>: <code>"2cm"</code></p>
|
||
</li>
|
||
<li><p id = "para-450">Specifies top margin</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-145">3.4.11.11. <code>tex.margin.bottom</code></h4>
|
||
<ul>
|
||
<li><p id = "para-451"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-452"><b>default value</b>: <code>"1.5cm"</code></p>
|
||
</li>
|
||
<li><p id = "para-453">Specifies left margin</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-146">3.4.11.12. <code>tex.title</code></h4>
|
||
<ul>
|
||
<li><p id = "para-454"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-455"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-456">If true, generate a title with \maketitle</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-147">3.4.11.13. <code>tex.font.size</code></h4>
|
||
<ul>
|
||
<li><p id = "para-457"><b>type</b>: integer</p>
|
||
</li>
|
||
<li><p id = "para-458"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-459">Specify latex font size (in pt, 10 (default), 11, or 12 are accepted)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-148">3.4.11.14. <code>tex.hyperref</code></h4>
|
||
<ul>
|
||
<li><p id = "para-460"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-461"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-462">If disabled, don’t try to find references inside the document</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-149">3.4.11.15. <code>tex.stdpage</code></h4>
|
||
<ul>
|
||
<li><p id = "para-463"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-464"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-465">If set to true, use ‘stdpage’ package to format a manuscript according to standards</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-150">3.4.12. Resources option</h3>
|
||
<h4 id = "link-151">3.4.12.1. <code>resources.files</code></h4>
|
||
<ul>
|
||
<li><p id = "para-466"><b>type</b>: list of strings</p>
|
||
</li>
|
||
<li><p id = "para-467"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-468">Whitespace-separated list of files to embed in e.g. EPUB file; useful for including e.g. fonts</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-152">3.4.12.2. <code>resources.out_path</code></h4>
|
||
<ul>
|
||
<li><p id = "para-469"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-470"><b>default value</b>: <code>data</code></p>
|
||
</li>
|
||
<li><p id = "para-471">Paths where additional resources should be copied in the EPUB file or HTML directory</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-153">3.4.12.3. <code>resources.base_path</code></h4>
|
||
<ul>
|
||
<li><p id = "para-472"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-473"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-474">Path where to find resources (in the source tree). By default, links and images are relative to the Markdown file. If this is set, it will be to this path.</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-154">3.4.12.4. <code>resources.base_path.links</code></h4>
|
||
<ul>
|
||
<li><p id = "para-475"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-476"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-477">Set base path but only for links. Useless if resources.base_path is set</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-155">3.4.12.5. <code>resources.base_path.images</code></h4>
|
||
<ul>
|
||
<li><p id = "para-478"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-479"><b>default value</b>: <code>.</code></p>
|
||
</li>
|
||
<li><p id = "para-480">Set base path but only for images. Useless if resources.base_path is set</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-156">3.4.12.6. <code>resources.base_path.files</code></h4>
|
||
<ul>
|
||
<li><p id = "para-481"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-482"><b>default value</b>: <code>.</code></p>
|
||
</li>
|
||
<li><p id = "para-483">Set base path but only for additional files. Useless if resources.base_path is set.</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-157">3.4.12.7. <code>resources.base_path.templates</code></h4>
|
||
<ul>
|
||
<li><p id = "para-484"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-485"><b>default value</b>: <code>.</code></p>
|
||
</li>
|
||
<li><p id = "para-486">Set base path but only for templates files. Useless if resources.base_path is set</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-158">3.4.13. Input options</h3>
|
||
<h4 id = "link-159">3.4.13.1. <code>input.clean</code></h4>
|
||
<ul>
|
||
<li><p id = "para-487"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-488"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-489">Toggle typographic cleaning of input markdown according to lang</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-160">3.4.13.2. <code>input.clean.smart_quotes</code></h4>
|
||
<ul>
|
||
<li><p id = "para-490"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-491"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-492">If enabled, tries to replace vertical quotations marks to curly ones</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-161">3.4.13.3. <code>input.clean.ligature.dashes</code></h4>
|
||
<ul>
|
||
<li><p id = "para-493"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-494"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-495">If enabled, replaces ‘--’ to en dash ('–') and ‘---’ to em dash ('—')</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-162">3.4.13.4. <code>input.clean.ligature.guillemets</code></h4>
|
||
<ul>
|
||
<li><p id = "para-496"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-497"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-498">If enabled, replaces ‘<<’ and ‘>>’ to french “guillemets” ('«’ and ‘»’)</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-163">3.4.13.5. <code>input.yaml_blocks</code></h4>
|
||
<ul>
|
||
<li><p id = "para-499"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-500"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-501">Enable inline YAML blocks to override options set in config file</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-164">3.4.14. Crowbook options</h3>
|
||
<h4 id = "link-165">3.4.14.1. <code>crowbook.html_as_text</code></h4>
|
||
<ul>
|
||
<li><p id = "para-502"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-503"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-504">Consider HTML blocks as text. This avoids having <code><foo></code> being considered as HTML and thus ignored.</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-166">3.4.14.2. <code>crowbook.markdown.superscript</code></h4>
|
||
<ul>
|
||
<li><p id = "para-505"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-506"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-507">If enabled, allow support for superscript and subscript using respectively foo<sup>up</sup> and bar<del>down</del> syntax.</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-167">3.4.14.3. <code>crowbook.temp_dir</code></h4>
|
||
<ul>
|
||
<li><p id = "para-508"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-509"><b>default value</b>: <code> </code> (empty string)</p>
|
||
</li>
|
||
<li><p id = "para-510">Path where to create a temporary directory (default: uses result from Rust’s std::env::temp_dir())</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-168">3.4.14.4. <code>crowbook.zip.command</code></h4>
|
||
<ul>
|
||
<li><p id = "para-511"><b>type</b>: string</p>
|
||
</li>
|
||
<li><p id = "para-512"><b>default value</b>: <code>zip</code></p>
|
||
</li>
|
||
<li><p id = "para-513">Command to use to zip files (for EPUB/ODT)</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-169">3.4.15. Output options (for proofreading)</h3>
|
||
<h4 id = "link-170">3.4.15.1. <code>output.proofread.html</code></h4>
|
||
<ul>
|
||
<li><p id = "para-514"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-515"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-516">Output file name for HTML rendering with proofread features</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-171">3.4.15.2. <code>output.proofread.html.dir</code></h4>
|
||
<ul>
|
||
<li><p id = "para-517"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-518"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-519">Output directory name for HTML rendering with proofread features</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-172">3.4.15.3. <code>output.proofread.pdf</code></h4>
|
||
<ul>
|
||
<li><p id = "para-520"><b>type</b>: path</p>
|
||
</li>
|
||
<li><p id = "para-521"><b>default value</b>: <code>not set</code></p>
|
||
</li>
|
||
<li><p id = "para-522">Output file name for PDF rendering with proofread features</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id = "link-173">3.4.16. Proofreading options (only for <code>output.proofread.*</code> targets)</h3>
|
||
<h4 id = "link-174">3.4.16.1. <code>proofread</code></h4>
|
||
<ul>
|
||
<li><p id = "para-523"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-524"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-525">If set to false, will disactivate proofreading even if one of output.proofread.x is present</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-175">3.4.16.2. <code>proofread.languagetool</code></h4>
|
||
<ul>
|
||
<li><p id = "para-526"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-527"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-528">If true, try to use language tool server to grammar check the book</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-176">3.4.16.3. <code>proofread.languagetool.port</code></h4>
|
||
<ul>
|
||
<li><p id = "para-529"><b>type</b>: integer</p>
|
||
</li>
|
||
<li><p id = "para-530"><b>default value</b>: <code>8081</code></p>
|
||
</li>
|
||
<li><p id = "para-531">Port to connect to languagetool-server</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-177">3.4.16.4. <code>proofread.grammalecte</code></h4>
|
||
<ul>
|
||
<li><p id = "para-532"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-533"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-534">If true, try to use grammalecte server to grammar check the book</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-178">3.4.16.5. <code>proofread.grammalecte.port</code></h4>
|
||
<ul>
|
||
<li><p id = "para-535"><b>type</b>: integer</p>
|
||
</li>
|
||
<li><p id = "para-536"><b>default value</b>: <code>8080</code></p>
|
||
</li>
|
||
<li><p id = "para-537">Port to connect to grammalecte server</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-179">3.4.16.6. <code>proofread.repetitions</code></h4>
|
||
<ul>
|
||
<li><p id = "para-538"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-539"><b>default value</b>: <code>false</code></p>
|
||
</li>
|
||
<li><p id = "para-540">If set to true, use Caribon to detect repetitions</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-180">3.4.16.7. <code>proofread.repetitions.max_distance</code></h4>
|
||
<ul>
|
||
<li><p id = "para-541"><b>type</b>: integer</p>
|
||
</li>
|
||
<li><p id = "para-542"><b>default value</b>: <code>25</code></p>
|
||
</li>
|
||
<li><p id = "para-543">Max distance between two occurences so it is considered a repetition</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-181">3.4.16.8. <code>proofread.repetitions.fuzzy</code></h4>
|
||
<ul>
|
||
<li><p id = "para-544"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-545"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-546">Enable fuzzy string matching</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-182">3.4.16.9. <code>proofread.repetitions.fuzzy.threshold</code></h4>
|
||
<ul>
|
||
<li><p id = "para-547"><b>type</b>: float</p>
|
||
</li>
|
||
<li><p id = "para-548"><b>default value</b>: <code>0.2</code></p>
|
||
</li>
|
||
<li><p id = "para-549">Max threshold of differences to consider two strings a repetition</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-183">3.4.16.10. <code>proofread.repetitions.ignore_proper</code></h4>
|
||
<ul>
|
||
<li><p id = "para-550"><b>type</b>: boolean</p>
|
||
</li>
|
||
<li><p id = "para-551"><b>default value</b>: <code>true</code></p>
|
||
</li>
|
||
<li><p id = "para-552">Ignore proper nouns for repetitions</p>
|
||
</li>
|
||
</ul>
|
||
<h4 id = "link-184">3.4.16.11. <code>proofread.repetitions.threshold</code></h4>
|
||
<ul>
|
||
<li><p id = "para-553"><b>type</b>: float</p>
|
||
</li>
|
||
<li><p id = "para-554"><b>default value</b>: <code>2.0</code></p>
|
||
</li>
|
||
<li><p id = "para-555">Threshold to detect a repetition</p>
|
||
</li>
|
||
</ul>
|
||
|
||
<p class = "next_chapter">
|
||
<a href = "chapter_003.html">
|
||
4. Markdown format »
|
||
</a>
|
||
</p>
|
||
</div>
|
||
<footer id = "footer"><p id = "para-1197">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.16.1</p>
|
||
</footer>
|
||
</div>
|
||
</body>
|
||
</html>
|