README.adoc in asciidoctor-epub3-1.5.0.alpha.11 vs README.adoc in asciidoctor-epub3-1.5.0.alpha.12

- old
+ new

@@ -1,8 +1,8 @@ = {project-name}: A _native_ EPUB3 converter for AsciiDoc Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]> -v1.5.0.alpha.11, 2020-01-26 +v1.5.0.alpha.12, 2020-02-02 // Settings: :experimental: :idprefix: :idseparator: - :imagesdir: data/samples/images @@ -539,25 +539,43 @@ Show the usage message *-D, --destination-dir* :: Writes files to specified directory (defaults to the current directory) +*-a ebook-epubcheck-path=<path>*:: + Specifies path to EPUBCheck executable to use with `-a ebook-validate`. + This attribute takes precedence over `EPUBCHECK` environment variable. + *-a ebook-extract* :: Extracts the EPUB3 to a folder in the destination directory after the file is generated *-a ebook-format=<format>* :: Specifies the ebook format to generate (epub3 or kf8, default: epub3) +*-a ebook-kindlegen-path=<path>*:: + Specifies path to KindleGen executable to use when producing KF8/Mobi. + This attribute takes precedence over `KINDLEGEN` environment variable. + *-a ebook-validate* :: - Runs {uri-epubcheck}[EpubCheck] to validate output file against the EPUB3 specification + Runs {uri-epubcheck}[EPUBCheck] to validate output file against the EPUB3 specification *-a ebook-compress=<0|1|2|none|standard|huffdic>* :: Controls the compression type used by kindlegen (0=none [default if unset], 1=standard [default if empty], 2=huffdic) *-v, --version* :: Display the program version +=== Environment variables + +*EPUBCHECK*:: + Specifies path to EPUBCheck executable to use with `-a ebook-validate`. + Effect of this variable can be overriden with `-a ebook-epubcheck-path` attribute. + +*KINDLEGEN*:: + Specifies path to KindleGen executable to use when producing KF8/Mobi. + Effect of this variable can be overriden with `-a ebook-kindlegen-path` attribute. + === EPUB3 Archive Structure Here's a sample manifest of files found in an EPUB3 document produced by {project-name}. .... @@ -612,19 +630,19 @@ The sample book contains placeholder images for an author avatar and a book cover. // TODO explain the avatar and book cover images -=== Changing the Cover Image +=== Adding the Cover Image Ereaders have different image resolution and file size limits regarding a book's cover. -Kindle covers tend to be 1050x1600 (16:9 resolution), which is the size of the sample cover provided with {project-name}. +Kindle covers tend to be 1050x1600 (16:9 resolution). To ensure your cover displays correctly, you'll want to review the documentation or publisher guidelines for the e-reading platform you're targeting. WARNING: We've found that if the book cover is more than 1600px on any side, Aldiko will not render it and may even crash. Feel free to use the SVG of the sample cover in the [path]_data/images_ folder as a template for creating your own cover. -Once your image is ready, you can replace the placeholder cover image by defining the `front-cover-image` attribute in the header of the master document. +Once your image is ready, you can set the cover image by defining the `front-cover-image` attribute in the header of the master document. [source,asciidoc] ---- :front-cover-image: image:cover.png[Front Cover,1050,1600] ----