mirror of
https://github.com/lise-henry/crowbook
synced 2024-05-18 08:16:11 +02:00
565 lines
32 KiB
HTML
565 lines
32 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 - 9. Contributing</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-1210">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_007.html">
|
||
« 8. Tips and tricks
|
||
</a>
|
||
</p>
|
||
<h1 id = 'link-232'><span class = 'chapter-header'>Chapter 9</span><br />Contributing</h1><p id = "para-694"><code>crowbook</code> is a free software, and you can contribute to it. There are some things that can be accessible even if you don’t know anything about programming.</p>
|
||
<h2 id = "link-233">9.1. Internationalization</h2>
|
||
<p id = "para-695"><code>crowbook</code> aims to support multiple languages. However, unfortunately, currently only English, French, and (in a more limited way) Spanish are currently supported. If you want to have better support for the language you write in, there are easy things you can do:</p>
|
||
<ul>
|
||
<li><p id = "para-696">Provide a translation for the few strings that Crowbook insert into the rendered documents. This is really easy, as there are currently less than a dozen of them, and you just need to create a new variant of the <a href = "https://github.com/lise-henry/crowbook/blob/master/lang/en.yaml"><code>./lang/en.yaml</code></a> file.</p>
|
||
</li>
|
||
<li><p id = "para-697">Open an <a href = "https://github.com/lise-henry/crowbook/issues">issue</a> about the typographic rules in your language, if <code>crowbook</code> doesn’t cover them.</p>
|
||
</li>
|
||
<li><p id = "para-698">Provide a translation for the <code>crowbook</code> program. It requires creating a variant of the <a href = "https://github.com/lise-henry/crowbook/blob/master/lang/fr.po"><code>.po</code> file</a>, which is a bit more work because (at this time) it’s around 1,500 lines (and less a priority than the first item of this list, as this translation only affects the the command-line interface and not the rendered documents).</p>
|
||
</li>
|
||
</ul>
|
||
|
||
<p class = "next_chapter">
|
||
<a href = "chapter_009.html">
|
||
ChangeLog »
|
||
</a>
|
||
</p>
|
||
</div>
|
||
<footer id = "footer"><p id = "para-1209">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.16.1</p>
|
||
</footer>
|
||
</div>
|
||
</body>
|
||
</html>
|