summaryrefslogtreecommitdiff
path: root/support/make4ht/readme.tex
diff options
context:
space:
mode:
Diffstat (limited to 'support/make4ht/readme.tex')
-rw-r--r--support/make4ht/readme.tex52
1 files changed, 48 insertions, 4 deletions
diff --git a/support/make4ht/readme.tex b/support/make4ht/readme.tex
index 98a0712899..9cff4cbeea 100644
--- a/support/make4ht/readme.tex
+++ b/support/make4ht/readme.tex
@@ -45,6 +45,7 @@ make4ht [options] filename ["tex4ht.sty op." "tex4ht op."
possible values: tex4ht or lua4ht
-c,--config (default xhtml) Custom config file
-d,--output-dir (default "") Output directory
+-B,--build-dir (default nil) Build directory
-e,--build-file (default nil) If the build filename is different
than `filename`.mk4
-f,--format (default nil) Output file format
@@ -274,6 +275,17 @@ correct destinations.
$ make4ht -d outputdir filename.tex
\end{verbatim}
+\texttt{make4ht} can also output temporary files to a build directory,
+thanks to the \texttt{-\/-build-dir} (or \texttt{-B}) option. The
+following command with put \texttt{.aux}, \texttt{.4tc} and other
+auxiliary files to the \texttt{build} dir, and the generated
+\texttt{.html} and \texttt{.css} files to the \texttt{outputdir}
+directory.
+
+\begin{verbatim}
+$ make4ht -B build -d outputdir filename.tex
+\end{verbatim}
+
\hypertarget{image-conversion-and-postprocessing-of-the-generated-files}{%
\subsection{Image conversion and postprocessing of the generated
files}\label{image-conversion-and-postprocessing-of-the-generated-files}}
@@ -332,7 +344,15 @@ The extensions can be enabled or disabled by appending
\texttt{+EXTENSION} or \texttt{-EXTENSION} after the output format name:
\begin{verbatim}
- $ make4ht -uf html5+tidy filename.tex
+ $ make4ht -f html5+tidy filename.tex
+\end{verbatim}
+
+In \texttt{xhtml} and \texttt{html5} output formats, the
+\texttt{common\_domfilters} extension is triggered automatically, but it
+can still be disabled using:
+
+\begin{verbatim}
+ $ make4ht -f html5-common_domfilters filename.tex
\end{verbatim}
Available extensions:
@@ -342,9 +362,13 @@ Available extensions:
clean the output HTML files using filters.
\item[common\_domfilters]
clean the HTML file using DOM filters. It is more powerful than
-\texttt{common\_filters}. Used DOM filters are \texttt{fixinlines},
-\texttt{idcolons}, \texttt{joincharacters}, \texttt{sectionid} and
-\texttt{tablerows}.
+\texttt{common\_filters}. It used following DOM filters:
+\texttt{fixinlines}, \texttt{idcolons}, \texttt{joincharacters},
+\texttt{mathmlfixes}, \texttt{tablerows},\texttt{booktabs},
+\texttt{sectionid} and\texttt{itemparagraphs}
+\item[copy\_images]
+Copies the images to the output directory. This is useful if the
+original images are stored in directories above the document directory.
\item[detect\_engine]
detect engine and format necessary for the document compilation from the
magic comments supported by \LaTeX~editors such as TeXShop or TeXWorks.
@@ -1097,6 +1121,26 @@ filter_settings "collapsetoc" {
}
\end{verbatim}
+\hypertarget{the-copy_images-extension}{%
+\subsection{\texorpdfstring{The \texttt{copy\_images}
+extension}{The copy\_images extension}}\label{the-copy_images-extension}}
+
+\begin{description}
+\item[extensions]
+table with list of image extensions that should be processed.
+\item[img\_dir]
+name of the output directory where images should be stored
+\end{description}
+
+Default values:
+
+\begin{verbatim}
+ filter_settings "copy_images" {
+ extensions = {"png", "jpg", "jpeg", "svg"},
+ img_dir = ""
+ }
+\end{verbatim}
+
\hypertarget{the-fixinlines-dom-filter}{%
\subsection{\texorpdfstring{The \texttt{fixinlines} dom
filter}{The fixinlines dom filter}}\label{the-fixinlines-dom-filter}}