CTAN masthead graphic CTAN lion sketch

Directory: CTAN home / tex-archive/ macros/ latex/ contrib/ animate

You can get this entire directory bundled as animate.zip.

You can get an installable bundling called animate.tds.zip of the package from this directory.

Packages located here

Package Caption
animate Create PDF animations from graphics files and inline graphics.

Subdirectories of this one

NameDateDescription
doc/ 2008-10-06

Files in this directory

NameDateSize Description
README 2008-07-29 3 Kbyte download Shown below
animate.sty 2008-10-06 107 Kbyte download
animfp.sty 2008-07-21 9 Kbyte download

Contents of the README file

                             =====================
                              The animate Package
                             =====================

Author:

    Alexander Grahn


Description:

    This package provides an interface to create portable, JavaScript driven PDF
    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 and (Xe)LaTeX -> (x)dvipdfmx.

    The resulting PDF can be viewed in current Adobe Readers on all supported
    platforms.

    Note, this file only gives a summary of usage and available package and
    command options. Please refer to the documentation `animate.pdf' in the
    `doc/' directory for details and examples.

    Keywords: include portable PDF animated PDF animation animating
    embed animated graphics LaTeX pdfLaTeX PSTricks pgf TikZ MetaPost
    LaTeX-picture inline graphics vector graphics animated GIF LaTeX
    dvips ps2pdf dvipdfmx XeLaTeX JavaScript Adobe Reader


Usage:

    \usepackage[<package options>]{animate}

    * Package options: autopause, autoplay, autoresume, controls, final, draft,
                     buttonsize=<size>, buttonbg=<colour>, buttonfg=<colour>,
                     loop, palindrome, step, poster[=first | none | last],
                     useocg, dvipdfmx, xetex


    \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=<width>, height=<height>, depth=<depth>,
                       scale=<factor>, autopause, autoplay, autoresume, final,
                       draft, controls, buttonsize=<size>, buttonbg=<colour>,
                       buttonfg=<colour>, loop, palindrome, step, measure,
                       poster[=first | none | last], begin={<begin text>},
                       end={<end text>}, timeline=<timeline file>, useocg,
                       every=<number>, bb=<llx> <lly> <urx> <ury>,
                       viewport=<llx> <lly> <urx> <ury>,
                       trim=<left> <bottom> <right> <top>


Requirements:

    e-TeX
    pdfTeX, version >= 1.20
    Ghostscript, version >= 8.31 or Adobe Distiller
    dvipdfmx, version >= 20080607
    Adobe Reader, version >= 6


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.

    MiKTeX users should run the package manager for installation.


License:

    This material is subject to the LaTeX Project Public License. See

      http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html

    for the details of that license.

Small print: This listing is regenerated periodically so there is a small chance that the directory has changed from what is shown here; to be sure, check the FTP listing.