summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/animate/README
blob: 96465dcfd1498e07d450be9e00e89aa6d9f239f4 (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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
                             =====================
                              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 and LaTeX ->
    dvips -> ps2pdf (Ghostscript).

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

    The first release of `animate' was based on the work by Jan Holecek and Petr
    Sojka:

           http://www.fi.muni.cz/~xholecek/tex/pdfanim.xhtml

    Meanwhile, the package was rewritten to use Optional Content Groups (OCG),
    aka PDF-Layers. OCG-based animations are fully supported by Adobe Reader 8,
    but have some performance issues. Playback is usually slower in Reader 8
    than in previous versions, which is probably a bug.

    The old, non-OCG approach is still available if the package file
    `animate-noocg.sty' is used instead of `animate.sty'. However, options
    `autoplay', `autopause' and `autoresume' are not functional in Reader 8.
    Moreover, the animation position and the play/pause buttons are not properly
    reset on page change. This is due to usage restrictions that Adobe imposed
    on some important JavaScript methods in Reader 8.

    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 animation animating embed animated
    graphics LaTeX pdfLaTeX PSTricks pgf TikZ MetaPost LaTeX-picture
    inline graphics vector graphics animated GIF LaTeX dvips ps2pdf
    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]


 \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 ...
 \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,
                     poster[=first | none | last], begin={<begin text>},
                     end={<end text>}, timeline=<timeline file>,
                     every=<number>, bb=<llx> <lly> <urx> <ury>,
                     viewport=<llx> <lly> <urx> <ury>,
                     trim=<left> <bottom> <right> <top>


Requirements:

  pdfTeX, version >= 1.20
  Ghostscript, version >= 8.31 or Adobe Distiller
  Adobe Reader, version >= 6, but not 8


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.