More doc updates for multi-frame images

* doc/emacs/files.texi (File Conveniences): Not just GIFs can be animated.

* doc/lispref/display.texi (Multi-Frame Images): Minor rephrasing.

* etc/NEWS: Related edits.

diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog
index ba6f7e3..83d5b1d 100644 (file)
--- a/doc/emacs/ChangeLog
+++ b/doc/emacs/ChangeLog
@@ -1,3 +1,7 @@
+2013-02-21  Glenn Morris  <rgm@gnu.org>
+
+       * files.texi (File Conveniences): Not just GIFs can be animated.
+
 2013-02-13  Glenn Morris  <rgm@gnu.org>
 
        * ack.texi (Acknowledgments): Don't mention yow any more.

diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi
index a85c16e..7f7ae48 100644 (file)
--- a/doc/emacs/files.texi
+++ b/doc/emacs/files.texi
@@ -1937,8 +1937,7 @@ or taller than the frame, the usual point motion keys (@kbd{C-f},
 displayed.  If the image can be animated, the command @kbd{RET}
 (@code{image-toggle-animation}) starts or stops the animation.
 Animation plays once, unless the option @code{image-animate-loop} is
-non-@code{nil}.  Currently, Emacs only supports animation in GIF
-files.
+non-@code{nil}.
 
 @cindex ImageMagick support
 @vindex imagemagick-enabled-types

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 74f2eb9..355d0b5 100644 (file)
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,7 @@
+2013-02-21  Glenn Morris  <rgm@gnu.org>
+
+       * display.texi (Multi-Frame Images): Minor rephrasing.
+
 2013-02-20  Glenn Morris  <rgm@gnu.org>
 
        * display.texi (GIF Images, TIFF Images): Delete these nodes.

diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 1e596c1..eae6af9 100644 (file)
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -4925,10 +4925,10 @@ integer (counting from 0) that specifies which frame is being displayed.
 This function returns non-@code{nil} if @var{image} contains more than
 one frame.  The actual return value is a cons @code{(@var{nimages}
 . @var{delay})}, where @var{nimages} is the number of frames and
-@var{delay} is the delay in seconds between them, if the image itself
-specifies a delay.  Images that are intended to be animated usually
-specify a frame delay, whereas ones that are intended to be treated as
-multiple pages do not.
+@var{delay} is the delay in seconds between them, or @code{nil}
+if the image does not specify a delay.  Images that are intended to be
+animated usually specify a frame delay, whereas ones that are intended
+to be treated as multiple pages do not.
 @end defun
 
 @defun image-current-frame image

diff --git a/etc/NEWS b/etc/NEWS
index 2eda7a5..de151d0 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -145,8 +145,6 @@ directory, respectively.
 `f' (`image-next-frame') and `b' (`image-previous-frame') visit the
 next or previous frame.  `F' (`image-goto-frame') shows a specific frame.
 
-*** `image-animated-p' is now `image-multi-frame-p'.
-
 ---
 *** The command `image-mode-fit-frame' deletes other windows.
 When toggling, it restores the frame's previous window configuration.
@@ -291,6 +289,21 @@ rather than inheriting from it (as do face specs set via Customize).
 *** New face characteristic (supports :underline (:style wave))
 specifies whether or not the terminal can display a wavy line.
 
+** Image API
+
++++
+*** `image-animated-p' is now `image-multi-frame-p'.
+It returns non-nil for any image that contains multiple frames,
+whether or not it specifies a frame delay.
+
++++
+*** When animating images that do not specify a frame delay,
+Emacs uses `image-default-frame-delay'.
+
++++
+*** New functions `image-current-frame' and `image-show-frame' for getting
+and setting the current frame of a multi-frame image.
+
 ** time-to-seconds is not obsolete any more.
 ** New function special-form-p.
 ** Docstrings can be made dynamic by adding a `dynamic-docstring-function'