diff options
Diffstat (limited to 'Master/texmf-dist/doc/support/tex4ebook/readme.tex')
-rw-r--r-- | Master/texmf-dist/doc/support/tex4ebook/readme.tex | 87 |
1 files changed, 40 insertions, 47 deletions
diff --git a/Master/texmf-dist/doc/support/tex4ebook/readme.tex b/Master/texmf-dist/doc/support/tex4ebook/readme.tex index cf8a11c0b1c..d8b7d485a73 100644 --- a/Master/texmf-dist/doc/support/tex4ebook/readme.tex +++ b/Master/texmf-dist/doc/support/tex4ebook/readme.tex @@ -1,6 +1,6 @@ \section{Introduction}\label{introduction} -\texttt{TeX4ebook} is bundle of lua scripts and \texttt{LaTeX} packages +\texttt{TeX4ebook} is bundle of Lua scripts and \texttt{LaTeX} packages for conversion of LaTeX files to ebook formats, for example \texttt{epub}, \texttt{mobi} and \texttt{epub3}. \texttt{tex4ht} is used as conversion engine. @@ -88,9 +88,9 @@ that this behaviour is default. \begin{description} \item[-e,--build-file (default nil)] -Specify \href{https://github.com/michal-h21/make4ht\#build-file}{make4ht -build file}. Defaulf build file filename is \texttt{filename.mk4}, use -this option when it has different filename. +Specify make4ht build file\footnote{\url{https://github.com/michal-h21/make4ht\#build-file}}. +Defaulf build file filename is \texttt{filename.mk4}, use this option if +you use different filename. \item[-f,--format (default epub)] Output format. epub, epub3 and mobi are supported. \item[-l,--lua] @@ -107,14 +107,15 @@ resolution of target devices, which is usually about 167 ppi. Enable shell escape in htlatex run. This may be needed if you run external commands from your source files. \item[t,--tidy] -Run tidy on output html files. +process output html files with \texttt{HTML tidy} command\footnote{It + needs to be installed separately}. \end{description} \section{Configuration}\label{configuration} -\texttt{tex4ebook} uses \href{http://www.tug.org/tex4ht/}{tex4ht} for -conversion from LaTeX to html. \texttt{tex4ht} is highly configurable -using config files. Basic config file structure is +\texttt{tex4ebook} uses \texttt{tex4ht}\footnote{\url{http://www.tug.org/tex4ht/}} +for conversion from LaTeX to html. \texttt{tex4ht} is highly +configurable using config files. Basic config file structure is \begin{verbatim} \Preamble{xhtml, comma separated list of options} @@ -125,28 +126,22 @@ using config files. Basic config file structure is \end{verbatim} Basic info about command configurations can be found in a -work-in-progres -\href{https://github.com/michal-h21/helpers4ht/wiki/tex4ht-tutorial}{tex4ht -tutorial} , -\href{http://www.tug.org/applications/tex4ht/mn11.html}{tex4ht -documentation}, and in series of blogposts on CV Radhakrishnan's blog: -\href{http://www.cvr.cc/?p=323}{Configure part 1}, -\href{http://www.cvr.cc/?p=362}{Configure part 2}, -\href{http://www.cvr.cc/?p=482}{Low level commands}. Available options +work-in-progres \emph{tex4ht tutorial}\footnote{\url{https://github.com/michal-h21/helpers4ht/wiki/tex4ht-tutorial}} +, \emph{tex4ht documentation}\footnote{\url{http://www.tug.org/applications/tex4ht/mn11.html}}, +and in series of blogposts on CV Radhakrishnan's blog: \emph{Configure +part 1}\footnote{\url{http://www.cvr.cc/?p=323}}, \emph{Configure part +2}\footnote{\url{http://www.cvr.cc/?p=362}}, \emph{Low level +commands}\footnote{\url{http://www.cvr.cc/?p=482}}. Available options for \texttt{\textbackslash{}Preamble} command are listed in the article -\href{http://www.cvr.cc/?p=504}{TeX4ht: options}. +\emph{TeX4ht: options}\footnote{\url{http://www.cvr.cc/?p=504}}. -Great source of tips for \texttt{tex4ht} configuring is -\href{http://tex.stackexchange.com/questions/tagged/tex4ht}{tex4ht tag -on TeX.sx}, there is also a -\href{http://tex.stackexchange.com/questions/tagged/tex4ebook}{tag for -tex4ebook}. +Great source of tips for \texttt{tex4ht} configuring is \emph{tex4ht tag +on TeX.sx}\footnote{\url{http://tex.stackexchange.com/questions/tagged/tex4ht}}, +there is also a \emph{tag for tex4ebook}\footnote{\url{http://tex.stackexchange.com/questions/tagged/tex4ebook}}. -Examples of interesting questions are -\href{including\%20images\%20and\%20fonts\%20in\%20ebooks}{including -images and fonts in ebooks} or -\href{http://tex.stackexchange.com/a/195718/2891}{setting image size in -em units instead of pt}. +Examples of interesting questions are \emph{including images and fonts +in ebooks}\footnote{\url{http://tex.stackexchange.com/a/213165/2891}} or +\emph{setting image size in em units instead of pt}\footnote{\url{http://tex.stackexchange.com/a/195718/2891}}. \subsection{Provided configurations}\label{provided-configurations} @@ -220,24 +215,22 @@ files}\label{commands-available-in-config-files} register file in the \texttt{OPF} file. Current output file is added by default. \item[\texttt{\textbackslash{}OpfAddProperty\{property type\}}] -add \texttt{EPUB3} property for the current file. See -\href{http://www.idpf.org/epub/301/spec/epub-publications.html\#sec-item-property-values}{EPUB3 -spec} +add \texttt{EPUB3} property for the current file. See \emph{EPUB3 +spec}\footnote{\url{http://www.idpf.org/epub/301/spec/epub-publications.html\#sec-item-property-values}} \item[\texttt{\textbackslash{}OpfGuide{[}filename{]}\{title\}\{type\}}] Add file to the \texttt{\textless{}guide\textgreater{}} section in the -\texttt{OPF} file. See -\href{http://epubsecrets.com/where-do-you-start-an-epub-and-what-is-the-guide-section-of-the-opf-file.php}{Where -do you start an ePUB and what is the -\texttt{\textless{}guide\textgreater{}} section of the .OPF file?} for -some details. Note that \texttt{\textless{}guide\textgreater{}} is +\texttt{OPF} file. See \emph{Where do you start an ePUB and what is the +\texttt{\textless{}guide\textgreater{}} section of the .OPF +file?}\footnote{\url{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 \texttt{\textless{}guide\textgreater{}} is deprecated in \texttt{EPUB 3}. \end{description} \subsection{Build files}\label{build-files} -\texttt{tex4ebook} uses -\href{https://github.com/michal-h21/make4ht}{make4ht} as a build system. -See \texttt{make4ht} documentation for details on build files. +\texttt{tex4ebook} uses \texttt{make4ht}\footnote{\url{https://github.com/michal-h21/make4ht}} +as a build system. See \texttt{make4ht} documentation for details on +build files. \section{Troubleshooting}\label{troubleshooting} @@ -253,15 +246,15 @@ htlatex filename if same error as in \texttt{tex4ebook} run arises, the problem is in some \texttt{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 -\href{http://tug.org/mailman/listinfo/tex4ht}{tex4ht mailinglist} or on -\href{http://tex.stackexchange.com/}{TeX-sx}. +showing the error and ask for help either on \emph{tex4ht +mailinglist}\footnote{\url{http://tug.org/mailman/listinfo/tex4ht}} or +on \emph{TeX-sx}\footnote{\url{http://tex.stackexchange.com/}}. \subsection{Fontspec}\label{fontspec} \texttt{tex4ht} currently doesn't support \texttt{fontspec} and open type fonts. At this moment, workaround for this is to modify your source -file and conditionaly include fontspec and any other conflicting +file and conditionally include fontspec and any other conflicting packages only when document is not processed with \texttt{tex4ht}. Sample: @@ -283,16 +276,16 @@ Sample: \makeatother \end{verbatim} -Drawback is that not all characters of unicode range are supported with +Drawback is that not all characters of Unicode range are supported with \texttt{inputenc}. For some solutions of this limitation, see a thread -on \href{http://tug.org/pipermail/tex4ht/2013q1/000719.html}{tex4ht -mailinglist} +on \emph{tex4ht mailinglist}\footnote{\url{http://tug.org/pipermail/tex4ht/2013q1/000719.html}} \subsection{Validation}\label{validation} In case of successful compilation, use command line tool -\texttt{epubcheck} to check whether your document doesn't contain any -errors. +\texttt{epubcheck}\footnote{you need to install it separately, see + \url{https://github.com/IDPF/epubcheck}} to check whether your +document doesn't contain any errors. Type |