mirror of
https://github.com/lise-henry/crowbook
synced 2024-05-12 10:36:25 +02:00
Update documentation
This commit is contained in:
Elisabeth Henry
parent
c163d27b7a
commit
c6c99b491d
4
build.rs
4
build.rs
|
|
@ -12,7 +12,7 @@ fn main() {
|
|||
let mut extractor = Extractor::new();
|
||||
extractor.add_messages_from_dir(concat!(env!("CARGO_MANIFEST_DIR"), "/src/lib")).unwrap();
|
||||
// Uncomment to update crowbook.pot
|
||||
// extractor.write_pot_file(concat!(env!("CARGO_MANIFEST_DIR"), "/lang/lib/crowbook.pot")).unwrap();
|
||||
extractor.write_pot_file(concat!(env!("CARGO_MANIFEST_DIR"), "/lang/lib/crowbook.pot")).unwrap();
|
||||
|
||||
let mut localizer = Localizer::new(&extractor);
|
||||
localizer.add_lang("fr", include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/lang/lib/fr.po"))).unwrap();
|
||||
|
|
@ -24,7 +24,7 @@ fn main() {
|
|||
let mut extractor = Extractor::new();
|
||||
extractor.add_messages_from_dir(concat!(env!("CARGO_MANIFEST_DIR"), "/src/bin")).unwrap();
|
||||
// Uncomment to update crowbook.pot
|
||||
// extractor.write_pot_file(concat!(env!("CARGO_MANIFEST_DIR"), "/lang/bin/crowbook.pot")).unwrap();
|
||||
extractor.write_pot_file(concat!(env!("CARGO_MANIFEST_DIR"), "/lang/bin/crowbook.pot")).unwrap();
|
||||
|
||||
let mut localizer = Localizer::new(&extractor);
|
||||
localizer.add_lang("fr", include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/lang/bin/fr.po"))).unwrap();
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -703,7 +703,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1276">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1278">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -2894,512 +2894,516 @@ resources.files</span><span style="color:#839496;">: [</span><span style="color:
|
|||
</li>
|
||||
<li><p id = "para-800">Strikethrough</p>
|
||||
</li>
|
||||
<li><p id = "para-801">Task items</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-801">New option:</p>
|
||||
<li><p id = "para-802">New option:</p>
|
||||
<ul>
|
||||
<li><p id = "para-802"><code>crowbook.files_mean_chapters</code> allow to enforce that each files means a chapter break or to make sure that it doesn’t (by default, only true for numbered chapters).</p>
|
||||
<li><p id = "para-803"><code>crowbook.files_mean_chapters</code> allow to enforce that each files means a chapter break or to make sure that it doesn’t (by default, only true for numbered chapters).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-803">By default, don’t add an empty chapter title for non numbered “chapters” that don’t contain a title.</p>
|
||||
<li><p id = "para-804">Fallback on Rust zip library when there is no <code>zip</code> command.</p>
|
||||
</li>
|
||||
<li><p id = "para-804">Now uses <code>reqwest</code> instead of <code>hyper</code> to connect to languagetool/grammalecte.</p>
|
||||
<li><p id = "para-805">By default, don’t add an empty chapter title for non numbered “chapters” that don’t contain a title.</p>
|
||||
</li>
|
||||
<li><p id = "para-805"><code>hyphenation</code> dependency is now optional.</p>
|
||||
<li><p id = "para-806">Now uses <code>reqwest</code> instead of <code>hyper</code> to connect to languagetool/grammalecte.</p>
|
||||
</li>
|
||||
<li><p id = "para-806">Dependencies update.</p>
|
||||
<li><p id = "para-807"><code>hyphenation</code> dependency is now optional.</p>
|
||||
</li>
|
||||
<li><p id = "para-808">Dependencies update.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-127">0.14.1 (2018-06-01)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-807"><code>--stats</code> can now display more statistics when used with the <code>--verbose</code> option (if support for advanced statistics is compiled)</p>
|
||||
<li><p id = "para-809"><code>--stats</code> can now display more statistics when used with the <code>--verbose</code> option (if support for advanced statistics is compiled)</p>
|
||||
</li>
|
||||
<li><p id = "para-808">LaTeX outputs now make uses of user-defined <code>rendering.chapter</code> and <code>rendering.part</code></p>
|
||||
<li><p id = "para-810">LaTeX outputs now make uses of user-defined <code>rendering.chapter</code> and <code>rendering.part</code></p>
|
||||
</li>
|
||||
<li><p id = "para-809">Dependencies update</p>
|
||||
<li><p id = "para-811">Dependencies update</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-128">0.14.0 (2017-11-26)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-810">New option:</p>
|
||||
<li><p id = "para-812">New option:</p>
|
||||
<ul>
|
||||
<li><p id = "para-811"><code>autograph</code> is an autograph added after title.</p>
|
||||
<li><p id = "para-813"><code>autograph</code> is an autograph added after title.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-812">User interface:</p>
|
||||
<li><p id = "para-814">User interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-813">new argument <code>--autograph</code> prompts for an autograph.</p>
|
||||
<li><p id = "para-815">new argument <code>--autograph</code> prompts for an autograph.</p>
|
||||
</li>
|
||||
<li><p id = "para-814"><code>--list-options</code> and <code>--stats</code> now use colours if available.</p>
|
||||
<li><p id = "para-816"><code>--list-options</code> and <code>--stats</code> now use colours if available.</p>
|
||||
</li>
|
||||
<li><p id = "para-815">options description with <code>--list-options</code> are now wrapped.</p>
|
||||
<li><p id = "para-817">options description with <code>--list-options</code> are now wrapped.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-816">Bugfixes:</p>
|
||||
<li><p id = "para-818">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-817">Preserve errors/warnings order with fancy UI.</p>
|
||||
<li><p id = "para-819">Preserve errors/warnings order with fancy UI.</p>
|
||||
</li>
|
||||
<li><p id = "para-818">Clean secondary bar when there is an error instead of hanging the UI.</p>
|
||||
<li><p id = "para-820">Clean secondary bar when there is an error instead of hanging the UI.</p>
|
||||
</li>
|
||||
<li><p id = "para-819">LaTeX: fancy headers only applies to fancy pages (not chapter pages).</p>
|
||||
<li><p id = "para-821">LaTeX: fancy headers only applies to fancy pages (not chapter pages).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-129">0.14.0-beta (2017-10-08)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-820">Bugfixes:</p>
|
||||
<li><p id = "para-822">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-821">EPUB: escape quotes in content.opf.</p>
|
||||
<li><p id = "para-823">EPUB: escape quotes in content.opf.</p>
|
||||
</li>
|
||||
<li><p id = "para-822">LaTeX/PDF: allow hyphenations in typewriter font.</p>
|
||||
<li><p id = "para-824">LaTeX/PDF: allow hyphenations in typewriter font.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-823">User interface:</p>
|
||||
<li><p id = "para-825">User interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-824">User interface is quite fancier, with progress bars and all</p>
|
||||
<li><p id = "para-826">User interface is quite fancier, with progress bars and all</p>
|
||||
</li>
|
||||
<li><p id = "para-825">Debug/warning/info levels should be displayed in a more coherent manner</p>
|
||||
<li><p id = "para-827">Debug/warning/info levels should be displayed in a more coherent manner</p>
|
||||
</li>
|
||||
<li><p id = "para-826">New <code>--no-fancy</code> option if you don’t like the fancy UI (or if it doesn’t work in your terminal)</p>
|
||||
<li><p id = "para-828">New <code>--no-fancy</code> option if you don’t like the fancy UI (or if it doesn’t work in your terminal)</p>
|
||||
</li>
|
||||
<li><p id = "para-827">New <code>--force-emoji</code> option to force emoji usage.</p>
|
||||
<li><p id = "para-829">New <code>--force-emoji</code> option to force emoji usage.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-828">Library interface:</p>
|
||||
<li><p id = "para-830">Library interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-829">Removed <code>Book::set_verbosity</code> method (uses a logger library instead).</p>
|
||||
<li><p id = "para-831">Removed <code>Book::set_verbosity</code> method (uses a logger library instead).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-830">Now requires rustc >= 1.20.0</p>
|
||||
<li><p id = "para-832">Now requires rustc >= 1.20.0</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-130">0.13.0 (2017-07-14)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-831">Breaking changes:</p>
|
||||
<li><p id = "para-833">Breaking changes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-832">The <code>template.tex</code> template was quite modified. Crowbook now uses custom command for most markdown elements, defined in the template. This allow an user to redefine the way the book is rendered without having to modify Crowbook itself. Unfortunately, as tex templates for previous Crowbook versions won’t work anymore.</p>
|
||||
<li><p id = "para-834">The <code>template.tex</code> template was quite modified. Crowbook now uses custom command for most markdown elements, defined in the template. This allow an user to redefine the way the book is rendered without having to modify Crowbook itself. Unfortunately, as tex templates for previous Crowbook versions won’t work anymore.</p>
|
||||
</li>
|
||||
<li><p id = "para-833">the <code>resources.files</code> option is now a YAML list of strings, instead of a comma-seprated string.</p>
|
||||
<li><p id = "para-835">the <code>resources.files</code> option is now a YAML list of strings, instead of a comma-seprated string.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-834">Add support for grammalecte grammar checker.</p>
|
||||
<li><p id = "para-836">Add support for grammalecte grammar checker.</p>
|
||||
</li>
|
||||
<li><p id = "para-835"><code>crowbook</code> command takes a new argument, <code>-S</code> or <code>--stats</code> which displays stats on the book (currently, words and characters count).</p>
|
||||
<li><p id = "para-837"><code>crowbook</code> command takes a new argument, <code>-S</code> or <code>--stats</code> which displays stats on the book (currently, words and characters count).</p>
|
||||
</li>
|
||||
<li><p id = "para-836">Interactive fiction:</p>
|
||||
<li><p id = "para-838">Interactive fiction:</p>
|
||||
<ul>
|
||||
<li><p id = "para-837">Added conditional blocks.</p>
|
||||
<li><p id = "para-839">Added conditional blocks.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-838">Options:</p>
|
||||
<li><p id = "para-840">Options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-839"><code>output.xxx</code> options can now take the “auto” value, which will infer the output file name based on the book file name.</p>
|
||||
<li><p id = "para-841"><code>output.xxx</code> options can now take the “auto” value, which will infer the output file name based on the book file name.</p>
|
||||
</li>
|
||||
<li><p id = "para-840"><code>output</code> is a new option that can specify a series of format to render, with default output file name.</p>
|
||||
<li><p id = "para-842"><code>output</code> is a new option that can specify a series of format to render, with default output file name.</p>
|
||||
</li>
|
||||
<li><p id = "para-841"><code>proofread.grammalecte</code> and <code>proofread.grammalecte.port</code> allow respectively to enable grammar checking with Grammalecte and (optionnally) to specify the port to connect.</p>
|
||||
<li><p id = "para-843"><code>proofread.grammalecte</code> and <code>proofread.grammalecte.port</code> allow respectively to enable grammar checking with Grammalecte and (optionnally) to specify the port to connect.</p>
|
||||
</li>
|
||||
<li><p id = "para-842"><code>tex.margin.left</code>, <code>tex.margin.right</code>, <code>tex.margin.bottom</code> and <code>tex.margin.top</code> are new options that allow to specify margins for LaTeX/PDF outputs.</p>
|
||||
<li><p id = "para-844"><code>tex.margin.left</code>, <code>tex.margin.right</code>, <code>tex.margin.bottom</code> and <code>tex.margin.top</code> are new options that allow to specify margins for LaTeX/PDF outputs.</p>
|
||||
</li>
|
||||
<li><p id = "para-843"><code>tex.paper_size</code> was renamed <code>tex.paper_size</code>.</p>
|
||||
<li><p id = "para-845"><code>tex.paper_size</code> was renamed <code>tex.paper_size</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-844">HTML:</p>
|
||||
<li><p id = "para-846">HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-845">Add JSON-LD structured data to the book’s HTML files.</p>
|
||||
<li><p id = "para-847">Add JSON-LD structured data to the book’s HTML files.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-846">Bugfixes:</p>
|
||||
<li><p id = "para-848">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-847">LaTeX: fix rendering of part/chapter (part previously displayed as chapter and its first chapter as part)</p>
|
||||
<li><p id = "para-849">LaTeX: fix rendering of part/chapter (part previously displayed as chapter and its first chapter as part)</p>
|
||||
</li>
|
||||
<li><p id = "para-848">EPUB:</p>
|
||||
<li><p id = "para-850">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-849">Fix <code>.rule</code> so it is centered despite KOBO CSS injection.</p>
|
||||
<li><p id = "para-851">Fix <code>.rule</code> so it is centered despite KOBO CSS injection.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-850">Fix resources/images inclusion when they are symlinks to the actual file.</p>
|
||||
<li><p id = "para-852">Fix resources/images inclusion when they are symlinks to the actual file.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-131">0.12.0 (2017-06-05)</h2>
|
||||
<p id = "para-851">This release includes a few new features, such as the possiblity to include Markdown files as section/subsections and not only as chapter, experimental support for superscript and subscript, and yet more experimental support for writing interactive fiction.</p>
|
||||
<p id = "para-853">This release includes a few new features, such as the possiblity to include Markdown files as section/subsections and not only as chapter, experimental support for superscript and subscript, and yet more experimental support for writing interactive fiction.</p>
|
||||
<ul>
|
||||
<li><p id = "para-852">Book configuration file:</p>
|
||||
<li><p id = "para-854">Book configuration file:</p>
|
||||
<ul>
|
||||
<li><p id = "para-853">It is now possible to include subchapters using the <code>--</code> command (with one dash per sublevel: <code>--- foo.md</code> will include <code>foo.md</code> as a subsection).</p>
|
||||
<li><p id = "para-855">It is now possible to include subchapters using the <code>--</code> command (with one dash per sublevel: <code>--- foo.md</code> will include <code>foo.md</code> as a subsection).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-854">Markdown:</p>
|
||||
<li><p id = "para-856">Markdown:</p>
|
||||
<ul>
|
||||
<li><p id = "para-855">Added support for superscript and subscript features, using respectively <code>foo^up^</code> or <code>bar~down~</code> syntax.</p>
|
||||
<li><p id = "para-857">Added support for superscript and subscript features, using respectively <code>foo^up^</code> or <code>bar~down~</code> syntax.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-856">New options:</p>
|
||||
<li><p id = "para-858">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-857"><code>rendering.chapter</code>: change what is displayed in place of “chapter”.</p>
|
||||
<li><p id = "para-859"><code>rendering.chapter</code>: change what is displayed in place of “chapter”.</p>
|
||||
</li>
|
||||
<li><p id = "para-858"><code>rendering.part</code>: change what is displayed in place of “part”.</p>
|
||||
<li><p id = "para-860"><code>rendering.part</code>: change what is displayed in place of “part”.</p>
|
||||
</li>
|
||||
<li><p id = "para-859"><code>html.chapter.template</code> and <code>html.part.template</code> allow to tune a little how the chapters and parts are displayed in HTML.</p>
|
||||
<li><p id = "para-861"><code>html.chapter.template</code> and <code>html.part.template</code> allow to tune a little how the chapters and parts are displayed in HTML.</p>
|
||||
</li>
|
||||
<li><p id = "para-860"><code>tex.hyperref</code>, if set to <code>false</code>, will disable hyperrefs for local links. Can be useful for some files.</p>
|
||||
<li><p id = "para-862"><code>tex.hyperref</code>, if set to <code>false</code>, will disable hyperrefs for local links. Can be useful for some files.</p>
|
||||
</li>
|
||||
<li><p id = "para-861"><code>crowbook.html_as_text</code>, if set to false, will not treat HTML as text but ignore it.</p>
|
||||
<li><p id = "para-863"><code>crowbook.html_as_text</code>, if set to false, will not treat HTML as text but ignore it.</p>
|
||||
</li>
|
||||
<li><p id = "para-862"><code>subtitle</code>, as its name suggest, set the subtitle of a book.</p>
|
||||
<li><p id = "para-864"><code>subtitle</code>, as its name suggest, set the subtitle of a book.</p>
|
||||
</li>
|
||||
<li><p id = "para-863"><code>crowbook.markdown.superscript</code> can enable or disable superscript/subscript “extension”.</p>
|
||||
<li><p id = "para-865"><code>crowbook.markdown.superscript</code> can enable or disable superscript/subscript “extension”.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-864">Rendering:</p>
|
||||
<li><p id = "para-866">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-865">Change the way chapters are displayed by default.</p>
|
||||
<li><p id = "para-867">Change the way chapters are displayed by default.</p>
|
||||
</li>
|
||||
<li><p id = "para-866">PDF output now has a better-looking (hopefully) title page.</p>
|
||||
<li><p id = "para-868">PDF output now has a better-looking (hopefully) title page.</p>
|
||||
</li>
|
||||
<li><p id = "para-867">Internal links are a bit more flexible, e.g. if you link to <code>Readme.html</code> it will now try to link to the chapter corresponding to <code>Readme.md</code>.</p>
|
||||
<li><p id = "para-869">Internal links are a bit more flexible, e.g. if you link to <code>Readme.html</code> it will now try to link to the chapter corresponding to <code>Readme.md</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-868">Bugfixes:</p>
|
||||
<li><p id = "para-870">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-869">LaTeX:</p>
|
||||
<li><p id = "para-871">LaTeX:</p>
|
||||
<ul>
|
||||
<li><p id = "para-870">Fix bug in syntax highlighting.</p>
|
||||
<li><p id = "para-872">Fix bug in syntax highlighting.</p>
|
||||
</li>
|
||||
<li><p id = "para-871">Fix label placements (and thus navigation inside PDF document).</p>
|
||||
<li><p id = "para-873">Fix label placements (and thus navigation inside PDF document).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-872">EPUB:</p>
|
||||
<li><p id = "para-874">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-873">Add unnamed but numbered chapters to the TOC.</p>
|
||||
<li><p id = "para-875">Add unnamed but numbered chapters to the TOC.</p>
|
||||
</li>
|
||||
<li><p id = "para-874">Fix HTML escaping issue for chapter titles.</p>
|
||||
<li><p id = "para-876">Fix HTML escaping issue for chapter titles.</p>
|
||||
</li>
|
||||
<li><p id = "para-875">Fix the way parts were handled in the TOC.</p>
|
||||
<li><p id = "para-877">Fix the way parts were handled in the TOC.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-876">Book configuration file:</p>
|
||||
<li><p id = "para-878">Book configuration file:</p>
|
||||
<ul>
|
||||
<li><p id = "para-877">Fix issue when setting custom number for parts.</p>
|
||||
<li><p id = "para-879">Fix issue when setting custom number for parts.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-878">Crowbook now requires rustc >= 1.17.0</p>
|
||||
<li><p id = "para-880">Crowbook now requires rustc >= 1.17.0</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-132">0.11.4 (2017-03-21)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-879">An image can now be considered standalone even if it is inside a link.</p>
|
||||
<li><p id = "para-881">An image can now be considered standalone even if it is inside a link.</p>
|
||||
</li>
|
||||
<li><p id = "para-880">Bugfixes:</p>
|
||||
<li><p id = "para-882">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-881">HTML/EPUB: use raw (not HTML rendered) metadata in the places where HTML code is not appropriate. Templates can use this metadata with the <code>foo_raw</code> value.</p>
|
||||
<li><p id = "para-883">HTML/EPUB: use raw (not HTML rendered) metadata in the places where HTML code is not appropriate. Templates can use this metadata with the <code>foo_raw</code> value.</p>
|
||||
</li>
|
||||
<li><p id = "para-882">HTML/EPUB: fix double-escaping/rendering issues in titles.</p>
|
||||
<li><p id = "para-884">HTML/EPUB: fix double-escaping/rendering issues in titles.</p>
|
||||
</li>
|
||||
<li><p id = "para-883">EPUB:</p>
|
||||
<li><p id = "para-885">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-884">Escape title and author before feeding them to epub-builder.</p>
|
||||
<li><p id = "para-886">Escape title and author before feeding them to epub-builder.</p>
|
||||
</li>
|
||||
<li><p id = "para-885">Fix content.opf issue by not rendering first chapter’s title (marked as beginning of document) in <code><guide></code>.</p>
|
||||
<li><p id = "para-887">Fix content.opf issue by not rendering first chapter’s title (marked as beginning of document) in <code><guide></code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-886">Rendering:</p>
|
||||
<li><p id = "para-888">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-887">HTML/EPUB: standalone images are now displayed centered.</p>
|
||||
<li><p id = "para-889">HTML/EPUB: standalone images are now displayed centered.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-133">0.11.3 (2017-03-19)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-888">When crowbook parses the book’s contents, it now detects which features are used. This is useful in various ways:</p>
|
||||
<li><p id = "para-890">When crowbook parses the book’s contents, it now detects which features are used. This is useful in various ways:</p>
|
||||
<ul>
|
||||
<li><p id = "para-889">The ODT renderer only displays a global warning showing the lists of used features that are not implemented, instead of a warning each time such a feature is encountered.</p>
|
||||
<li><p id = "para-891">The ODT renderer only displays a global warning showing the lists of used features that are not implemented, instead of a warning each time such a feature is encountered.</p>
|
||||
</li>
|
||||
<li><p id = "para-890">The LaTeX and HTML/EPUB renderers only initialize <code>syntect</code> (which can take some time) if code blocks are used in the document.</p>
|
||||
<li><p id = "para-892">The LaTeX and HTML/EPUB renderers only initialize <code>syntect</code> (which can take some time) if code blocks are used in the document.</p>
|
||||
</li>
|
||||
<li><p id = "para-891">The LaTeX renderer only requires LaTeX packages that are actually used in the document.</p>
|
||||
<li><p id = "para-893">The LaTeX renderer only requires LaTeX packages that are actually used in the document.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-892">Command-line interface:</p>
|
||||
<li><p id = "para-894">Command-line interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-893">Warnings are now displayed by default.</p>
|
||||
<li><p id = "para-895">Warnings are now displayed by default.</p>
|
||||
</li>
|
||||
<li><p id = "para-894">The (undocumented) <code>--debug</code> argument has been removed.</p>
|
||||
<li><p id = "para-896">The (undocumented) <code>--debug</code> argument has been removed.</p>
|
||||
</li>
|
||||
<li><p id = "para-895">The status of some messages have been modified (“warning” to “debug” or “error” to “warning”).</p>
|
||||
<li><p id = "para-897">The status of some messages have been modified (“warning” to “debug” or “error” to “warning”).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-896">Deprecated option:</p>
|
||||
<li><p id = "para-898">Deprecated option:</p>
|
||||
<ul>
|
||||
<li><p id = "para-897"><code>crowbook.verbose</code> has been deprecated, at it should be set by the CLI.</p>
|
||||
<li><p id = "para-899"><code>crowbook.verbose</code> has been deprecated, at it should be set by the CLI.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-134">0.11.2 (2017-03-05)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-898">General:</p>
|
||||
<li><p id = "para-900">General:</p>
|
||||
<ul>
|
||||
<li><p id = "para-899">When there is an error setting an option from the book configuration file (e.g. because it is an invalid key), print an error but do not abort, only ignore this specific option.</p>
|
||||
<li><p id = "para-901">When there is an error setting an option from the book configuration file (e.g. because it is an invalid key), print an error but do not abort, only ignore this specific option.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-900">New options:</p>
|
||||
<li><p id = "para-902">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-901"><code>tex.stdpage</code>: if set to <code>true</code>, will use the <code>stdpage</code> package to render the book according to standards for submitting manuscripts.</p>
|
||||
<li><p id = "para-903"><code>tex.stdpage</code>: if set to <code>true</code>, will use the <code>stdpage</code> package to render the book according to standards for submitting manuscripts.</p>
|
||||
</li>
|
||||
<li><p id = "para-902"><code>rendering.highlight.theme</code> allows to specifies a theme for syntax highlighting (only used if <code>rendering.highlight</code> is set to “syntect”).</p>
|
||||
<li><p id = "para-904"><code>rendering.highlight.theme</code> allows to specifies a theme for syntax highlighting (only used if <code>rendering.highlight</code> is set to “syntect”).</p>
|
||||
</li>
|
||||
<li><p id = "para-903"><code>html.highlight.theme</code>, <code>epub.highlight.theme</code> and <code>tex.highlight.theme</code> allow to specify a theme for HTML/EPUB/LaTeX renderers (only used with syntect).</p>
|
||||
<li><p id = "para-905"><code>html.highlight.theme</code>, <code>epub.highlight.theme</code> and <code>tex.highlight.theme</code> allow to specify a theme for HTML/EPUB/LaTeX renderers (only used with syntect).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-904">Deprecated option:</p>
|
||||
<li><p id = "para-906">Deprecated option:</p>
|
||||
<ul>
|
||||
<li><p id = "para-905"><code>proofread.nb_spaces</code>.</p>
|
||||
<li><p id = "para-907"><code>proofread.nb_spaces</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-906">Rendering:</p>
|
||||
<li><p id = "para-908">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-907"><code>[syntect](https://crates.io/crates/syntect)</code> is now the default for <code>rendering.highlight</code>. Concretely, this means that by default syntax highlighting is now done when <code>crowbook</code> is run instead of using <code>[highlight.js](https://highlightjs.org/)</code>.</p>
|
||||
<li><p id = "para-909"><code>[syntect](https://crates.io/crates/syntect)</code> is now the default for <code>rendering.highlight</code>. Concretely, this means that by default syntax highlighting is now done when <code>crowbook</code> is run instead of using <code>[highlight.js](https://highlightjs.org/)</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-908">EPUB:</p>
|
||||
<li><p id = "para-910">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-909">Now sets the “cover-image” property and meta so readers should display cover correctly.</p>
|
||||
<li><p id = "para-911">Now sets the “cover-image” property and meta so readers should display cover correctly.</p>
|
||||
</li>
|
||||
<li><p id = "para-910">Narrow non-breaking spaces should display more correctly on KOBO ereaders (hoping this won’t break the way they are displayed everywhere else).</p>
|
||||
<li><p id = "para-912">Narrow non-breaking spaces should display more correctly on KOBO ereaders (hoping this won’t break the way they are displayed everywhere else).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-911">Proofreading:</p>
|
||||
<li><p id = "para-913">Proofreading:</p>
|
||||
<ul>
|
||||
<li><p id = "para-912">Repetition detection is now a bit less of an hack, and should cause less problems when used in conjunction with grammar checking. It now also works on PDF output (so the way it is highlighted could be improved).</p>
|
||||
<li><p id = "para-914">Repetition detection is now a bit less of an hack, and should cause less problems when used in conjunction with grammar checking. It now also works on PDF output (so the way it is highlighted could be improved).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-913">Bugfixes:</p>
|
||||
<li><p id = "para-915">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-914">Fix <code>mimetype</code> of EPUB files (make sure it is always “stored” and not “deflated” by the <code>zip</code> command).</p>
|
||||
<li><p id = "para-916">Fix <code>mimetype</code> of EPUB files (make sure it is always “stored” and not “deflated” by the <code>zip</code> command).</p>
|
||||
</li>
|
||||
<li><p id = "para-915">Avoid initializing <code>syntect</code> (at the cost of performances) if it is not used.</p>
|
||||
<li><p id = "para-917">Avoid initializing <code>syntect</code> (at the cost of performances) if it is not used.</p>
|
||||
</li>
|
||||
<li><p id = "para-916">Avoid creating an empty file if some book renderer fails (e.g. EPUB or ODT because <code>zip</code> command is not present).</p>
|
||||
<li><p id = "para-918">Avoid creating an empty file if some book renderer fails (e.g. EPUB or ODT because <code>zip</code> command is not present).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-135">0.11.1 (2017-01-05)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-917">Rendering:</p>
|
||||
<li><p id = "para-919">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-918">Avoid page break before or after a separating rule.</p>
|
||||
<li><p id = "para-920">Avoid page break before or after a separating rule.</p>
|
||||
</li>
|
||||
<li><p id = "para-919">Add support for <a href = "https://crates.io/crates/syntect">syntect</a> for syntax highlighting. This is activated by setting <code>rendering.highlight</code> to <code>syntect</code> (see below).</p>
|
||||
<li><p id = "para-921">Add support for <a href = "https://crates.io/crates/syntect">syntect</a> for syntax highlighting. This is activated by setting <code>rendering.highlight</code> to <code>syntect</code> (see below).</p>
|
||||
</li>
|
||||
<li><p id = "para-920">EPUB:</p>
|
||||
<li><p id = "para-922">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-921">Set back HTML escape of narrow non-breaking spaces to <code>true</code> by default (it caused problems on some readers, but cause much more serious one if <code>false</code>).</p>
|
||||
<li><p id = "para-923">Set back HTML escape of narrow non-breaking spaces to <code>true</code> by default (it caused problems on some readers, but cause much more serious one if <code>false</code>).</p>
|
||||
</li>
|
||||
<li><p id = "para-922">Add more information to guide/nav landmarks.</p>
|
||||
<li><p id = "para-924">Add more information to guide/nav landmarks.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-923">LaTeX/PDF:</p>
|
||||
<li><p id = "para-925">LaTeX/PDF:</p>
|
||||
<ul>
|
||||
<li><p id = "para-924">Improve the way code blocks are displayed, using the <code>mdframed</code> package.</p>
|
||||
<li><p id = "para-926">Improve the way code blocks are displayed, using the <code>mdframed</code> package.</p>
|
||||
</li>
|
||||
<li><p id = "para-925">Try to reduce the issues of too long lines when using code and code blocks, by inserting <code>\allowbreak{}</code> directive after some characters (<code>.</code>, <code>/</code>, <code>_</code>, ...).</p>
|
||||
<li><p id = "para-927">Try to reduce the issues of too long lines when using code and code blocks, by inserting <code>\allowbreak{}</code> directive after some characters (<code>.</code>, <code>/</code>, <code>_</code>, ...).</p>
|
||||
</li>
|
||||
<li><p id = "para-926">Block quotes are now displayed in italics.</p>
|
||||
<li><p id = "para-928">Block quotes are now displayed in italics.</p>
|
||||
</li>
|
||||
<li><p id = "para-927">Tables now use <code>tabularx</code>, which allows to break too long lines (it still doesn’t break pages, though).</p>
|
||||
<li><p id = "para-929">Tables now use <code>tabularx</code>, which allows to break too long lines (it still doesn’t break pages, though).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-928">New options:</p>
|
||||
<li><p id = "para-930">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-929"><code>rendering.highlight</code> can be set to <code>none</code>, <code>highlight.js</code> (by default, enables syntax highlighting via Javascript, but only on HTML document) or <code>syntect</code> (doesn’t necessitate javascript, and can work in EPUB or LaTeX, but more experimental at this point).</p>
|
||||
<li><p id = "para-931"><code>rendering.highlight</code> can be set to <code>none</code>, <code>highlight.js</code> (by default, enables syntax highlighting via Javascript, but only on HTML document) or <code>syntect</code> (doesn’t necessitate javascript, and can work in EPUB or LaTeX, but more experimental at this point).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-930">Deprecated options:</p>
|
||||
<li><p id = "para-932">Deprecated options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-931"><code>html.highlight_code</code> (use <code>rendering.highlight</code> instead).</p>
|
||||
<li><p id = "para-933"><code>html.highlight_code</code> (use <code>rendering.highlight</code> instead).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-932">Bugfixes:</p>
|
||||
<li><p id = "para-934">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-933">HTML (standalone): fix the template that contained invalid HTML code.</p>
|
||||
<li><p id = "para-935">HTML (standalone): fix the template that contained invalid HTML code.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-136">0.11.0 (2016-12-31)</h2>
|
||||
<p id = "para-934">Substantial changes in this release, the more important one being support for parts!</p>
|
||||
<p id = "para-936">Substantial changes in this release, the more important one being support for parts!</p>
|
||||
<ul>
|
||||
<li><p id = "para-935"><b>Breaking changes</b>: the API has undergone some breaking changes, hoping they will be the last ones for a while. API should now be more simple and consistent (?). This version contains also substantial options renaming (see below).</p>
|
||||
<li><p id = "para-937"><b>Breaking changes</b>: the API has undergone some breaking changes, hoping they will be the last ones for a while. API should now be more simple and consistent (?). This version contains also substantial options renaming (see below).</p>
|
||||
</li>
|
||||
<li><p id = "para-936">Crowbook now supports parts (above the “chapter” level), using the ‘@’ character in the book configuration file.</p>
|
||||
<li><p id = "para-938">Crowbook now supports parts (above the “chapter” level), using the ‘@’ character in the book configuration file.</p>
|
||||
</li>
|
||||
<li><p id = "para-937">Command-line interface:</p>
|
||||
<li><p id = "para-939">Command-line interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-938">Behaviour of <code>--to</code> should now be consistent for all output formats.</p>
|
||||
<li><p id = "para-940">Behaviour of <code>--to</code> should now be consistent for all output formats.</p>
|
||||
</li>
|
||||
<li><p id = "para-939">If <code>--output</code> is set to <code>-</code>, prints to stdout.</p>
|
||||
<li><p id = "para-941">If <code>--output</code> is set to <code>-</code>, prints to stdout.</p>
|
||||
</li>
|
||||
<li><p id = "para-940">Conversely, if <code><BOOK></code> is set to <code>-</code>, reads from stdin.</p>
|
||||
<li><p id = "para-942">Conversely, if <code><BOOK></code> is set to <code>-</code>, reads from stdin.</p>
|
||||
</li>
|
||||
<li><p id = "para-941">Path specified by <code>--output</code> is now interpreted relatively to current directory (and not depending on where <code><BOOK></code> is or its options).</p>
|
||||
<li><p id = "para-943">Path specified by <code>--output</code> is now interpreted relatively to current directory (and not depending on where <code><BOOK></code> is or its options).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-942">Rendering:</p>
|
||||
<li><p id = "para-944">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-943">Chapters with no titles now have an empty title added (so it can at least display e.g. “Chapter X”).</p>
|
||||
<li><p id = "para-945">Chapters with no titles now have an empty title added (so it can at least display e.g. “Chapter X”).</p>
|
||||
</li>
|
||||
<li><p id = "para-944">EPUB:</p>
|
||||
<li><p id = "para-946">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-945">The <code>toc.ncx</code> file now displays links to “title” and (if set) “cover” (can be deactivated, see below).</p>
|
||||
<li><p id = "para-947">The <code>toc.ncx</code> file now displays links to “title” and (if set) “cover” (can be deactivated, see below).</p>
|
||||
</li>
|
||||
<li><p id = "para-946">The <code>toc.ncx</code> file now displays toc levels below chapter.</p>
|
||||
<li><p id = "para-948">The <code>toc.ncx</code> file now displays toc levels below chapter.</p>
|
||||
</li>
|
||||
<li><p id = "para-947">The table of contents is now displayed inline if <code>rendering.inline_toc</code> is set to <code>true</code>.</p>
|
||||
<li><p id = "para-949">The table of contents is now displayed inline if <code>rendering.inline_toc</code> is set to <code>true</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-948">New options:</p>
|
||||
<li><p id = "para-950">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-949"><code>epub.toc.extras</code>, set to <code>true</code> by default, will add links to the title and the cover (if it is set) in the table of contents.</p>
|
||||
<li><p id = "para-951"><code>epub.toc.extras</code>, set to <code>true</code> by default, will add links to the title and the cover (if it is set) in the table of contents.</p>
|
||||
</li>
|
||||
<li><p id = "para-950"><code>epub.escape_nb_spaces</code>, similar to <code>html.escape_nb_spaces</code> and set to false by default since at least Kobo reader don’t seem to be able to understand the CSS to escape those nb spaces...</p>
|
||||
<li><p id = "para-952"><code>epub.escape_nb_spaces</code>, similar to <code>html.escape_nb_spaces</code> and set to false by default since at least Kobo reader don’t seem to be able to understand the CSS to escape those nb spaces...</p>
|
||||
</li>
|
||||
<li><p id = "para-951"><code>rendering.chapter.roman_numerals</code>, if set to <code>true</code>, will display chapter numbers using roman numerals.</p>
|
||||
<li><p id = "para-953"><code>rendering.chapter.roman_numerals</code>, if set to <code>true</code>, will display chapter numbers using roman numerals.</p>
|
||||
</li>
|
||||
<li><p id = "para-952"><code>rendering.part.roman_numerals</code>, if set to <code>true</code> (it is by default) will display part numbers using roman numerals.</p>
|
||||
<li><p id = "para-954"><code>rendering.part.roman_numerals</code>, if set to <code>true</code> (it is by default) will display part numbers using roman numerals.</p>
|
||||
</li>
|
||||
<li><p id = "para-953"><code>rendering.part.template</code> specifies the numbering scheme of parts.</p>
|
||||
<li><p id = "para-955"><code>rendering.part.template</code> specifies the numbering scheme of parts.</p>
|
||||
</li>
|
||||
<li><p id = "para-954"><code>rendering.part.reset_counter</code>, if set to <code>true</code> (it is by default), resets chapter number to zero after a part.</p>
|
||||
<li><p id = "para-956"><code>rendering.part.reset_counter</code>, if set to <code>true</code> (it is by default), resets chapter number to zero after a part.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-955">Renamed options:</p>
|
||||
<li><p id = "para-957">Renamed options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-956"><code>import_config</code> renamed to <code>import</code>.</p>
|
||||
<li><p id = "para-958"><code>import_config</code> renamed to <code>import</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-957"><code>rendering.chapter_template</code> renamed to <code>rendering.chapter.template</code>.</p>
|
||||
<li><p id = "para-959"><code>rendering.chapter_template</code> renamed to <code>rendering.chapter.template</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-958"><code>html_single.html</code> renamed to <code>html.standalone.template</code>.</p>
|
||||
<li><p id = "para-960"><code>html_single.html</code> renamed to <code>html.standalone.template</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-959"><code>html_single.js</code> renamed to <code>html.standalone.js</code>.</p>
|
||||
<li><p id = "para-961"><code>html_single.js</code> renamed to <code>html.standalone.js</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-960"><code>html_single.one_chapter</code> renamed to <code>html.standalone.one_chapter</code>.</p>
|
||||
<li><p id = "para-962"><code>html_single.one_chapter</code> renamed to <code>html.standalone.one_chapter</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-961"><code>output.html_dir</code> renamed to <code>output.html.dir</code>.</p>
|
||||
<li><p id = "para-963"><code>output.html_dir</code> renamed to <code>output.html.dir</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-962"><code>output.proofread.html_dir</code> renamed to <code>output.proofread.html.dir</code>.</p>
|
||||
<li><p id = "para-964"><code>output.proofread.html_dir</code> renamed to <code>output.proofread.html.dir</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-963"><code>html_dir.index.html</code> and <code>html.dir.chapter.html</code> have been merged and both renamed to <code>html.dir.template</code>.</p>
|
||||
<li><p id = "para-965"><code>html_dir.index.html</code> and <code>html.dir.chapter.html</code> have been merged and both renamed to <code>html.dir.template</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-964"><code>tex.font_size</code> renamed to <code>tex.font.size</code>.</p>
|
||||
<li><p id = "para-966"><code>tex.font_size</code> renamed to <code>tex.font.size</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-965">Bugfixes:</p>
|
||||
<li><p id = "para-967">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-966">EPUB:</p>
|
||||
<li><p id = "para-968">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-967">Fix duplicate HTML escaping (resulting in e.g. “&” instead of “&”).</p>
|
||||
<li><p id = "para-969">Fix duplicate HTML escaping (resulting in e.g. “&” instead of “&”).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-968">HTML directory:</p>
|
||||
<li><p id = "para-970">HTML directory:</p>
|
||||
<ul>
|
||||
<li><p id = "para-969">Fix panic when trying to generate html directory in “../xxx” (<a href = "https://github.com/lise-henry/crowbook/issues/23">#23</a>).</p>
|
||||
<li><p id = "para-971">Fix panic when trying to generate html directory in “../xxx” (<a href = "https://github.com/lise-henry/crowbook/issues/23">#23</a>).</p>
|
||||
</li>
|
||||
<li><p id = "para-970">Fix “previous chapter” links that were not displayed when “html.header” was set.</p>
|
||||
<li><p id = "para-972">Fix “previous chapter” links that were not displayed when “html.header” was set.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-971">HTML:</p>
|
||||
<li><p id = "para-973">HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-972">Fix the way initial letter is displayed if <code>rendering.initials</code> is true.</p>
|
||||
<li><p id = "para-974">Fix the way initial letter is displayed if <code>rendering.initials</code> is true.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-973">Internationalization:</p>
|
||||
<li><p id = "para-975">Internationalization:</p>
|
||||
<ul>
|
||||
<li><p id = "para-974">Strings in generated Crowbook documents (such as “Table of contents”, “Title”, “Cover” and such) are now translated in spanish.</p>
|
||||
<li><p id = "para-976">Strings in generated Crowbook documents (such as “Table of contents”, “Title”, “Cover” and such) are now translated in spanish.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-137">0.10.4 (2016-12-16)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-975">New options:</p>
|
||||
<li><p id = "para-977">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-976"><code>tex.font_size</code> specifies an optional font size (in pt) passed to the LaTeX class (must be 10, 11 or 12).</p>
|
||||
<li><p id = "para-978"><code>tex.font_size</code> specifies an optional font size (in pt) passed to the LaTeX class (must be 10, 11 or 12).</p>
|
||||
</li>
|
||||
<li><p id = "para-977"><code>tex.title</code> can be set to <code>false</code> to avoid rendering the title with <code>\maketitle</code>.</p>
|
||||
<li><p id = "para-979"><code>tex.title</code> can be set to <code>false</code> to avoid rendering the title with <code>\maketitle</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-978"><code>tex.paper_size</code> specifies the paper size for PDF output.</p>
|
||||
<li><p id = "para-980"><code>tex.paper_size</code> specifies the paper size for PDF output.</p>
|
||||
</li>
|
||||
<li><p id = "para-979"><code>tex.template.add</code>, <code>html.css.add</code> and <code>epub.css.add</code>allow to specify inline LaTex or CSS code in the book configuration file that will be added respectively to <code>tex.template.add</code>, <code>html.css.add</code> and <code>epub.css.add</code>.</p>
|
||||
<li><p id = "para-981"><code>tex.template.add</code>, <code>html.css.add</code> and <code>epub.css.add</code>allow to specify inline LaTex or CSS code in the book configuration file that will be added respectively to <code>tex.template.add</code>, <code>html.css.add</code> and <code>epub.css.add</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-980"><code>html.icon</code> allows to specify the path of an icon for HTML documents.</p>
|
||||
<li><p id = "para-982"><code>html.icon</code> allows to specify the path of an icon for HTML documents.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-981">Command-line interface:</p>
|
||||
<li><p id = "para-983">Command-line interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-982">Paths that are displayed should now be normalized, e.g. “foo/bar.pdf” instead of “baz/../foo/bar.pdf”.</p>
|
||||
<li><p id = "para-984">Paths that are displayed should now be normalized, e.g. “foo/bar.pdf” instead of “baz/../foo/bar.pdf”.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-983">Rendering:</p>
|
||||
<li><p id = "para-985">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-984">HTML:</p>
|
||||
<li><p id = "para-986">HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-985">The default CSS style has been slightly modified.</p>
|
||||
<li><p id = "para-987">The default CSS style has been slightly modified.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -3408,392 +3412,392 @@ resources.files</span><span style="color:#839496;">: [</span><span style="color:
|
|||
</ul>
|
||||
<h2 id = "link-138">0.10.3 (2016-11-19)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-986">Building:</p>
|
||||
<li><p id = "para-988">Building:</p>
|
||||
<ul>
|
||||
<li><p id = "para-987">Crowbook now requires rustc >= 1.13.0 to build.</p>
|
||||
<li><p id = "para-989">Crowbook now requires rustc >= 1.13.0 to build.</p>
|
||||
</li>
|
||||
<li><p id = "para-988">Pre-built binaries now all include the proofreading feature.</p>
|
||||
<li><p id = "para-990">Pre-built binaries now all include the proofreading feature.</p>
|
||||
</li>
|
||||
<li><p id = "para-989">Linux binaries are now linked against <code>musl</code> library so they should really work on any Linux platform.</p>
|
||||
<li><p id = "para-991">Linux binaries are now linked against <code>musl</code> library so they should really work on any Linux platform.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-990">Bugfixes:</p>
|
||||
<li><p id = "para-992">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-991">Fixed escaping of <code>author</code> and <code>title</code> fields.</p>
|
||||
<li><p id = "para-993">Fixed escaping of <code>author</code> and <code>title</code> fields.</p>
|
||||
</li>
|
||||
<li><p id = "para-992">Fixed text cleaning in ODT rendering that causes corrupt files to be generated.</p>
|
||||
<li><p id = "para-994">Fixed text cleaning in ODT rendering that causes corrupt files to be generated.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-993">CommandLine Interface:</p>
|
||||
<li><p id = "para-995">CommandLine Interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-994">Crowbook displays clearer error messages when unable to launch <code>latex</code> or <code>zip</code> commands.</p>
|
||||
<li><p id = "para-996">Crowbook displays clearer error messages when unable to launch <code>latex</code> or <code>zip</code> commands.</p>
|
||||
</li>
|
||||
<li><p id = "para-995">Crowbook uses <code>term</code> library in order to display colours correctly on e.g. Windows.</p>
|
||||
<li><p id = "para-997">Crowbook uses <code>term</code> library in order to display colours correctly on e.g. Windows.</p>
|
||||
</li>
|
||||
<li><p id = "para-996">The new argument <code>--lang</code> (or <code>-L</code>) allows to set the runtime language used by Crowbook, overriding <code>LANG</code> environment variable.</p>
|
||||
<li><p id = "para-998">The new argument <code>--lang</code> (or <code>-L</code>) allows to set the runtime language used by Crowbook, overriding <code>LANG</code> environment variable.</p>
|
||||
</li>
|
||||
<li><p id = "para-997"><code>--list-options</code> no longer uses colours as it caused problems depending on the terminal or when piping to <code>less</code>.</p>
|
||||
<li><p id = "para-999"><code>--list-options</code> no longer uses colours as it caused problems depending on the terminal or when piping to <code>less</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-139">0.10.2 (2016-10-21)</h2>
|
||||
<p id = "para-998">Only minor changes in this version:</p>
|
||||
<p id = "para-1000">Only minor changes in this version:</p>
|
||||
<ul>
|
||||
<li><p id = "para-999">Options:</p>
|
||||
<li><p id = "para-1001">Options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1000"><code>author</code> and <code>title</code>’s default values are both set to the empty string, instead of <code>Anonymous</code> and <code>Untitled</code>.</p>
|
||||
<li><p id = "para-1002"><code>author</code> and <code>title</code>’s default values are both set to the empty string, instead of <code>Anonymous</code> and <code>Untitled</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1001"><code>input.autoclean</code> has been renamed <code>input.clean</code>.</p>
|
||||
<li><p id = "para-1003"><code>input.autoclean</code> has been renamed <code>input.clean</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1002"><code>input.smart_quotes</code> has been renamed <code>input.clean.smart_quotes</code>.</p>
|
||||
<li><p id = "para-1004"><code>input.smart_quotes</code> has been renamed <code>input.clean.smart_quotes</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1003">new option: <code>input.clean.ligature.dashes</code> will (if set to true) replace <code>--</code> to en dash (<code>–</code>) and <code>---</code> to em dash (<code>—</code>).</p>
|
||||
<li><p id = "para-1005">new option: <code>input.clean.ligature.dashes</code> will (if set to true) replace <code>--</code> to en dash (<code>–</code>) and <code>---</code> to em dash (<code>—</code>).</p>
|
||||
</li>
|
||||
<li><p id = "para-1004">new option: <code>input.clean.ligature.guillemets</code> will (if set to true) replace <code><<</code> and <code>>></code> to french guillemets (<code>«</code> and <code>»</code>).</p>
|
||||
<li><p id = "para-1006">new option: <code>input.clean.ligature.guillemets</code> will (if set to true) replace <code><<</code> and <code>>></code> to french guillemets (<code>«</code> and <code>»</code>).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1005">Rendering:</p>
|
||||
<li><p id = "para-1007">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1006">HTML: if <code>html_single.one_chapter</code> and <code>rendering.inline_toc</code> are both set to true, only render the TOC if currently displayed chapter is the first.</p>
|
||||
<li><p id = "para-1008">HTML: if <code>html_single.one_chapter</code> and <code>rendering.inline_toc</code> are both set to true, only render the TOC if currently displayed chapter is the first.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-140">0.10.1 (2016-10-18)</h2>
|
||||
<p id = "para-1007">Fixed a bug in <code>fr.po</code> translation that prevented building from fresh install.</p>
|
||||
<p id = "para-1009">Fixed a bug in <code>fr.po</code> translation that prevented building from fresh install.</p>
|
||||
<h2 id = "link-141">0.10.0 (2016-10-18)</h2>
|
||||
<p id = "para-1008">This release contains some breaking changes (mostly for the API, which has been split in separate libraries). It alse features some internationalization support, and the program should now be tranlated if your <code>LANG</code> environment variable is set to french.</p>
|
||||
<p id = "para-1010">This release contains some breaking changes (mostly for the API, which has been split in separate libraries). It alse features some internationalization support, and the program should now be tranlated if your <code>LANG</code> environment variable is set to french.</p>
|
||||
<ul>
|
||||
<li><p id = "para-1009"><b>Breaking changes</b>:</p>
|
||||
<li><p id = "para-1011"><b>Breaking changes</b>:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1010">Templates:</p>
|
||||
<li><p id = "para-1012">Templates:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1011">Conditional inclusion depending on <code>lang</code> must now be done using <code>lang_LANG</code> (e.g. <code>lang_fr</code>, <code>lang_en</code>, and so on). This might impact custom <code>epub.css</code> and <code>html.css</code> templates.</p>
|
||||
<li><p id = "para-1013">Conditional inclusion depending on <code>lang</code> must now be done using <code>lang_LANG</code> (e.g. <code>lang_fr</code>, <code>lang_en</code>, and so on). This might impact custom <code>epub.css</code> and <code>html.css</code> templates.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1012">API:</p>
|
||||
<li><p id = "para-1014">API:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1013">The <code>escape</code> module has been moved to a separate crate, <code>crowbook_text_processing</code>. The <code>cleaner</code> module is no longer public, but the features it provided are also available in <code>crowbook_text_processing</code>.</p>
|
||||
<li><p id = "para-1015">The <code>escape</code> module has been moved to a separate crate, <code>crowbook_text_processing</code>. The <code>cleaner</code> module is no longer public, but the features it provided are also available in <code>crowbook_text_processing</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1014">New options:</p>
|
||||
<li><p id = "para-1016">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1015"><code>html.css.colours</code> allows to provide a CSS file that only redefine the colour scheme. Such a file can be built from <code>crowbook --print-template html.css.colours</code>.</p>
|
||||
<li><p id = "para-1017"><code>html.css.colours</code> allows to provide a CSS file that only redefine the colour scheme. Such a file can be built from <code>crowbook --print-template html.css.colours</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1016"><code>input.smart_quotes</code>: if set to <code>true</code>, tries to replace <code>'</code> and <code>"</code> by curly quotes.</p>
|
||||
<li><p id = "para-1018"><code>input.smart_quotes</code>: if set to <code>true</code>, tries to replace <code>'</code> and <code>"</code> by curly quotes.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1017">Command line interface:</p>
|
||||
<li><p id = "para-1019">Command line interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1018">Crowbook is now (imperfectly) localized in french, and can be translated to other languages.</p>
|
||||
<li><p id = "para-1020">Crowbook is now (imperfectly) localized in french, and can be translated to other languages.</p>
|
||||
</li>
|
||||
<li><p id = "para-1019">Added the <code>--quiet</code> (or <code>-q</code>) argument, that makes crowbook run without displaying any messages (except some error messages at this point).</p>
|
||||
<li><p id = "para-1021">Added the <code>--quiet</code> (or <code>-q</code>) argument, that makes crowbook run without displaying any messages (except some error messages at this point).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1020">Rendering:</p>
|
||||
<li><p id = "para-1022">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1021">HTML:</p>
|
||||
<li><p id = "para-1023">HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1022">The table of contents menu is no longer displayed in the HTML single renderer if it doesn’t contain at least two elements.</p>
|
||||
<li><p id = "para-1024">The table of contents menu is no longer displayed in the HTML single renderer if it doesn’t contain at least two elements.</p>
|
||||
</li>
|
||||
<li><p id = "para-1023">The default colour theme has been modified a little.</p>
|
||||
<li><p id = "para-1025">The default colour theme has been modified a little.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1024">Bugfixes:</p>
|
||||
<li><p id = "para-1026">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1025">Fix the escaping of non-breaking spaces in EPUB, as <code>&nbsp;</code> and its friends aren’t valid entities in XHTML, apparently.</p>
|
||||
<li><p id = "para-1027">Fix the escaping of non-breaking spaces in EPUB, as <code>&nbsp;</code> and its friends aren’t valid entities in XHTML, apparently.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-142">0.9.1 (2016-09-29)</h2>
|
||||
<p id = "para-1026">This release mainly introduces generation of proofreading copies, allowing, if they are set (and <code>crowbook</code> was compiled with the <code>proofread</code> feature) to generate proofreading copies, using tools to check grammar and detect repetitions. These features are currently experimental.</p>
|
||||
<p id = "para-1028">This release mainly introduces generation of proofreading copies, allowing, if they are set (and <code>crowbook</code> was compiled with the <code>proofread</code> feature) to generate proofreading copies, using tools to check grammar and detect repetitions. These features are currently experimental.</p>
|
||||
<ul>
|
||||
<li><p id = "para-1027">New options:</p>
|
||||
<li><p id = "para-1029">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1028"><code>html.escape_nb_spaces</code>, if set to true (by default), will replace unicode non breaking spaces with HTML entites and CSS so it can display correctly even if reader’s don’t have a browser/font supporting these unicode symbols.</p>
|
||||
<li><p id = "para-1030"><code>html.escape_nb_spaces</code>, if set to true (by default), will replace unicode non breaking spaces with HTML entites and CSS so it can display correctly even if reader’s don’t have a browser/font supporting these unicode symbols.</p>
|
||||
</li>
|
||||
<li><p id = "para-1029">Output files for proofread documents: <code>output.proofread.html</code>, <code>output.proofread.html_dir</code> and <code>output.proofread.pdf</code>.</p>
|
||||
<li><p id = "para-1031">Output files for proofread documents: <code>output.proofread.html</code>, <code>output.proofread.html_dir</code> and <code>output.proofread.pdf</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1030">Proofread options <code>proofread.repetitions</code> and <code>proofread.nb_spaces</code> have been added.</p>
|
||||
<li><p id = "para-1032">Proofread options <code>proofread.repetitions</code> and <code>proofread.nb_spaces</code> have been added.</p>
|
||||
<ul>
|
||||
<li><p id = "para-1031"><code>proofread.nb_spaces</code>, if set to true, highlights non-breaking spaces so it is easier to check the correct typography of a book. Note that it requires that <code>html.escape_nb_spaces</code> be set to true (default) to work.</p>
|
||||
<li><p id = "para-1033"><code>proofread.nb_spaces</code>, if set to true, highlights non-breaking spaces so it is easier to check the correct typography of a book. Note that it requires that <code>html.escape_nb_spaces</code> be set to true (default) to work.</p>
|
||||
</li>
|
||||
<li><p id = "para-1032"><code>proofread.reppetitions</code>, if set to true, uses <a href = "https://github.com/lise-henry/caribon">Caribon</a> to highlight repetitions in a document. It also uses the settings <code>proofread.repetitions.fuzzy</code>, <code>proofread.repetitions.max_distance</code>, <code>proofread.repetitions.threshold</code>, <code>proofread.repetitions.fuzzy.threshold</code>, <code>proofread.repetitions.ignore_proper</code>. Note that this feature is not built by default, you’ll have to build crowbook with <code>cargo build --release --features "repetitions"</code>.</p>
|
||||
<li><p id = "para-1034"><code>proofread.reppetitions</code>, if set to true, uses <a href = "https://github.com/lise-henry/caribon">Caribon</a> to highlight repetitions in a document. It also uses the settings <code>proofread.repetitions.fuzzy</code>, <code>proofread.repetitions.max_distance</code>, <code>proofread.repetitions.threshold</code>, <code>proofread.repetitions.fuzzy.threshold</code>, <code>proofread.repetitions.ignore_proper</code>. Note that this feature is not built by default, you’ll have to build crowbook with <code>cargo build --release --features "repetitions"</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1033">New default settings for options:</p>
|
||||
<li><p id = "para-1035">New default settings for options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1034"><code>tex.command</code> is now <code>xelatex</code> by default.</p>
|
||||
<li><p id = "para-1036"><code>tex.command</code> is now <code>xelatex</code> by default.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1035">Rendering:</p>
|
||||
<li><p id = "para-1037">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1036">LaTeX:</p>
|
||||
<li><p id = "para-1038">LaTeX:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1037">Add support for xelatex in the default template.</p>
|
||||
<li><p id = "para-1039">Add support for xelatex in the default template.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1038">Improved french cleaner (see <a href = "https://crowdagger.github.io/textes/articles/heuristique.html">an article (in french)</a> that talks about what it does).</p>
|
||||
<li><p id = "para-1040">Improved french cleaner (see <a href = "https://crowdagger.github.io/textes/articles/heuristique.html">an article (in french)</a> that talks about what it does).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1039">Crowbook user guide: documentation has been updated to correctly reflect 0.9.x options.</p>
|
||||
<li><p id = "para-1041">Crowbook user guide: documentation has been updated to correctly reflect 0.9.x options.</p>
|
||||
</li>
|
||||
<li><p id = "para-1040">API:</p>
|
||||
<li><p id = "para-1042">API:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1041"><code>clap</code> dependency is now optional, people who want to use Crowbook as a library should include it with <code>crowbook = { version = "0.9", default-features = false }</code>. (<code>clap</code> is still required to build a working binary).</p>
|
||||
<li><p id = "para-1043"><code>clap</code> dependency is now optional, people who want to use Crowbook as a library should include it with <code>crowbook = { version = "0.9", default-features = false }</code>. (<code>clap</code> is still required to build a working binary).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-143">0.9.0 (2016-09-23)</h2>
|
||||
<p id = "para-1042">The main objective of this release is to clean public interfaces, in order to limit breaking changes in the future. <em>Ideally</em>, all pre-1.0 releases should thus be 0.9.x. Concretely, this meant three things:</p>
|
||||
<p id = "para-1044">The main objective of this release is to clean public interfaces, in order to limit breaking changes in the future. <em>Ideally</em>, all pre-1.0 releases should thus be 0.9.x. Concretely, this meant three things:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1043">reducing the surface of Crowbook’s library API;</p>
|
||||
<li><p id = "para-1045">reducing the surface of Crowbook’s library API;</p>
|
||||
</li>
|
||||
<li><p id = "para-1044">cleaning options names</p>
|
||||
<li><p id = "para-1046">cleaning options names</p>
|
||||
</li>
|
||||
<li><p id = "para-1045">cleaning the names exported in templates and document them, in order not to break user-defined templates in future (non-breaking) releases. More detailed changes for this release:</p>
|
||||
<li><p id = "para-1047">cleaning the names exported in templates and document them, in order not to break user-defined templates in future (non-breaking) releases. More detailed changes for this release:</p>
|
||||
</li>
|
||||
<li><p id = "para-1046"><b>Breaking change for users</b>: removed <code>tex.short</code> option, replaced by a more generic <code>tex.class</code> (default being <code>book</code>). <code>html.crowbook_link</code> has also been removed.</p>
|
||||
<li><p id = "para-1048"><b>Breaking change for users</b>: removed <code>tex.short</code> option, replaced by a more generic <code>tex.class</code> (default being <code>book</code>). <code>html.crowbook_link</code> has also been removed.</p>
|
||||
</li>
|
||||
<li><p id = "para-1047">Renamed options. Using the old name will print a deprecation warning but will still work for a while.</p>
|
||||
<li><p id = "para-1049">Renamed options. Using the old name will print a deprecation warning but will still work for a while.</p>
|
||||
<ul>
|
||||
<li><p id = "para-1048"><code>temp_dir</code> -> <code>crowbook.temp_dir</code></p>
|
||||
<li><p id = "para-1050"><code>temp_dir</code> -> <code>crowbook.temp_dir</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1049"><code>zip.command</code> -> <code>crowbook.zip.command</code></p>
|
||||
<li><p id = "para-1051"><code>zip.command</code> -> <code>crowbook.zip.command</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1050"><code>verbose</code> -> <code>crowbook.verbose</code></p>
|
||||
<li><p id = "para-1052"><code>verbose</code> -> <code>crowbook.verbose</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1051"><code>html.print_css</code> -> <code>html.css.print</code></p>
|
||||
<li><p id = "para-1053"><code>html.print_css</code> -> <code>html.css.print</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1052"><code>html.display_chapter</code> -> <code>html_single.one_chapter</code></p>
|
||||
<li><p id = "para-1054"><code>html.display_chapter</code> -> <code>html_single.one_chapter</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1053"><code>html.script</code> -> <code>html_single.js</code></p>
|
||||
<li><p id = "para-1055"><code>html.script</code> -> <code>html_single.js</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1054"><code>numbering</code> -> <code>rendering.num_depth</code></p>
|
||||
<li><p id = "para-1056"><code>numbering</code> -> <code>rendering.num_depth</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1055"><code>numbering_template</code> -> <code>rendering.chapter_template</code></p>
|
||||
<li><p id = "para-1057"><code>numbering_template</code> -> <code>rendering.chapter_template</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1056"><code>display_toc</code> -> <code>rendering.inline_toc</code></p>
|
||||
<li><p id = "para-1058"><code>display_toc</code> -> <code>rendering.inline_toc</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1057"><code>toc_name</code> -> <code>rendering.inline_toc.name</code></p>
|
||||
<li><p id = "para-1059"><code>toc_name</code> -> <code>rendering.inline_toc.name</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1058"><code>enable_yaml_blocks</code> -> <code>input.yaml_blocks</code></p>
|
||||
<li><p id = "para-1060"><code>enable_yaml_blocks</code> -> <code>input.yaml_blocks</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1059"><code>use_initials</code> -> <code>rendering.initials</code></p>
|
||||
<li><p id = "para-1061"><code>use_initials</code> -> <code>rendering.initials</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1060"><code>autoclean</code> -> <code>input.autoclean</code></p>
|
||||
<li><p id = "para-1062"><code>autoclean</code> -> <code>input.autoclean</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1061"><code>html_dir.css</code> -> <code>html.css</code> (not really renamed, <code>html_dir.css</code> isactually removed as there is no point in having different CSS for standalone and multifile HTML rendering, is it?)</p>
|
||||
<li><p id = "para-1063"><code>html_dir.css</code> -> <code>html.css</code> (not really renamed, <code>html_dir.css</code> isactually removed as there is no point in having different CSS for standalone and multifile HTML rendering, is it?)</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1062">New options:</p>
|
||||
<li><p id = "para-1064">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1063">More metadata: <code>license</code>, <code>version</code> and <code>date</code>. These metadata are not treated by the renderers, but they are exported to the templates: <code>{{{metadata}}}</code> allows to access the content. If they are present, a <code>has_metadata</code> is also set to true, allowing to do something like <code>{{{title}}} {{#has_version}}version {{{version}}} {{/has_version}}</code>.</p>
|
||||
<li><p id = "para-1065">More metadata: <code>license</code>, <code>version</code> and <code>date</code>. These metadata are not treated by the renderers, but they are exported to the templates: <code>{{{metadata}}}</code> allows to access the content. If they are present, a <code>has_metadata</code> is also set to true, allowing to do something like <code>{{{title}}} {{#has_version}}version {{{version}}} {{/has_version}}</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1064">Yet more metadata: it is possible to add custom metadata by prefixing it with <code>metadata.</code>. They will then be accessible in the templates, with dots ('.') replaced by underscores ('_'). E.g., with <code>metadata.foo: bar</code> you can access it in your templates with <code>{{{metadata_foo}}}</code>.</p>
|
||||
<li><p id = "para-1066">Yet more metadata: it is possible to add custom metadata by prefixing it with <code>metadata.</code>. They will then be accessible in the templates, with dots ('.') replaced by underscores ('_'). E.g., with <code>metadata.foo: bar</code> you can access it in your templates with <code>{{{metadata_foo}}}</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1065"><code>output.base_path</code> specifies a directory where the output files (set by <code>output.FORMAT</code> will be written.</p>
|
||||
<li><p id = "para-1067"><code>output.base_path</code> specifies a directory where the output files (set by <code>output.FORMAT</code> will be written.</p>
|
||||
</li>
|
||||
<li><p id = "para-1066"><code>resources.base_path.templates</code> specifies where templates can be found.</p>
|
||||
<li><p id = "para-1068"><code>resources.base_path.templates</code> specifies where templates can be found.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1067">Rendering:</p>
|
||||
<li><p id = "para-1069">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1068">Metadata can now contain Markdown and will be rendered by the renderers. This might not be a good idea for common fields (e.g. “title”), though. Use with caution.</p>
|
||||
<li><p id = "para-1070">Metadata can now contain Markdown and will be rendered by the renderers. This might not be a good idea for common fields (e.g. “title”), though. Use with caution.</p>
|
||||
</li>
|
||||
<li><p id = "para-1069"><code>rendering.inline_toc.name</code> can use <code>{{{loc_toc}}}</code> to specify a localized name.</p>
|
||||
<li><p id = "para-1071"><code>rendering.inline_toc.name</code> can use <code>{{{loc_toc}}}</code> to specify a localized name.</p>
|
||||
</li>
|
||||
<li><p id = "para-1070">HTML:</p>
|
||||
<li><p id = "para-1072">HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1071"><code>html.top</code> and <code>hstml.footer</code> are now considered as templates, so you can use some <code>{{{metadata}}}</code> in it.</p>
|
||||
<li><p id = "para-1073"><code>html.top</code> and <code>hstml.footer</code> are now considered as templates, so you can use some <code>{{{metadata}}}</code> in it.</p>
|
||||
</li>
|
||||
<li><p id = "para-1072">Improved the way footnotes are displayed.</p>
|
||||
<li><p id = "para-1074">Improved the way footnotes are displayed.</p>
|
||||
</li>
|
||||
<li><p id = "para-1073">In standalone HTML, footnotes are rendered at the end of the document instead of at the end of the chapter, unless <code>html_single.one_chapter</code> is true.</p>
|
||||
<li><p id = "para-1075">In standalone HTML, footnotes are rendered at the end of the document instead of at the end of the chapter, unless <code>html_single.one_chapter</code> is true.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1074">LaTeX:</p>
|
||||
<li><p id = "para-1076">LaTeX:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1075">If <code>tex.class</code> is set to <code>article</code>, chapters will be displayed as <code>\sections</code> since <code>article</code> class doesn’t handle chapters.</p>
|
||||
<li><p id = "para-1077">If <code>tex.class</code> is set to <code>article</code>, chapters will be displayed as <code>\sections</code> since <code>article</code> class doesn’t handle chapters.</p>
|
||||
</li>
|
||||
<li><p id = "para-1076">Except if <code>tex.class</code> is set to <code>book</code>, margins are now symmetrical.</p>
|
||||
<li><p id = "para-1078">Except if <code>tex.class</code> is set to <code>book</code>, margins are now symmetrical.</p>
|
||||
</li>
|
||||
<li><p id = "para-1077">LaTex template now uses <code>version</code> and <code>date</code>.</p>
|
||||
<li><p id = "para-1079">LaTex template now uses <code>version</code> and <code>date</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1078">Bugfixes:</p>
|
||||
<li><p id = "para-1080">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1079"><code>import_config</code> only import options from another book file that are not equal to the default ones and that haven’t already been set by the caller. E.g., <code>author: foo</code> then <code>import_config: bar.book</code> won’t erase the author previously set.</p>
|
||||
<li><p id = "para-1081"><code>import_config</code> only import options from another book file that are not equal to the default ones and that haven’t already been set by the caller. E.g., <code>author: foo</code> then <code>import_config: bar.book</code> won’t erase the author previously set.</p>
|
||||
</li>
|
||||
<li><p id = "para-1080"><code>import_config</code> now correctly translates the imported book’s paths.</p>
|
||||
<li><p id = "para-1082"><code>import_config</code> now correctly translates the imported book’s paths.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1081">Crowbook program:</p>
|
||||
<li><p id = "para-1083">Crowbook program:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1082">Still working to improve error messages.</p>
|
||||
<li><p id = "para-1084">Still working to improve error messages.</p>
|
||||
</li>
|
||||
<li><p id = "para-1083"><code>crowbook --list-options</code> uses colours. This might hurt your eyes.</p>
|
||||
<li><p id = "para-1085"><code>crowbook --list-options</code> uses colours. This might hurt your eyes.</p>
|
||||
</li>
|
||||
<li><p id = "para-1084">Display an error message when mustache can’t compile a template, instead of panicking.</p>
|
||||
<li><p id = "para-1086">Display an error message when mustache can’t compile a template, instead of panicking.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1085">Internal/API:</p>
|
||||
<li><p id = "para-1087">Internal/API:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1086">Added static methods to <code>Logger</code> to allows displaying messages more easily/prettily.</p>
|
||||
<li><p id = "para-1088">Added static methods to <code>Logger</code> to allows displaying messages more easily/prettily.</p>
|
||||
</li>
|
||||
<li><p id = "para-1087">Reduce pubic API’s surface so less changes will need to be considered breaking in the future.</p>
|
||||
<li><p id = "para-1089">Reduce pubic API’s surface so less changes will need to be considered breaking in the future.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-144">0.8.0 (2016-09-19)</h2>
|
||||
<p id = "para-1088">This release adds support for syntax higlighting in code blocks, customized top and footer blocks for HTML rendering, and the special <code>import_config</code> option that allows to import options from another book file. It also provides (hopefully) better error messages.</p>
|
||||
<p id = "para-1090">This release adds support for syntax higlighting in code blocks, customized top and footer blocks for HTML rendering, and the special <code>import_config</code> option that allows to import options from another book file. It also provides (hopefully) better error messages.</p>
|
||||
<ul>
|
||||
<li><p id = "para-1089">New options:</p>
|
||||
<li><p id = "para-1091">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1090"><code>import_config</code>is not really an option, but allows to import another configuration file, useful if you share a same set of options between multiple books.</p>
|
||||
<li><p id = "para-1092"><code>import_config</code>is not really an option, but allows to import another configuration file, useful if you share a same set of options between multiple books.</p>
|
||||
</li>
|
||||
<li><p id = "para-1091"><code>use_initials</code> (set to false by default) makes Crowbook use initials (“lettrines”) at start of each chapter. Support is still experimental.</p>
|
||||
<li><p id = "para-1093"><code>use_initials</code> (set to false by default) makes Crowbook use initials (“lettrines”) at start of each chapter. Support is still experimental.</p>
|
||||
</li>
|
||||
<li><p id = "para-1092"><code>html.highlight_code</code> (set to true by default) allows syntax highlighting for code blocks, using highlight.js.</p>
|
||||
<li><p id = "para-1094"><code>html.highlight_code</code> (set to true by default) allows syntax highlighting for code blocks, using highlight.js.</p>
|
||||
</li>
|
||||
<li><p id = "para-1093"><code>html.higlight.css</code> and <code>html.highlight.js</code> can be used to provide other themes (default is default.css) and an highlight.js build that support other languages.</p>
|
||||
<li><p id = "para-1095"><code>html.higlight.css</code> and <code>html.highlight.js</code> can be used to provide other themes (default is default.css) and an highlight.js build that support other languages.</p>
|
||||
</li>
|
||||
<li><p id = "para-1094"><code>html.footer</code> allows to specify custom footer. If not set, <code>html.crowbook_link</code> allows to disable “Generated by Crowbook” message.</p>
|
||||
<li><p id = "para-1096"><code>html.footer</code> allows to specify custom footer. If not set, <code>html.crowbook_link</code> allows to disable “Generated by Crowbook” message.</p>
|
||||
</li>
|
||||
<li><p id = "para-1095"><code>html.top</code> allows to specify a custom header that will be displayed at the top of HTML file(s).</p>
|
||||
<li><p id = "para-1097"><code>html.top</code> allows to specify a custom header that will be displayed at the top of HTML file(s).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1096">Deprecated options:</p>
|
||||
<li><p id = "para-1098">Deprecated options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1097"><code>side_notes</code> has been renamed <code>html.side_notes</code>.</p>
|
||||
<li><p id = "para-1099"><code>side_notes</code> has been renamed <code>html.side_notes</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1098">Crowbook program:</p>
|
||||
<li><p id = "para-1100">Crowbook program:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1099">All output formats are now rendered concurrently.</p>
|
||||
<li><p id = "para-1101">All output formats are now rendered concurrently.</p>
|
||||
</li>
|
||||
<li><p id = "para-1100">Better error messages. Crowbook now tries to give more information when displaying an error, with the file name where a problem was found, and, in some cases, the line. It also tries to detect errors (such as files not found) sooner.</p>
|
||||
<li><p id = "para-1102">Better error messages. Crowbook now tries to give more information when displaying an error, with the file name where a problem was found, and, in some cases, the line. It also tries to detect errors (such as files not found) sooner.</p>
|
||||
</li>
|
||||
<li><p id = "para-1101">Some “warning” messages have also been “moved” to error messages, to make sure they are displayed even when crowbook isn’t runned with <code>--verbose</code>.</p>
|
||||
<li><p id = "para-1103">Some “warning” messages have also been “moved” to error messages, to make sure they are displayed even when crowbook isn’t runned with <code>--verbose</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1102">Rendering:</p>
|
||||
<li><p id = "para-1104">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1103">Hidden chapter now produce empty <code>\chapter*{}</code> and <code><h1></code> in LaTeX and HTML. This allow to delimit a chapter break even if nothing is displayed.</p>
|
||||
<li><p id = "para-1105">Hidden chapter now produce empty <code>\chapter*{}</code> and <code><h1></code> in LaTeX and HTML. This allow to delimit a chapter break even if nothing is displayed.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1104">Bugfixes:</p>
|
||||
<li><p id = "para-1106">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1105">Navigation menu of standalone HTML didn’t include a call to javascript when <code>html.display_chapter</code> was set to true, meaning it didn’t display the chapter correctly.</p>
|
||||
<li><p id = "para-1107">Navigation menu of standalone HTML didn’t include a call to javascript when <code>html.display_chapter</code> was set to true, meaning it didn’t display the chapter correctly.</p>
|
||||
</li>
|
||||
<li><p id = "para-1106">Implementations of <code>Image</code> and <code>StandaloneImage</code> were reversed in LaTeX.</p>
|
||||
<li><p id = "para-1108">Implementations of <code>Image</code> and <code>StandaloneImage</code> were reversed in LaTeX.</p>
|
||||
</li>
|
||||
<li><p id = "para-1107"><code>StandaloneImage</code> urls were not adjusted (meanning that running <code>crowbook</code> from another directory failed).</p>
|
||||
<li><p id = "para-1109"><code>StandaloneImage</code> urls were not adjusted (meanning that running <code>crowbook</code> from another directory failed).</p>
|
||||
</li>
|
||||
<li><p id = "para-1108">Image paths are now found correctly in HtmlDir rendering even if <code>crowbook</code> is called from another directory (same fix as 0.6’s for Epub and LaTeX, which was forgotten for HtmlDir).</p>
|
||||
<li><p id = "para-1110">Image paths are now found correctly in HtmlDir rendering even if <code>crowbook</code> is called from another directory (same fix as 0.6’s for Epub and LaTeX, which was forgotten for HtmlDir).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1109">Internal/API:</p>
|
||||
<li><p id = "para-1111">Internal/API:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1110">In order to have better error messages, there was a need to refactor the <code>Error</code> type, and make more methods return <code>Result<X></code> instead of <code>X</code>. The API is, therefore, quite modified.</p>
|
||||
<li><p id = "para-1112">In order to have better error messages, there was a need to refactor the <code>Error</code> type, and make more methods return <code>Result<X></code> instead of <code>X</code>. The API is, therefore, quite modified.</p>
|
||||
</li>
|
||||
<li><p id = "para-1111">Added a <code>Renderer</code> trait used by the various renderers.</p>
|
||||
<li><p id = "para-1113">Added a <code>Renderer</code> trait used by the various renderers.</p>
|
||||
</li>
|
||||
<li><p id = "para-1112">Removed some methods from public API.</p>
|
||||
<li><p id = "para-1114">Removed some methods from public API.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-145">0.7.0 (2016-09-11)</h2>
|
||||
<p id = "para-1113">This releases renders images differently when they are on a standalone paragraph or inside a paragraph.</p>
|
||||
<p id = "para-1115">This releases renders images differently when they are on a standalone paragraph or inside a paragraph.</p>
|
||||
<ul>
|
||||
<li><p id = "para-1114">Internal/API:</p>
|
||||
<li><p id = "para-1116">Internal/API:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1115"><code>Token</code> has a new variant, <code>StandaloneImage</code>. This is used to distinguish an image that is alone in a paragraph of an image that is inlined alongside text.</p>
|
||||
<li><p id = "para-1117"><code>Token</code> has a new variant, <code>StandaloneImage</code>. This is used to distinguish an image that is alone in a paragraph of an image that is inlined alongside text.</p>
|
||||
</li>
|
||||
<li><p id = "para-1116"><code>Parser.parse</code> method now distingues between <code>Image</code> and <code>StandaloneImage</code>. Currently, an image is considered “standalone” if it is the sole element of a paragraph, even if it is among a link.</p>
|
||||
<li><p id = "para-1118"><code>Parser.parse</code> method now distingues between <code>Image</code> and <code>StandaloneImage</code>. Currently, an image is considered “standalone” if it is the sole element of a paragraph, even if it is among a link.</p>
|
||||
</li>
|
||||
<li><p id = "para-1117"><code>Token</code> has a new <code>is_image</code> method.</p>
|
||||
<li><p id = "para-1119"><code>Token</code> has a new <code>is_image</code> method.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1118">Rendering:</p>
|
||||
<li><p id = "para-1120">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1119">Standalone images are now rendered differently than inline images (80% of width VS original size) in HTML/EPUB and LaTeX.</p>
|
||||
<li><p id = "para-1121">Standalone images are now rendered differently than inline images (80% of width VS original size) in HTML/EPUB and LaTeX.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-146">0.6.0 (2016-09-09)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1120">Deprecated options:</p>
|
||||
<li><p id = "para-1122">Deprecated options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1121"><code>nb_char</code>: since it was only used for french cleaner and for typography reasons it’s better to use different non breaking spaces according to context, this option was not really useful anymore.</p>
|
||||
<li><p id = "para-1123"><code>nb_char</code>: since it was only used for french cleaner and for typography reasons it’s better to use different non breaking spaces according to context, this option was not really useful anymore.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1122">Rendering:</p>
|
||||
<li><p id = "para-1124">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1123">Images are now displayed at 80% width of the page.</p>
|
||||
<li><p id = "para-1125">Images are now displayed at 80% width of the page.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1124">Bugfixes:</p>
|
||||
<li><p id = "para-1126">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1125">Image paths are now found correctly in LaTeX and EPUB rendering even if <code>crowbook</code> is called from another directory.</p>
|
||||
<li><p id = "para-1127">Image paths are now found correctly in LaTeX and EPUB rendering even if <code>crowbook</code> is called from another directory.</p>
|
||||
</li>
|
||||
<li><p id = "para-1126">Fixed a bug in <code>French</code> cleaner when a string to clean ended by a non-breaking space (space was doubled with a breaking one).</p>
|
||||
<li><p id = "para-1128">Fixed a bug in <code>French</code> cleaner when a string to clean ended by a non-breaking space (space was doubled with a breaking one).</p>
|
||||
</li>
|
||||
<li><p id = "para-1127">LaTeX/PDF:</p>
|
||||
<li><p id = "para-1129">LaTeX/PDF:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1128">“Autocleaning” is now also activated (for french at least) for LaTeX rendering, since it doesn’t correctly insert non-breaking spaces for e.g. ‘«’ or ‘»’.</p>
|
||||
<li><p id = "para-1130">“Autocleaning” is now also activated (for french at least) for LaTeX rendering, since it doesn’t correctly insert non-breaking spaces for e.g. ‘«’ or ‘»’.</p>
|
||||
</li>
|
||||
<li><p id = "para-1129">Fixed escaping of <code>--</code> to <code>-{}-</code> to avoid tex ligatures.</p>
|
||||
<li><p id = "para-1131">Fixed escaping of <code>--</code> to <code>-{}-</code> to avoid tex ligatures.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1130">HTML/EPUB:</p>
|
||||
<li><p id = "para-1132">HTML/EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1131"><code>html.display_chapter</code> now defaults to <code>false</code> (e.g., by default the HTML displays the entirety of a book).</p>
|
||||
<li><p id = "para-1133"><code>html.display_chapter</code> now defaults to <code>false</code> (e.g., by default the HTML displays the entirety of a book).</p>
|
||||
</li>
|
||||
<li><p id = "para-1132">Fixed rendering of lists when <code>lang</code> is set to <code>fr</code>.</p>
|
||||
<li><p id = "para-1134">Fixed rendering of lists when <code>lang</code> is set to <code>fr</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1133">Links are now HTML-escaped, fixing errors in XHTML (for EPUB rendering) when links contained ‘&’ character.</p>
|
||||
<li><p id = "para-1135">Links are now HTML-escaped, fixing errors in XHTML (for EPUB rendering) when links contained ‘&’ character.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -3801,37 +3805,37 @@ resources.files</span><span style="color:#839496;">: [</span><span style="color:
|
|||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-147">0.5.1 (2016-04-14)</h2>
|
||||
<p id = "para-1134">Mostly rendering fixes:</p>
|
||||
<p id = "para-1136">Mostly rendering fixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1135">Epub:</p>
|
||||
<li><p id = "para-1137">Epub:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1136">Fix a validation problem when book contained hidden chapters.</p>
|
||||
<li><p id = "para-1138">Fix a validation problem when book contained hidden chapters.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1137">French cleaner:</p>
|
||||
<li><p id = "para-1139">French cleaner:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1138">Use semi-cadratine space instead of cadratine space for dialogs.</p>
|
||||
<li><p id = "para-1140">Use semi-cadratine space instead of cadratine space for dialogs.</p>
|
||||
</li>
|
||||
<li><p id = "para-1139">Use non-narrow non-breaking spapce instead of narrow one for ‘:’, ‘«’ and ‘»’ (following <a href = "https://fr.wikipedia.org/wiki/Espace_ins%C3%A9cable#En_France">https://fr.wikipedia.org/wiki/Espace_ins%C3%A9cable#En_France</a>).</p>
|
||||
<li><p id = "para-1141">Use non-narrow non-breaking spapce instead of narrow one for ‘:’, ‘«’ and ‘»’ (following <a href = "https://fr.wikipedia.org/wiki/Espace_ins%C3%A9cable#En_France">https://fr.wikipedia.org/wiki/Espace_ins%C3%A9cable#En_France</a>).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1140">HTML:</p>
|
||||
<li><p id = "para-1142">HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1141">Add viewport meta tags.</p>
|
||||
<li><p id = "para-1143">Add viewport meta tags.</p>
|
||||
</li>
|
||||
<li><p id = "para-1142">Standalone HTML:</p>
|
||||
<li><p id = "para-1144">Standalone HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1143">Don’t display the button to display chapter and the previous/next chapter link if <code>html.display_chapter</code> is set to <code>false</code>.</p>
|
||||
<li><p id = "para-1145">Don’t display the button to display chapter and the previous/next chapter link if <code>html.display_chapter</code> is set to <code>false</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1144">Fix chapter displaying when some chapters are not numbered.</p>
|
||||
<li><p id = "para-1146">Fix chapter displaying when some chapters are not numbered.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1145">Multi-files HTML:</p>
|
||||
<li><p id = "para-1147">Multi-files HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1146">Fix previous/next chapter display to make it consistent with standalone HTML.</p>
|
||||
<li><p id = "para-1148">Fix previous/next chapter display to make it consistent with standalone HTML.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -3840,232 +3844,232 @@ resources.files</span><span style="color:#839496;">: [</span><span style="color:
|
|||
</ul>
|
||||
<h2 id = "link-148">0.5.0 (2016-04-02)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1147">Crowbook now requires Rustc 1.7.0.</p>
|
||||
<li><p id = "para-1149">Crowbook now requires Rustc 1.7.0.</p>
|
||||
</li>
|
||||
<li><p id = "para-1148">It is now possible to render HTML in multiple files:</p>
|
||||
<li><p id = "para-1150">It is now possible to render HTML in multiple files:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1149"><code>output.html_dir</code> will activate this renderer, and specify in which directory to render these files;</p>
|
||||
<li><p id = "para-1151"><code>output.html_dir</code> will activate this renderer, and specify in which directory to render these files;</p>
|
||||
</li>
|
||||
<li><p id = "para-1150"><code>html_dir.css</code> allows to override the CSS for this rendering;</p>
|
||||
<li><p id = "para-1152"><code>html_dir.css</code> allows to override the CSS for this rendering;</p>
|
||||
</li>
|
||||
<li><p id = "para-1151"><code>html_dir.index.html</code> allows to specify a template for the <code>index.html</code> page;</p>
|
||||
<li><p id = "para-1153"><code>html_dir.index.html</code> allows to specify a template for the <code>index.html</code> page;</p>
|
||||
</li>
|
||||
<li><p id = "para-1152"><code>html_dir.chapter.html</code> allows to specify a template for the chapters pages.</p>
|
||||
<li><p id = "para-1154"><code>html_dir.chapter.html</code> allows to specify a template for the chapters pages.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1153">New book options:</p>
|
||||
<li><p id = "para-1155">New book options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1154"><code>tex.short</code>: if set to true, the LaTeX renderer will use <code>article</code> instead of <code>book</code> as document class, and will use the default <code>\maketitle</code> command for article. This option is by default set to false, except when Crowbook is called with <code>--single</code>.</p>
|
||||
<li><p id = "para-1156"><code>tex.short</code>: if set to true, the LaTeX renderer will use <code>article</code> instead of <code>book</code> as document class, and will use the default <code>\maketitle</code> command for article. This option is by default set to false, except when Crowbook is called with <code>--single</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1155"><code>enable_yaml_blocks</code>: parsing YAML blocks is no longer activated by default, except when using <code>--single</code>. This is because you might want to have e.g. multiple short stories using YAML blocks to set their titles and so on, <em>and</em> a separate <code>.book</code> file to render a book as a collection of short stories. In this case, you wouldn’t want the displayed title or the output.pdf/html/epub files be redefined by the short stories .md files.</p>
|
||||
<li><p id = "para-1157"><code>enable_yaml_blocks</code>: parsing YAML blocks is no longer activated by default, except when using <code>--single</code>. This is because you might want to have e.g. multiple short stories using YAML blocks to set their titles and so on, <em>and</em> a separate <code>.book</code> file to render a book as a collection of short stories. In this case, you wouldn’t want the displayed title or the output.pdf/html/epub files be redefined by the short stories .md files.</p>
|
||||
</li>
|
||||
<li><p id = "para-1156"><code>html.print_css</code>: allows to specify a stylesheet for media print</p>
|
||||
<li><p id = "para-1158"><code>html.print_css</code>: allows to specify a stylesheet for media print</p>
|
||||
</li>
|
||||
<li><p id = "para-1157"><code>html.display_chapter</code>: displays one chapter at a time in standalone HTML</p>
|
||||
<li><p id = "para-1159"><code>html.display_chapter</code>: displays one chapter at a time in standalone HTML</p>
|
||||
</li>
|
||||
<li><p id = "para-1158"><code>html.script</code>: allows to specify a custom javascript file for standalone HTML</p>
|
||||
<li><p id = "para-1160"><code>html.script</code>: allows to specify a custom javascript file for standalone HTML</p>
|
||||
</li>
|
||||
<li><p id = "para-1159"><code>html_dir.script</code>: same thing for multipage HTML</p>
|
||||
<li><p id = "para-1161"><code>html_dir.script</code>: same thing for multipage HTML</p>
|
||||
</li>
|
||||
<li><p id = "para-1160"><code>resources.base_path</code>: by default, Crowbook resolves local links in markdown files relatively to the markdown file. This option allows to resolve them relatively to a base path. This option comes with two variants, <code>resources.base_path.images</code> and <code>resources.base_path.links</code>, which only activate it for respectively images tags and links tags. These two options are ignored when <code>base_path</code> is set. There is also <code>resources.base_path.files</code> which specify where additional files (see below) should be read, but this is one is set to <code>.</code> (i.e., the directory where the <code>.book</code> file is) by default.</p>
|
||||
<li><p id = "para-1162"><code>resources.base_path</code>: by default, Crowbook resolves local links in markdown files relatively to the markdown file. This option allows to resolve them relatively to a base path. This option comes with two variants, <code>resources.base_path.images</code> and <code>resources.base_path.links</code>, which only activate it for respectively images tags and links tags. These two options are ignored when <code>base_path</code> is set. There is also <code>resources.base_path.files</code> which specify where additional files (see below) should be read, but this is one is set to <code>.</code> (i.e., the directory where the <code>.book</code> file is) by default.</p>
|
||||
</li>
|
||||
<li><p id = "para-1161"><code>resources.files</code>: indicate a (whitespace-separated) list of files that should be embedded. Currently only used with the EPUB renderer.</p>
|
||||
<li><p id = "para-1163"><code>resources.files</code>: indicate a (whitespace-separated) list of files that should be embedded. Currently only used with the EPUB renderer.</p>
|
||||
</li>
|
||||
<li><p id = "para-1162"><code>resources.out_path</code>: indicate where <code>resources.files</code> should be copied in the final document. Default to <code>data</code>, meaning that files will be placed in a <code>data</code> directory in the EPUB.</p>
|
||||
<li><p id = "para-1164"><code>resources.out_path</code>: indicate where <code>resources.files</code> should be copied in the final document. Default to <code>data</code>, meaning that files will be placed in a <code>data</code> directory in the EPUB.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1163">Rendering:</p>
|
||||
<li><p id = "para-1165">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1164">Templates can now use localized strings according to the <code>lang</code> option</p>
|
||||
<li><p id = "para-1166">Templates can now use localized strings according to the <code>lang</code> option</p>
|
||||
</li>
|
||||
<li><p id = "para-1165">Standalone HTML now includes locale files using base64.</p>
|
||||
<li><p id = "para-1167">Standalone HTML now includes locale files using base64.</p>
|
||||
</li>
|
||||
<li><p id = "para-1166">Standalone HTML displays one chapter at a time, thouht it can be changed via a button in the menu.</p>
|
||||
<li><p id = "para-1168">Standalone HTML displays one chapter at a time, thouht it can be changed via a button in the menu.</p>
|
||||
</li>
|
||||
<li><p id = "para-1167">HTML/EPUB: default CSS now uses the <code>lang</code> value do determine how to display lists (currently the only difference is it uses “–” when <code>lang</code> is set to “fr” and standard bullets for other languages).</p>
|
||||
<li><p id = "para-1169">HTML/EPUB: default CSS now uses the <code>lang</code> value do determine how to display lists (currently the only difference is it uses “–” when <code>lang</code> is set to “fr” and standard bullets for other languages).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1168">Bugfixes:</p>
|
||||
<li><p id = "para-1170">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1169">Fixed a bug of filename “resolution” when Crowbook was called with <code>--single</code> (e.g., <code>crowbook -s tests/test.md</code> would previously try to load `tests/tests/test.md).</p>
|
||||
<li><p id = "para-1171">Fixed a bug of filename “resolution” when Crowbook was called with <code>--single</code> (e.g., <code>crowbook -s tests/test.md</code> would previously try to load `tests/tests/test.md).</p>
|
||||
</li>
|
||||
<li><p id = "para-1170">Epub renderer now uses the <code>mime_guess</code> library to guess the mime type based on extension, which should fix the mime type guessed for a wide range of extensions (e.g., svg).</p>
|
||||
<li><p id = "para-1172">Epub renderer now uses the <code>mime_guess</code> library to guess the mime type based on extension, which should fix the mime type guessed for a wide range of extensions (e.g., svg).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1171">Internal/API:</p>
|
||||
<li><p id = "para-1173">Internal/API:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1172">The <code>Book::new</code>, <code>new_from_file</code>, and <code>new_from_markdown_file</code> take an additional <code>options</code> parameter. To create a book with default options, set it to <code>&[]</code>.</p>
|
||||
<li><p id = "para-1174">The <code>Book::new</code>, <code>new_from_file</code>, and <code>new_from_markdown_file</code> take an additional <code>options</code> parameter. To create a book with default options, set it to <code>&[]</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-149">0.4.0 (2016-03-01)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1173">Crowbook now internally uses a true YAML parser, <code>yaml_rust</code>, for its options. Since the “old” Crowbooks’s config format was similar, but had some subtle differences, this is somewhat of a breaking change:</p>
|
||||
<li><p id = "para-1175">Crowbook now internally uses a true YAML parser, <code>yaml_rust</code>, for its options. Since the “old” Crowbooks’s config format was similar, but had some subtle differences, this is somewhat of a breaking change:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1174">strings should now be escaped with “” in some cases (e.g. if it contains special characters). On the other hand, it <em>allows</em> to optionally escape a string with these quotes, which wasn’t possible until then and might be useful in some cases.</p>
|
||||
<li><p id = "para-1176">strings should now be escaped with “” in some cases (e.g. if it contains special characters). On the other hand, it <em>allows</em> to optionally escape a string with these quotes, which wasn’t possible until then and might be useful in some cases.</p>
|
||||
</li>
|
||||
<li><p id = "para-1175">multiline strings now follow the YAML format, instead of the previous “YAML-ish” format. This can impact the way newlines are added at the end of a multiline string. See e.g. <a href = "http://stackoverflow.com/questions/3790454/in-yaml-how-do-i-break-a-string-over-multiple-lines">this link</a> for the various ways to include mulitiline strings in Yaml.</p>
|
||||
<li><p id = "para-1177">multiline strings now follow the YAML format, instead of the previous “YAML-ish” format. This can impact the way newlines are added at the end of a multiline string. See e.g. <a href = "http://stackoverflow.com/questions/3790454/in-yaml-how-do-i-break-a-string-over-multiple-lines">this link</a> for the various ways to include mulitiline strings in Yaml.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1176">Crowbook now parses YAML blocks (delimited by two lines with “---”) in Markdown files, ignoring keys that it doesn’t recognize. This allows crowbook to be compatible(-ish) with Markdown that contains YAML blocks for Jekyll or Pandoc.</p>
|
||||
<li><p id = "para-1178">Crowbook now parses YAML blocks (delimited by two lines with “---”) in Markdown files, ignoring keys that it doesn’t recognize. This allows crowbook to be compatible(-ish) with Markdown that contains YAML blocks for Jekyll or Pandoc.</p>
|
||||
</li>
|
||||
<li><p id = "para-1177">New option <code>--single</code> allows to give Crowbook a single Markdown file (which can contain options within an inline YAML block) instead of a book configuration file. This is useful for e.g. short stories.</p>
|
||||
<li><p id = "para-1179">New option <code>--single</code> allows to give Crowbook a single Markdown file (which can contain options within an inline YAML block) instead of a book configuration file. This is useful for e.g. short stories.</p>
|
||||
</li>
|
||||
<li><p id = "para-1178">Enhanced the way debugging/warning/info messages are handled and displayed:</p>
|
||||
<li><p id = "para-1180">Enhanced the way debugging/warning/info messages are handled and displayed:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1179">Added a <code>--debug</code> option to the binary.</p>
|
||||
<li><p id = "para-1181">Added a <code>--debug</code> option to the binary.</p>
|
||||
</li>
|
||||
<li><p id = "para-1180">Internal: added a <code>Logger</code> struct.</p>
|
||||
<li><p id = "para-1182">Internal: added a <code>Logger</code> struct.</p>
|
||||
</li>
|
||||
<li><p id = "para-1181">Different levels of information (debug/warning/info/error) get different colours.</p>
|
||||
<li><p id = "para-1183">Different levels of information (debug/warning/info/error) get different colours.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1182">Bugfixes:</p>
|
||||
<li><p id = "para-1184">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1183">Crowbook no longer crashes when called with the <code>--to</code> argument if it can’t create a file.</p>
|
||||
<li><p id = "para-1185">Crowbook no longer crashes when called with the <code>--to</code> argument if it can’t create a file.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-150">0.3.0 (2016-02-27)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1184">Crowbook now tries to convert local links. That is, if you link to a Markdown file that is used in the book. (e.g. <a href = "#chapter-0">README.md</a>), it <em>should</em> link to an appropriate inner reference inside the book.</p>
|
||||
<li><p id = "para-1186">Crowbook now tries to convert local links. That is, if you link to a Markdown file that is used in the book. (e.g. <a href = "#chapter-0">README.md</a>), it <em>should</em> link to an appropriate inner reference inside the book.</p>
|
||||
</li>
|
||||
<li><p id = "para-1185">Latex renderer now supports (local) images.</p>
|
||||
<li><p id = "para-1187">Latex renderer now supports (local) images.</p>
|
||||
</li>
|
||||
<li><p id = "para-1186">Epub renderer now embed (local) images in the EPUB file.</p>
|
||||
<li><p id = "para-1188">Epub renderer now embed (local) images in the EPUB file.</p>
|
||||
</li>
|
||||
<li><p id = "para-1187">Some changes to the HTML/Epub stylesheets.</p>
|
||||
<li><p id = "para-1189">Some changes to the HTML/Epub stylesheets.</p>
|
||||
</li>
|
||||
<li><p id = "para-1188">Internal (or usage as a library):</p>
|
||||
<li><p id = "para-1190">Internal (or usage as a library):</p>
|
||||
<ul>
|
||||
<li><p id = "para-1189">Crowbook no longer changes current directory, which worked in the binary but could cause problem if library was used in multithreaded environment (e.g. in <code>cargo test</code>).</p>
|
||||
<li><p id = "para-1191">Crowbook no longer changes current directory, which worked in the binary but could cause problem if library was used in multithreaded environment (e.g. in <code>cargo test</code>).</p>
|
||||
</li>
|
||||
<li><p id = "para-1190">More modules and methods are now private.</p>
|
||||
<li><p id = "para-1192">More modules and methods are now private.</p>
|
||||
</li>
|
||||
<li><p id = "para-1191">Improved documentation.</p>
|
||||
<li><p id = "para-1193">Improved documentation.</p>
|
||||
</li>
|
||||
<li><p id = "para-1192">Added more unit tests.</p>
|
||||
<li><p id = "para-1194">Added more unit tests.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1193">Bugfixes:</p>
|
||||
<li><p id = "para-1195">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1194">Epub renderer now correctly renders unnumbered chapter without a number in its toc.ncx file</p>
|
||||
<li><p id = "para-1196">Epub renderer now correctly renders unnumbered chapter without a number in its toc.ncx file</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-151">0.2.2 (2016-02-25)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1195">Bugfixes:</p>
|
||||
<li><p id = "para-1197">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1196">French cleaner now correctly replaces space after — (in e.g. dialogs) with “em space”.</p>
|
||||
<li><p id = "para-1198">French cleaner now correctly replaces space after — (in e.g. dialogs) with “em space”.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-152">0.2.1 (2016-02-25)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1197">Bugfixes:</p>
|
||||
<li><p id = "para-1199">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1198">HTML/Epub rendering no longer incorrectly increment chapter count for unnumbered chapters.</p>
|
||||
<li><p id = "para-1200">HTML/Epub rendering no longer incorrectly increment chapter count for unnumbered chapters.</p>
|
||||
</li>
|
||||
<li><p id = "para-1199">Latex: makes what is possible to avoid orverflowing the page.</p>
|
||||
<li><p id = "para-1201">Latex: makes what is possible to avoid orverflowing the page.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1200">Minor changes:</p>
|
||||
<li><p id = "para-1202">Minor changes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1201">Latex: improvement of the default way URLs are displayed.</p>
|
||||
<li><p id = "para-1203">Latex: improvement of the default way URLs are displayed.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-153">0.2.0 (2016-02-25)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1202">Command line arguments:</p>
|
||||
<li><p id = "para-1204">Command line arguments:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1203">New argument <code>--print-template</code> now allows to print a built-in template to stdout.</p>
|
||||
<li><p id = "para-1205">New argument <code>--print-template</code> now allows to print a built-in template to stdout.</p>
|
||||
</li>
|
||||
<li><p id = "para-1204">New argument <code>--list-options</code> prints out all valid options in a config file (or in <code>set</code>), their type and default value.</p>
|
||||
<li><p id = "para-1206">New argument <code>--list-options</code> prints out all valid options in a config file (or in <code>set</code>), their type and default value.</p>
|
||||
</li>
|
||||
<li><p id = "para-1205">New argument <code>--set</code> allows to define or override whatever option set in a book configuration.</p>
|
||||
<li><p id = "para-1207">New argument <code>--set</code> allows to define or override whatever option set in a book configuration.</p>
|
||||
</li>
|
||||
<li><p id = "para-1206"><code>--create</code> can now be used without specifying a <code>BOOK</code>, printing its result on <code>stdout</code>.</p>
|
||||
<li><p id = "para-1208"><code>--create</code> can now be used without specifying a <code>BOOK</code>, printing its result on <code>stdout</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1207">Configuration file:</p>
|
||||
<li><p id = "para-1209">Configuration file:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1208">Added support for multiline strings in <code>.book</code> files, with either ‘|’ (preserving line returns) or ‘>’ (transforming line returns in spaces)</p>
|
||||
<li><p id = "para-1210">Added support for multiline strings in <code>.book</code> files, with either ‘|’ (preserving line returns) or ‘>’ (transforming line returns in spaces)</p>
|
||||
</li>
|
||||
<li><p id = "para-1209">New option <code>display_toc</code> allows to display the table of contents (whose name, at least for HTML, is specified by <code>toc_name</code>) in HTML and PDF documents.</p>
|
||||
<li><p id = "para-1211">New option <code>display_toc</code> allows to display the table of contents (whose name, at least for HTML, is specified by <code>toc_name</code>) in HTML and PDF documents.</p>
|
||||
</li>
|
||||
<li><p id = "para-1210">Option <code>numbering</code> now takes an int instead of a boolean, allowing to specify the maximum level to number (e.g. <code>1</code>: chapters only, <code>2</code>: chapters and sectino, ..., <code>6</code>: everything).</p>
|
||||
<li><p id = "para-1212">Option <code>numbering</code> now takes an int instead of a boolean, allowing to specify the maximum level to number (e.g. <code>1</code>: chapters only, <code>2</code>: chapters and sectino, ..., <code>6</code>: everything).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1211">Rendering:</p>
|
||||
<li><p id = "para-1213">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1212">Added support for numbering all headers, not just level-1 (e.g., having a subsection numbered <code>2.3.1</code>).</p>
|
||||
<li><p id = "para-1214">Added support for numbering all headers, not just level-1 (e.g., having a subsection numbered <code>2.3.1</code>).</p>
|
||||
</li>
|
||||
<li><p id = "para-1213">Tables and Footnotes are now implemented for HTML/Epub and LaTeX output.</p>
|
||||
<li><p id = "para-1215">Tables and Footnotes are now implemented for HTML/Epub and LaTeX output.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1214">Internal:</p>
|
||||
<li><p id = "para-1216">Internal:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1215">Refactored <code>Book</code> to use an HashMap of <code>BookOption</code>s instead of having like 42 fields.</p>
|
||||
<li><p id = "para-1217">Refactored <code>Book</code> to use an HashMap of <code>BookOption</code>s instead of having like 42 fields.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-154">0.1.0 (2016-02-21)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1216">initial release</p>
|
||||
<li><p id = "para-1218">initial release</p>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div><div id = "chapter-10" class = "chapter">
|
||||
<h1 id = 'link-155'>GNU LESSER GENERAL PUBLIC LICENSE</h1><pre><span style="color:#839496;"> Version 2.1, February 1999
|
||||
</span></pre><p id = "para-1217">Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.</p>
|
||||
<p id = "para-1218">[This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.]</p>
|
||||
</span></pre><p id = "para-1219">Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.</p>
|
||||
<p id = "para-1220">[This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.]</p>
|
||||
<pre><span style="color:#839496;"> Preamble
|
||||
</span></pre><p id = "para-1219">The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users.</p>
|
||||
<p id = "para-1220">This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below.</p>
|
||||
<p id = "para-1221">When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things.</p>
|
||||
<p id = "para-1222">To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it.</p>
|
||||
<p id = "para-1223">For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights.</p>
|
||||
<p id = "para-1224">We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library.</p>
|
||||
<p id = "para-1225">To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author’s reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license.</p>
|
||||
<p id = "para-1226">Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs.</p>
|
||||
<p id = "para-1227">When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library.</p>
|
||||
<p id = "para-1228">We call this license the “Lesser” General Public License because it does Less to protect the user’s freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances.</p>
|
||||
<p id = "para-1229">For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License.</p>
|
||||
<p id = "para-1230">In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system.</p>
|
||||
<p id = "para-1231">Although the Lesser General Public License is Less protective of the users’ freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library.</p>
|
||||
<p id = "para-1232">The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a “work based on the library” and a “work that uses the library”. The former contains code derived from the library, whereas the latter must be combined with the library in order to run. GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</p>
|
||||
</span></pre><p id = "para-1221">The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users.</p>
|
||||
<p id = "para-1222">This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below.</p>
|
||||
<p id = "para-1223">When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things.</p>
|
||||
<p id = "para-1224">To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it.</p>
|
||||
<p id = "para-1225">For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights.</p>
|
||||
<p id = "para-1226">We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library.</p>
|
||||
<p id = "para-1227">To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author’s reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license.</p>
|
||||
<p id = "para-1228">Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs.</p>
|
||||
<p id = "para-1229">When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library.</p>
|
||||
<p id = "para-1230">We call this license the “Lesser” General Public License because it does Less to protect the user’s freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances.</p>
|
||||
<p id = "para-1231">For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License.</p>
|
||||
<p id = "para-1232">In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system.</p>
|
||||
<p id = "para-1233">Although the Lesser General Public License is Less protective of the users’ freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library.</p>
|
||||
<p id = "para-1234">The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a “work based on the library” and a “work that uses the library”. The former contains code derived from the library, whereas the latter must be combined with the library in order to run. GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</p>
|
||||
<ol start = "0">
|
||||
<li><p id = "para-1233">This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called “this License”). Each licensee is addressed as “you”.</p>
|
||||
<li><p id = "para-1235">This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called “this License”). Each licensee is addressed as “you”.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1234">A “library” means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables.</p>
|
||||
<p id = "para-1235">The “Library”, below, refers to any such software library or work which has been distributed under these terms. A “work based on the Library” means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term “modification”.)</p>
|
||||
<p id = "para-1236">“Source code” for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library.</p>
|
||||
<p id = "para-1237">Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does.</p>
|
||||
<p id = "para-1236">A “library” means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables.</p>
|
||||
<p id = "para-1237">The “Library”, below, refers to any such software library or work which has been distributed under these terms. A “work based on the Library” means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term “modification”.)</p>
|
||||
<p id = "para-1238">“Source code” for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library.</p>
|
||||
<p id = "para-1239">Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does.</p>
|
||||
<ol>
|
||||
<li><p id = "para-1238">You may copy and distribute verbatim copies of the Library’s complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library.</p>
|
||||
<li><p id = "para-1240">You may copy and distribute verbatim copies of the Library’s complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1239">You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:</p>
|
||||
<p id = "para-1241">You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:</p>
|
||||
<pre><span style="color:#839496;">a) The modified work must itself be a software library.
|
||||
|
||||
b) You must cause the files modified to carry prominent notices
|
||||
|
|
@ -4088,28 +4092,28 @@ application. Therefore, Subsection 2d requires that any
|
|||
application-supplied function or table used by this function must
|
||||
be optional: if the application does not supply it, the square
|
||||
root function must still compute square roots.)
|
||||
</span></pre><p id = "para-1240">These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.</p>
|
||||
<p id = "para-1241">Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library.</p>
|
||||
<p id = "para-1242">In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.</p>
|
||||
</span></pre><p id = "para-1242">These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.</p>
|
||||
<p id = "para-1243">Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library.</p>
|
||||
<p id = "para-1244">In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.</p>
|
||||
<ol start = "3">
|
||||
<li><p id = "para-1243">You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy.</p>
|
||||
<li><p id = "para-1245">You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1244">This option is useful when you wish to copy part of the code of the Library into a program that is not a library.</p>
|
||||
<p id = "para-1246">This option is useful when you wish to copy part of the code of the Library into a program that is not a library.</p>
|
||||
<ol start = "4">
|
||||
<li><p id = "para-1245">You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange.</p>
|
||||
<li><p id = "para-1247">You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1246">If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code.</p>
|
||||
<p id = "para-1248">If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code.</p>
|
||||
<ol start = "5">
|
||||
<li><p id = "para-1247">A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a “work that uses the Library”. Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License.</p>
|
||||
<li><p id = "para-1249">A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a “work that uses the Library”. Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1248">However, linking a “work that uses the Library” with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a “work that uses the library”. The executable is therefore covered by this License. Section 6 states terms for distribution of such executables.</p>
|
||||
<p id = "para-1249">When a “work that uses the Library” uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law.</p>
|
||||
<p id = "para-1250">If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.)</p>
|
||||
<p id = "para-1251">Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a “work that uses the Library” with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer’s own use and reverse engineering for debugging such modifications.</p>
|
||||
<p id = "para-1252">You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things:</p>
|
||||
<p id = "para-1250">However, linking a “work that uses the Library” with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a “work that uses the library”. The executable is therefore covered by this License. Section 6 states terms for distribution of such executables.</p>
|
||||
<p id = "para-1251">When a “work that uses the Library” uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law.</p>
|
||||
<p id = "para-1252">If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.)</p>
|
||||
<p id = "para-1253">Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a “work that uses the Library” with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer’s own use and reverse engineering for debugging such modifications.</p>
|
||||
<p id = "para-1254">You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things:</p>
|
||||
<pre><span style="color:#839496;">a) Accompany the work with the complete corresponding
|
||||
machine-readable source code for the Library including whatever
|
||||
changes were used in the work (which must be distributed under
|
||||
|
|
@ -4141,8 +4145,8 @@ specified materials from the same place.
|
|||
|
||||
e) Verify that the user has already received a copy of these
|
||||
materials or that you have already sent this user a copy.
|
||||
</span></pre><p id = "para-1253">For an executable, the required form of the “work that uses the Library” must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.</p>
|
||||
<p id = "para-1254">It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things:</p>
|
||||
</span></pre><p id = "para-1255">For an executable, the required form of the “work that uses the Library” must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.</p>
|
||||
<p id = "para-1256">It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things:</p>
|
||||
<pre><span style="color:#839496;">a) Accompany the combined library with a copy of the same work
|
||||
based on the Library, uncombined with any other library
|
||||
facilities. This must be distributed under the terms of the
|
||||
|
|
@ -4152,36 +4156,36 @@ b) Give prominent notice with the combined library of the fact
|
|||
that part of it is a work based on the Library, and explaining
|
||||
where to find the accompanying uncombined form of the same work.
|
||||
</span></pre><ol start = "8">
|
||||
<li><p id = "para-1255">You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.</p>
|
||||
<li><p id = "para-1257">You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.</p>
|
||||
</li>
|
||||
<li><p id = "para-1256">You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it.</p>
|
||||
<li><p id = "para-1258">You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it.</p>
|
||||
</li>
|
||||
<li><p id = "para-1257">Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients’ exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. </p>
|
||||
<li><p id = "para-1259">Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients’ exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. </p>
|
||||
</li>
|
||||
<li><p id = "para-1258">If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library.</p>
|
||||
<li><p id = "para-1260">If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1259">If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances.</p>
|
||||
<p id = "para-1260">It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.</p>
|
||||
<p id = "para-1261">This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.</p>
|
||||
<p id = "para-1261">If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances.</p>
|
||||
<p id = "para-1262">It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.</p>
|
||||
<p id = "para-1263">This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.</p>
|
||||
<ol start = "12">
|
||||
<li><p id = "para-1262">If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.</p>
|
||||
<li><p id = "para-1264">If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.</p>
|
||||
</li>
|
||||
<li><p id = "para-1263">The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.</p>
|
||||
<li><p id = "para-1265">The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1264">Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and “any later version”, you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.</p>
|
||||
<p id = "para-1266">Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and “any later version”, you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.</p>
|
||||
<pre><span style="color:#839496;"> NO WARRANTY
|
||||
</span></pre><ol start = "15">
|
||||
<li><p id = "para-1265">BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p>
|
||||
<li><p id = "para-1267">BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p>
|
||||
</li>
|
||||
<li><p id = "para-1266">IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</p>
|
||||
<li><p id = "para-1268">IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</p>
|
||||
<pre><span style="color:#839496;"> END OF TERMS AND CONDITIONS
|
||||
</span></pre></li>
|
||||
</ol>
|
||||
<p id = "para-1267"> How to Apply These Terms to Your New Libraries</p>
|
||||
<p id = "para-1268">If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License).</p>
|
||||
<p id = "para-1269">To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.</p>
|
||||
<p id = "para-1269"> How to Apply These Terms to Your New Libraries</p>
|
||||
<p id = "para-1270">If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License).</p>
|
||||
<p id = "para-1271">To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.</p>
|
||||
<pre><span style="color:#839496;"><one line to give the library's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
|
|
@ -4198,16 +4202,16 @@ Lesser General Public License for more details.
|
|||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
</span></pre><p id = "para-1270">Also add information on how to contact you by electronic and paper mail.</p>
|
||||
<p id = "para-1271">You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the library, if necessary. Here is a sample; alter the names:</p>
|
||||
<p id = "para-1272">Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob’ (a library for tweaking knobs) written by James Random Hacker.</p>
|
||||
<p id = "para-1273"><signature of Ty Coon>, 1 April 1990 Ty Coon, President of Vice</p>
|
||||
<p id = "para-1274">That’s all there is to it!</p>
|
||||
</span></pre><p id = "para-1272">Also add information on how to contact you by electronic and paper mail.</p>
|
||||
<p id = "para-1273">You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the library, if necessary. Here is a sample; alter the names:</p>
|
||||
<p id = "para-1274">Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob’ (a library for tweaking knobs) written by James Random Hacker.</p>
|
||||
<p id = "para-1275"><signature of Ty Coon>, 1 April 1990 Ty Coon, President of Vice</p>
|
||||
<p id = "para-1276">That’s all there is to it!</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1275">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1277">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
Binary file not shown.
Binary file not shown.
|
|
@ -204,7 +204,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1276">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1278">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -327,7 +327,7 @@ title</span><span style="color:#839496;">: </span><span style="color:#2aa198;">M
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1275">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1277">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1278">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1280">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -339,7 +339,7 @@ Cheers, *Joan*
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1277">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1279">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1280">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1282">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -1680,7 +1680,7 @@ output.epub</span><span style="color:#839496;">: </span><span style="color:#2aa1
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1279">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1281">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1282">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1284">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -290,7 +290,7 @@ This is NOT part of the foonote.
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1281">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1283">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1284">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1286">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -456,7 +456,7 @@ Foo does not exist
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1283">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1285">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1286">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1288">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -296,7 +296,7 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1285">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1287">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1288">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1290">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -286,7 +286,7 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1287">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1289">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1290">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1292">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -260,7 +260,7 @@ resources.files</span><span style="color:#839496;">: [</span><span style="color:
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1289">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1291">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1292">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1294">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -236,7 +236,7 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1291">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1293">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1294">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1296">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -226,512 +226,516 @@ function toggle() {
|
|||
</li>
|
||||
<li><p id = "para-800">Strikethrough</p>
|
||||
</li>
|
||||
<li><p id = "para-801">Task items</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-801">New option:</p>
|
||||
<li><p id = "para-802">New option:</p>
|
||||
<ul>
|
||||
<li><p id = "para-802"><code>crowbook.files_mean_chapters</code> allow to enforce that each files means a chapter break or to make sure that it doesn’t (by default, only true for numbered chapters).</p>
|
||||
<li><p id = "para-803"><code>crowbook.files_mean_chapters</code> allow to enforce that each files means a chapter break or to make sure that it doesn’t (by default, only true for numbered chapters).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-803">By default, don’t add an empty chapter title for non numbered “chapters” that don’t contain a title.</p>
|
||||
<li><p id = "para-804">Fallback on Rust zip library when there is no <code>zip</code> command.</p>
|
||||
</li>
|
||||
<li><p id = "para-804">Now uses <code>reqwest</code> instead of <code>hyper</code> to connect to languagetool/grammalecte.</p>
|
||||
<li><p id = "para-805">By default, don’t add an empty chapter title for non numbered “chapters” that don’t contain a title.</p>
|
||||
</li>
|
||||
<li><p id = "para-805"><code>hyphenation</code> dependency is now optional.</p>
|
||||
<li><p id = "para-806">Now uses <code>reqwest</code> instead of <code>hyper</code> to connect to languagetool/grammalecte.</p>
|
||||
</li>
|
||||
<li><p id = "para-806">Dependencies update.</p>
|
||||
<li><p id = "para-807"><code>hyphenation</code> dependency is now optional.</p>
|
||||
</li>
|
||||
<li><p id = "para-808">Dependencies update.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-127">0.14.1 (2018-06-01)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-807"><code>--stats</code> can now display more statistics when used with the <code>--verbose</code> option (if support for advanced statistics is compiled)</p>
|
||||
<li><p id = "para-809"><code>--stats</code> can now display more statistics when used with the <code>--verbose</code> option (if support for advanced statistics is compiled)</p>
|
||||
</li>
|
||||
<li><p id = "para-808">LaTeX outputs now make uses of user-defined <code>rendering.chapter</code> and <code>rendering.part</code></p>
|
||||
<li><p id = "para-810">LaTeX outputs now make uses of user-defined <code>rendering.chapter</code> and <code>rendering.part</code></p>
|
||||
</li>
|
||||
<li><p id = "para-809">Dependencies update</p>
|
||||
<li><p id = "para-811">Dependencies update</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-128">0.14.0 (2017-11-26)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-810">New option:</p>
|
||||
<li><p id = "para-812">New option:</p>
|
||||
<ul>
|
||||
<li><p id = "para-811"><code>autograph</code> is an autograph added after title.</p>
|
||||
<li><p id = "para-813"><code>autograph</code> is an autograph added after title.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-812">User interface:</p>
|
||||
<li><p id = "para-814">User interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-813">new argument <code>--autograph</code> prompts for an autograph.</p>
|
||||
<li><p id = "para-815">new argument <code>--autograph</code> prompts for an autograph.</p>
|
||||
</li>
|
||||
<li><p id = "para-814"><code>--list-options</code> and <code>--stats</code> now use colours if available.</p>
|
||||
<li><p id = "para-816"><code>--list-options</code> and <code>--stats</code> now use colours if available.</p>
|
||||
</li>
|
||||
<li><p id = "para-815">options description with <code>--list-options</code> are now wrapped.</p>
|
||||
<li><p id = "para-817">options description with <code>--list-options</code> are now wrapped.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-816">Bugfixes:</p>
|
||||
<li><p id = "para-818">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-817">Preserve errors/warnings order with fancy UI.</p>
|
||||
<li><p id = "para-819">Preserve errors/warnings order with fancy UI.</p>
|
||||
</li>
|
||||
<li><p id = "para-818">Clean secondary bar when there is an error instead of hanging the UI.</p>
|
||||
<li><p id = "para-820">Clean secondary bar when there is an error instead of hanging the UI.</p>
|
||||
</li>
|
||||
<li><p id = "para-819">LaTeX: fancy headers only applies to fancy pages (not chapter pages).</p>
|
||||
<li><p id = "para-821">LaTeX: fancy headers only applies to fancy pages (not chapter pages).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-129">0.14.0-beta (2017-10-08)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-820">Bugfixes:</p>
|
||||
<li><p id = "para-822">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-821">EPUB: escape quotes in content.opf.</p>
|
||||
<li><p id = "para-823">EPUB: escape quotes in content.opf.</p>
|
||||
</li>
|
||||
<li><p id = "para-822">LaTeX/PDF: allow hyphenations in typewriter font.</p>
|
||||
<li><p id = "para-824">LaTeX/PDF: allow hyphenations in typewriter font.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-823">User interface:</p>
|
||||
<li><p id = "para-825">User interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-824">User interface is quite fancier, with progress bars and all</p>
|
||||
<li><p id = "para-826">User interface is quite fancier, with progress bars and all</p>
|
||||
</li>
|
||||
<li><p id = "para-825">Debug/warning/info levels should be displayed in a more coherent manner</p>
|
||||
<li><p id = "para-827">Debug/warning/info levels should be displayed in a more coherent manner</p>
|
||||
</li>
|
||||
<li><p id = "para-826">New <code>--no-fancy</code> option if you don’t like the fancy UI (or if it doesn’t work in your terminal)</p>
|
||||
<li><p id = "para-828">New <code>--no-fancy</code> option if you don’t like the fancy UI (or if it doesn’t work in your terminal)</p>
|
||||
</li>
|
||||
<li><p id = "para-827">New <code>--force-emoji</code> option to force emoji usage.</p>
|
||||
<li><p id = "para-829">New <code>--force-emoji</code> option to force emoji usage.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-828">Library interface:</p>
|
||||
<li><p id = "para-830">Library interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-829">Removed <code>Book::set_verbosity</code> method (uses a logger library instead).</p>
|
||||
<li><p id = "para-831">Removed <code>Book::set_verbosity</code> method (uses a logger library instead).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-830">Now requires rustc >= 1.20.0</p>
|
||||
<li><p id = "para-832">Now requires rustc >= 1.20.0</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-130">0.13.0 (2017-07-14)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-831">Breaking changes:</p>
|
||||
<li><p id = "para-833">Breaking changes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-832">The <code>template.tex</code> template was quite modified. Crowbook now uses custom command for most markdown elements, defined in the template. This allow an user to redefine the way the book is rendered without having to modify Crowbook itself. Unfortunately, as tex templates for previous Crowbook versions won’t work anymore.</p>
|
||||
<li><p id = "para-834">The <code>template.tex</code> template was quite modified. Crowbook now uses custom command for most markdown elements, defined in the template. This allow an user to redefine the way the book is rendered without having to modify Crowbook itself. Unfortunately, as tex templates for previous Crowbook versions won’t work anymore.</p>
|
||||
</li>
|
||||
<li><p id = "para-833">the <code>resources.files</code> option is now a YAML list of strings, instead of a comma-seprated string.</p>
|
||||
<li><p id = "para-835">the <code>resources.files</code> option is now a YAML list of strings, instead of a comma-seprated string.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-834">Add support for grammalecte grammar checker.</p>
|
||||
<li><p id = "para-836">Add support for grammalecte grammar checker.</p>
|
||||
</li>
|
||||
<li><p id = "para-835"><code>crowbook</code> command takes a new argument, <code>-S</code> or <code>--stats</code> which displays stats on the book (currently, words and characters count).</p>
|
||||
<li><p id = "para-837"><code>crowbook</code> command takes a new argument, <code>-S</code> or <code>--stats</code> which displays stats on the book (currently, words and characters count).</p>
|
||||
</li>
|
||||
<li><p id = "para-836">Interactive fiction:</p>
|
||||
<li><p id = "para-838">Interactive fiction:</p>
|
||||
<ul>
|
||||
<li><p id = "para-837">Added conditional blocks.</p>
|
||||
<li><p id = "para-839">Added conditional blocks.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-838">Options:</p>
|
||||
<li><p id = "para-840">Options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-839"><code>output.xxx</code> options can now take the “auto” value, which will infer the output file name based on the book file name.</p>
|
||||
<li><p id = "para-841"><code>output.xxx</code> options can now take the “auto” value, which will infer the output file name based on the book file name.</p>
|
||||
</li>
|
||||
<li><p id = "para-840"><code>output</code> is a new option that can specify a series of format to render, with default output file name.</p>
|
||||
<li><p id = "para-842"><code>output</code> is a new option that can specify a series of format to render, with default output file name.</p>
|
||||
</li>
|
||||
<li><p id = "para-841"><code>proofread.grammalecte</code> and <code>proofread.grammalecte.port</code> allow respectively to enable grammar checking with Grammalecte and (optionnally) to specify the port to connect.</p>
|
||||
<li><p id = "para-843"><code>proofread.grammalecte</code> and <code>proofread.grammalecte.port</code> allow respectively to enable grammar checking with Grammalecte and (optionnally) to specify the port to connect.</p>
|
||||
</li>
|
||||
<li><p id = "para-842"><code>tex.margin.left</code>, <code>tex.margin.right</code>, <code>tex.margin.bottom</code> and <code>tex.margin.top</code> are new options that allow to specify margins for LaTeX/PDF outputs.</p>
|
||||
<li><p id = "para-844"><code>tex.margin.left</code>, <code>tex.margin.right</code>, <code>tex.margin.bottom</code> and <code>tex.margin.top</code> are new options that allow to specify margins for LaTeX/PDF outputs.</p>
|
||||
</li>
|
||||
<li><p id = "para-843"><code>tex.paper_size</code> was renamed <code>tex.paper_size</code>.</p>
|
||||
<li><p id = "para-845"><code>tex.paper_size</code> was renamed <code>tex.paper_size</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-844">HTML:</p>
|
||||
<li><p id = "para-846">HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-845">Add JSON-LD structured data to the book’s HTML files.</p>
|
||||
<li><p id = "para-847">Add JSON-LD structured data to the book’s HTML files.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-846">Bugfixes:</p>
|
||||
<li><p id = "para-848">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-847">LaTeX: fix rendering of part/chapter (part previously displayed as chapter and its first chapter as part)</p>
|
||||
<li><p id = "para-849">LaTeX: fix rendering of part/chapter (part previously displayed as chapter and its first chapter as part)</p>
|
||||
</li>
|
||||
<li><p id = "para-848">EPUB:</p>
|
||||
<li><p id = "para-850">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-849">Fix <code>.rule</code> so it is centered despite KOBO CSS injection.</p>
|
||||
<li><p id = "para-851">Fix <code>.rule</code> so it is centered despite KOBO CSS injection.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-850">Fix resources/images inclusion when they are symlinks to the actual file.</p>
|
||||
<li><p id = "para-852">Fix resources/images inclusion when they are symlinks to the actual file.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-131">0.12.0 (2017-06-05)</h2>
|
||||
<p id = "para-851">This release includes a few new features, such as the possiblity to include Markdown files as section/subsections and not only as chapter, experimental support for superscript and subscript, and yet more experimental support for writing interactive fiction.</p>
|
||||
<p id = "para-853">This release includes a few new features, such as the possiblity to include Markdown files as section/subsections and not only as chapter, experimental support for superscript and subscript, and yet more experimental support for writing interactive fiction.</p>
|
||||
<ul>
|
||||
<li><p id = "para-852">Book configuration file:</p>
|
||||
<li><p id = "para-854">Book configuration file:</p>
|
||||
<ul>
|
||||
<li><p id = "para-853">It is now possible to include subchapters using the <code>--</code> command (with one dash per sublevel: <code>--- foo.md</code> will include <code>foo.md</code> as a subsection).</p>
|
||||
<li><p id = "para-855">It is now possible to include subchapters using the <code>--</code> command (with one dash per sublevel: <code>--- foo.md</code> will include <code>foo.md</code> as a subsection).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-854">Markdown:</p>
|
||||
<li><p id = "para-856">Markdown:</p>
|
||||
<ul>
|
||||
<li><p id = "para-855">Added support for superscript and subscript features, using respectively <code>foo^up^</code> or <code>bar~down~</code> syntax.</p>
|
||||
<li><p id = "para-857">Added support for superscript and subscript features, using respectively <code>foo^up^</code> or <code>bar~down~</code> syntax.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-856">New options:</p>
|
||||
<li><p id = "para-858">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-857"><code>rendering.chapter</code>: change what is displayed in place of “chapter”.</p>
|
||||
<li><p id = "para-859"><code>rendering.chapter</code>: change what is displayed in place of “chapter”.</p>
|
||||
</li>
|
||||
<li><p id = "para-858"><code>rendering.part</code>: change what is displayed in place of “part”.</p>
|
||||
<li><p id = "para-860"><code>rendering.part</code>: change what is displayed in place of “part”.</p>
|
||||
</li>
|
||||
<li><p id = "para-859"><code>html.chapter.template</code> and <code>html.part.template</code> allow to tune a little how the chapters and parts are displayed in HTML.</p>
|
||||
<li><p id = "para-861"><code>html.chapter.template</code> and <code>html.part.template</code> allow to tune a little how the chapters and parts are displayed in HTML.</p>
|
||||
</li>
|
||||
<li><p id = "para-860"><code>tex.hyperref</code>, if set to <code>false</code>, will disable hyperrefs for local links. Can be useful for some files.</p>
|
||||
<li><p id = "para-862"><code>tex.hyperref</code>, if set to <code>false</code>, will disable hyperrefs for local links. Can be useful for some files.</p>
|
||||
</li>
|
||||
<li><p id = "para-861"><code>crowbook.html_as_text</code>, if set to false, will not treat HTML as text but ignore it.</p>
|
||||
<li><p id = "para-863"><code>crowbook.html_as_text</code>, if set to false, will not treat HTML as text but ignore it.</p>
|
||||
</li>
|
||||
<li><p id = "para-862"><code>subtitle</code>, as its name suggest, set the subtitle of a book.</p>
|
||||
<li><p id = "para-864"><code>subtitle</code>, as its name suggest, set the subtitle of a book.</p>
|
||||
</li>
|
||||
<li><p id = "para-863"><code>crowbook.markdown.superscript</code> can enable or disable superscript/subscript “extension”.</p>
|
||||
<li><p id = "para-865"><code>crowbook.markdown.superscript</code> can enable or disable superscript/subscript “extension”.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-864">Rendering:</p>
|
||||
<li><p id = "para-866">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-865">Change the way chapters are displayed by default.</p>
|
||||
<li><p id = "para-867">Change the way chapters are displayed by default.</p>
|
||||
</li>
|
||||
<li><p id = "para-866">PDF output now has a better-looking (hopefully) title page.</p>
|
||||
<li><p id = "para-868">PDF output now has a better-looking (hopefully) title page.</p>
|
||||
</li>
|
||||
<li><p id = "para-867">Internal links are a bit more flexible, e.g. if you link to <code>Readme.html</code> it will now try to link to the chapter corresponding to <code>Readme.md</code>.</p>
|
||||
<li><p id = "para-869">Internal links are a bit more flexible, e.g. if you link to <code>Readme.html</code> it will now try to link to the chapter corresponding to <code>Readme.md</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-868">Bugfixes:</p>
|
||||
<li><p id = "para-870">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-869">LaTeX:</p>
|
||||
<li><p id = "para-871">LaTeX:</p>
|
||||
<ul>
|
||||
<li><p id = "para-870">Fix bug in syntax highlighting.</p>
|
||||
<li><p id = "para-872">Fix bug in syntax highlighting.</p>
|
||||
</li>
|
||||
<li><p id = "para-871">Fix label placements (and thus navigation inside PDF document).</p>
|
||||
<li><p id = "para-873">Fix label placements (and thus navigation inside PDF document).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-872">EPUB:</p>
|
||||
<li><p id = "para-874">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-873">Add unnamed but numbered chapters to the TOC.</p>
|
||||
<li><p id = "para-875">Add unnamed but numbered chapters to the TOC.</p>
|
||||
</li>
|
||||
<li><p id = "para-874">Fix HTML escaping issue for chapter titles.</p>
|
||||
<li><p id = "para-876">Fix HTML escaping issue for chapter titles.</p>
|
||||
</li>
|
||||
<li><p id = "para-875">Fix the way parts were handled in the TOC.</p>
|
||||
<li><p id = "para-877">Fix the way parts were handled in the TOC.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-876">Book configuration file:</p>
|
||||
<li><p id = "para-878">Book configuration file:</p>
|
||||
<ul>
|
||||
<li><p id = "para-877">Fix issue when setting custom number for parts.</p>
|
||||
<li><p id = "para-879">Fix issue when setting custom number for parts.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-878">Crowbook now requires rustc >= 1.17.0</p>
|
||||
<li><p id = "para-880">Crowbook now requires rustc >= 1.17.0</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-132">0.11.4 (2017-03-21)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-879">An image can now be considered standalone even if it is inside a link.</p>
|
||||
<li><p id = "para-881">An image can now be considered standalone even if it is inside a link.</p>
|
||||
</li>
|
||||
<li><p id = "para-880">Bugfixes:</p>
|
||||
<li><p id = "para-882">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-881">HTML/EPUB: use raw (not HTML rendered) metadata in the places where HTML code is not appropriate. Templates can use this metadata with the <code>foo_raw</code> value.</p>
|
||||
<li><p id = "para-883">HTML/EPUB: use raw (not HTML rendered) metadata in the places where HTML code is not appropriate. Templates can use this metadata with the <code>foo_raw</code> value.</p>
|
||||
</li>
|
||||
<li><p id = "para-882">HTML/EPUB: fix double-escaping/rendering issues in titles.</p>
|
||||
<li><p id = "para-884">HTML/EPUB: fix double-escaping/rendering issues in titles.</p>
|
||||
</li>
|
||||
<li><p id = "para-883">EPUB:</p>
|
||||
<li><p id = "para-885">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-884">Escape title and author before feeding them to epub-builder.</p>
|
||||
<li><p id = "para-886">Escape title and author before feeding them to epub-builder.</p>
|
||||
</li>
|
||||
<li><p id = "para-885">Fix content.opf issue by not rendering first chapter’s title (marked as beginning of document) in <code><guide></code>.</p>
|
||||
<li><p id = "para-887">Fix content.opf issue by not rendering first chapter’s title (marked as beginning of document) in <code><guide></code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-886">Rendering:</p>
|
||||
<li><p id = "para-888">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-887">HTML/EPUB: standalone images are now displayed centered.</p>
|
||||
<li><p id = "para-889">HTML/EPUB: standalone images are now displayed centered.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-133">0.11.3 (2017-03-19)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-888">When crowbook parses the book’s contents, it now detects which features are used. This is useful in various ways:</p>
|
||||
<li><p id = "para-890">When crowbook parses the book’s contents, it now detects which features are used. This is useful in various ways:</p>
|
||||
<ul>
|
||||
<li><p id = "para-889">The ODT renderer only displays a global warning showing the lists of used features that are not implemented, instead of a warning each time such a feature is encountered.</p>
|
||||
<li><p id = "para-891">The ODT renderer only displays a global warning showing the lists of used features that are not implemented, instead of a warning each time such a feature is encountered.</p>
|
||||
</li>
|
||||
<li><p id = "para-890">The LaTeX and HTML/EPUB renderers only initialize <code>syntect</code> (which can take some time) if code blocks are used in the document.</p>
|
||||
<li><p id = "para-892">The LaTeX and HTML/EPUB renderers only initialize <code>syntect</code> (which can take some time) if code blocks are used in the document.</p>
|
||||
</li>
|
||||
<li><p id = "para-891">The LaTeX renderer only requires LaTeX packages that are actually used in the document.</p>
|
||||
<li><p id = "para-893">The LaTeX renderer only requires LaTeX packages that are actually used in the document.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-892">Command-line interface:</p>
|
||||
<li><p id = "para-894">Command-line interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-893">Warnings are now displayed by default.</p>
|
||||
<li><p id = "para-895">Warnings are now displayed by default.</p>
|
||||
</li>
|
||||
<li><p id = "para-894">The (undocumented) <code>--debug</code> argument has been removed.</p>
|
||||
<li><p id = "para-896">The (undocumented) <code>--debug</code> argument has been removed.</p>
|
||||
</li>
|
||||
<li><p id = "para-895">The status of some messages have been modified (“warning” to “debug” or “error” to “warning”).</p>
|
||||
<li><p id = "para-897">The status of some messages have been modified (“warning” to “debug” or “error” to “warning”).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-896">Deprecated option:</p>
|
||||
<li><p id = "para-898">Deprecated option:</p>
|
||||
<ul>
|
||||
<li><p id = "para-897"><code>crowbook.verbose</code> has been deprecated, at it should be set by the CLI.</p>
|
||||
<li><p id = "para-899"><code>crowbook.verbose</code> has been deprecated, at it should be set by the CLI.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-134">0.11.2 (2017-03-05)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-898">General:</p>
|
||||
<li><p id = "para-900">General:</p>
|
||||
<ul>
|
||||
<li><p id = "para-899">When there is an error setting an option from the book configuration file (e.g. because it is an invalid key), print an error but do not abort, only ignore this specific option.</p>
|
||||
<li><p id = "para-901">When there is an error setting an option from the book configuration file (e.g. because it is an invalid key), print an error but do not abort, only ignore this specific option.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-900">New options:</p>
|
||||
<li><p id = "para-902">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-901"><code>tex.stdpage</code>: if set to <code>true</code>, will use the <code>stdpage</code> package to render the book according to standards for submitting manuscripts.</p>
|
||||
<li><p id = "para-903"><code>tex.stdpage</code>: if set to <code>true</code>, will use the <code>stdpage</code> package to render the book according to standards for submitting manuscripts.</p>
|
||||
</li>
|
||||
<li><p id = "para-902"><code>rendering.highlight.theme</code> allows to specifies a theme for syntax highlighting (only used if <code>rendering.highlight</code> is set to “syntect”).</p>
|
||||
<li><p id = "para-904"><code>rendering.highlight.theme</code> allows to specifies a theme for syntax highlighting (only used if <code>rendering.highlight</code> is set to “syntect”).</p>
|
||||
</li>
|
||||
<li><p id = "para-903"><code>html.highlight.theme</code>, <code>epub.highlight.theme</code> and <code>tex.highlight.theme</code> allow to specify a theme for HTML/EPUB/LaTeX renderers (only used with syntect).</p>
|
||||
<li><p id = "para-905"><code>html.highlight.theme</code>, <code>epub.highlight.theme</code> and <code>tex.highlight.theme</code> allow to specify a theme for HTML/EPUB/LaTeX renderers (only used with syntect).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-904">Deprecated option:</p>
|
||||
<li><p id = "para-906">Deprecated option:</p>
|
||||
<ul>
|
||||
<li><p id = "para-905"><code>proofread.nb_spaces</code>.</p>
|
||||
<li><p id = "para-907"><code>proofread.nb_spaces</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-906">Rendering:</p>
|
||||
<li><p id = "para-908">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-907"><code>[syntect](https://crates.io/crates/syntect)</code> is now the default for <code>rendering.highlight</code>. Concretely, this means that by default syntax highlighting is now done when <code>crowbook</code> is run instead of using <code>[highlight.js](https://highlightjs.org/)</code>.</p>
|
||||
<li><p id = "para-909"><code>[syntect](https://crates.io/crates/syntect)</code> is now the default for <code>rendering.highlight</code>. Concretely, this means that by default syntax highlighting is now done when <code>crowbook</code> is run instead of using <code>[highlight.js](https://highlightjs.org/)</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-908">EPUB:</p>
|
||||
<li><p id = "para-910">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-909">Now sets the “cover-image” property and meta so readers should display cover correctly.</p>
|
||||
<li><p id = "para-911">Now sets the “cover-image” property and meta so readers should display cover correctly.</p>
|
||||
</li>
|
||||
<li><p id = "para-910">Narrow non-breaking spaces should display more correctly on KOBO ereaders (hoping this won’t break the way they are displayed everywhere else).</p>
|
||||
<li><p id = "para-912">Narrow non-breaking spaces should display more correctly on KOBO ereaders (hoping this won’t break the way they are displayed everywhere else).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-911">Proofreading:</p>
|
||||
<li><p id = "para-913">Proofreading:</p>
|
||||
<ul>
|
||||
<li><p id = "para-912">Repetition detection is now a bit less of an hack, and should cause less problems when used in conjunction with grammar checking. It now also works on PDF output (so the way it is highlighted could be improved).</p>
|
||||
<li><p id = "para-914">Repetition detection is now a bit less of an hack, and should cause less problems when used in conjunction with grammar checking. It now also works on PDF output (so the way it is highlighted could be improved).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-913">Bugfixes:</p>
|
||||
<li><p id = "para-915">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-914">Fix <code>mimetype</code> of EPUB files (make sure it is always “stored” and not “deflated” by the <code>zip</code> command).</p>
|
||||
<li><p id = "para-916">Fix <code>mimetype</code> of EPUB files (make sure it is always “stored” and not “deflated” by the <code>zip</code> command).</p>
|
||||
</li>
|
||||
<li><p id = "para-915">Avoid initializing <code>syntect</code> (at the cost of performances) if it is not used.</p>
|
||||
<li><p id = "para-917">Avoid initializing <code>syntect</code> (at the cost of performances) if it is not used.</p>
|
||||
</li>
|
||||
<li><p id = "para-916">Avoid creating an empty file if some book renderer fails (e.g. EPUB or ODT because <code>zip</code> command is not present).</p>
|
||||
<li><p id = "para-918">Avoid creating an empty file if some book renderer fails (e.g. EPUB or ODT because <code>zip</code> command is not present).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-135">0.11.1 (2017-01-05)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-917">Rendering:</p>
|
||||
<li><p id = "para-919">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-918">Avoid page break before or after a separating rule.</p>
|
||||
<li><p id = "para-920">Avoid page break before or after a separating rule.</p>
|
||||
</li>
|
||||
<li><p id = "para-919">Add support for <a href = "https://crates.io/crates/syntect">syntect</a> for syntax highlighting. This is activated by setting <code>rendering.highlight</code> to <code>syntect</code> (see below).</p>
|
||||
<li><p id = "para-921">Add support for <a href = "https://crates.io/crates/syntect">syntect</a> for syntax highlighting. This is activated by setting <code>rendering.highlight</code> to <code>syntect</code> (see below).</p>
|
||||
</li>
|
||||
<li><p id = "para-920">EPUB:</p>
|
||||
<li><p id = "para-922">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-921">Set back HTML escape of narrow non-breaking spaces to <code>true</code> by default (it caused problems on some readers, but cause much more serious one if <code>false</code>).</p>
|
||||
<li><p id = "para-923">Set back HTML escape of narrow non-breaking spaces to <code>true</code> by default (it caused problems on some readers, but cause much more serious one if <code>false</code>).</p>
|
||||
</li>
|
||||
<li><p id = "para-922">Add more information to guide/nav landmarks.</p>
|
||||
<li><p id = "para-924">Add more information to guide/nav landmarks.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-923">LaTeX/PDF:</p>
|
||||
<li><p id = "para-925">LaTeX/PDF:</p>
|
||||
<ul>
|
||||
<li><p id = "para-924">Improve the way code blocks are displayed, using the <code>mdframed</code> package.</p>
|
||||
<li><p id = "para-926">Improve the way code blocks are displayed, using the <code>mdframed</code> package.</p>
|
||||
</li>
|
||||
<li><p id = "para-925">Try to reduce the issues of too long lines when using code and code blocks, by inserting <code>\allowbreak{}</code> directive after some characters (<code>.</code>, <code>/</code>, <code>_</code>, ...).</p>
|
||||
<li><p id = "para-927">Try to reduce the issues of too long lines when using code and code blocks, by inserting <code>\allowbreak{}</code> directive after some characters (<code>.</code>, <code>/</code>, <code>_</code>, ...).</p>
|
||||
</li>
|
||||
<li><p id = "para-926">Block quotes are now displayed in italics.</p>
|
||||
<li><p id = "para-928">Block quotes are now displayed in italics.</p>
|
||||
</li>
|
||||
<li><p id = "para-927">Tables now use <code>tabularx</code>, which allows to break too long lines (it still doesn’t break pages, though).</p>
|
||||
<li><p id = "para-929">Tables now use <code>tabularx</code>, which allows to break too long lines (it still doesn’t break pages, though).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-928">New options:</p>
|
||||
<li><p id = "para-930">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-929"><code>rendering.highlight</code> can be set to <code>none</code>, <code>highlight.js</code> (by default, enables syntax highlighting via Javascript, but only on HTML document) or <code>syntect</code> (doesn’t necessitate javascript, and can work in EPUB or LaTeX, but more experimental at this point).</p>
|
||||
<li><p id = "para-931"><code>rendering.highlight</code> can be set to <code>none</code>, <code>highlight.js</code> (by default, enables syntax highlighting via Javascript, but only on HTML document) or <code>syntect</code> (doesn’t necessitate javascript, and can work in EPUB or LaTeX, but more experimental at this point).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-930">Deprecated options:</p>
|
||||
<li><p id = "para-932">Deprecated options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-931"><code>html.highlight_code</code> (use <code>rendering.highlight</code> instead).</p>
|
||||
<li><p id = "para-933"><code>html.highlight_code</code> (use <code>rendering.highlight</code> instead).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-932">Bugfixes:</p>
|
||||
<li><p id = "para-934">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-933">HTML (standalone): fix the template that contained invalid HTML code.</p>
|
||||
<li><p id = "para-935">HTML (standalone): fix the template that contained invalid HTML code.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-136">0.11.0 (2016-12-31)</h2>
|
||||
<p id = "para-934">Substantial changes in this release, the more important one being support for parts!</p>
|
||||
<p id = "para-936">Substantial changes in this release, the more important one being support for parts!</p>
|
||||
<ul>
|
||||
<li><p id = "para-935"><b>Breaking changes</b>: the API has undergone some breaking changes, hoping they will be the last ones for a while. API should now be more simple and consistent (?). This version contains also substantial options renaming (see below).</p>
|
||||
<li><p id = "para-937"><b>Breaking changes</b>: the API has undergone some breaking changes, hoping they will be the last ones for a while. API should now be more simple and consistent (?). This version contains also substantial options renaming (see below).</p>
|
||||
</li>
|
||||
<li><p id = "para-936">Crowbook now supports parts (above the “chapter” level), using the ‘@’ character in the book configuration file.</p>
|
||||
<li><p id = "para-938">Crowbook now supports parts (above the “chapter” level), using the ‘@’ character in the book configuration file.</p>
|
||||
</li>
|
||||
<li><p id = "para-937">Command-line interface:</p>
|
||||
<li><p id = "para-939">Command-line interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-938">Behaviour of <code>--to</code> should now be consistent for all output formats.</p>
|
||||
<li><p id = "para-940">Behaviour of <code>--to</code> should now be consistent for all output formats.</p>
|
||||
</li>
|
||||
<li><p id = "para-939">If <code>--output</code> is set to <code>-</code>, prints to stdout.</p>
|
||||
<li><p id = "para-941">If <code>--output</code> is set to <code>-</code>, prints to stdout.</p>
|
||||
</li>
|
||||
<li><p id = "para-940">Conversely, if <code><BOOK></code> is set to <code>-</code>, reads from stdin.</p>
|
||||
<li><p id = "para-942">Conversely, if <code><BOOK></code> is set to <code>-</code>, reads from stdin.</p>
|
||||
</li>
|
||||
<li><p id = "para-941">Path specified by <code>--output</code> is now interpreted relatively to current directory (and not depending on where <code><BOOK></code> is or its options).</p>
|
||||
<li><p id = "para-943">Path specified by <code>--output</code> is now interpreted relatively to current directory (and not depending on where <code><BOOK></code> is or its options).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-942">Rendering:</p>
|
||||
<li><p id = "para-944">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-943">Chapters with no titles now have an empty title added (so it can at least display e.g. “Chapter X”).</p>
|
||||
<li><p id = "para-945">Chapters with no titles now have an empty title added (so it can at least display e.g. “Chapter X”).</p>
|
||||
</li>
|
||||
<li><p id = "para-944">EPUB:</p>
|
||||
<li><p id = "para-946">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-945">The <code>toc.ncx</code> file now displays links to “title” and (if set) “cover” (can be deactivated, see below).</p>
|
||||
<li><p id = "para-947">The <code>toc.ncx</code> file now displays links to “title” and (if set) “cover” (can be deactivated, see below).</p>
|
||||
</li>
|
||||
<li><p id = "para-946">The <code>toc.ncx</code> file now displays toc levels below chapter.</p>
|
||||
<li><p id = "para-948">The <code>toc.ncx</code> file now displays toc levels below chapter.</p>
|
||||
</li>
|
||||
<li><p id = "para-947">The table of contents is now displayed inline if <code>rendering.inline_toc</code> is set to <code>true</code>.</p>
|
||||
<li><p id = "para-949">The table of contents is now displayed inline if <code>rendering.inline_toc</code> is set to <code>true</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-948">New options:</p>
|
||||
<li><p id = "para-950">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-949"><code>epub.toc.extras</code>, set to <code>true</code> by default, will add links to the title and the cover (if it is set) in the table of contents.</p>
|
||||
<li><p id = "para-951"><code>epub.toc.extras</code>, set to <code>true</code> by default, will add links to the title and the cover (if it is set) in the table of contents.</p>
|
||||
</li>
|
||||
<li><p id = "para-950"><code>epub.escape_nb_spaces</code>, similar to <code>html.escape_nb_spaces</code> and set to false by default since at least Kobo reader don’t seem to be able to understand the CSS to escape those nb spaces...</p>
|
||||
<li><p id = "para-952"><code>epub.escape_nb_spaces</code>, similar to <code>html.escape_nb_spaces</code> and set to false by default since at least Kobo reader don’t seem to be able to understand the CSS to escape those nb spaces...</p>
|
||||
</li>
|
||||
<li><p id = "para-951"><code>rendering.chapter.roman_numerals</code>, if set to <code>true</code>, will display chapter numbers using roman numerals.</p>
|
||||
<li><p id = "para-953"><code>rendering.chapter.roman_numerals</code>, if set to <code>true</code>, will display chapter numbers using roman numerals.</p>
|
||||
</li>
|
||||
<li><p id = "para-952"><code>rendering.part.roman_numerals</code>, if set to <code>true</code> (it is by default) will display part numbers using roman numerals.</p>
|
||||
<li><p id = "para-954"><code>rendering.part.roman_numerals</code>, if set to <code>true</code> (it is by default) will display part numbers using roman numerals.</p>
|
||||
</li>
|
||||
<li><p id = "para-953"><code>rendering.part.template</code> specifies the numbering scheme of parts.</p>
|
||||
<li><p id = "para-955"><code>rendering.part.template</code> specifies the numbering scheme of parts.</p>
|
||||
</li>
|
||||
<li><p id = "para-954"><code>rendering.part.reset_counter</code>, if set to <code>true</code> (it is by default), resets chapter number to zero after a part.</p>
|
||||
<li><p id = "para-956"><code>rendering.part.reset_counter</code>, if set to <code>true</code> (it is by default), resets chapter number to zero after a part.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-955">Renamed options:</p>
|
||||
<li><p id = "para-957">Renamed options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-956"><code>import_config</code> renamed to <code>import</code>.</p>
|
||||
<li><p id = "para-958"><code>import_config</code> renamed to <code>import</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-957"><code>rendering.chapter_template</code> renamed to <code>rendering.chapter.template</code>.</p>
|
||||
<li><p id = "para-959"><code>rendering.chapter_template</code> renamed to <code>rendering.chapter.template</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-958"><code>html_single.html</code> renamed to <code>html.standalone.template</code>.</p>
|
||||
<li><p id = "para-960"><code>html_single.html</code> renamed to <code>html.standalone.template</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-959"><code>html_single.js</code> renamed to <code>html.standalone.js</code>.</p>
|
||||
<li><p id = "para-961"><code>html_single.js</code> renamed to <code>html.standalone.js</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-960"><code>html_single.one_chapter</code> renamed to <code>html.standalone.one_chapter</code>.</p>
|
||||
<li><p id = "para-962"><code>html_single.one_chapter</code> renamed to <code>html.standalone.one_chapter</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-961"><code>output.html_dir</code> renamed to <code>output.html.dir</code>.</p>
|
||||
<li><p id = "para-963"><code>output.html_dir</code> renamed to <code>output.html.dir</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-962"><code>output.proofread.html_dir</code> renamed to <code>output.proofread.html.dir</code>.</p>
|
||||
<li><p id = "para-964"><code>output.proofread.html_dir</code> renamed to <code>output.proofread.html.dir</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-963"><code>html_dir.index.html</code> and <code>html.dir.chapter.html</code> have been merged and both renamed to <code>html.dir.template</code>.</p>
|
||||
<li><p id = "para-965"><code>html_dir.index.html</code> and <code>html.dir.chapter.html</code> have been merged and both renamed to <code>html.dir.template</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-964"><code>tex.font_size</code> renamed to <code>tex.font.size</code>.</p>
|
||||
<li><p id = "para-966"><code>tex.font_size</code> renamed to <code>tex.font.size</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-965">Bugfixes:</p>
|
||||
<li><p id = "para-967">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-966">EPUB:</p>
|
||||
<li><p id = "para-968">EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-967">Fix duplicate HTML escaping (resulting in e.g. “&” instead of “&”).</p>
|
||||
<li><p id = "para-969">Fix duplicate HTML escaping (resulting in e.g. “&” instead of “&”).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-968">HTML directory:</p>
|
||||
<li><p id = "para-970">HTML directory:</p>
|
||||
<ul>
|
||||
<li><p id = "para-969">Fix panic when trying to generate html directory in “../xxx” (<a href = "https://github.com/lise-henry/crowbook/issues/23">#23</a>).</p>
|
||||
<li><p id = "para-971">Fix panic when trying to generate html directory in “../xxx” (<a href = "https://github.com/lise-henry/crowbook/issues/23">#23</a>).</p>
|
||||
</li>
|
||||
<li><p id = "para-970">Fix “previous chapter” links that were not displayed when “html.header” was set.</p>
|
||||
<li><p id = "para-972">Fix “previous chapter” links that were not displayed when “html.header” was set.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-971">HTML:</p>
|
||||
<li><p id = "para-973">HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-972">Fix the way initial letter is displayed if <code>rendering.initials</code> is true.</p>
|
||||
<li><p id = "para-974">Fix the way initial letter is displayed if <code>rendering.initials</code> is true.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-973">Internationalization:</p>
|
||||
<li><p id = "para-975">Internationalization:</p>
|
||||
<ul>
|
||||
<li><p id = "para-974">Strings in generated Crowbook documents (such as “Table of contents”, “Title”, “Cover” and such) are now translated in spanish.</p>
|
||||
<li><p id = "para-976">Strings in generated Crowbook documents (such as “Table of contents”, “Title”, “Cover” and such) are now translated in spanish.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-137">0.10.4 (2016-12-16)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-975">New options:</p>
|
||||
<li><p id = "para-977">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-976"><code>tex.font_size</code> specifies an optional font size (in pt) passed to the LaTeX class (must be 10, 11 or 12).</p>
|
||||
<li><p id = "para-978"><code>tex.font_size</code> specifies an optional font size (in pt) passed to the LaTeX class (must be 10, 11 or 12).</p>
|
||||
</li>
|
||||
<li><p id = "para-977"><code>tex.title</code> can be set to <code>false</code> to avoid rendering the title with <code>\maketitle</code>.</p>
|
||||
<li><p id = "para-979"><code>tex.title</code> can be set to <code>false</code> to avoid rendering the title with <code>\maketitle</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-978"><code>tex.paper_size</code> specifies the paper size for PDF output.</p>
|
||||
<li><p id = "para-980"><code>tex.paper_size</code> specifies the paper size for PDF output.</p>
|
||||
</li>
|
||||
<li><p id = "para-979"><code>tex.template.add</code>, <code>html.css.add</code> and <code>epub.css.add</code>allow to specify inline LaTex or CSS code in the book configuration file that will be added respectively to <code>tex.template.add</code>, <code>html.css.add</code> and <code>epub.css.add</code>.</p>
|
||||
<li><p id = "para-981"><code>tex.template.add</code>, <code>html.css.add</code> and <code>epub.css.add</code>allow to specify inline LaTex or CSS code in the book configuration file that will be added respectively to <code>tex.template.add</code>, <code>html.css.add</code> and <code>epub.css.add</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-980"><code>html.icon</code> allows to specify the path of an icon for HTML documents.</p>
|
||||
<li><p id = "para-982"><code>html.icon</code> allows to specify the path of an icon for HTML documents.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-981">Command-line interface:</p>
|
||||
<li><p id = "para-983">Command-line interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-982">Paths that are displayed should now be normalized, e.g. “foo/bar.pdf” instead of “baz/../foo/bar.pdf”.</p>
|
||||
<li><p id = "para-984">Paths that are displayed should now be normalized, e.g. “foo/bar.pdf” instead of “baz/../foo/bar.pdf”.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-983">Rendering:</p>
|
||||
<li><p id = "para-985">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-984">HTML:</p>
|
||||
<li><p id = "para-986">HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-985">The default CSS style has been slightly modified.</p>
|
||||
<li><p id = "para-987">The default CSS style has been slightly modified.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -740,392 +744,392 @@ function toggle() {
|
|||
</ul>
|
||||
<h2 id = "link-138">0.10.3 (2016-11-19)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-986">Building:</p>
|
||||
<li><p id = "para-988">Building:</p>
|
||||
<ul>
|
||||
<li><p id = "para-987">Crowbook now requires rustc >= 1.13.0 to build.</p>
|
||||
<li><p id = "para-989">Crowbook now requires rustc >= 1.13.0 to build.</p>
|
||||
</li>
|
||||
<li><p id = "para-988">Pre-built binaries now all include the proofreading feature.</p>
|
||||
<li><p id = "para-990">Pre-built binaries now all include the proofreading feature.</p>
|
||||
</li>
|
||||
<li><p id = "para-989">Linux binaries are now linked against <code>musl</code> library so they should really work on any Linux platform.</p>
|
||||
<li><p id = "para-991">Linux binaries are now linked against <code>musl</code> library so they should really work on any Linux platform.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-990">Bugfixes:</p>
|
||||
<li><p id = "para-992">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-991">Fixed escaping of <code>author</code> and <code>title</code> fields.</p>
|
||||
<li><p id = "para-993">Fixed escaping of <code>author</code> and <code>title</code> fields.</p>
|
||||
</li>
|
||||
<li><p id = "para-992">Fixed text cleaning in ODT rendering that causes corrupt files to be generated.</p>
|
||||
<li><p id = "para-994">Fixed text cleaning in ODT rendering that causes corrupt files to be generated.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-993">CommandLine Interface:</p>
|
||||
<li><p id = "para-995">CommandLine Interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-994">Crowbook displays clearer error messages when unable to launch <code>latex</code> or <code>zip</code> commands.</p>
|
||||
<li><p id = "para-996">Crowbook displays clearer error messages when unable to launch <code>latex</code> or <code>zip</code> commands.</p>
|
||||
</li>
|
||||
<li><p id = "para-995">Crowbook uses <code>term</code> library in order to display colours correctly on e.g. Windows.</p>
|
||||
<li><p id = "para-997">Crowbook uses <code>term</code> library in order to display colours correctly on e.g. Windows.</p>
|
||||
</li>
|
||||
<li><p id = "para-996">The new argument <code>--lang</code> (or <code>-L</code>) allows to set the runtime language used by Crowbook, overriding <code>LANG</code> environment variable.</p>
|
||||
<li><p id = "para-998">The new argument <code>--lang</code> (or <code>-L</code>) allows to set the runtime language used by Crowbook, overriding <code>LANG</code> environment variable.</p>
|
||||
</li>
|
||||
<li><p id = "para-997"><code>--list-options</code> no longer uses colours as it caused problems depending on the terminal or when piping to <code>less</code>.</p>
|
||||
<li><p id = "para-999"><code>--list-options</code> no longer uses colours as it caused problems depending on the terminal or when piping to <code>less</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-139">0.10.2 (2016-10-21)</h2>
|
||||
<p id = "para-998">Only minor changes in this version:</p>
|
||||
<p id = "para-1000">Only minor changes in this version:</p>
|
||||
<ul>
|
||||
<li><p id = "para-999">Options:</p>
|
||||
<li><p id = "para-1001">Options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1000"><code>author</code> and <code>title</code>’s default values are both set to the empty string, instead of <code>Anonymous</code> and <code>Untitled</code>.</p>
|
||||
<li><p id = "para-1002"><code>author</code> and <code>title</code>’s default values are both set to the empty string, instead of <code>Anonymous</code> and <code>Untitled</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1001"><code>input.autoclean</code> has been renamed <code>input.clean</code>.</p>
|
||||
<li><p id = "para-1003"><code>input.autoclean</code> has been renamed <code>input.clean</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1002"><code>input.smart_quotes</code> has been renamed <code>input.clean.smart_quotes</code>.</p>
|
||||
<li><p id = "para-1004"><code>input.smart_quotes</code> has been renamed <code>input.clean.smart_quotes</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1003">new option: <code>input.clean.ligature.dashes</code> will (if set to true) replace <code>--</code> to en dash (<code>–</code>) and <code>---</code> to em dash (<code>—</code>).</p>
|
||||
<li><p id = "para-1005">new option: <code>input.clean.ligature.dashes</code> will (if set to true) replace <code>--</code> to en dash (<code>–</code>) and <code>---</code> to em dash (<code>—</code>).</p>
|
||||
</li>
|
||||
<li><p id = "para-1004">new option: <code>input.clean.ligature.guillemets</code> will (if set to true) replace <code><<</code> and <code>>></code> to french guillemets (<code>«</code> and <code>»</code>).</p>
|
||||
<li><p id = "para-1006">new option: <code>input.clean.ligature.guillemets</code> will (if set to true) replace <code><<</code> and <code>>></code> to french guillemets (<code>«</code> and <code>»</code>).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1005">Rendering:</p>
|
||||
<li><p id = "para-1007">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1006">HTML: if <code>html_single.one_chapter</code> and <code>rendering.inline_toc</code> are both set to true, only render the TOC if currently displayed chapter is the first.</p>
|
||||
<li><p id = "para-1008">HTML: if <code>html_single.one_chapter</code> and <code>rendering.inline_toc</code> are both set to true, only render the TOC if currently displayed chapter is the first.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-140">0.10.1 (2016-10-18)</h2>
|
||||
<p id = "para-1007">Fixed a bug in <code>fr.po</code> translation that prevented building from fresh install.</p>
|
||||
<p id = "para-1009">Fixed a bug in <code>fr.po</code> translation that prevented building from fresh install.</p>
|
||||
<h2 id = "link-141">0.10.0 (2016-10-18)</h2>
|
||||
<p id = "para-1008">This release contains some breaking changes (mostly for the API, which has been split in separate libraries). It alse features some internationalization support, and the program should now be tranlated if your <code>LANG</code> environment variable is set to french.</p>
|
||||
<p id = "para-1010">This release contains some breaking changes (mostly for the API, which has been split in separate libraries). It alse features some internationalization support, and the program should now be tranlated if your <code>LANG</code> environment variable is set to french.</p>
|
||||
<ul>
|
||||
<li><p id = "para-1009"><b>Breaking changes</b>:</p>
|
||||
<li><p id = "para-1011"><b>Breaking changes</b>:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1010">Templates:</p>
|
||||
<li><p id = "para-1012">Templates:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1011">Conditional inclusion depending on <code>lang</code> must now be done using <code>lang_LANG</code> (e.g. <code>lang_fr</code>, <code>lang_en</code>, and so on). This might impact custom <code>epub.css</code> and <code>html.css</code> templates.</p>
|
||||
<li><p id = "para-1013">Conditional inclusion depending on <code>lang</code> must now be done using <code>lang_LANG</code> (e.g. <code>lang_fr</code>, <code>lang_en</code>, and so on). This might impact custom <code>epub.css</code> and <code>html.css</code> templates.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1012">API:</p>
|
||||
<li><p id = "para-1014">API:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1013">The <code>escape</code> module has been moved to a separate crate, <code>crowbook_text_processing</code>. The <code>cleaner</code> module is no longer public, but the features it provided are also available in <code>crowbook_text_processing</code>.</p>
|
||||
<li><p id = "para-1015">The <code>escape</code> module has been moved to a separate crate, <code>crowbook_text_processing</code>. The <code>cleaner</code> module is no longer public, but the features it provided are also available in <code>crowbook_text_processing</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1014">New options:</p>
|
||||
<li><p id = "para-1016">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1015"><code>html.css.colours</code> allows to provide a CSS file that only redefine the colour scheme. Such a file can be built from <code>crowbook --print-template html.css.colours</code>.</p>
|
||||
<li><p id = "para-1017"><code>html.css.colours</code> allows to provide a CSS file that only redefine the colour scheme. Such a file can be built from <code>crowbook --print-template html.css.colours</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1016"><code>input.smart_quotes</code>: if set to <code>true</code>, tries to replace <code>'</code> and <code>"</code> by curly quotes.</p>
|
||||
<li><p id = "para-1018"><code>input.smart_quotes</code>: if set to <code>true</code>, tries to replace <code>'</code> and <code>"</code> by curly quotes.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1017">Command line interface:</p>
|
||||
<li><p id = "para-1019">Command line interface:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1018">Crowbook is now (imperfectly) localized in french, and can be translated to other languages.</p>
|
||||
<li><p id = "para-1020">Crowbook is now (imperfectly) localized in french, and can be translated to other languages.</p>
|
||||
</li>
|
||||
<li><p id = "para-1019">Added the <code>--quiet</code> (or <code>-q</code>) argument, that makes crowbook run without displaying any messages (except some error messages at this point).</p>
|
||||
<li><p id = "para-1021">Added the <code>--quiet</code> (or <code>-q</code>) argument, that makes crowbook run without displaying any messages (except some error messages at this point).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1020">Rendering:</p>
|
||||
<li><p id = "para-1022">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1021">HTML:</p>
|
||||
<li><p id = "para-1023">HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1022">The table of contents menu is no longer displayed in the HTML single renderer if it doesn’t contain at least two elements.</p>
|
||||
<li><p id = "para-1024">The table of contents menu is no longer displayed in the HTML single renderer if it doesn’t contain at least two elements.</p>
|
||||
</li>
|
||||
<li><p id = "para-1023">The default colour theme has been modified a little.</p>
|
||||
<li><p id = "para-1025">The default colour theme has been modified a little.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1024">Bugfixes:</p>
|
||||
<li><p id = "para-1026">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1025">Fix the escaping of non-breaking spaces in EPUB, as <code>&nbsp;</code> and its friends aren’t valid entities in XHTML, apparently.</p>
|
||||
<li><p id = "para-1027">Fix the escaping of non-breaking spaces in EPUB, as <code>&nbsp;</code> and its friends aren’t valid entities in XHTML, apparently.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-142">0.9.1 (2016-09-29)</h2>
|
||||
<p id = "para-1026">This release mainly introduces generation of proofreading copies, allowing, if they are set (and <code>crowbook</code> was compiled with the <code>proofread</code> feature) to generate proofreading copies, using tools to check grammar and detect repetitions. These features are currently experimental.</p>
|
||||
<p id = "para-1028">This release mainly introduces generation of proofreading copies, allowing, if they are set (and <code>crowbook</code> was compiled with the <code>proofread</code> feature) to generate proofreading copies, using tools to check grammar and detect repetitions. These features are currently experimental.</p>
|
||||
<ul>
|
||||
<li><p id = "para-1027">New options:</p>
|
||||
<li><p id = "para-1029">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1028"><code>html.escape_nb_spaces</code>, if set to true (by default), will replace unicode non breaking spaces with HTML entites and CSS so it can display correctly even if reader’s don’t have a browser/font supporting these unicode symbols.</p>
|
||||
<li><p id = "para-1030"><code>html.escape_nb_spaces</code>, if set to true (by default), will replace unicode non breaking spaces with HTML entites and CSS so it can display correctly even if reader’s don’t have a browser/font supporting these unicode symbols.</p>
|
||||
</li>
|
||||
<li><p id = "para-1029">Output files for proofread documents: <code>output.proofread.html</code>, <code>output.proofread.html_dir</code> and <code>output.proofread.pdf</code>.</p>
|
||||
<li><p id = "para-1031">Output files for proofread documents: <code>output.proofread.html</code>, <code>output.proofread.html_dir</code> and <code>output.proofread.pdf</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1030">Proofread options <code>proofread.repetitions</code> and <code>proofread.nb_spaces</code> have been added.</p>
|
||||
<li><p id = "para-1032">Proofread options <code>proofread.repetitions</code> and <code>proofread.nb_spaces</code> have been added.</p>
|
||||
<ul>
|
||||
<li><p id = "para-1031"><code>proofread.nb_spaces</code>, if set to true, highlights non-breaking spaces so it is easier to check the correct typography of a book. Note that it requires that <code>html.escape_nb_spaces</code> be set to true (default) to work.</p>
|
||||
<li><p id = "para-1033"><code>proofread.nb_spaces</code>, if set to true, highlights non-breaking spaces so it is easier to check the correct typography of a book. Note that it requires that <code>html.escape_nb_spaces</code> be set to true (default) to work.</p>
|
||||
</li>
|
||||
<li><p id = "para-1032"><code>proofread.reppetitions</code>, if set to true, uses <a href = "https://github.com/lise-henry/caribon">Caribon</a> to highlight repetitions in a document. It also uses the settings <code>proofread.repetitions.fuzzy</code>, <code>proofread.repetitions.max_distance</code>, <code>proofread.repetitions.threshold</code>, <code>proofread.repetitions.fuzzy.threshold</code>, <code>proofread.repetitions.ignore_proper</code>. Note that this feature is not built by default, you’ll have to build crowbook with <code>cargo build --release --features "repetitions"</code>.</p>
|
||||
<li><p id = "para-1034"><code>proofread.reppetitions</code>, if set to true, uses <a href = "https://github.com/lise-henry/caribon">Caribon</a> to highlight repetitions in a document. It also uses the settings <code>proofread.repetitions.fuzzy</code>, <code>proofread.repetitions.max_distance</code>, <code>proofread.repetitions.threshold</code>, <code>proofread.repetitions.fuzzy.threshold</code>, <code>proofread.repetitions.ignore_proper</code>. Note that this feature is not built by default, you’ll have to build crowbook with <code>cargo build --release --features "repetitions"</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1033">New default settings for options:</p>
|
||||
<li><p id = "para-1035">New default settings for options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1034"><code>tex.command</code> is now <code>xelatex</code> by default.</p>
|
||||
<li><p id = "para-1036"><code>tex.command</code> is now <code>xelatex</code> by default.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1035">Rendering:</p>
|
||||
<li><p id = "para-1037">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1036">LaTeX:</p>
|
||||
<li><p id = "para-1038">LaTeX:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1037">Add support for xelatex in the default template.</p>
|
||||
<li><p id = "para-1039">Add support for xelatex in the default template.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1038">Improved french cleaner (see <a href = "https://crowdagger.github.io/textes/articles/heuristique.html">an article (in french)</a> that talks about what it does).</p>
|
||||
<li><p id = "para-1040">Improved french cleaner (see <a href = "https://crowdagger.github.io/textes/articles/heuristique.html">an article (in french)</a> that talks about what it does).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1039">Crowbook user guide: documentation has been updated to correctly reflect 0.9.x options.</p>
|
||||
<li><p id = "para-1041">Crowbook user guide: documentation has been updated to correctly reflect 0.9.x options.</p>
|
||||
</li>
|
||||
<li><p id = "para-1040">API:</p>
|
||||
<li><p id = "para-1042">API:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1041"><code>clap</code> dependency is now optional, people who want to use Crowbook as a library should include it with <code>crowbook = { version = "0.9", default-features = false }</code>. (<code>clap</code> is still required to build a working binary).</p>
|
||||
<li><p id = "para-1043"><code>clap</code> dependency is now optional, people who want to use Crowbook as a library should include it with <code>crowbook = { version = "0.9", default-features = false }</code>. (<code>clap</code> is still required to build a working binary).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-143">0.9.0 (2016-09-23)</h2>
|
||||
<p id = "para-1042">The main objective of this release is to clean public interfaces, in order to limit breaking changes in the future. <em>Ideally</em>, all pre-1.0 releases should thus be 0.9.x. Concretely, this meant three things:</p>
|
||||
<p id = "para-1044">The main objective of this release is to clean public interfaces, in order to limit breaking changes in the future. <em>Ideally</em>, all pre-1.0 releases should thus be 0.9.x. Concretely, this meant three things:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1043">reducing the surface of Crowbook’s library API;</p>
|
||||
<li><p id = "para-1045">reducing the surface of Crowbook’s library API;</p>
|
||||
</li>
|
||||
<li><p id = "para-1044">cleaning options names</p>
|
||||
<li><p id = "para-1046">cleaning options names</p>
|
||||
</li>
|
||||
<li><p id = "para-1045">cleaning the names exported in templates and document them, in order not to break user-defined templates in future (non-breaking) releases. More detailed changes for this release:</p>
|
||||
<li><p id = "para-1047">cleaning the names exported in templates and document them, in order not to break user-defined templates in future (non-breaking) releases. More detailed changes for this release:</p>
|
||||
</li>
|
||||
<li><p id = "para-1046"><b>Breaking change for users</b>: removed <code>tex.short</code> option, replaced by a more generic <code>tex.class</code> (default being <code>book</code>). <code>html.crowbook_link</code> has also been removed.</p>
|
||||
<li><p id = "para-1048"><b>Breaking change for users</b>: removed <code>tex.short</code> option, replaced by a more generic <code>tex.class</code> (default being <code>book</code>). <code>html.crowbook_link</code> has also been removed.</p>
|
||||
</li>
|
||||
<li><p id = "para-1047">Renamed options. Using the old name will print a deprecation warning but will still work for a while.</p>
|
||||
<li><p id = "para-1049">Renamed options. Using the old name will print a deprecation warning but will still work for a while.</p>
|
||||
<ul>
|
||||
<li><p id = "para-1048"><code>temp_dir</code> -> <code>crowbook.temp_dir</code></p>
|
||||
<li><p id = "para-1050"><code>temp_dir</code> -> <code>crowbook.temp_dir</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1049"><code>zip.command</code> -> <code>crowbook.zip.command</code></p>
|
||||
<li><p id = "para-1051"><code>zip.command</code> -> <code>crowbook.zip.command</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1050"><code>verbose</code> -> <code>crowbook.verbose</code></p>
|
||||
<li><p id = "para-1052"><code>verbose</code> -> <code>crowbook.verbose</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1051"><code>html.print_css</code> -> <code>html.css.print</code></p>
|
||||
<li><p id = "para-1053"><code>html.print_css</code> -> <code>html.css.print</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1052"><code>html.display_chapter</code> -> <code>html_single.one_chapter</code></p>
|
||||
<li><p id = "para-1054"><code>html.display_chapter</code> -> <code>html_single.one_chapter</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1053"><code>html.script</code> -> <code>html_single.js</code></p>
|
||||
<li><p id = "para-1055"><code>html.script</code> -> <code>html_single.js</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1054"><code>numbering</code> -> <code>rendering.num_depth</code></p>
|
||||
<li><p id = "para-1056"><code>numbering</code> -> <code>rendering.num_depth</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1055"><code>numbering_template</code> -> <code>rendering.chapter_template</code></p>
|
||||
<li><p id = "para-1057"><code>numbering_template</code> -> <code>rendering.chapter_template</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1056"><code>display_toc</code> -> <code>rendering.inline_toc</code></p>
|
||||
<li><p id = "para-1058"><code>display_toc</code> -> <code>rendering.inline_toc</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1057"><code>toc_name</code> -> <code>rendering.inline_toc.name</code></p>
|
||||
<li><p id = "para-1059"><code>toc_name</code> -> <code>rendering.inline_toc.name</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1058"><code>enable_yaml_blocks</code> -> <code>input.yaml_blocks</code></p>
|
||||
<li><p id = "para-1060"><code>enable_yaml_blocks</code> -> <code>input.yaml_blocks</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1059"><code>use_initials</code> -> <code>rendering.initials</code></p>
|
||||
<li><p id = "para-1061"><code>use_initials</code> -> <code>rendering.initials</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1060"><code>autoclean</code> -> <code>input.autoclean</code></p>
|
||||
<li><p id = "para-1062"><code>autoclean</code> -> <code>input.autoclean</code></p>
|
||||
</li>
|
||||
<li><p id = "para-1061"><code>html_dir.css</code> -> <code>html.css</code> (not really renamed, <code>html_dir.css</code> isactually removed as there is no point in having different CSS for standalone and multifile HTML rendering, is it?)</p>
|
||||
<li><p id = "para-1063"><code>html_dir.css</code> -> <code>html.css</code> (not really renamed, <code>html_dir.css</code> isactually removed as there is no point in having different CSS for standalone and multifile HTML rendering, is it?)</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1062">New options:</p>
|
||||
<li><p id = "para-1064">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1063">More metadata: <code>license</code>, <code>version</code> and <code>date</code>. These metadata are not treated by the renderers, but they are exported to the templates: <code>{{{metadata}}}</code> allows to access the content. If they are present, a <code>has_metadata</code> is also set to true, allowing to do something like <code>{{{title}}} {{#has_version}}version {{{version}}} {{/has_version}}</code>.</p>
|
||||
<li><p id = "para-1065">More metadata: <code>license</code>, <code>version</code> and <code>date</code>. These metadata are not treated by the renderers, but they are exported to the templates: <code>{{{metadata}}}</code> allows to access the content. If they are present, a <code>has_metadata</code> is also set to true, allowing to do something like <code>{{{title}}} {{#has_version}}version {{{version}}} {{/has_version}}</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1064">Yet more metadata: it is possible to add custom metadata by prefixing it with <code>metadata.</code>. They will then be accessible in the templates, with dots ('.') replaced by underscores ('_'). E.g., with <code>metadata.foo: bar</code> you can access it in your templates with <code>{{{metadata_foo}}}</code>.</p>
|
||||
<li><p id = "para-1066">Yet more metadata: it is possible to add custom metadata by prefixing it with <code>metadata.</code>. They will then be accessible in the templates, with dots ('.') replaced by underscores ('_'). E.g., with <code>metadata.foo: bar</code> you can access it in your templates with <code>{{{metadata_foo}}}</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1065"><code>output.base_path</code> specifies a directory where the output files (set by <code>output.FORMAT</code> will be written.</p>
|
||||
<li><p id = "para-1067"><code>output.base_path</code> specifies a directory where the output files (set by <code>output.FORMAT</code> will be written.</p>
|
||||
</li>
|
||||
<li><p id = "para-1066"><code>resources.base_path.templates</code> specifies where templates can be found.</p>
|
||||
<li><p id = "para-1068"><code>resources.base_path.templates</code> specifies where templates can be found.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1067">Rendering:</p>
|
||||
<li><p id = "para-1069">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1068">Metadata can now contain Markdown and will be rendered by the renderers. This might not be a good idea for common fields (e.g. “title”), though. Use with caution.</p>
|
||||
<li><p id = "para-1070">Metadata can now contain Markdown and will be rendered by the renderers. This might not be a good idea for common fields (e.g. “title”), though. Use with caution.</p>
|
||||
</li>
|
||||
<li><p id = "para-1069"><code>rendering.inline_toc.name</code> can use <code>{{{loc_toc}}}</code> to specify a localized name.</p>
|
||||
<li><p id = "para-1071"><code>rendering.inline_toc.name</code> can use <code>{{{loc_toc}}}</code> to specify a localized name.</p>
|
||||
</li>
|
||||
<li><p id = "para-1070">HTML:</p>
|
||||
<li><p id = "para-1072">HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1071"><code>html.top</code> and <code>hstml.footer</code> are now considered as templates, so you can use some <code>{{{metadata}}}</code> in it.</p>
|
||||
<li><p id = "para-1073"><code>html.top</code> and <code>hstml.footer</code> are now considered as templates, so you can use some <code>{{{metadata}}}</code> in it.</p>
|
||||
</li>
|
||||
<li><p id = "para-1072">Improved the way footnotes are displayed.</p>
|
||||
<li><p id = "para-1074">Improved the way footnotes are displayed.</p>
|
||||
</li>
|
||||
<li><p id = "para-1073">In standalone HTML, footnotes are rendered at the end of the document instead of at the end of the chapter, unless <code>html_single.one_chapter</code> is true.</p>
|
||||
<li><p id = "para-1075">In standalone HTML, footnotes are rendered at the end of the document instead of at the end of the chapter, unless <code>html_single.one_chapter</code> is true.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1074">LaTeX:</p>
|
||||
<li><p id = "para-1076">LaTeX:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1075">If <code>tex.class</code> is set to <code>article</code>, chapters will be displayed as <code>\sections</code> since <code>article</code> class doesn’t handle chapters.</p>
|
||||
<li><p id = "para-1077">If <code>tex.class</code> is set to <code>article</code>, chapters will be displayed as <code>\sections</code> since <code>article</code> class doesn’t handle chapters.</p>
|
||||
</li>
|
||||
<li><p id = "para-1076">Except if <code>tex.class</code> is set to <code>book</code>, margins are now symmetrical.</p>
|
||||
<li><p id = "para-1078">Except if <code>tex.class</code> is set to <code>book</code>, margins are now symmetrical.</p>
|
||||
</li>
|
||||
<li><p id = "para-1077">LaTex template now uses <code>version</code> and <code>date</code>.</p>
|
||||
<li><p id = "para-1079">LaTex template now uses <code>version</code> and <code>date</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1078">Bugfixes:</p>
|
||||
<li><p id = "para-1080">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1079"><code>import_config</code> only import options from another book file that are not equal to the default ones and that haven’t already been set by the caller. E.g., <code>author: foo</code> then <code>import_config: bar.book</code> won’t erase the author previously set.</p>
|
||||
<li><p id = "para-1081"><code>import_config</code> only import options from another book file that are not equal to the default ones and that haven’t already been set by the caller. E.g., <code>author: foo</code> then <code>import_config: bar.book</code> won’t erase the author previously set.</p>
|
||||
</li>
|
||||
<li><p id = "para-1080"><code>import_config</code> now correctly translates the imported book’s paths.</p>
|
||||
<li><p id = "para-1082"><code>import_config</code> now correctly translates the imported book’s paths.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1081">Crowbook program:</p>
|
||||
<li><p id = "para-1083">Crowbook program:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1082">Still working to improve error messages.</p>
|
||||
<li><p id = "para-1084">Still working to improve error messages.</p>
|
||||
</li>
|
||||
<li><p id = "para-1083"><code>crowbook --list-options</code> uses colours. This might hurt your eyes.</p>
|
||||
<li><p id = "para-1085"><code>crowbook --list-options</code> uses colours. This might hurt your eyes.</p>
|
||||
</li>
|
||||
<li><p id = "para-1084">Display an error message when mustache can’t compile a template, instead of panicking.</p>
|
||||
<li><p id = "para-1086">Display an error message when mustache can’t compile a template, instead of panicking.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1085">Internal/API:</p>
|
||||
<li><p id = "para-1087">Internal/API:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1086">Added static methods to <code>Logger</code> to allows displaying messages more easily/prettily.</p>
|
||||
<li><p id = "para-1088">Added static methods to <code>Logger</code> to allows displaying messages more easily/prettily.</p>
|
||||
</li>
|
||||
<li><p id = "para-1087">Reduce pubic API’s surface so less changes will need to be considered breaking in the future.</p>
|
||||
<li><p id = "para-1089">Reduce pubic API’s surface so less changes will need to be considered breaking in the future.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-144">0.8.0 (2016-09-19)</h2>
|
||||
<p id = "para-1088">This release adds support for syntax higlighting in code blocks, customized top and footer blocks for HTML rendering, and the special <code>import_config</code> option that allows to import options from another book file. It also provides (hopefully) better error messages.</p>
|
||||
<p id = "para-1090">This release adds support for syntax higlighting in code blocks, customized top and footer blocks for HTML rendering, and the special <code>import_config</code> option that allows to import options from another book file. It also provides (hopefully) better error messages.</p>
|
||||
<ul>
|
||||
<li><p id = "para-1089">New options:</p>
|
||||
<li><p id = "para-1091">New options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1090"><code>import_config</code>is not really an option, but allows to import another configuration file, useful if you share a same set of options between multiple books.</p>
|
||||
<li><p id = "para-1092"><code>import_config</code>is not really an option, but allows to import another configuration file, useful if you share a same set of options between multiple books.</p>
|
||||
</li>
|
||||
<li><p id = "para-1091"><code>use_initials</code> (set to false by default) makes Crowbook use initials (“lettrines”) at start of each chapter. Support is still experimental.</p>
|
||||
<li><p id = "para-1093"><code>use_initials</code> (set to false by default) makes Crowbook use initials (“lettrines”) at start of each chapter. Support is still experimental.</p>
|
||||
</li>
|
||||
<li><p id = "para-1092"><code>html.highlight_code</code> (set to true by default) allows syntax highlighting for code blocks, using highlight.js.</p>
|
||||
<li><p id = "para-1094"><code>html.highlight_code</code> (set to true by default) allows syntax highlighting for code blocks, using highlight.js.</p>
|
||||
</li>
|
||||
<li><p id = "para-1093"><code>html.higlight.css</code> and <code>html.highlight.js</code> can be used to provide other themes (default is default.css) and an highlight.js build that support other languages.</p>
|
||||
<li><p id = "para-1095"><code>html.higlight.css</code> and <code>html.highlight.js</code> can be used to provide other themes (default is default.css) and an highlight.js build that support other languages.</p>
|
||||
</li>
|
||||
<li><p id = "para-1094"><code>html.footer</code> allows to specify custom footer. If not set, <code>html.crowbook_link</code> allows to disable “Generated by Crowbook” message.</p>
|
||||
<li><p id = "para-1096"><code>html.footer</code> allows to specify custom footer. If not set, <code>html.crowbook_link</code> allows to disable “Generated by Crowbook” message.</p>
|
||||
</li>
|
||||
<li><p id = "para-1095"><code>html.top</code> allows to specify a custom header that will be displayed at the top of HTML file(s).</p>
|
||||
<li><p id = "para-1097"><code>html.top</code> allows to specify a custom header that will be displayed at the top of HTML file(s).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1096">Deprecated options:</p>
|
||||
<li><p id = "para-1098">Deprecated options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1097"><code>side_notes</code> has been renamed <code>html.side_notes</code>.</p>
|
||||
<li><p id = "para-1099"><code>side_notes</code> has been renamed <code>html.side_notes</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1098">Crowbook program:</p>
|
||||
<li><p id = "para-1100">Crowbook program:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1099">All output formats are now rendered concurrently.</p>
|
||||
<li><p id = "para-1101">All output formats are now rendered concurrently.</p>
|
||||
</li>
|
||||
<li><p id = "para-1100">Better error messages. Crowbook now tries to give more information when displaying an error, with the file name where a problem was found, and, in some cases, the line. It also tries to detect errors (such as files not found) sooner.</p>
|
||||
<li><p id = "para-1102">Better error messages. Crowbook now tries to give more information when displaying an error, with the file name where a problem was found, and, in some cases, the line. It also tries to detect errors (such as files not found) sooner.</p>
|
||||
</li>
|
||||
<li><p id = "para-1101">Some “warning” messages have also been “moved” to error messages, to make sure they are displayed even when crowbook isn’t runned with <code>--verbose</code>.</p>
|
||||
<li><p id = "para-1103">Some “warning” messages have also been “moved” to error messages, to make sure they are displayed even when crowbook isn’t runned with <code>--verbose</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1102">Rendering:</p>
|
||||
<li><p id = "para-1104">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1103">Hidden chapter now produce empty <code>\chapter*{}</code> and <code><h1></code> in LaTeX and HTML. This allow to delimit a chapter break even if nothing is displayed.</p>
|
||||
<li><p id = "para-1105">Hidden chapter now produce empty <code>\chapter*{}</code> and <code><h1></code> in LaTeX and HTML. This allow to delimit a chapter break even if nothing is displayed.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1104">Bugfixes:</p>
|
||||
<li><p id = "para-1106">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1105">Navigation menu of standalone HTML didn’t include a call to javascript when <code>html.display_chapter</code> was set to true, meaning it didn’t display the chapter correctly.</p>
|
||||
<li><p id = "para-1107">Navigation menu of standalone HTML didn’t include a call to javascript when <code>html.display_chapter</code> was set to true, meaning it didn’t display the chapter correctly.</p>
|
||||
</li>
|
||||
<li><p id = "para-1106">Implementations of <code>Image</code> and <code>StandaloneImage</code> were reversed in LaTeX.</p>
|
||||
<li><p id = "para-1108">Implementations of <code>Image</code> and <code>StandaloneImage</code> were reversed in LaTeX.</p>
|
||||
</li>
|
||||
<li><p id = "para-1107"><code>StandaloneImage</code> urls were not adjusted (meanning that running <code>crowbook</code> from another directory failed).</p>
|
||||
<li><p id = "para-1109"><code>StandaloneImage</code> urls were not adjusted (meanning that running <code>crowbook</code> from another directory failed).</p>
|
||||
</li>
|
||||
<li><p id = "para-1108">Image paths are now found correctly in HtmlDir rendering even if <code>crowbook</code> is called from another directory (same fix as 0.6’s for Epub and LaTeX, which was forgotten for HtmlDir).</p>
|
||||
<li><p id = "para-1110">Image paths are now found correctly in HtmlDir rendering even if <code>crowbook</code> is called from another directory (same fix as 0.6’s for Epub and LaTeX, which was forgotten for HtmlDir).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1109">Internal/API:</p>
|
||||
<li><p id = "para-1111">Internal/API:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1110">In order to have better error messages, there was a need to refactor the <code>Error</code> type, and make more methods return <code>Result<X></code> instead of <code>X</code>. The API is, therefore, quite modified.</p>
|
||||
<li><p id = "para-1112">In order to have better error messages, there was a need to refactor the <code>Error</code> type, and make more methods return <code>Result<X></code> instead of <code>X</code>. The API is, therefore, quite modified.</p>
|
||||
</li>
|
||||
<li><p id = "para-1111">Added a <code>Renderer</code> trait used by the various renderers.</p>
|
||||
<li><p id = "para-1113">Added a <code>Renderer</code> trait used by the various renderers.</p>
|
||||
</li>
|
||||
<li><p id = "para-1112">Removed some methods from public API.</p>
|
||||
<li><p id = "para-1114">Removed some methods from public API.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-145">0.7.0 (2016-09-11)</h2>
|
||||
<p id = "para-1113">This releases renders images differently when they are on a standalone paragraph or inside a paragraph.</p>
|
||||
<p id = "para-1115">This releases renders images differently when they are on a standalone paragraph or inside a paragraph.</p>
|
||||
<ul>
|
||||
<li><p id = "para-1114">Internal/API:</p>
|
||||
<li><p id = "para-1116">Internal/API:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1115"><code>Token</code> has a new variant, <code>StandaloneImage</code>. This is used to distinguish an image that is alone in a paragraph of an image that is inlined alongside text.</p>
|
||||
<li><p id = "para-1117"><code>Token</code> has a new variant, <code>StandaloneImage</code>. This is used to distinguish an image that is alone in a paragraph of an image that is inlined alongside text.</p>
|
||||
</li>
|
||||
<li><p id = "para-1116"><code>Parser.parse</code> method now distingues between <code>Image</code> and <code>StandaloneImage</code>. Currently, an image is considered “standalone” if it is the sole element of a paragraph, even if it is among a link.</p>
|
||||
<li><p id = "para-1118"><code>Parser.parse</code> method now distingues between <code>Image</code> and <code>StandaloneImage</code>. Currently, an image is considered “standalone” if it is the sole element of a paragraph, even if it is among a link.</p>
|
||||
</li>
|
||||
<li><p id = "para-1117"><code>Token</code> has a new <code>is_image</code> method.</p>
|
||||
<li><p id = "para-1119"><code>Token</code> has a new <code>is_image</code> method.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1118">Rendering:</p>
|
||||
<li><p id = "para-1120">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1119">Standalone images are now rendered differently than inline images (80% of width VS original size) in HTML/EPUB and LaTeX.</p>
|
||||
<li><p id = "para-1121">Standalone images are now rendered differently than inline images (80% of width VS original size) in HTML/EPUB and LaTeX.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-146">0.6.0 (2016-09-09)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1120">Deprecated options:</p>
|
||||
<li><p id = "para-1122">Deprecated options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1121"><code>nb_char</code>: since it was only used for french cleaner and for typography reasons it’s better to use different non breaking spaces according to context, this option was not really useful anymore.</p>
|
||||
<li><p id = "para-1123"><code>nb_char</code>: since it was only used for french cleaner and for typography reasons it’s better to use different non breaking spaces according to context, this option was not really useful anymore.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1122">Rendering:</p>
|
||||
<li><p id = "para-1124">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1123">Images are now displayed at 80% width of the page.</p>
|
||||
<li><p id = "para-1125">Images are now displayed at 80% width of the page.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1124">Bugfixes:</p>
|
||||
<li><p id = "para-1126">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1125">Image paths are now found correctly in LaTeX and EPUB rendering even if <code>crowbook</code> is called from another directory.</p>
|
||||
<li><p id = "para-1127">Image paths are now found correctly in LaTeX and EPUB rendering even if <code>crowbook</code> is called from another directory.</p>
|
||||
</li>
|
||||
<li><p id = "para-1126">Fixed a bug in <code>French</code> cleaner when a string to clean ended by a non-breaking space (space was doubled with a breaking one).</p>
|
||||
<li><p id = "para-1128">Fixed a bug in <code>French</code> cleaner when a string to clean ended by a non-breaking space (space was doubled with a breaking one).</p>
|
||||
</li>
|
||||
<li><p id = "para-1127">LaTeX/PDF:</p>
|
||||
<li><p id = "para-1129">LaTeX/PDF:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1128">“Autocleaning” is now also activated (for french at least) for LaTeX rendering, since it doesn’t correctly insert non-breaking spaces for e.g. ‘«’ or ‘»’.</p>
|
||||
<li><p id = "para-1130">“Autocleaning” is now also activated (for french at least) for LaTeX rendering, since it doesn’t correctly insert non-breaking spaces for e.g. ‘«’ or ‘»’.</p>
|
||||
</li>
|
||||
<li><p id = "para-1129">Fixed escaping of <code>--</code> to <code>-{}-</code> to avoid tex ligatures.</p>
|
||||
<li><p id = "para-1131">Fixed escaping of <code>--</code> to <code>-{}-</code> to avoid tex ligatures.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1130">HTML/EPUB:</p>
|
||||
<li><p id = "para-1132">HTML/EPUB:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1131"><code>html.display_chapter</code> now defaults to <code>false</code> (e.g., by default the HTML displays the entirety of a book).</p>
|
||||
<li><p id = "para-1133"><code>html.display_chapter</code> now defaults to <code>false</code> (e.g., by default the HTML displays the entirety of a book).</p>
|
||||
</li>
|
||||
<li><p id = "para-1132">Fixed rendering of lists when <code>lang</code> is set to <code>fr</code>.</p>
|
||||
<li><p id = "para-1134">Fixed rendering of lists when <code>lang</code> is set to <code>fr</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1133">Links are now HTML-escaped, fixing errors in XHTML (for EPUB rendering) when links contained ‘&’ character.</p>
|
||||
<li><p id = "para-1135">Links are now HTML-escaped, fixing errors in XHTML (for EPUB rendering) when links contained ‘&’ character.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -1133,37 +1137,37 @@ function toggle() {
|
|||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-147">0.5.1 (2016-04-14)</h2>
|
||||
<p id = "para-1134">Mostly rendering fixes:</p>
|
||||
<p id = "para-1136">Mostly rendering fixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1135">Epub:</p>
|
||||
<li><p id = "para-1137">Epub:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1136">Fix a validation problem when book contained hidden chapters.</p>
|
||||
<li><p id = "para-1138">Fix a validation problem when book contained hidden chapters.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1137">French cleaner:</p>
|
||||
<li><p id = "para-1139">French cleaner:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1138">Use semi-cadratine space instead of cadratine space for dialogs.</p>
|
||||
<li><p id = "para-1140">Use semi-cadratine space instead of cadratine space for dialogs.</p>
|
||||
</li>
|
||||
<li><p id = "para-1139">Use non-narrow non-breaking spapce instead of narrow one for ‘:’, ‘«’ and ‘»’ (following <a href = "https://fr.wikipedia.org/wiki/Espace_ins%C3%A9cable#En_France">https://fr.wikipedia.org/wiki/Espace_ins%C3%A9cable#En_France</a>).</p>
|
||||
<li><p id = "para-1141">Use non-narrow non-breaking spapce instead of narrow one for ‘:’, ‘«’ and ‘»’ (following <a href = "https://fr.wikipedia.org/wiki/Espace_ins%C3%A9cable#En_France">https://fr.wikipedia.org/wiki/Espace_ins%C3%A9cable#En_France</a>).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1140">HTML:</p>
|
||||
<li><p id = "para-1142">HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1141">Add viewport meta tags.</p>
|
||||
<li><p id = "para-1143">Add viewport meta tags.</p>
|
||||
</li>
|
||||
<li><p id = "para-1142">Standalone HTML:</p>
|
||||
<li><p id = "para-1144">Standalone HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1143">Don’t display the button to display chapter and the previous/next chapter link if <code>html.display_chapter</code> is set to <code>false</code>.</p>
|
||||
<li><p id = "para-1145">Don’t display the button to display chapter and the previous/next chapter link if <code>html.display_chapter</code> is set to <code>false</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1144">Fix chapter displaying when some chapters are not numbered.</p>
|
||||
<li><p id = "para-1146">Fix chapter displaying when some chapters are not numbered.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1145">Multi-files HTML:</p>
|
||||
<li><p id = "para-1147">Multi-files HTML:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1146">Fix previous/next chapter display to make it consistent with standalone HTML.</p>
|
||||
<li><p id = "para-1148">Fix previous/next chapter display to make it consistent with standalone HTML.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -1172,197 +1176,197 @@ function toggle() {
|
|||
</ul>
|
||||
<h2 id = "link-148">0.5.0 (2016-04-02)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1147">Crowbook now requires Rustc 1.7.0.</p>
|
||||
<li><p id = "para-1149">Crowbook now requires Rustc 1.7.0.</p>
|
||||
</li>
|
||||
<li><p id = "para-1148">It is now possible to render HTML in multiple files:</p>
|
||||
<li><p id = "para-1150">It is now possible to render HTML in multiple files:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1149"><code>output.html_dir</code> will activate this renderer, and specify in which directory to render these files;</p>
|
||||
<li><p id = "para-1151"><code>output.html_dir</code> will activate this renderer, and specify in which directory to render these files;</p>
|
||||
</li>
|
||||
<li><p id = "para-1150"><code>html_dir.css</code> allows to override the CSS for this rendering;</p>
|
||||
<li><p id = "para-1152"><code>html_dir.css</code> allows to override the CSS for this rendering;</p>
|
||||
</li>
|
||||
<li><p id = "para-1151"><code>html_dir.index.html</code> allows to specify a template for the <code>index.html</code> page;</p>
|
||||
<li><p id = "para-1153"><code>html_dir.index.html</code> allows to specify a template for the <code>index.html</code> page;</p>
|
||||
</li>
|
||||
<li><p id = "para-1152"><code>html_dir.chapter.html</code> allows to specify a template for the chapters pages.</p>
|
||||
<li><p id = "para-1154"><code>html_dir.chapter.html</code> allows to specify a template for the chapters pages.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1153">New book options:</p>
|
||||
<li><p id = "para-1155">New book options:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1154"><code>tex.short</code>: if set to true, the LaTeX renderer will use <code>article</code> instead of <code>book</code> as document class, and will use the default <code>\maketitle</code> command for article. This option is by default set to false, except when Crowbook is called with <code>--single</code>.</p>
|
||||
<li><p id = "para-1156"><code>tex.short</code>: if set to true, the LaTeX renderer will use <code>article</code> instead of <code>book</code> as document class, and will use the default <code>\maketitle</code> command for article. This option is by default set to false, except when Crowbook is called with <code>--single</code>.</p>
|
||||
</li>
|
||||
<li><p id = "para-1155"><code>enable_yaml_blocks</code>: parsing YAML blocks is no longer activated by default, except when using <code>--single</code>. This is because you might want to have e.g. multiple short stories using YAML blocks to set their titles and so on, <em>and</em> a separate <code>.book</code> file to render a book as a collection of short stories. In this case, you wouldn’t want the displayed title or the output.pdf/html/epub files be redefined by the short stories .md files.</p>
|
||||
<li><p id = "para-1157"><code>enable_yaml_blocks</code>: parsing YAML blocks is no longer activated by default, except when using <code>--single</code>. This is because you might want to have e.g. multiple short stories using YAML blocks to set their titles and so on, <em>and</em> a separate <code>.book</code> file to render a book as a collection of short stories. In this case, you wouldn’t want the displayed title or the output.pdf/html/epub files be redefined by the short stories .md files.</p>
|
||||
</li>
|
||||
<li><p id = "para-1156"><code>html.print_css</code>: allows to specify a stylesheet for media print</p>
|
||||
<li><p id = "para-1158"><code>html.print_css</code>: allows to specify a stylesheet for media print</p>
|
||||
</li>
|
||||
<li><p id = "para-1157"><code>html.display_chapter</code>: displays one chapter at a time in standalone HTML</p>
|
||||
<li><p id = "para-1159"><code>html.display_chapter</code>: displays one chapter at a time in standalone HTML</p>
|
||||
</li>
|
||||
<li><p id = "para-1158"><code>html.script</code>: allows to specify a custom javascript file for standalone HTML</p>
|
||||
<li><p id = "para-1160"><code>html.script</code>: allows to specify a custom javascript file for standalone HTML</p>
|
||||
</li>
|
||||
<li><p id = "para-1159"><code>html_dir.script</code>: same thing for multipage HTML</p>
|
||||
<li><p id = "para-1161"><code>html_dir.script</code>: same thing for multipage HTML</p>
|
||||
</li>
|
||||
<li><p id = "para-1160"><code>resources.base_path</code>: by default, Crowbook resolves local links in markdown files relatively to the markdown file. This option allows to resolve them relatively to a base path. This option comes with two variants, <code>resources.base_path.images</code> and <code>resources.base_path.links</code>, which only activate it for respectively images tags and links tags. These two options are ignored when <code>base_path</code> is set. There is also <code>resources.base_path.files</code> which specify where additional files (see below) should be read, but this is one is set to <code>.</code> (i.e., the directory where the <code>.book</code> file is) by default.</p>
|
||||
<li><p id = "para-1162"><code>resources.base_path</code>: by default, Crowbook resolves local links in markdown files relatively to the markdown file. This option allows to resolve them relatively to a base path. This option comes with two variants, <code>resources.base_path.images</code> and <code>resources.base_path.links</code>, which only activate it for respectively images tags and links tags. These two options are ignored when <code>base_path</code> is set. There is also <code>resources.base_path.files</code> which specify where additional files (see below) should be read, but this is one is set to <code>.</code> (i.e., the directory where the <code>.book</code> file is) by default.</p>
|
||||
</li>
|
||||
<li><p id = "para-1161"><code>resources.files</code>: indicate a (whitespace-separated) list of files that should be embedded. Currently only used with the EPUB renderer.</p>
|
||||
<li><p id = "para-1163"><code>resources.files</code>: indicate a (whitespace-separated) list of files that should be embedded. Currently only used with the EPUB renderer.</p>
|
||||
</li>
|
||||
<li><p id = "para-1162"><code>resources.out_path</code>: indicate where <code>resources.files</code> should be copied in the final document. Default to <code>data</code>, meaning that files will be placed in a <code>data</code> directory in the EPUB.</p>
|
||||
<li><p id = "para-1164"><code>resources.out_path</code>: indicate where <code>resources.files</code> should be copied in the final document. Default to <code>data</code>, meaning that files will be placed in a <code>data</code> directory in the EPUB.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1163">Rendering:</p>
|
||||
<li><p id = "para-1165">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1164">Templates can now use localized strings according to the <code>lang</code> option</p>
|
||||
<li><p id = "para-1166">Templates can now use localized strings according to the <code>lang</code> option</p>
|
||||
</li>
|
||||
<li><p id = "para-1165">Standalone HTML now includes locale files using base64.</p>
|
||||
<li><p id = "para-1167">Standalone HTML now includes locale files using base64.</p>
|
||||
</li>
|
||||
<li><p id = "para-1166">Standalone HTML displays one chapter at a time, thouht it can be changed via a button in the menu.</p>
|
||||
<li><p id = "para-1168">Standalone HTML displays one chapter at a time, thouht it can be changed via a button in the menu.</p>
|
||||
</li>
|
||||
<li><p id = "para-1167">HTML/EPUB: default CSS now uses the <code>lang</code> value do determine how to display lists (currently the only difference is it uses “–” when <code>lang</code> is set to “fr” and standard bullets for other languages).</p>
|
||||
<li><p id = "para-1169">HTML/EPUB: default CSS now uses the <code>lang</code> value do determine how to display lists (currently the only difference is it uses “–” when <code>lang</code> is set to “fr” and standard bullets for other languages).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1168">Bugfixes:</p>
|
||||
<li><p id = "para-1170">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1169">Fixed a bug of filename “resolution” when Crowbook was called with <code>--single</code> (e.g., <code>crowbook -s tests/test.md</code> would previously try to load `tests/tests/test.md).</p>
|
||||
<li><p id = "para-1171">Fixed a bug of filename “resolution” when Crowbook was called with <code>--single</code> (e.g., <code>crowbook -s tests/test.md</code> would previously try to load `tests/tests/test.md).</p>
|
||||
</li>
|
||||
<li><p id = "para-1170">Epub renderer now uses the <code>mime_guess</code> library to guess the mime type based on extension, which should fix the mime type guessed for a wide range of extensions (e.g., svg).</p>
|
||||
<li><p id = "para-1172">Epub renderer now uses the <code>mime_guess</code> library to guess the mime type based on extension, which should fix the mime type guessed for a wide range of extensions (e.g., svg).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1171">Internal/API:</p>
|
||||
<li><p id = "para-1173">Internal/API:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1172">The <code>Book::new</code>, <code>new_from_file</code>, and <code>new_from_markdown_file</code> take an additional <code>options</code> parameter. To create a book with default options, set it to <code>&[]</code>.</p>
|
||||
<li><p id = "para-1174">The <code>Book::new</code>, <code>new_from_file</code>, and <code>new_from_markdown_file</code> take an additional <code>options</code> parameter. To create a book with default options, set it to <code>&[]</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-149">0.4.0 (2016-03-01)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1173">Crowbook now internally uses a true YAML parser, <code>yaml_rust</code>, for its options. Since the “old” Crowbooks’s config format was similar, but had some subtle differences, this is somewhat of a breaking change:</p>
|
||||
<li><p id = "para-1175">Crowbook now internally uses a true YAML parser, <code>yaml_rust</code>, for its options. Since the “old” Crowbooks’s config format was similar, but had some subtle differences, this is somewhat of a breaking change:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1174">strings should now be escaped with “” in some cases (e.g. if it contains special characters). On the other hand, it <em>allows</em> to optionally escape a string with these quotes, which wasn’t possible until then and might be useful in some cases.</p>
|
||||
<li><p id = "para-1176">strings should now be escaped with “” in some cases (e.g. if it contains special characters). On the other hand, it <em>allows</em> to optionally escape a string with these quotes, which wasn’t possible until then and might be useful in some cases.</p>
|
||||
</li>
|
||||
<li><p id = "para-1175">multiline strings now follow the YAML format, instead of the previous “YAML-ish” format. This can impact the way newlines are added at the end of a multiline string. See e.g. <a href = "http://stackoverflow.com/questions/3790454/in-yaml-how-do-i-break-a-string-over-multiple-lines">this link</a> for the various ways to include mulitiline strings in Yaml.</p>
|
||||
<li><p id = "para-1177">multiline strings now follow the YAML format, instead of the previous “YAML-ish” format. This can impact the way newlines are added at the end of a multiline string. See e.g. <a href = "http://stackoverflow.com/questions/3790454/in-yaml-how-do-i-break-a-string-over-multiple-lines">this link</a> for the various ways to include mulitiline strings in Yaml.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1176">Crowbook now parses YAML blocks (delimited by two lines with “---”) in Markdown files, ignoring keys that it doesn’t recognize. This allows crowbook to be compatible(-ish) with Markdown that contains YAML blocks for Jekyll or Pandoc.</p>
|
||||
<li><p id = "para-1178">Crowbook now parses YAML blocks (delimited by two lines with “---”) in Markdown files, ignoring keys that it doesn’t recognize. This allows crowbook to be compatible(-ish) with Markdown that contains YAML blocks for Jekyll or Pandoc.</p>
|
||||
</li>
|
||||
<li><p id = "para-1177">New option <code>--single</code> allows to give Crowbook a single Markdown file (which can contain options within an inline YAML block) instead of a book configuration file. This is useful for e.g. short stories.</p>
|
||||
<li><p id = "para-1179">New option <code>--single</code> allows to give Crowbook a single Markdown file (which can contain options within an inline YAML block) instead of a book configuration file. This is useful for e.g. short stories.</p>
|
||||
</li>
|
||||
<li><p id = "para-1178">Enhanced the way debugging/warning/info messages are handled and displayed:</p>
|
||||
<li><p id = "para-1180">Enhanced the way debugging/warning/info messages are handled and displayed:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1179">Added a <code>--debug</code> option to the binary.</p>
|
||||
<li><p id = "para-1181">Added a <code>--debug</code> option to the binary.</p>
|
||||
</li>
|
||||
<li><p id = "para-1180">Internal: added a <code>Logger</code> struct.</p>
|
||||
<li><p id = "para-1182">Internal: added a <code>Logger</code> struct.</p>
|
||||
</li>
|
||||
<li><p id = "para-1181">Different levels of information (debug/warning/info/error) get different colours.</p>
|
||||
<li><p id = "para-1183">Different levels of information (debug/warning/info/error) get different colours.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1182">Bugfixes:</p>
|
||||
<li><p id = "para-1184">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1183">Crowbook no longer crashes when called with the <code>--to</code> argument if it can’t create a file.</p>
|
||||
<li><p id = "para-1185">Crowbook no longer crashes when called with the <code>--to</code> argument if it can’t create a file.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-150">0.3.0 (2016-02-27)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1184">Crowbook now tries to convert local links. That is, if you link to a Markdown file that is used in the book. (e.g. <a href = "chapter_000.html">README.md</a>), it <em>should</em> link to an appropriate inner reference inside the book.</p>
|
||||
<li><p id = "para-1186">Crowbook now tries to convert local links. That is, if you link to a Markdown file that is used in the book. (e.g. <a href = "chapter_000.html">README.md</a>), it <em>should</em> link to an appropriate inner reference inside the book.</p>
|
||||
</li>
|
||||
<li><p id = "para-1185">Latex renderer now supports (local) images.</p>
|
||||
<li><p id = "para-1187">Latex renderer now supports (local) images.</p>
|
||||
</li>
|
||||
<li><p id = "para-1186">Epub renderer now embed (local) images in the EPUB file.</p>
|
||||
<li><p id = "para-1188">Epub renderer now embed (local) images in the EPUB file.</p>
|
||||
</li>
|
||||
<li><p id = "para-1187">Some changes to the HTML/Epub stylesheets.</p>
|
||||
<li><p id = "para-1189">Some changes to the HTML/Epub stylesheets.</p>
|
||||
</li>
|
||||
<li><p id = "para-1188">Internal (or usage as a library):</p>
|
||||
<li><p id = "para-1190">Internal (or usage as a library):</p>
|
||||
<ul>
|
||||
<li><p id = "para-1189">Crowbook no longer changes current directory, which worked in the binary but could cause problem if library was used in multithreaded environment (e.g. in <code>cargo test</code>).</p>
|
||||
<li><p id = "para-1191">Crowbook no longer changes current directory, which worked in the binary but could cause problem if library was used in multithreaded environment (e.g. in <code>cargo test</code>).</p>
|
||||
</li>
|
||||
<li><p id = "para-1190">More modules and methods are now private.</p>
|
||||
<li><p id = "para-1192">More modules and methods are now private.</p>
|
||||
</li>
|
||||
<li><p id = "para-1191">Improved documentation.</p>
|
||||
<li><p id = "para-1193">Improved documentation.</p>
|
||||
</li>
|
||||
<li><p id = "para-1192">Added more unit tests.</p>
|
||||
<li><p id = "para-1194">Added more unit tests.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1193">Bugfixes:</p>
|
||||
<li><p id = "para-1195">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1194">Epub renderer now correctly renders unnumbered chapter without a number in its toc.ncx file</p>
|
||||
<li><p id = "para-1196">Epub renderer now correctly renders unnumbered chapter without a number in its toc.ncx file</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-151">0.2.2 (2016-02-25)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1195">Bugfixes:</p>
|
||||
<li><p id = "para-1197">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1196">French cleaner now correctly replaces space after — (in e.g. dialogs) with “em space”.</p>
|
||||
<li><p id = "para-1198">French cleaner now correctly replaces space after — (in e.g. dialogs) with “em space”.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-152">0.2.1 (2016-02-25)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1197">Bugfixes:</p>
|
||||
<li><p id = "para-1199">Bugfixes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1198">HTML/Epub rendering no longer incorrectly increment chapter count for unnumbered chapters.</p>
|
||||
<li><p id = "para-1200">HTML/Epub rendering no longer incorrectly increment chapter count for unnumbered chapters.</p>
|
||||
</li>
|
||||
<li><p id = "para-1199">Latex: makes what is possible to avoid orverflowing the page.</p>
|
||||
<li><p id = "para-1201">Latex: makes what is possible to avoid orverflowing the page.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1200">Minor changes:</p>
|
||||
<li><p id = "para-1202">Minor changes:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1201">Latex: improvement of the default way URLs are displayed.</p>
|
||||
<li><p id = "para-1203">Latex: improvement of the default way URLs are displayed.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-153">0.2.0 (2016-02-25)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1202">Command line arguments:</p>
|
||||
<li><p id = "para-1204">Command line arguments:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1203">New argument <code>--print-template</code> now allows to print a built-in template to stdout.</p>
|
||||
<li><p id = "para-1205">New argument <code>--print-template</code> now allows to print a built-in template to stdout.</p>
|
||||
</li>
|
||||
<li><p id = "para-1204">New argument <code>--list-options</code> prints out all valid options in a config file (or in <code>set</code>), their type and default value.</p>
|
||||
<li><p id = "para-1206">New argument <code>--list-options</code> prints out all valid options in a config file (or in <code>set</code>), their type and default value.</p>
|
||||
</li>
|
||||
<li><p id = "para-1205">New argument <code>--set</code> allows to define or override whatever option set in a book configuration.</p>
|
||||
<li><p id = "para-1207">New argument <code>--set</code> allows to define or override whatever option set in a book configuration.</p>
|
||||
</li>
|
||||
<li><p id = "para-1206"><code>--create</code> can now be used without specifying a <code>BOOK</code>, printing its result on <code>stdout</code>.</p>
|
||||
<li><p id = "para-1208"><code>--create</code> can now be used without specifying a <code>BOOK</code>, printing its result on <code>stdout</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1207">Configuration file:</p>
|
||||
<li><p id = "para-1209">Configuration file:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1208">Added support for multiline strings in <code>.book</code> files, with either ‘|’ (preserving line returns) or ‘>’ (transforming line returns in spaces)</p>
|
||||
<li><p id = "para-1210">Added support for multiline strings in <code>.book</code> files, with either ‘|’ (preserving line returns) or ‘>’ (transforming line returns in spaces)</p>
|
||||
</li>
|
||||
<li><p id = "para-1209">New option <code>display_toc</code> allows to display the table of contents (whose name, at least for HTML, is specified by <code>toc_name</code>) in HTML and PDF documents.</p>
|
||||
<li><p id = "para-1211">New option <code>display_toc</code> allows to display the table of contents (whose name, at least for HTML, is specified by <code>toc_name</code>) in HTML and PDF documents.</p>
|
||||
</li>
|
||||
<li><p id = "para-1210">Option <code>numbering</code> now takes an int instead of a boolean, allowing to specify the maximum level to number (e.g. <code>1</code>: chapters only, <code>2</code>: chapters and sectino, ..., <code>6</code>: everything).</p>
|
||||
<li><p id = "para-1212">Option <code>numbering</code> now takes an int instead of a boolean, allowing to specify the maximum level to number (e.g. <code>1</code>: chapters only, <code>2</code>: chapters and sectino, ..., <code>6</code>: everything).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1211">Rendering:</p>
|
||||
<li><p id = "para-1213">Rendering:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1212">Added support for numbering all headers, not just level-1 (e.g., having a subsection numbered <code>2.3.1</code>).</p>
|
||||
<li><p id = "para-1214">Added support for numbering all headers, not just level-1 (e.g., having a subsection numbered <code>2.3.1</code>).</p>
|
||||
</li>
|
||||
<li><p id = "para-1213">Tables and Footnotes are now implemented for HTML/Epub and LaTeX output.</p>
|
||||
<li><p id = "para-1215">Tables and Footnotes are now implemented for HTML/Epub and LaTeX output.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p id = "para-1214">Internal:</p>
|
||||
<li><p id = "para-1216">Internal:</p>
|
||||
<ul>
|
||||
<li><p id = "para-1215">Refactored <code>Book</code> to use an HashMap of <code>BookOption</code>s instead of having like 42 fields.</p>
|
||||
<li><p id = "para-1217">Refactored <code>Book</code> to use an HashMap of <code>BookOption</code>s instead of having like 42 fields.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id = "link-154">0.1.0 (2016-02-21)</h2>
|
||||
<ul>
|
||||
<li><p id = "para-1216">initial release</p>
|
||||
<li><p id = "para-1218">initial release</p>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -1372,7 +1376,7 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1293">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1295">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1296">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1298">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -219,36 +219,36 @@ function toggle() {
|
|||
</a>
|
||||
</p>
|
||||
<h1 id = 'link-155'>GNU LESSER GENERAL PUBLIC LICENSE</h1><pre><span style="color:#839496;"> Version 2.1, February 1999
|
||||
</span></pre><p id = "para-1217">Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.</p>
|
||||
<p id = "para-1218">[This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.]</p>
|
||||
</span></pre><p id = "para-1219">Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.</p>
|
||||
<p id = "para-1220">[This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.]</p>
|
||||
<pre><span style="color:#839496;"> Preamble
|
||||
</span></pre><p id = "para-1219">The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users.</p>
|
||||
<p id = "para-1220">This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below.</p>
|
||||
<p id = "para-1221">When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things.</p>
|
||||
<p id = "para-1222">To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it.</p>
|
||||
<p id = "para-1223">For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights.</p>
|
||||
<p id = "para-1224">We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library.</p>
|
||||
<p id = "para-1225">To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author’s reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license.</p>
|
||||
<p id = "para-1226">Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs.</p>
|
||||
<p id = "para-1227">When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library.</p>
|
||||
<p id = "para-1228">We call this license the “Lesser” General Public License because it does Less to protect the user’s freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances.</p>
|
||||
<p id = "para-1229">For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License.</p>
|
||||
<p id = "para-1230">In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system.</p>
|
||||
<p id = "para-1231">Although the Lesser General Public License is Less protective of the users’ freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library.</p>
|
||||
<p id = "para-1232">The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a “work based on the library” and a “work that uses the library”. The former contains code derived from the library, whereas the latter must be combined with the library in order to run. GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</p>
|
||||
</span></pre><p id = "para-1221">The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users.</p>
|
||||
<p id = "para-1222">This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below.</p>
|
||||
<p id = "para-1223">When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things.</p>
|
||||
<p id = "para-1224">To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it.</p>
|
||||
<p id = "para-1225">For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights.</p>
|
||||
<p id = "para-1226">We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library.</p>
|
||||
<p id = "para-1227">To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author’s reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license.</p>
|
||||
<p id = "para-1228">Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs.</p>
|
||||
<p id = "para-1229">When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library.</p>
|
||||
<p id = "para-1230">We call this license the “Lesser” General Public License because it does Less to protect the user’s freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances.</p>
|
||||
<p id = "para-1231">For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License.</p>
|
||||
<p id = "para-1232">In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system.</p>
|
||||
<p id = "para-1233">Although the Lesser General Public License is Less protective of the users’ freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library.</p>
|
||||
<p id = "para-1234">The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a “work based on the library” and a “work that uses the library”. The former contains code derived from the library, whereas the latter must be combined with the library in order to run. GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</p>
|
||||
<ol start = "0">
|
||||
<li><p id = "para-1233">This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called “this License”). Each licensee is addressed as “you”.</p>
|
||||
<li><p id = "para-1235">This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called “this License”). Each licensee is addressed as “you”.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1234">A “library” means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables.</p>
|
||||
<p id = "para-1235">The “Library”, below, refers to any such software library or work which has been distributed under these terms. A “work based on the Library” means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term “modification”.)</p>
|
||||
<p id = "para-1236">“Source code” for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library.</p>
|
||||
<p id = "para-1237">Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does.</p>
|
||||
<p id = "para-1236">A “library” means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables.</p>
|
||||
<p id = "para-1237">The “Library”, below, refers to any such software library or work which has been distributed under these terms. A “work based on the Library” means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term “modification”.)</p>
|
||||
<p id = "para-1238">“Source code” for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library.</p>
|
||||
<p id = "para-1239">Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does.</p>
|
||||
<ol>
|
||||
<li><p id = "para-1238">You may copy and distribute verbatim copies of the Library’s complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library.</p>
|
||||
<li><p id = "para-1240">You may copy and distribute verbatim copies of the Library’s complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1239">You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:</p>
|
||||
<p id = "para-1241">You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:</p>
|
||||
<pre><span style="color:#839496;">a) The modified work must itself be a software library.
|
||||
|
||||
b) You must cause the files modified to carry prominent notices
|
||||
|
|
@ -271,28 +271,28 @@ application. Therefore, Subsection 2d requires that any
|
|||
application-supplied function or table used by this function must
|
||||
be optional: if the application does not supply it, the square
|
||||
root function must still compute square roots.)
|
||||
</span></pre><p id = "para-1240">These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.</p>
|
||||
<p id = "para-1241">Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library.</p>
|
||||
<p id = "para-1242">In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.</p>
|
||||
</span></pre><p id = "para-1242">These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.</p>
|
||||
<p id = "para-1243">Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library.</p>
|
||||
<p id = "para-1244">In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.</p>
|
||||
<ol start = "3">
|
||||
<li><p id = "para-1243">You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy.</p>
|
||||
<li><p id = "para-1245">You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1244">This option is useful when you wish to copy part of the code of the Library into a program that is not a library.</p>
|
||||
<p id = "para-1246">This option is useful when you wish to copy part of the code of the Library into a program that is not a library.</p>
|
||||
<ol start = "4">
|
||||
<li><p id = "para-1245">You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange.</p>
|
||||
<li><p id = "para-1247">You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1246">If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code.</p>
|
||||
<p id = "para-1248">If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code.</p>
|
||||
<ol start = "5">
|
||||
<li><p id = "para-1247">A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a “work that uses the Library”. Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License.</p>
|
||||
<li><p id = "para-1249">A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a “work that uses the Library”. Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1248">However, linking a “work that uses the Library” with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a “work that uses the library”. The executable is therefore covered by this License. Section 6 states terms for distribution of such executables.</p>
|
||||
<p id = "para-1249">When a “work that uses the Library” uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law.</p>
|
||||
<p id = "para-1250">If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.)</p>
|
||||
<p id = "para-1251">Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a “work that uses the Library” with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer’s own use and reverse engineering for debugging such modifications.</p>
|
||||
<p id = "para-1252">You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things:</p>
|
||||
<p id = "para-1250">However, linking a “work that uses the Library” with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a “work that uses the library”. The executable is therefore covered by this License. Section 6 states terms for distribution of such executables.</p>
|
||||
<p id = "para-1251">When a “work that uses the Library” uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law.</p>
|
||||
<p id = "para-1252">If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.)</p>
|
||||
<p id = "para-1253">Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a “work that uses the Library” with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer’s own use and reverse engineering for debugging such modifications.</p>
|
||||
<p id = "para-1254">You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things:</p>
|
||||
<pre><span style="color:#839496;">a) Accompany the work with the complete corresponding
|
||||
machine-readable source code for the Library including whatever
|
||||
changes were used in the work (which must be distributed under
|
||||
|
|
@ -324,8 +324,8 @@ specified materials from the same place.
|
|||
|
||||
e) Verify that the user has already received a copy of these
|
||||
materials or that you have already sent this user a copy.
|
||||
</span></pre><p id = "para-1253">For an executable, the required form of the “work that uses the Library” must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.</p>
|
||||
<p id = "para-1254">It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things:</p>
|
||||
</span></pre><p id = "para-1255">For an executable, the required form of the “work that uses the Library” must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.</p>
|
||||
<p id = "para-1256">It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things:</p>
|
||||
<pre><span style="color:#839496;">a) Accompany the combined library with a copy of the same work
|
||||
based on the Library, uncombined with any other library
|
||||
facilities. This must be distributed under the terms of the
|
||||
|
|
@ -335,36 +335,36 @@ b) Give prominent notice with the combined library of the fact
|
|||
that part of it is a work based on the Library, and explaining
|
||||
where to find the accompanying uncombined form of the same work.
|
||||
</span></pre><ol start = "8">
|
||||
<li><p id = "para-1255">You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.</p>
|
||||
<li><p id = "para-1257">You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.</p>
|
||||
</li>
|
||||
<li><p id = "para-1256">You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it.</p>
|
||||
<li><p id = "para-1258">You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it.</p>
|
||||
</li>
|
||||
<li><p id = "para-1257">Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients’ exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. </p>
|
||||
<li><p id = "para-1259">Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients’ exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. </p>
|
||||
</li>
|
||||
<li><p id = "para-1258">If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library.</p>
|
||||
<li><p id = "para-1260">If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1259">If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances.</p>
|
||||
<p id = "para-1260">It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.</p>
|
||||
<p id = "para-1261">This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.</p>
|
||||
<p id = "para-1261">If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances.</p>
|
||||
<p id = "para-1262">It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.</p>
|
||||
<p id = "para-1263">This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.</p>
|
||||
<ol start = "12">
|
||||
<li><p id = "para-1262">If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.</p>
|
||||
<li><p id = "para-1264">If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.</p>
|
||||
</li>
|
||||
<li><p id = "para-1263">The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.</p>
|
||||
<li><p id = "para-1265">The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p id = "para-1264">Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and “any later version”, you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.</p>
|
||||
<p id = "para-1266">Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and “any later version”, you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.</p>
|
||||
<pre><span style="color:#839496;"> NO WARRANTY
|
||||
</span></pre><ol start = "15">
|
||||
<li><p id = "para-1265">BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p>
|
||||
<li><p id = "para-1267">BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p>
|
||||
</li>
|
||||
<li><p id = "para-1266">IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</p>
|
||||
<li><p id = "para-1268">IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</p>
|
||||
<pre><span style="color:#839496;"> END OF TERMS AND CONDITIONS
|
||||
</span></pre></li>
|
||||
</ol>
|
||||
<p id = "para-1267"> How to Apply These Terms to Your New Libraries</p>
|
||||
<p id = "para-1268">If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License).</p>
|
||||
<p id = "para-1269">To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.</p>
|
||||
<p id = "para-1269"> How to Apply These Terms to Your New Libraries</p>
|
||||
<p id = "para-1270">If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License).</p>
|
||||
<p id = "para-1271">To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.</p>
|
||||
<pre><span style="color:#839496;"><one line to give the library's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
|
|
@ -381,15 +381,15 @@ Lesser General Public License for more details.
|
|||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
</span></pre><p id = "para-1270">Also add information on how to contact you by electronic and paper mail.</p>
|
||||
<p id = "para-1271">You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the library, if necessary. Here is a sample; alter the names:</p>
|
||||
<p id = "para-1272">Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob’ (a library for tweaking knobs) written by James Random Hacker.</p>
|
||||
<p id = "para-1273"><signature of Ty Coon>, 1 April 1990 Ty Coon, President of Vice</p>
|
||||
<p id = "para-1274">That’s all there is to it!</p>
|
||||
</span></pre><p id = "para-1272">Also add information on how to contact you by electronic and paper mail.</p>
|
||||
<p id = "para-1273">You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the library, if necessary. Here is a sample; alter the names:</p>
|
||||
<p id = "para-1274">Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob’ (a library for tweaking knobs) written by James Random Hacker.</p>
|
||||
<p id = "para-1275"><signature of Ty Coon>, 1 April 1990 Ty Coon, President of Vice</p>
|
||||
<p id = "para-1276">That’s all there is to it!</p>
|
||||
|
||||
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1295">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1297">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -186,7 +186,7 @@ function toggle() {
|
|||
</nav>
|
||||
|
||||
<div id = "content">
|
||||
<div id = "top"><p id = "para-1297">Crowbook User Guide 0.14.0</p>
|
||||
<div id = "top"><p id = "para-1299">Crowbook User Guide 0.14.0</p>
|
||||
</div>
|
||||
<div id = "page">
|
||||
<header>
|
||||
|
|
@ -211,7 +211,7 @@ function toggle() {
|
|||
</p>
|
||||
|
||||
</div>
|
||||
<footer id = "footer"><p id = "para-1298">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-unreleased</p>
|
||||
<footer id = "footer"><p id = "para-1300">Generated by <a href = "https://github.com/lise-henry/crowbook">Crowbook</a> 0.15.0-beta2</p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
|||
Loading…
Reference in New Issue