elicker :: sanitary wrapper for eLyXer, optimizing output HTML to real-world end use (e.g., EPUB2 ebook readers)
elicker
is a single zsh
script and hence (usually!) trivially installed.
elicker
requires the following runtime dependencies:
After installing such dependencies, simply copy elicker
to a directory in the current user's ${PATH}
(e.g., /usr/local/bin
).
elicker [OPTIONS]... SOURCE_DIRECTORY SOURCE_LYX_FILE TARGET_HTML_FILE
While elicker
is runnable directly from the command line, elicker
is mostly intended to be run from within LyX. To do so, edit the Converter:
field in LyX's Tools → Preferences → File Handling → Converters dialog to read:
elicker --title "My Book Title" $$r $$i $$o
Since neither elicker
or eLyXer are capable of automatically copying the title from input LyX documents to output HTML files, consider explicitly passing such title as above on a per-document basis.
As an eLyXer sanitizer, elicker
supports all options and arguments supported by eLyXer as well as the following elicker
-specific options:
--end-use END-USE
, optimize output HTML to the specified real-world end use, whereEND-USE
is one of the following strings (defaulting toebook-quality-high
if unspecified):website
, producing high-quality dynamic content for publication on websites.ebook-quality-high
, producing high-quality dynamic content for use in EPUB3 and/or KF8 ebooks.ebook-quality-low
, producing low-quality static content for use in EPUB2 and/or MOBI ebooks.
As example:
elicker --title "My Book Title" --end-use ebook-quality-low $$r $$i $$o
elicker
adheres to a conventional GPLv3 license. See LICENSE for details.