summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/animate/README
blob: fd24ad33f783875f141557f5f4fc346f3a2d470f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
                             =====================
                              The animate Package
                             =====================

Author:

    Alexander Grahn


Description:

    This package provides an interface to create portable, JavaScript driven PDF
    animations from sets of graphics files or from inline 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 and LaTeX
    -> dvips -> ps2pdf (Ghostscript) / Distiller. 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, animation, embed, animated, inline graphics,
              graphics files, LaTeX, dvips, ps2pdf, pdfLaTeX, PDF, JavaScript,
              PSTricks, pgf, TikZ, LaTeX-picture, Adobe Reader


Usage:

 \usepackage[<package options>]{animate}

 * Package options: autopause, autoplay, autoresume, controls,
                    buttonsize=<size>, screenbg=<colour>, buttonbg=<colour>,
                    loop, palindrome


 \animategraphics[<options>]{<frame rate>}{<file basename>}{<first>}{<last>}

 \begin{animate}[<options>]{<frame rate>}
     ... typeset material ...
 \newframe
     ... typeset material ...
 \newframe
     ... typeset material ...
 \end{animate}

 * Command options: width=<width>, height=<height>, depth=<depth>,
                    scale=<factor>, autopause, autoplay, autoresume, controls,
                    buttonsize=<size>, screenbg=<colour>, buttonbg=<colour>,
                    loop, palindrome


Requirements:

  pdfLaTeX, version >= 1.20 is needed for direct PDF output.


Installation:

  Put the file animate.sty to a place where TeX can find it.


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.