summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/tex4ebook/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-04-28 21:21:37 +0000
committerKarl Berry <karl@freefriends.org>2017-04-28 21:21:37 +0000
commit37dfda47fe844c888a24fb8cc380d34139dca9f4 (patch)
treea1a1d9dc047773102a07f939e2ada149f00fb179 /Master/texmf-dist/doc/support/tex4ebook/README
parenteda997681c2c45b147792fe2f546e45150447197 (diff)
tex4ebook (28apr17)
git-svn-id: svn://tug.org/texlive/trunk@44103 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support/tex4ebook/README')
-rw-r--r--Master/texmf-dist/doc/support/tex4ebook/README59
1 files changed, 32 insertions, 27 deletions
diff --git a/Master/texmf-dist/doc/support/tex4ebook/README b/Master/texmf-dist/doc/support/tex4ebook/README
index 2514a630aca..2314aa3478b 100644
--- a/Master/texmf-dist/doc/support/tex4ebook/README
+++ b/Master/texmf-dist/doc/support/tex4ebook/README
@@ -50,7 +50,7 @@ but it is optional. You shouldn't need to modify your \TeX\ files
# Command line options
--c,--config
+`-c,--config`
: specify custom config file for `tex4ht`
@@ -69,48 +69,48 @@ but it is optional. You shouldn't need to modify your \TeX\ files
This config file will create `xhtml` file for every section. Note that this
behaviour is default.
--e,--build-file (default nil)
+`-e,--build-file (default nil)`
-: Specify make4ht build file^[\url{https://github.com/michal-h21/make4ht\#build-file}].
+: Specify make4ht build file^[https://github.com/michal-h21/make4ht#build-file].
Defaulf build file filename is `filename.mk4`, use this option if you use
different filename.
--f,--format (default epub)
+`-f,--format (default epub)`
: Output format. epub, epub3 and mobi are supported.
--l,--lua
+`-l,--lua`
: Runs htlualatex instead of htlatex.
--m,--mode (default default)
+`-m,--mode (default default)`
: This set `mode` variable, accessible in the build file. Default supported
values are `default` and `draft`. In `draft` mode, document is compiled
only once, instead of three times.
--r,--resolution
+`-r,--resolution`
: Resolution of generated images, for example math. It should meet resolution
of target devices, which is usually about 167 ppi.
--s,--shell-escape
+`-s,--shell-escape`
: Enable shell escape in htlatex run. This may be needed if you run external
commands from your source files.
--t,--tidy
+`-t,--tidy`
: process output html files with `HTML tidy` command^[It needs to be installed separately].
--v,--version
+`-v,--version`
: print version number
# Configuration
-`tex4ebook` uses `tex4ht`^[\url{http://www.tug.org/tex4ht/}] for conversion from LaTeX
+`tex4ebook` uses `tex4ht`^[http://www.tug.org/tex4ht/] for conversion from LaTeX
to html. `tex4ht` is highly configurable using config files. Basic config file
structure is
@@ -121,20 +121,20 @@ structure is
\EndPreamble
Basic info about command configurations can be found in a work-in-progres
- *tex4ht tutorial*^[\url{https://github.com/michal-h21/helpers4ht/wiki/tex4ht-tutorial}]
-, *tex4ht documentation*^[\url{http://www.tug.org/applications/tex4ht/mn11.html}],
+ *tex4ht tutorial*^[https://github.com/michal-h21/helpers4ht/wiki/tex4ht-tutorial]
+, *tex4ht documentation*^[http://www.tug.org/applications/tex4ht/mn11.html],
and in series of blogposts on CV Radhakrishnan's blog:
-*Configure part 1*^[\url{http://www.cvr.cc/?p=323}],
-*Configure part 2*^[\url{http://www.cvr.cc/?p=362}],
-*Low level commands*^[\url{http://www.cvr.cc/?p=482}].
+*Configure part 1*^[http://www.cvr.cc/?p=323],
+*Configure part 2*^[http://www.cvr.cc/?p=362],
+*Low level commands*^[http://www.cvr.cc/?p=482].
Available options for `\Preamble` command are listed in the article
-*TeX4ht: options*^[\url{http://www.cvr.cc/?p=504}].
+*TeX4ht: options*^[http://www.cvr.cc/?p=504].
-Great source of tips for `tex4ht` configuring is *tex4ht tag on TeX.sx*^[\url{http://tex.stackexchange.com/questions/tagged/tex4ht}], there is also a *tag for tex4ebook*^[\url{http://tex.stackexchange.com/questions/tagged/tex4ebook}].
+Great source of tips for `tex4ht` configuring is *tex4ht tag on TeX.sx*^[http://tex.stackexchange.com/questions/tagged/tex4ht], there is also a *tag for tex4ebook*^[http://tex.stackexchange.com/questions/tagged/tex4ebook].
Examples of interesting questions are
-*including images and fonts in ebooks*^[\url{http://tex.stackexchange.com/a/213165/2891}]
-or *setting image size in em units instead of pt*^[\url{http://tex.stackexchange.com/a/195718/2891}].
+*including images and fonts in ebooks*^[http://tex.stackexchange.com/a/213165/2891]
+or *setting image size in em units instead of pt*^[http://tex.stackexchange.com/a/195718/2891].
## Provided configurations
@@ -151,6 +151,11 @@ Default identifier is URI, with value `http://example.com/\jobname`.
Type of unique identifier, default type is URI. It is
used only in epub, it is deprecated for `epub3`
+ \Configure{resettoclevels}{list of section types in descending order}
+
+Configure section types which should be included in the `NCX` file. Default
+value is the whole document hiearchy, from `\part` to `\paragraph`.
+
\Configure{DocumentLanguage}{language code}
Each epub must declare the document language. It is inferred from `babel` main
@@ -198,17 +203,17 @@ Add xml name space to `xhtml` files. Useful in `EPUB 3`
`\OpfAddProperty{property type}`
-: add `EPUB3` property for the current file. See *EPUB3 spec*^[\url{http://www.idpf.org/epub/301/spec/epub-publications.html\#sec-item-property-values}]
+: add `EPUB3` property for the current file. See *EPUB3 spec*^[http://www.idpf.org/epub/301/spec/epub-publications.html#sec-item-property-values]
`\OpfGuide[filename]{title}{type}`
: Add file to the `<guide>` section in the `OPF` file. See *Where do you start an ePUB and what is the `<guide>` section of the .OPF
- file?*^[\url{http://epubsecrets.com/where-do-you-start-an-epub-and-what-is-the-guide-section-of-the-opf-file.php}]
+ file?*^[http://epubsecrets.com/where-do-you-start-an-epub-and-what-is-the-guide-section-of-the-opf-file.php]
for some details. Note that `<guide>` is deprecated in `EPUB 3`.
## Build files
-`tex4ebook` uses `make4ht`^[\url{https://github.com/michal-h21/make4ht}] as a build
+`tex4ebook` uses `make4ht`^[https://github.com/michal-h21/make4ht] as a build
system. See `make4ht` documentation for details on build files.
# Troubleshooting
@@ -222,8 +227,8 @@ be caused by some problem in `tex4ht` configuration. Comment out line
if same error as in `tex4ebook` run arises, the problem is in some `tex4ht`
configuration. Try to identify the source of problem and if you cannot find the
solution, make minimal example showing the error and ask for help either on
-*tex4ht mailing list*^[\url{http://tug.org/mailman/listinfo/tex4ht}] or on
-*TeX-sx*^[\url{http://tex.stackexchange.com/}].
+*tex4ht mailing list*^[http://tug.org/mailman/listinfo/tex4ht] or on
+*TeX-sx*^[http://tex.stackexchange.com/].
## Fontspec
@@ -251,7 +256,7 @@ Sample:
The drawback is that not all characters of the Unicode range are supported with
`inputenc`. For some solutions of this limitation, see a thread on *tex4ht
-mailing list*^[\url{http://tug.org/pipermail/tex4ht/2013q1/000719.html}]
+mailing list*^[http://tug.org/pipermail/tex4ht/2013q1/000719.html]
Other approach is to use `alternative4ht` package from [helpers4ht](https://github.com/michal-h21/helpers4ht)
bundle. It works only with Lua backend, but it supports full unicode and you
@@ -261,7 +266,7 @@ an [example](http://michal-h21.github.io/samples/helpers4ht/fontspec.html).
## Validation
In case of successful compilation, use command line tool `epubcheck`^[you need
-to install it separately, see \url{https://github.com/IDPF/epubcheck}] to check
+to install it separately, see https://github.com/IDPF/epubcheck] to check
whether your document doesn't contain any errors.