diff options
author | Karl Berry <karl@freefriends.org> | 2021-07-26 20:31:33 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2021-07-26 20:31:33 +0000 |
commit | c38f2e3735eb97eaf74132a87ca64c6980519265 (patch) | |
tree | bcb896190dc5ce20972e2d10339d5d26aa01bc1e /Master/texmf-dist/doc | |
parent | 1a474c651eb1c2b83dd97da9e49738c391ebbee4 (diff) |
tex4ebook (26jul21)
git-svn-id: svn://tug.org/texlive/trunk@60083 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/support/tex4ebook/README | 61 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/tex4ebook/changelog.tex | 55 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/tex4ebook/readme.tex | 74 | ||||
-rw-r--r-- | Master/texmf-dist/doc/support/tex4ebook/tex4ebook-doc.pdf | bin | 79505 -> 83506 bytes |
4 files changed, 179 insertions, 11 deletions
diff --git a/Master/texmf-dist/doc/support/tex4ebook/README b/Master/texmf-dist/doc/support/tex4ebook/README index 3634974ab82..f87bd02f422 100644 --- a/Master/texmf-dist/doc/support/tex4ebook/README +++ b/Master/texmf-dist/doc/support/tex4ebook/README @@ -46,7 +46,17 @@ But it is optional. You shouldn't need to modify your \TeX\ files ## Available commands -- `\coverimage{coverimage.name}` - include cover image to the document. +- `\coverimage[<graphicx options>]{coverimage.name}` - include cover image to + the document. You can pass the same options as to `\includegraphics` command + in the optional argument. + +For example: + + \thispagestyle{empty} + \begin{document} + \coverimage[scale=0.8]{coverimage.name} % include scaled cover image + ... + \pagestyle{headings} # Command line options @@ -212,6 +222,42 @@ Add item to `<manifest>` section in the `OPF` file. Add `XML` name space to the generated `XHTML` files. Useful in `EPUB 3`. +### Example config file + + \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 + +Remarks: + +- Leading percent signs in the `.cfg` file introduce comments +- If the unique identifier is a URI which contains diacritical characters, the + equivalent HTML code needs to be inserted. `UTF8` is not recognized at that place. +- `UTF8` characters may be used in the `OpfMetadata` sections. + + + ## Commands available in the config file @@ -229,6 +275,7 @@ Add `XML` name space to the generated `XHTML` files. Useful in `EPUB 3`. *Where do you start an ePUB and what is the `<guide>` section of the `.OPF` 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`^[https://github.com/michal-h21/make4ht] as a build @@ -254,10 +301,14 @@ See the `make4ht` documentation for an example and more information. The basic support for the Fixed layout EPUB 3 can be enabled using the following configurations: - \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}} Modify the dimensions in the `<meta name="viewport>` element according to your needs. diff --git a/Master/texmf-dist/doc/support/tex4ebook/changelog.tex b/Master/texmf-dist/doc/support/tex4ebook/changelog.tex index 3d0d6c1c6c4..f415f81c8c2 100644 --- a/Master/texmf-dist/doc/support/tex4ebook/changelog.tex +++ b/Master/texmf-dist/doc/support/tex4ebook/changelog.tex @@ -3,6 +3,61 @@ \begin{itemize} \item + 2021/07/26 + + \begin{itemize} + \tightlist + \item + released version \texttt{0.3d} + \end{itemize} +\item + 2021/05/29 + + \begin{itemize} + \tightlist + \item + renamed \texttt{DeclareLanguage} to + \texttt{\textbackslash{}DeclareLanguageEbook}. Fixes + \href{https://github.com/michal-h21/tex4ebook/issues/78}{issue 78}. + \end{itemize} +\item + 2021/05/15 + + \begin{itemize} + \tightlist + \item + use \texttt{assert} in checking of existence of the \texttt{zip} + command. + \item + replace colons in \texttt{OPF} \texttt{id} attributes and add + trailing \texttt{x} if the \texttt{id} starts with number. It should + fix some validation issues. + \end{itemize} +\item + 2021/05/02 + + \begin{itemize} + \tightlist + \item + added more examples of configuration to the documentation. + \end{itemize} +\item + 2020/11/09 + + \begin{itemize} + \tightlist + \item + set exit status + \end{itemize} +\item + 2020/11/09 + + \begin{itemize} + \tightlist + \item + don't redefine \texttt{PicDisplay} configuration. + \end{itemize} +\item 2020/11/06 \begin{itemize} 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 diff --git a/Master/texmf-dist/doc/support/tex4ebook/tex4ebook-doc.pdf b/Master/texmf-dist/doc/support/tex4ebook/tex4ebook-doc.pdf Binary files differindex 3546db973f5..170a8fc4f1c 100644 --- a/Master/texmf-dist/doc/support/tex4ebook/tex4ebook-doc.pdf +++ b/Master/texmf-dist/doc/support/tex4ebook/tex4ebook-doc.pdf |