summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/tex4ebook/readme.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/tex4ebook/readme.tex')
-rw-r--r--Master/texmf-dist/doc/support/tex4ebook/readme.tex74
1 files changed, 68 insertions, 6 deletions
diff --git a/Master/texmf-dist/doc/support/tex4ebook/readme.tex b/Master/texmf-dist/doc/support/tex4ebook/readme.tex
index 0fdb16c1c91..428ac6c68ca 100644
--- a/Master/texmf-dist/doc/support/tex4ebook/readme.tex
+++ b/Master/texmf-dist/doc/support/tex4ebook/readme.tex
@@ -53,10 +53,22 @@ But it is optional. You shouldn't need to modify your \TeX~files
\begin{itemize}
\tightlist
\item
- \texttt{\textbackslash{}coverimage\{coverimage.name\}} - include cover
- image to the document.
+ \texttt{\textbackslash{}coverimage{[}\textless{}graphicx\ options\textgreater{}{]}\{coverimage.name\}}
+ - include cover image to the document. You can pass the same options
+ as to \texttt{\textbackslash{}includegraphics} command in the optional
+ argument.
\end{itemize}
+For example:
+
+\begin{verbatim}
+\thispagestyle{empty}
+\begin{document}
+\coverimage[scale=0.8]{coverimage.name} % include scaled cover image
+...
+\pagestyle{headings}
+\end{verbatim}
+
\hypertarget{command-line-options}{%
\section{Command line options}\label{command-line-options}}
@@ -246,6 +258,52 @@ Add item to \texttt{\textless{}manifest\textgreater{}} section in the
Add \texttt{XML} name space to the generated \texttt{XHTML} files.
Useful in \texttt{EPUB\ 3}.
+\hypertarget{example-config-file}{%
+\subsubsection{Example config file}\label{example-config-file}}
+
+\begin{verbatim}
+\Preamble{xhtml}
+\begin{document}
+\Configure{DocumentLanguage}{de}
+% Use following lines if your document has ISBN:
+% \Configure{OpfScheme}{ISBN}
+% \Configure{UniqueIdentifier}{3-0000-1111-X}
+% Another possibility is URI that points for example to the ebook homepage:
+\Configure{OpfScheme}{URI}
+\Configure{UniqueIdentifier}
+{https://de.wikipedia.org/wiki/Der_achte_Schöpfungstag}
+\Configure{CoverMimeType}{image/jpeg}
+% If you don't use \coverimage in the document text,
+% add cover image using this command:
+\CoverMetadata{coverimage.jpg}
+% You can also add more authors to your ebook metadata:
+\Configure{OpfMetadata}
+{\HCode{<dc:publisher>Deutscher Bücherbund</dc:publisher>}}
+\Configure{OpfMetadata}
+{\HCode{<dc:contributor>Image Artist</dc:contributor>}}
+\Configure{OpfMetadata}
+{\HCode{<dc:contributor>Trans Lator</dc:contributor>}}
+\Configure{OpfMetadata}
+{\HCode{<dc:date opf:event='original-publication'>1888</dc:date>}}
+\EndPreamble
+\end{verbatim}
+
+Remarks:
+
+\begin{itemize}
+\tightlist
+\item
+ Leading percent signs in the \texttt{.cfg} file introduce comments
+\item
+ If the unique identifier is a URI which contains diacritical
+ characters, the\\
+ equivalent HTML code needs to be inserted. \texttt{UTF8} is not
+ recognized at that place.
+\item
+ \texttt{UTF8} characters may be used in the \texttt{OpfMetadata}
+ sections.
+\end{itemize}
+
\hypertarget{commands-available-in-the-config-file}{%
\subsection{Commands available in the config
file}\label{commands-available-in-the-config-file}}
@@ -301,10 +359,14 @@ The basic support for the Fixed layout EPUB 3 can be enabled using the
following configurations:
\begin{verbatim}
-\Configure{OpfMetadata}{\HCode{<meta property="rendition:layout">pre-paginated</meta>}}
-\Configure{OpfMetadata}{\HCode{<meta property="rendition:orientation">landscape</meta>}}
-\Configure{OpfMetadata}{\HCode{<meta property="rendition:spread">none</meta>}}
-\Configure{@HEAD}{\HCode{<meta name="viewport" content="width=1920, height=1080"/>\Hnewline}}
+\Configure{OpfMetadata}
+{\HCode{<meta property="rendition:layout">pre-paginated</meta>}}
+\Configure{OpfMetadata}
+{\HCode{<meta property="rendition:orientation">landscape</meta>}}
+\Configure{OpfMetadata}
+{\HCode{<meta property="rendition:spread">none</meta>}}
+\Configure{@HEAD}
+{\HCode{<meta name="viewport" content="width=1920, height=1080"/>\Hnewline}}
\end{verbatim}
Modify the dimensions in the