diff options
author | Karl Berry <karl@freefriends.org> | 2018-12-20 23:33:07 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2018-12-20 23:33:07 +0000 |
commit | abaa7495cdb0085d22d3b04bb5a1f19bdd132fd9 (patch) | |
tree | 94cf40068d2323860d94679df98f395a14af2557 /Master/texmf-dist/doc/latex/animate/README.txt | |
parent | c1c2f89e5ac31208bb51e9e29ebbd21084474d96 (diff) |
animate (20dec18)
git-svn-id: svn://tug.org/texlive/trunk@49461 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/animate/README.txt')
-rw-r--r-- | Master/texmf-dist/doc/latex/animate/README.txt | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/animate/README.txt b/Master/texmf-dist/doc/latex/animate/README.txt new file mode 100644 index 00000000000..8d0cf82e541 --- /dev/null +++ b/Master/texmf-dist/doc/latex/animate/README.txt @@ -0,0 +1,123 @@ +=================================== + The animate Package + + https://gitlab.com/agrahn/animate + + (C) 2007--\today Alexander Grahn +=================================== + + +1. Description +============== + +This package provides an interface to create portable, JavaScript driven PDF +and SVG animations from sets of (vector) graphics or rasterized image files +or from inline (vector) graphics, such as LaTeX-picture, PSTricks or pgf/TikZ +generated pictures, or just from typeset text. + +It supports the usual PDF making workflows, i. e. pdfLaTeX, LaTeX -> dvips +-> ps2pdf (Ghostscript)/Distiller, (Xe)LaTeX -> (x)dvipdfmx, LuaLaTeX, and +LaTeX -> dvisvgm for SVG. + +The resulting PDF with animations can be viewed in Acrobat Reader (except +on mobile devices), in PDF-XChange and in Foxit Reader. Animated SVG are +self-contained files that can be embedded into HTML using the `<object>` tag or +opened directly in a Web browser, such as Firefox or Chromium. + +Note, this file only gives a summary of usage and available package and +command options. Please refer to the documentation `animate.pdf' for details +and examples. + + * 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 + + +2. Usage +======== + +\usepackage[<package options>]{animate} + + * Package options: width=<h-size>, height=<v-size>, totalheight=<v-size>, + keepaspectratio, scale=<factor>, nomouse, + autopause, autoplay, autoresume, controls[=all | none | ...], + final, draft, + buttonsize=<size>, + buttonbg=<colour>, buttonfg=<colour>, buttonalpha=<opacity>, + loop, palindrome, step, + poster[=first | <num> | last | none], + method=icon | widget | ocg, + dvipdfmx, dvisvgm, xetex, + type=[<file ext>], + export + + +\animategraphics[<options>]{<frame rate>}{<file basename>}{<first>}{<last>} + +\begin{animateinline}[<options>]{<frame rate>} + ... typeset material ... +\newframe[<frame rate>] + ... typeset material ... +\newframe*[<frame rate>] + ... typeset material ... +\newframe +\multiframe{<number of frames>}{[<variables>]}{ + ... repeated (parameterized) material ... +} +\end{animateinline} + + * Command options: width=<h-size>, height=<v-size>, totalheight=<v-size>, + keepaspectratio, scale=<factor>, nomouse, + autopause, autoplay, autoresume, final, draft, + controls[=all | none | ...], + buttonsize=<size>, + buttonbg=<colour>, buttonfg=<colour>, buttonalpha=<opacity>, + loop, palindrome, step, measure, + poster[=first | <num> | last | none], + begin={<begin text>}, end={<end text>}, + timeline=<timeline file>, + method=icon | widget | ocg, + every=<number>, bb=<llx> <lly> <urx> <ury>, + viewport=<llx> <lly> <urx> <ury>, + trim=<left> <bottom> <right> <top>, + label=<label text>, type=[<file ext>] + + +3. Requirements +=============== + + * e-TeX + * pdfTeX, version >= 1.20, or LuaLaTeX, version >= 0.95 + * Ghostscript, version >= 9.15 or Adobe Distiller + * dvipdfmx, version >= 20080607 + * dvisvgm + * Acrobat Reader (version >= 7), PDF-XChange, Foxit Reader + * Firefox, Chrome, Chromium + + +4. Installation +=============== + +Unzip the file `animate.tds.zip' into the local TDS root directory which can +be found by running + + kpsewhich -var-value TEXMFLOCAL + +on the command line. + +After installation, update the filename database by running `texhash' on the +command line. + +TeXLive and MiKTeX users should run the package manager for installation. + + + * * * + +This material is subject to the LaTeX Project Public License. See + + http://mirrors.ctan.org/macros/latex/base/lppl.txt + +for the details of that license. |