CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/animate

README.md

The animate Package

© 2007–\today Alexander Grahn

https://gitlab.com/agrahn/animate

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 -picture, PSTricks or pgf/TikZ generated pictures, or just from typeset text.

It supports the usual PDF making workflows, i. e. pdf, dvipsps2pdf (Ghostscript)/Distiller, (Xe)(x)dvipdfmx, Lua., and 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 4ht web animating embed animated graphics pdf Lua PSTricks pgf TikZ -picture inline graphics vector graphics animated GIF dvips ps2pdf dvipdfmx XeLaTeX JavaScript Acrobat Reader PDF-XChange Foxit Reader Firefox Chrome Chromium

Usage

\usepackage[<package options>]{animate}

  • Package options:
width=<h-size>, height=<v-size>, totalheight=<v-size>,
keepaspectratio, scale=<factor>, nomouse,
hiresbb,pagebox,interpolate,
autopause, autoplay, autoresume, controls[=all | none | ...],
final, draft,
buttonsize=<size>,
buttonbg=<colour>, buttonfg=<colour>, buttonalpha=<opacity>,
loop, palindrome, step,
poster[=first | <num> | last | none],
alttext=none | {<alternative description>},
method=icon | widget | ocg,
dvipdfmx, dvisvgm, xetex,
type=[<file ext>],
export

  • User interface:
\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,
hiresbb,pagebox,interpolate,
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>]

Requirements

Recent versions of

  • Ghostscript or Adobe Distiller
  • dvipdfmx
  • dvisvgm
  • PDF: Acrobat Reader, PDF-XChange, Foxit Reader
  • SVG: Blink-based web browsers (Chromium, Chrome, Opera, ...) or Firefox

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.

Live and MiK users should run the package manager for installation.

License

This material is subject to the Project Public License.

Download the contents of this package in one zip archive (3.1M).

animate – Create PDF and SVG animations from graphics files and inline graphics

The package provides an interface to create portable, JavaScript driven PDF and SVG animations from sets of graphics files or from inline graphics, such as picture environment, PSTricks or pgf/TikZ generated pictures, or just from typeset text.

Packageanimate
Repositoryhttps://gitlab.com/agrahn/animate
Version 2019-08-20
LicensesThe Project Public License
Copyright2007–2019 Alexander Grahn
MaintainerAlexander Grahn
TDS archiveanimate.tds.zip
Contained inTeX Live as animate
MiKTeX as animate
TopicsGraphics motion
...
Guest Book Sitemap Contact Contact Author