[Emacs-diffs] /srv/bzr/emacs/trunk r111843: More doc updates for multi-frame images

[Glenn Morris]

------------------------------------------------------------
revno: 111843
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Wed 2013-02-20 22:03:02 -0800
message:
  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.
modified:
  doc/emacs/ChangeLog
  doc/emacs/files.texi
  doc/lispref/ChangeLog
  doc/lispref/display.texi
  etc/NEWS

=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2013-02-13 08:50:44 +0000
+++ b/doc/emacs/ChangeLog       2013-02-21 06:03:02 +0000
@@ -1,3 +1,7 @@
+2013-02-21  Glenn Morris  <address@hidden>
+
+       * files.texi (File Conveniences): Not just GIFs can be animated.
+
 2013-02-13  Glenn Morris  <address@hidden>
 
        * ack.texi (Acknowledgments): Don't mention yow any more.

=== modified file 'doc/emacs/files.texi'
--- a/doc/emacs/files.texi      2013-01-01 09:11:05 +0000
+++ b/doc/emacs/files.texi      2013-02-21 06:03:02 +0000
@@ -1937,8 +1937,7 @@
 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
address@hidden  Currently, Emacs only supports animation in GIF
-files.
address@hidden
 
 @cindex ImageMagick support
 @vindex imagemagick-enabled-types

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2013-02-20 08:34:28 +0000
+++ b/doc/lispref/ChangeLog     2013-02-21 06:03:02 +0000
@@ -1,3 +1,7 @@
+2013-02-21  Glenn Morris  <address@hidden>
+
+       * display.texi (Multi-Frame Images): Minor rephrasing.
+
 2013-02-20  Glenn Morris  <address@hidden>
 
        * display.texi (GIF Images, TIFF Images): Delete these nodes.

=== modified file 'doc/lispref/display.texi'
--- a/doc/lispref/display.texi  2013-02-20 08:34:28 +0000
+++ b/doc/lispref/display.texi  2013-02-21 06:03:02 +0000
@@ -4925,10 +4925,10 @@
 This function returns address@hidden 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
address@hidden 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.
address@hidden 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

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2013-02-16 19:56:50 +0000
+++ b/etc/NEWS  2013-02-21 06:03:02 +0000
@@ -145,8 +145,6 @@
 `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 @@
 *** 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'