mirror/ crowbook
1
0
Fork 0
mirror of https://github.com/lise-henry/crowbook synced 2024-05-28 14:06:29 +02:00
Code Issues

Updated documentation

This commit is contained in:
Elisabeth Henry 2016-02-21 02:06:14 +01:00
parent 80e0d50c53
commit a8a51235f1
4 changed files with 35 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Bugs.md
View File

@ -5,6 +5,7 @@ Bugs
* epub: no way to embed custom files to epub
* markdown: no support for footnotes and tables
* latex: no support for links and images
* odt: no support for... a lot of stuff, actually
* config: can't handle multiline string (and really, isn't there
an existing format for that?)
* config: can't parse specified numbers for negative chapter (is it

7
README.md
View File

@ -76,13 +76,14 @@ Features
--------
### Done ###
* Support for some simple formatconfiguration files to
* Support for some simple format configuration files to
list chapters and metadatas, so you just run `crowbook
some_file` and you don't have to pass more options, it generates the
rest.
* Support for Epub2 and Epub3 format as output.
* Support for LaTeX format as output, and PDF through it.
* Support for HTML format as output.
* Partial support for LaTeX format as output, and PDF through it.
* Experimental support for Odt format as output.
* Support for basic french typography (i.e. non-breaking spaces) in HTML/Epub format.
* Some configuration for HTML/Epub templates and CSS.
@ -90,8 +91,8 @@ Features
* Allow more customization.
* Support for easily embedding custom fonts (and other files) in
Epub/HTML.
* Improve LaTeX and Odt generation.
* Correct support for technical books.
* Support for ODT as output format?
See also [Bugs](Bugs.md).

1
book_example/config.book
View File

@ -20,6 +20,7 @@ temp_dir: .
output_epub: book.epub
output_html: book.html
#output_pdf: book.pdf
output_odt: book.odt
#output_tex: book.tex
# finally, our files

32
book_example/config.md
View File

@ -195,7 +195,18 @@ and runs
$ crowbook some/dir/config.book
```
`foo.epub` will be generated in `some/dir`, not in your current directory.
`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
```
$ 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).
#### output_epub ####
@ -203,6 +214,9 @@ The name of the epub file you want to generate.
**default**: `None`
Crowbook use the `zip` command to generate the epub, so it won't work
if this command is not installed on your system.
#### output_html ####
The name of the HTML file you want to generate. Note that this HTML
@ -219,9 +233,21 @@ The name of the LaTeX file you want to generate.
#### output_pdf ####
The name of the PDF file you want to generate. Crowbook uses LaTeX to
generate it, so it won't work if it isn't installed on your computer.
generate it, so it won't work if it isn't installed on your
computer. (See `tex_command` to specify which flavour of LaTeX you
want to use.)
**default**:: `None`
**default**: `None`
### output_odt ###
The name of the ODT (OpenOffice) file you want to generate. Beware:
ODT support is still experimental.
**default**: `None`
As for Epub generation, Crowbook depends on the presence of the `zip`
command to generate this file.
### Options for customizing generated code ###