mirror/crowbook
1
0
Fork 0
mirror of https://github.com/lise-henry/crowbook synced 2024-09-21 08:11:35 +02:00
Code Issues
8a3a0f6488
crowbook/guide/config.md
Elisabeth Henry 8a3a0f6488 Update config.md
2016-10-13 06:13:03 +02:00

688 lines
20 KiB
Markdown
Raw Blame History

The configuration file
======================
If you want to use Crowbook for your book, this configuration file
is all you'll have to add (assuming you already have the book in
Markdown files; if you don't, you'll also have to write a book first,
but that's besides the scope of this document).
The format is not very complicated. This is an example of it:
```yaml
# metadata
author: Joan Doe
title: Some book
lang: en
output.html: some_book.html
# list of chapters
- preface.md
+ chapter_1.md
+ chapter_2.md
+ chapter_3.md
+ chapter_4.md
- epilogue.md
```
Basically, it is divided in two parts:
* a list of options, under the form `key: value`, following YAML syntax.
* a list of Markdown files.
Lines starting with the `#` characters are comments and are discarded.
The list of files
-----------------
There are various options to include a markdown file.
* `+ file_name.md` includes a numbered chapter.
* `- file_name.md` includes an unnumbered chapter.
* `! file_name.md` includes a chapter whose title won't be displayed
(except in the table of contents); this is useful for e.g. including a
copyright at the beginning or the book, or for short stories where
there is only one chapter.
* `42. file_name.md` specifies the number for a chapter.
So a typical usage might look like this:
```yaml
! copyright.md
- preface.md
# We want first chapter to be Chapter 0 because we are programmers!
0. chapter_0.md
# Next chapters can be numbered automatically
+ chapter_1.md
+ chapter_2.md
...
```
There are two important things to note:
1. you must *not* use quotes around the file names.
2. the path of these files are relative to the directory where your
configuration file is. This means you can run `crowbook
books/my_trilogy/first_book/config.book` without being in the
book's directory.
Also note that you don't have to specify a title. This is because the title
of the chapter is inferred from the Markdown document. To go back to
our previous example:
```
+ chapter_1.md
```
does not specify a chapter title, because it will read it directly in
`chapter_1.md`, e.g.:
```markdown
The day I was born
==================
...
```
You should have one and only one level-one header (i.e. chapter title)
in each markdown file.
If you have more than one, Crowbook will print a warning and treat it
as another chapter (numbered according to the scheme specified for
including the file). It might however mess the table of contents in
some cases (e.g. for Epub).
If you do *not* have a level-1 header in a
markdown file:
* if it is a numbered chapter, Crowbook will infer a chapter name from
the numbering scheme;
* if it is not numbered, chapter's title will default to the empty
string and won't be displayed in the TOC.
Crowbook options
----------------
The first part of the configuration file is dedicated to pass options
to Crowbook. This is
[YAML syntax](https://en.wikipedia.org/wiki/YAML), so each line should
be of the form `key: value`. Note that in most cases you don't have to
put string in quotes, e.g.:
```yaml
title: My title
```
It is however possible (and sometimes necessary) to escape some
characters to use quotes around strings:
```yaml
title: "My: title!"
```
It is possible to use multiline strings with `>-` and
then indenting the lines that are part of the string:
```yaml
title: >-
A
long
title
author: Joan Doe
```
will set `title` to `"A long title"`. See
[block literals in YAML](https://en.wikipedia.org/wiki/YAML#Block_literals)
for more information on the various way to insert multiline strings
(which mostly change the way newlines will or won't be inserted).
A final note on the syntax: all options must be set *before* the first
chapter inclusion (that is, a line beginning with '+', '-', 'x.'
(where `x` is a number) or '!').
Here is the complete list of options, with a short description. The
usage of some of them is detailed later on.
### Metadata ###
- **`author`**
- **type**: string
- **default value**: `Anonymous`
- Author of the book
- **`title`**
- **type**: string
- **default value**: `Untitled`
- Title of the book
- **`lang`**
- **type**: string
- **default value**: `en`
- Language of the book
- **`subject`**
- **type**: string
- **default value**: `not set`
- Subject of the book (used for EPUB metadata)
- **`description`**
- **type**: string
- **default value**: `not set`
- Description of the book (used for EPUB metadata)
- **`cover`**
- **type**: path
- **default value**: `not set`
- Path to the cover of the book
### Additional metadata ###
- **`license`**
- **type**: string
- **default value**: `not set`
- License of the book
- **`version`**
- **type**: string
- **default value**: `not set`
- Version of the book
- **`date`**
- **type**: string
- **default value**: `not set`
- Date the book was revised
### Output options ###
- **`output.epub`**
- **type**: path
- **default value**: `not set`
- Output file name for EPUB rendering
- **`output.html`**
- **type**: path
- **default value**: `not set`
- Output file name for HTML rendering
- **`output.html_dir`**
- **type**: path
- **default value**: `not set`
- Output directory name for HTML rendering
- **`output.tex`**
- **type**: path
- **default value**: `not set`
- Output file name for LaTeX rendering
- **`output.pdf`**
- **type**: path
- **default value**: `not set`
- Output file name for PDF rendering
- **`output.odt`**
- **type**: path
- **default value**: `not set`
- Output file name for ODT rendering
- **`output.base_path`**
- **type**: path
- **default value**: `""`
- Directory where those output files will we written
### Rendering options ###
- **`rendering.initials`**
- **type**: boolean
- **default value**: `false`
- Use initials ('lettrines') for first letter of a chapter (experimental)
- **`rendering.inline_toc`**
- **type**: boolean
- **default value**: `false`
- Display a table of content in the document
- **`rendering.inline_toc.name`**
- **type**: string
- **default value**: `"{{{loc_toc}}}"`
- Name of the table of contents if it is displayed in document
- **`rendering.num_depth`**
- **type**: integer
- **default value**: `1`
- The maximum heading levels that should be numbered (0: no numbering, 1: only chapters, ..., 6: all)
- **`rendering.chapter_template`**
- **type**: string
- **default value**: `"{{{number}}}\\. {{{chapter_title}}}"`
- Naming scheme of chapters
### Special option ###
- **`import_config`**
- **type**: path
- **default value**: `not set`
- Import another book configuration file
### HTML options ###
- **`html.header`**
- **type**: string
- **default value**: `not set`
- Custom header to display at the beginning of html file(s)
- **`html.footer`**
- **type**: string
- **default value**: `not set`
- Custom footer to display at the end of HTML file(s)
- **`html.css`**
- **type**: template path
- **default value**: `not set`
- Path of a stylesheet for HTML rendering
- **`html.js`**
- **type**: template path
- **default value**: `not set`
- Path of a javascript file
- **`html.css.print`**
- **type**: template path
- **default value**: `not set`
- Path of a media print stylesheet for HTML rendering
- **`html.highlight_code`**
- **type**: boolean
- **default value**: `true`
- Provides syntax highlighting for code blocks (using highlight.js)
- **`html.highlight.js`**
- **type**: template path
- **default value**: `not set`
- Set another highlight.js version than the bundled one
- **`html.highlight.css`**
- **type**: template path
- **default value**: `not set`
- Set another highlight.js CSS theme than the default one
- **`html.side_notes`**
- **type**: boolean
- **default value**: `false`
- Display footnotes as side notes in HTML/Epub (experimental)
- **`html.escape_nb_spaces`**
- **type**: boolean
- **default value**: `true`
- Replace unicode non breaking spaces with HTML entities and CSS
### Standalone HTML options ###
- **`html_single.one_chapter`**
- **type**: boolean
- **default value**: `false`
- Display only one chapter at a time (with a button to display all)
- **`html_single.html`**
- **type**: template path
- **default value**: `not set`
- Path of an HTML template
- **`html_single.js`**
- **type**: template path
- **default value**: `not set`
- Path of a javascript file
### Multifile HTML options ###
- **`html_dir.index.html`**
- **type**: template path
- **default value**: `not set`
- Path of index.html template
- **`html_dir.chapter.html`**
- **type**: template path
- **default value**: `not set`
- Path of a chapter.html template
### EPUB options ###
- **`epub.version`**
- **type**: integer
- **default value**: `2`
- EPUB version to generate (2 or 3)
- **`epub.css`**
- **type**: template path
- **default value**: `not set`
- Path of a stylesheet for EPUB
- **`epub.chapter.xhtml`**
- **type**: template path
- **default value**: `not set`
- Path of an xhtml template for each chapter
### LaTeX options ###
- **`tex.links_as_footnotes`**
- **type**: boolean
- **default value**: `true`
- Add foontotes to URL of links so they are readable when printed
- **`tex.command`**
- **type**: string
- **default value**: `xelatex`
- LaTeX command to use for generating PDF
- **`tex.template`**
- **type**: template path
- **default value**: `not set`
- Path of a LaTeX template file
- **`tex.class`**
- **type**: string
- **default value**: `book`
- LaTeX class to use
### Resources option ###
- **`resources.files`**
- **type**: string
- **default value**: `not set`
- Whitespace-separated list of files to embed in e.g. EPUB file; useful for including e.g. fonts
- **`resources.base_path`**
- **type**: path
- **default value**: `not set`
- Path where to find resources (in the source tree). By default, links and images are relative to the Markdown file. If this is set, it will be to this path.
- **`resources.base_path.links`**
- **type**: path
- **default value**: `not set`
- Set base path but only for links. Useless if resources.base_path is set.
- **`resources.base_path.images`**
- **type**: path
- **default value**: `.`
- Set base path but only for images. Useless if resources.base_path is set.
- **`resources.base_path.files`**
- **type**: path
- **default value**: `.`
- Set base path but only for additional files. Useless if resources.base_path is set.
- **`resources.base_path.templates`**
- **type**: path
- **default value**: `.`
- Set base path but only for templates files. Useless if resources.base_path is set.
- **`resources.out_path`**
- **type**: path
- **default value**: `data`
- Paths where additional resources should be copied in the EPUB file or HTML directory
### Input options ###
- **`input.autoclean`**
- **type**: boolean
- **default value**: `true`
- Toggle cleaning of input markdown according to lang
- **`input.yaml_blocks`**
- **type**: boolean
- **default value**: `false`
- Enable inline YAML blocks to override options set in config file
### Crowbook options ###
- **`crowbook.temp_dir`**
- **type**: path
- **default value**: ``
- Path where to create a temporary directory (default: uses result from Rust's std::env::temp_dir())
- **`crowbook.zip.command`**
- **type**: string
- **default value**: `zip`
- Command to use to zip files (for EPUB/ODT)
- **`crowbook.verbose`**
- **type**: boolean
- **default value**: `false`
- Make Crowbook display more messages
### Output options (for proofreading) ###
- **`output.proofread.html`**
- **type**: path
- **default value**: `not set`
- Output file name for HTML rendering with proofread features
- **`output.proofread.html_dir`**
- **type**: path
- **default value**: `not set`
- Output directory name for HTML rendering with proofread features
- **`output.proofread.pdf`**
- **type**: path
- **default value**: `not set`
- Output file name for PDF rendering with proofread features
### Proofreading options (only for output.proofread.* targets) ###
- **`proofread`**
- **type**: boolean
- **default value**: `false`
- Activate generation of proofreading copies
- **`proofread.nb_spaces`**
- **type**: boolean
- **default value**: `true`
- Highlight non breaking spaces so it is easier to see if typography is correct
- **`proofread.languagetool`**
- **type**: boolean
- **default value**: `false`
- If true, try to use language tool server to grammar check the book
- **`proofread.languagetool.port`**
- **type**: integer
- **default value**: `8081`
- Port to connect to languagetool-server
- **`proofread.repetitions`**
- **type**: boolean
- **default value**: `false`
- If set to true, use Caribon to detect repetitions
- **`proofread.repetitions.max_distance`**
- **type**: integer
- **default value**: `25`
- Max distance between two occurences so it is considered a repetition
- **`proofread.repetitions.fuzzy`**
- **type**: boolean
- **default value**: `true`
- Enable fuzzy string matching
- **`proofread.repetitions.fuzzy.threshold`**
- **type**: float
- **default value**: `0.2`
- Max threshold of differences to consider two strings a repetition
- **`proofread.repetitions.ignore_proper`**
- **type**: boolean
- **default value**: `true`
- Ignore proper nouns for repetitions
- **`proofread.repetitions.threshold`**
- **type**: float
- **default value**: `2.0`
- Threshold to detect a repetition
```
Note that these options have a type, which in most case should be
pretty straightforward (a boolean can be `true` or `false`, an integer
must be composed by a number, a string is, well, any string). The `path`
type might puzzle you a
bit, but it's equivalent to a string, except Crowbook will consider it
relatively to the book file. The `template path` type is just the
`path` of a template. Metadata are just strings.
### Metadata ###
Metadata are data about the book. Except for `cover`, which points to
an image file, all its fields are strings. The main metadata are:
* `author`: the author(s) of the book.
* `title`: the title of the book.
* `lang`: the language of the book. The unicode language code should
be used, e.g. `en_GB` or `en`, `fr_FR`, ...
* `cover`: path to an image file for the cover of the book (notdisplayed in all output formats).
There are also additional metadata:
* `subject`
* `description`
* `license`
* `version`
* `date`
You can define your own metadata by starting an option name with
`metadata.foo`.
All metadata are accessible from templates, see
[Templates](templates.md).
### The `import_config` special option ###
The special `import_config` option allows you to include the options
of another book configuration file in this file. E.g., assuming that
you some common options that you want to be applied to both `foo.book`
and `bar.book`, you can create a `common.book` file:
```yaml
author: Joan Doe
lang: en
license: "Copyright (C) Joan Doe. All rights reserved."
html.header: "[Joan Doe's website](http://joan-doe.com)"
tex.template: my_template.tex
```
You can then include this file in `foo.book`:
```yaml
import_config: common.book
title: Foo
+ foo_01.md
+ foo_02.md
```
Or include it in `bar.book`, but overriding some of its features:
```yaml
import_config: common.book
title: Bar
license: CC-BY-SA # Override the license from common.book
+ bar_01.md
```
### Output options ###
These options specify which files to generate. You must at least set
one of this option, or Crowbook won't do anything.
Recall that all file paths are relative to the directory where the
config file is, not to the one where you run `crowbook`. So if you set
```yaml
output.epub = foo.epub
```
and runs
```bash
$ crowbook some/dir/config.book
```
`foo.epub` will be generated in `some/dir`, not in your current
directory.
Crowbook will try to generate each of the `output.xxx` files that are
specified. That means that you'll have to set at least one of those if you want a call to
```bash
$ crowbook my.book
```
to generate anything. (It's still possible to generate a specific
format, and only this one, by using the `--to` argument on the command
line).
Note that some formats depend on some commands being installed on your
system. Most notably, Crowbook depends on LaTeX (`xelatex` by
default, though you can specify the command to use with `tex.command`) to generate a PDF file,
so PDF rendering won't work if it is not installed on your
system. Crowbook also uses the `zip` command to generate the EPUB and
ODT, files.
Current output options are:
* `output.html`: renders a standalone HTML file;
* `output.html_dir`: render a HTML directory with one page by chapter;
* `output.epub`: renders an EPUB file;
* `output.tex`: renders a LaTeX file;
* `output.pdf`: renders a PDF file (using `tex.command`).
(There are other output options for generating proofreading files, see
[Proofreading](proofreading.md).)
#### `output.base_path` ####
Additionally, the `output.base_path` option allows you to set where
the output files will be written (relatively to the book configuration
file). E.g.,
```yaml
output.base_path: docs/book
output.epub: book.epub
```
will render the EPUB file in `docs/book/book.epub`.
### Generic options for rendering ###
These options allow to configure the rendering for all formats.
#### rendering.num_depth ####
An integer that represents the maximum level of numbering for your
book. E.g., `1` will only number chapters, while `2` will number
chapters, sections, but not anything below that. `6` is the maximum level
and turns numbering on for all headers.
**default**: `1`
#### rendering.chapter_template ####
A string that will be used for chapter titles. You can use `{{{number}}}` and
`{{{title}}}` in this string, e.g.:
```yaml
numbering_template: "Chapter {{{number}} {{title}}}"
```
Note that:
* in this case, quoting is necessary because `{` and `}` have special
meaning in YAML;
* this string won't be used for unnumbered chapters;
* this string isn't currently used by LaTeX, either.
#### rendering.inline_toc ####
If set to true, Crowbook will include a table of contents at the
beginning of the document.
#### rendering.initials ####
If set to true, Crowbook will use initials, or "lettrines", displaying
the first letter of each chapter bigger than the others.
### Resources options ###
These options allow to embed additional files for some formats
(currently, only EPUB). This can be useful for embedding fonts.
#### resources.files ####
A list of files or directories that should be added. It's a
whitespace-separated list, so it can be, e.g.:
```yaml
resources.files: font1.otf font2.otf
```
It is also possible to specify a directory (or multiple
directories). So if you have a `fonts` directories containing
`font1.otf` and `font2.otf`,
```yaml
resources.files: fonts
```
will be equivalent to:
```yaml
resources.files: fonts/font1.otf fonts/font2.otf
```
**default**: not set
#### resources.out_path ####
This option determine where (in which directory), *in the resulting
document*, will those files be copied. The default is `data`, so by
default the `resources.files` in the first example above will search
`font1.otf` and `font2.otf` *in the same directory than the `.book`
file, and will copy them to `data/font1.otf` and `data/font2.otf` *in
the EPUB file*. This is therefore this last path that you should use
if you want to access those files e.g. in a custom CSS stylesheet.
Note that if you pass directories to `resources.files`, the whole
directory would be copied. So assuming `fonts/` contains `font1.otf`
and `font2.otf`
```yaml
resources.files: fonts
resources.path: data
```
will copy these two files to `data/fonts/font1.otf` and
`data/fonts/font2.otf` (and not `data/font1.otf` and `data/font2.otf`).
Similarly, the whole path of `resources.files` is copied, so
```yaml
resources.files: fonts/font1.otf fonts/font2.otf
```
will yield the same result.
**default**: `data`
View Git Blame Copy Permalink