summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-01-10 22:21:14 +0000
committerKarl Berry <karl@freefriends.org>2019-01-10 22:21:14 +0000
commit8368bb1a1e80c128b441a121a8fda08f0e32d5ae (patch)
treefb96d623f66cd3bd555c48c0874af9c5ec85fc07 /Master/texmf-dist/doc/support
parent59da7b9e7d480f0bc7e89000998103cd707436e7 (diff)
make4ht (10jan19)
git-svn-id: svn://tug.org/texlive/trunk@49664 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support')
-rw-r--r--Master/texmf-dist/doc/support/make4ht/README48
-rw-r--r--Master/texmf-dist/doc/support/make4ht/changelog.tex137
-rw-r--r--Master/texmf-dist/doc/support/make4ht/make4ht-doc.pdfbin106622 -> 111304 bytes
-rw-r--r--Master/texmf-dist/doc/support/make4ht/readme.tex51
4 files changed, 221 insertions, 15 deletions
diff --git a/Master/texmf-dist/doc/support/make4ht/README b/Master/texmf-dist/doc/support/make4ht/README
index c878fdb1db4..46b22e5b14f 100644
--- a/Master/texmf-dist/doc/support/make4ht/README
+++ b/Master/texmf-dist/doc/support/make4ht/README
@@ -17,7 +17,7 @@ ePub and other e-book formats.
`tex4ht` system supports several output formats, most notably `XHTML`, `HTML 5` and `ODT`.
The conversion can be invoked using several commands. These commands invoke LaTeX\ or Plain TeX
with special instructions to load `tex4ht.sty` package. The \TeX\ run produces special `DVI` file
-which contains the code for desired output format. The `DVI` file is then processed and
+which contains the code for desired output format. Produced `DVI` file is then processed and
desired output files are created.
The basic command provided by `tex4ht` is named `htlatex`. It compiles \LaTeX\
@@ -71,8 +71,6 @@ should copy all output files to the correct destinations.
make4ht -d outputdir filename.tex
-
-
The image conversion is configured in the
[env file](http://www.tug.org/applications/tex4ht/mn35.html#index35-73001),
which has really strange syntax based and the rules are
@@ -96,6 +94,8 @@ format can be requested using the `--format` option. Supported formats are:
- `xhtml`
- `html5`
- `odt`
+ - `tei`
+ - `docbook`
The `--format` option can be also used for extension loading.
@@ -130,7 +130,7 @@ common\_filters
common\_domfilters
-: Clean the HTML file using DOM filters. It is more powerful than
+: clean the HTML file using DOM filters. It is more powerful than
`common_filters`. Used DOM filters are `fixinlines`, `idcolons` and
`joincharacters`.
@@ -140,6 +140,10 @@ mathjaxnode
convert from MathML code to HTML + CSS or SVG. See [the available
settings](#mathjaxsettings).
+odttemplate
+
+: automatically load the `odttemplate` filter.
+
staticsite
: build the document in form suitable for static site generators like [Jekyll](https://jekyllrb.com/).
@@ -375,9 +379,15 @@ mathjaxnode
convert from MathML code to HTML + CSS or SVG. See [the available
settings](#mathjaxsettings).
+odttemplate
+
+: use styles from another `ODT` file serving as a template in the current
+ document. It works for the `styles.xml` file in the `ODT` file. During
+ the compilation, this file is named as `\jobname.4oy`.
+
staticsite
-: create HTML file in format suitable for static site generators such as [Jekyll](https://jekyllrb.com/)
+: create HTML files in format suitable for static site generators such as [Jekyll](https://jekyllrb.com/)
svg-height
@@ -431,6 +441,14 @@ joincharacters
: join consecutive `<span>` or `<mn>` elements.
+odtimagesize
+
+: set correct dimensions for images in the ODT format. It is loaded by default for the ODT output.
+
+t4htlinks
+
+: fix hyperlinks in the ODT format.
+
### make4ht-aeneas-config package
Companion for the `aeneas` DOM filter is the `make4ht-aeneas-config` plugin. It
@@ -517,10 +535,10 @@ Table keys are the configured file names. It is necessary to insert them as
`["filename.html"]`, because of Lua syntax rules.
This example maps audio file `sample.mp3` to a section subpage. The main HTML
-file, which may contain title and table of contents doesn't have an
+file, which may contain title and table of contents doesn't have a
corresponding audio file.
-The filenames of sub files corresponds to chapter numbers, so they are not
+Filenames of the sub files corresponds to the chapter numbers, so they are not
stable when a new chapter is added. It is possible to request file names
interfered from the chapter titles using the `sec-filename` option or `tex4ht`.
@@ -796,6 +814,22 @@ parallel_size
: number of pages used in each Dvisvgm call. The extension detects changed pages in the DVI file and construct multiple calls to Dvisvgm with only changed pages.
+scale
+
+: SVG scaling.
+
+### The `odttemplate` filter and extension
+
+template
+
+: filename of the template `ODT` file
+
+
+`odttemplate` can also get the template filename from the `odttemplate` option from `tex4ht_sty_par` parameter. It can be set useing following command line call, for example:
+
+ make4ht -f odt+odttemplate filename.tex "odttemplate=template.odt"
+
+
# Configuration file {#configfile}
diff --git a/Master/texmf-dist/doc/support/make4ht/changelog.tex b/Master/texmf-dist/doc/support/make4ht/changelog.tex
index ec2c521110f..1467115b2c5 100644
--- a/Master/texmf-dist/doc/support/make4ht/changelog.tex
+++ b/Master/texmf-dist/doc/support/make4ht/changelog.tex
@@ -3,6 +3,143 @@
\begin{itemize}
\item
+ 2019/01/10
+
+ \begin{itemize}
+ \tightlist
+ \item
+ version 0.2d released
+ \end{itemize}
+\item
+ 2019/01/05
+
+ \begin{itemize}
+ \tightlist
+ \item
+ added \texttt{docbook} and \texttt{tei} output formats.
+ \end{itemize}
+\item
+ 2018/12/19
+
+ \begin{itemize}
+ \tightlist
+ \item
+ new library: \texttt{make4ht-xtpipes.lua}. It contains code for
+ xtpipes handling.
+ \item
+ moved Xtpipes handling code from \texttt{formats/odt.lua}.
+ \end{itemize}
+\item
+ 2018/12/18
+
+ \begin{itemize}
+ \tightlist
+ \item
+ new filter: \texttt{odttemplate}. It can be used for replacing style
+ in a generated \texttt{ODT} file by a style from another existing
+ \texttt{ODT} file.
+ \item
+ new extension: \texttt{odttemplate}. Companioning extension for
+ filter with the same name.
+ \item
+ fixed bug in \texttt{make4ht-filters.lua}: the parameters table
+ haven't been passed to filters.
+ \end{itemize}
+\item
+ 2018/12/17
+
+ \begin{itemize}
+ \tightlist
+ \item
+ fixed extension handling. The disabling from the command line didn't
+ take precedence over extensions enabled in the config file.
+ Extensions also could be executed multiple times.
+ \end{itemize}
+\item
+ 2018/11/08
+
+ \begin{itemize}
+ \tightlist
+ \item
+ removed replacing newlines by blank strings in the
+ \texttt{joincharacters} domfilter. The issue it fixed doesn't seem
+ to exist anymore, and it ate spaces sometimes.
+ \end{itemize}
+\item
+ 2018/11/01
+
+ \begin{itemize}
+ \tightlist
+ \item
+ added \texttt{t4htlinks} domfilter
+ \item
+ fixed the \texttt{xtpipes} and \texttt{filters} execution order in
+ the \texttt{ODT} format
+ \end{itemize}
+\item
+ 2018/10/26
+
+ \begin{itemize}
+ \tightlist
+ \item
+ fixed ODT generation for files that contains special characters for
+ Lua string patterns
+ \item
+ replace non-breaking spaces with entities. It caused issues in LO
+ \end{itemize}
+\item
+ 2018/10/18
+
+ \begin{itemize}
+ \tightlist
+ \item
+ fixed the executable installation
+ \end{itemize}
+\item
+ 2018/09/16
+
+ \begin{itemize}
+ \tightlist
+ \item
+ added the \texttt{scale} option for \texttt{dvisvgm\_hashes}
+ extension
+ \end{itemize}
+\item
+ 2018/09/14
+
+ \begin{itemize}
+ \tightlist
+ \item
+ require the \texttt{-dvi} option with \texttt{latexmk\_build}
+ extension
+ \end{itemize}
+\item
+ 2018/09/12
+
+ \begin{itemize}
+ \tightlist
+ \item
+ added \texttt{xindy} command for the build file
+ \end{itemize}
+\item
+ 2018/09/03
+
+ \begin{itemize}
+ \tightlist
+ \item
+ expanded the \texttt{-\/-help} option
+ \end{itemize}
+\item
+ 2018/08/27
+
+ \begin{itemize}
+ \tightlist
+ \item
+ added \texttt{odtimagesize} domfilter
+ \item
+ load \texttt{odtimagesize} by default in the ODT format
+ \end{itemize}
+\item
2018/08/23
\begin{itemize}
diff --git a/Master/texmf-dist/doc/support/make4ht/make4ht-doc.pdf b/Master/texmf-dist/doc/support/make4ht/make4ht-doc.pdf
index d25efb855d9..e05e081ad12 100644
--- a/Master/texmf-dist/doc/support/make4ht/make4ht-doc.pdf
+++ b/Master/texmf-dist/doc/support/make4ht/make4ht-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/make4ht/readme.tex b/Master/texmf-dist/doc/support/make4ht/readme.tex
index 20bf33575d1..bb4fa0e7803 100644
--- a/Master/texmf-dist/doc/support/make4ht/readme.tex
+++ b/Master/texmf-dist/doc/support/make4ht/readme.tex
@@ -21,7 +21,7 @@ commands}{The issues with default tex4ht conversion commands}}\label{the-issues-
invoked using several commands. These commands invoke LaTeX~or Plain TeX
with special instructions to load \texttt{tex4ht.sty} package. The
\TeX~run produces special \texttt{DVI} file which contains the code for
-desired output format. The \texttt{DVI} file is then processed and
+desired output format. Produced \texttt{DVI} file is then processed and
desired output files are created.
The basic command provided by \texttt{tex4ht} is named \texttt{htlatex}.
@@ -130,6 +130,10 @@ Supported formats are:
\texttt{html5}
\item
\texttt{odt}
+\item
+ \texttt{tei}
+\item
+ \texttt{docbook}
\end{itemize}
The \texttt{-\/-format} option can be also used for extension loading.
@@ -161,13 +165,15 @@ multiple processor cores and generates only changed images.
\item[common\_filters]
clean the output HTML files using filters.
\item[common\_domfilters]
-Clean the HTML file using DOM filters. It is more powerful than
+clean the HTML file using DOM filters. It is more powerful than
\texttt{common\_filters}. Used DOM filters are \texttt{fixinlines},
\texttt{idcolons} and \texttt{joincharacters}.
\item[mathjaxnode]
use \href{https://github.com/pkra/mathjax-node-page/}{mathjax-node-page}
to convert from MathML code to HTML + CSS or SVG. See
\protect\hyperlink{mathjaxsettings}{the available settings}.
+\item[odttemplate]
+automatically load the \texttt{odttemplate} filter.
\item[staticsite]
build the document in form suitable for static site generators like
\href{https://jekyllrb.com/}{Jekyll}.
@@ -395,8 +401,13 @@ internal links, which results in validation error.
use \href{https://github.com/pkra/mathjax-node-page/}{mathjax-node-page}
to convert from MathML code to HTML + CSS or SVG. See
\protect\hyperlink{mathjaxsettings}{the available settings}.
+\item[odttemplate]
+use styles from another \texttt{ODT} file serving as a template in the
+current document. It works for the \texttt{styles.xml} file in the
+\texttt{ODT} file. During the compilation, this file is named as
+\texttt{\textbackslash{}jobname.4oy}.
\item[staticsite]
-create HTML file in format suitable for static site generators such as
+create HTML files in format suitable for static site generators such as
\href{https://jekyllrb.com/}{Jekyll}
\item[svg-height]
some SVG images produced by \texttt{dvisvgm} seem to have wrong
@@ -452,6 +463,11 @@ replace the colon (\texttt{:}) character in internal links and
\item[joincharacters]
join consecutive \texttt{\textless{}span\textgreater{}} or
\texttt{\textless{}mn\textgreater{}} elements.
+\item[odtimagesize]
+set correct dimensions for images in the ODT format. It is loaded by
+default for the ODT output.
+\item[t4htlinks]
+fix hyperlinks in the ODT format.
\end{description}
\hypertarget{make4ht-aeneas-config-package}{%
@@ -538,12 +554,12 @@ as \texttt{{[}"filename.html"{]}}, because of Lua syntax rules.
This example maps audio file \texttt{sample.mp3} to a section subpage.
The main HTML file, which may contain title and table of contents
-doesn't have an corresponding audio file.
+doesn't have a corresponding audio file.
-The filenames of sub files corresponds to chapter numbers, so they are
-not stable when a new chapter is added. It is possible to request file
-names interfered from the chapter titles using the \texttt{sec-filename}
-option or \texttt{tex4ht}.
+Filenames of the sub files corresponds to the chapter numbers, so they
+are not stable when a new chapter is added. It is possible to request
+file names interfered from the chapter titles using the
+\texttt{sec-filename} option or \texttt{tex4ht}.
Available \texttt{map} options:
@@ -881,8 +897,27 @@ detect the available cores automatically by default.
number of pages used in each Dvisvgm call. The extension detects changed
pages in the DVI file and construct multiple calls to Dvisvgm with only
changed pages.
+\item[scale]
+SVG scaling.
+\end{description}
+
+\hypertarget{the-odttemplate-filter-and-extension}{%
+\subsubsection{\texorpdfstring{The \texttt{odttemplate} filter and
+extension}{The odttemplate filter and extension}}\label{the-odttemplate-filter-and-extension}}
+
+\begin{description}
+\item[template]
+filename of the template \texttt{ODT} file
\end{description}
+\texttt{odttemplate} can also get the template filename from the
+\texttt{odttemplate} option from \texttt{tex4ht\_sty\_par} parameter. It
+can be set useing following command line call, for example:
+
+\begin{verbatim}
+ make4ht -f odt+odttemplate filename.tex "odttemplate=template.odt"
+\end{verbatim}
+
\hypertarget{configfile}{%
\section{Configuration file}\label{configfile}}