From 2b465ca87794c05f1793552a8608392027a2e100 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 20 Nov 2018 22:01:10 +0000 Subject: animate (20nov18) git-svn-id: svn://tug.org/texlive/trunk@49204 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/source/latex/animate/animate.tex | 102 ++++++++++++++++++--- 1 file changed, 87 insertions(+), 15 deletions(-) (limited to 'Master/texmf-dist/source/latex/animate') diff --git a/Master/texmf-dist/source/latex/animate/animate.tex b/Master/texmf-dist/source/latex/animate/animate.tex index d54f2973b91..786bc1a2989 100644 --- a/Master/texmf-dist/source/latex/animate/animate.tex +++ b/Master/texmf-dist/source/latex/animate/animate.tex @@ -61,7 +61,7 @@ % \makeatother %\fi -\def\keywords{include portable PDF animation animated PDF animating embed animated graphics LaTeX pdfLaTeX LuaLaTeX PSTricks pgf TikZ LaTeX-picture MetaPost inline graphics vector graphics animated GIF LaTeX dvips ps2pdf dvipdfmx XeLaTeX JavaScript Acrobat Reader PDF-XChange Foxit Reader} +\def\keywords{include portable PDF animation SVG animation animated PDF animated SVG dvisvgm html TeX4ht web animating embed animated graphics LaTeX pdfLaTeX LuaLaTeX PSTricks pgf TikZ LaTeX-picture MetaPost inline graphics vector graphics animated GIF LaTeX dvips ps2pdf dvipdfmx XeLaTeX JavaScript Acrobat Reader PDF-XChange Foxit Reader Firefox Chrome Chromium} \hypersetup{ pdftitle={The animate Package}, pdfsubject={Documentation}, @@ -80,7 +80,7 @@ \def\day{#3} } -\hyphenation{Ja-va-Script} +\hyphenation{Ja-va-Script pro-vid-ed} \begin{document} \title{The {\sffamily animate} Package} @@ -95,31 +95,33 @@ \begin{abstract} \raggedright -\noindent A LaTeX package for creating portable, JavaScript driven PDF animations from sets of vector graphics or raster image files or from inline graphics. +\noindent A LaTeX package for creating portable, JavaScript driven PDF and SVG animations from sets of vector graphics or raster image files or from inline graphics. \vskip 0.2\baselineskip \emph{Keywords}: \keywords \end{abstract} - +%\vspace{1.5cm} \tableofcontents %\newpage \section{Introduction} -This package provides an interface for creating PDFs with animated content from sets of graphics or image files, from inline graphics, such as \LaTeX-picture, PSTricks or pgf/TikZ generated pictures, or just from typeset text. Unlike standard movie/video formats, package `animate' allows for animating vector graphics. The result is roughly similar to the SWF (Flash) format, although not as space-efficient. +This package provides an interface for creating PDF and SVG files with animated content from sets of graphics or image files, from inline graphics, such as \LaTeX-picture, PSTricks or pgf/TikZ generated pictures, or just from typeset text. Unlike standard movie/video formats, package `animate' allows for animating vector graphics. The result is roughly similar to the SWF (Flash) format, although not as space-efficient. The user interacts with the animation through optional animation controls or using the mouse like so: Pressing the mouse button over the animation widget immediately pauses a playing animation and releasing it resumes playback. Pressing the shift-key at the same time reverses the playback direction. Keeping the mouse button pressed while moving the mouse pointer off the animation widget permanently pauses playback. -Package `animate' supports the usual PDF making workflows, i.\,e. pdf\LaTeX{}, Lua\LaTeX{}, \LaTeX{} $\rightarrow$ \verb+dvips+ $\rightarrow$ \verb+ps2pdf+/Distiller and \pXepLaTeX{} $\rightarrow$ \verb+(x)dvipdfmx+. +Package `animate' supports the usual workflows for making PDF, i.\,e. pdf\LaTeX{}, Lua\LaTeX{}, \LaTeX{} $\rightarrow$ \verb+dvips+ $\rightarrow$ \verb+ps2pdf+/Distiller and \pXepLaTeX{} $\rightarrow$ \verb+(x)dvipdfmx+, and \LaTeX{} $\rightarrow$ \verb+dvisvgm+ for SVG. -PDF files with animations can be viewed in Acrobat Reader (except on mobile devices), PDF-XChange and Foxit Reader. +PDF files with animations can be viewed in Acrobat Reader (except on mobile devices), PDF-XChange and Foxit Reader. Animated SVG produced by means of \LaTeX{} and \verb+dvisvgm+ are self-contained files that can be embedded into HTML using the \verb++ tag or opened directly in a Web browser, such as Firefox or Chromium. \section{Requirements} \begin{trivlist} %\item $\varepsilon$-\TeX \item pdf\TeX{}, version $\ge1.20$, or Lua\TeX{}, version $\ge0.95$, for direct PDF output \item Ghostscript, version $\ge9.15$ or Adobe Distiller for PS to PDF conversion -\item dvipdfmx, version $\ge20080607$ for DVI to PDF conversion -\item Acrobat Reader (version $\ge7$), PDF-XChange, Foxit Reader +\item \verb+dvipdfmx+ for DVI to PDF conversion +\item \verb+dvisvgm+ for DVI to SVG conversion (also requires Ghostscript) +\item PDF: Acrobat Reader (version $\ge7$), PDF-XChange, Foxit Reader +\item SVG: Firefox, Chrome/Chromium and others \end{trivlist} \section{Installation} @@ -140,6 +142,7 @@ to the preamble of the document source, i.\,e. somewhere between \verb+\document \begin{verbatim} dvipdfmx xetex +dvisvgm export autoplay autopause @@ -164,16 +167,22 @@ type= method=icon | widget | ocg poster[=first | | last | none] \end{verbatim} -Except for `\verb+dvipdfmx+', `\verb+xetex+' and `\verb+export+', the listed package options are also available (among others) as command options and will be explained shortly. However, if used as package options they have global scope, taking effect on all animations in the document. In turn, command options locally override global settings. Options without an argument are boolean options and can be negated, with the exception of package-only options `\verb+dvipdfmx+', `\verb+xetex+' and `\verb+export+', by appending `\verb+=false+'. +Except for `\verb+dvipdfmx+', `\verb+xetex+', `\verb+dvisvgm+' and `\verb+export+', the listed package options are also available (among others) as command options and will be explained shortly. However, if used as package options they have global scope, taking effect on all animations in the document. In turn, command options locally override global settings. Options without an argument are boolean options and can be negated, with the exception of package-only options `\verb+dvipdfmx+', `\verb+xetex+', `\verb+dvisvgm+ and `\verb+export+', by appending `\verb+=false+'. \begin{animateinline}[autoplay,loop,nomouse]{1}\strut\emph{Important:}\newframe[3]\end{animateinline} Option `\verb+-Ppdf+' should \emph{not} be used with \verb+dvips+ when converting DVI to Postscript. If you cannot do without, put `\verb+-D 1200+' \emph{after} `\verb+-Ppdf+' on the command line. Users of \LaTeX-aware text editors with menu-driven toolchain invocation, such as \TeX{}nicCenter, should check the configuration of the \verb+dvips+ call. -All workflows require the `graphicx' package to be loaded explicitly. For \verb+dvipdfmx+, `\verb+dvipdfmx+' must be set as a document class option, as in +All workflows require the `graphicx' package to be loaded explicitly. + +Options `\verb+dvipdfmx+' or `\verb+dvisvgm+' must be set for the document class, as in %\verb+\documentclass[dvipdfmx,...]{...}+, \begin{verbatim} \documentclass[dvipdfmx,...]{...} \end{verbatim} -because this driver cannot be auto-detected by `animate', `graphicx' and other packages. +or +\begin{verbatim} + \documentclass[dvisvgm,...]{...} +\end{verbatim} +because these drivers cannot be auto-detected by `animate', `graphicx' and other packages. Usually, a second \LaTeX{} run is necessary to resolve internally created object references. A warning message will be issued if appropriate. @@ -229,7 +238,7 @@ For example, given the sequence `frame\_5.png' through `frame\_50.png' from a po \animategraphics{12}{frame_}{5}{50} \end{verbatim} -The possible file formats depend on the output driver being used. In the case of \LaTeX{} + \verb+dvips+, files with the `eps' extension are at first searched for, followed by `mps' (\MP-generated Postscript) and `ps'. With pdf\LaTeX{} and Lua\LaTeX{} the searching order is: (1)~`pdf', (2)~`mps', (3)~`png', (4)~`jpg', (5)~`jpeg', (6)~`jbig2', (7)~`jb2', (8)~`jp2'\footnotemark[1], (9)~`j2k'\footnotemark[1], (10)~`jpx'\footnotemark[1]\footnotetext[1]{Only Lua\LaTeX{} currently supports JPEG2000.} and with \XeLaTeX{} or \LaTeX{}+\verb+dvipdfmx+: (1)~`pdf', (2)~`mps', (3)~`eps', (4)~`ps', (5)~`png', (6)~`jpg', (7)~`jpeg', (8)~`bmp'. That is, files capable of storing vector graphics are found first. Make sure that all file names have \emph{lower case} extensions. +The possible file formats depend on the output driver being used. In the case of \LaTeX{} + \verb+dvips+, files with the `eps' extension are at first searched for, followed by `mps' (\MP-generated Postscript) and `ps'. With pdf\LaTeX{} and Lua\LaTeX{} the searching order is: (1)~`pdf', (2)~`mps', (3)~`png', (4)~`jpg', (5)~`jpeg', (6)~`jbig2', (7)~`jb2', (8)~`jp2'\footnotemark[1], (9)~`j2k'\footnotemark[1], (10)~`jpx'\footnotemark[1]\footnotetext[1]{Only Lua\LaTeX{} currently supports JPEG2000.}, with \XeLaTeX{} or \LaTeX{}+\verb+dvipdfmx+: (1)~`pdf', (2)~`mps', (3)~`eps', (4)~`ps', (5)~`png', (6)~`jpg', (7)~`jpeg', (8)~`bmp', and with \LaTeX{}+\verb+dvisvgm+: (1)~`eps', (2)~`ps', (3)~`svg', (4)~`png', (5)~`jpg', (6)~`jpeg'. That is, files capable of storing vector graphics are found first. Make sure that all file names have \emph{lower case} extensions. This searching procedure can be skipped thanks to the package and command option `\verb+type=+'. It enforces the embedding of files with the given file name extension \verb++. @@ -250,7 +259,7 @@ The following options to \verb+\animategraphics+ and `\verb+animateinline+' have \begin{verbatim} label=