[Emacs-diffs] trunk r113082: * doc/lispref/keymaps.texi (Active Keymaps): Fix documentation of

[Stefan Monnier]

------------------------------------------------------------
revno: 113082
revision-id: address@hidden
parent: address@hidden
committer: Stefan Monnier <address@hidden>
branch nick: trunk
timestamp: Wed 2013-06-19 09:51:47 -0400
message:
  * doc/lispref/keymaps.texi (Active Keymaps): Fix documentation of
  set-temporary-overlay-map and overriding-terminal-local-map.
  * doc/lispref/modes.texi (Mode Line Data, Properties in Mode): Advertise
  `keymap' rather than `local-map'.
modified:
  doc/lispref/ChangeLog          changelog-20091113204419-o5vbwnq5f7feedwu-6155
  doc/lispref/display.texi       
display.texi-20091113204419-o5vbwnq5f7feedwu-6172
  doc/lispref/keymaps.texi       
keymaps.texi-20091113204419-o5vbwnq5f7feedwu-6190
  doc/lispref/modes.texi         modes.texi-20091113204419-o5vbwnq5f7feedwu-6201

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2013-06-19 03:49:26 +0000
+++ b/doc/lispref/ChangeLog     2013-06-19 13:51:47 +0000
@@ -1,3 +1,11 @@
+2013-06-19  Stefan Monnier  <address@hidden>
+
+       * modes.texi (Mode Line Data, Properties in Mode): Advertise `keymap'
+       rather than `local-map'.
+
+       * keymaps.texi (Active Keymaps): Fix documentation of
+       set-temporary-overlay-map and overriding-terminal-local-map.
+
 2013-06-19  Glenn Morris  <address@hidden>
 
        * Makefile.in (dist): Edit more configure variables.

=== modified file 'doc/lispref/display.texi'
--- a/doc/lispref/display.texi  2013-06-17 15:04:50 +0000
+++ b/doc/lispref/display.texi  2013-06-19 13:51:47 +0000
@@ -1655,26 +1655,26 @@
 an empty overlay a address@hidden @code{evaporate} property, that deletes
 it immediately.
 
address@hidden keymap
address@hidden keymap of character (and overlays)
address@hidden keymap @r{(overlay property)}
+If this property is address@hidden, it specifies a keymap for a portion of the
+text.  This keymap is used when the character after point is within the
+overlay, and takes precedence over most other keymaps.  @xref{Active Keymaps}.
+
 @item local-map
address@hidden keymap of character (and overlays)
 @kindex local-map @r{(overlay property)}
-If this property is address@hidden, it specifies a keymap for a portion
-of the text.  The property's value replaces the buffer's local map, when
-the character after point is within the overlay.  @xref{Active Keymaps}.
-
address@hidden keymap
address@hidden keymap @r{(overlay property)}
-The @code{keymap} property is similar to @code{local-map} but overrides the
-buffer's local map (and the map specified by the @code{local-map}
-property) rather than replacing it.
+The @code{local-map} property is similar to @code{keymap} but replaces the
+buffer's local map rather than augmenting existing keymaps.  This also means it
+has lower precedence than minor mode keymaps.
 @end table
 
-The @code{local-map} and @code{keymap} properties do not affect a
+The @code{keymap} and @code{local-map} properties do not affect a
 string displayed by the @code{before-string}, @code{after-string}, or
 @code{display} properties.  This is only relevant for mouse clicks and
 other mouse events that fall on the string, since point is never on
 the string.  To bind special mouse events for the string, assign it a
address@hidden or @code{keymap} text property.  @xref{Special
address@hidden or @code{local-map} text property.  @xref{Special
 Properties}.
 
 @node Finding Overlays

=== modified file 'doc/lispref/keymaps.texi'
--- a/doc/lispref/keymaps.texi  2013-02-13 04:31:09 +0000
+++ b/doc/lispref/keymaps.texi  2013-06-19 13:51:47 +0000
@@ -663,17 +663,16 @@
 
   The highest precedence normal keymap comes from the @code{keymap}
 text or overlay property.  If that is address@hidden, it is the first
-keymap to be processed, in normal circumstances.  Next comes
-any keymap added by the function @code{set-temporary-overlay-map}.
address@hidden Active Maps}.
+keymap to be processed, in normal circumstances.
 
   However, there are also special ways for programs to substitute
 other keymaps for some of those.  The variable
 @code{overriding-local-map}, if address@hidden, specifies a keymap
 that replaces all the usual active keymaps except the global keymap.
-Another way to do this is with @code{overriding-terminal-local-map};
-it operates on a per-terminal basis.  These variables are documented
-below.
+
+The very highest precedence keymap comes from
address@hidden; it operates on a per-terminal basis and
+is normally used for modal/transient keybindings.
 
 @cindex major mode keymap
   Since every buffer that uses the same major mode normally uses the

=== modified file 'doc/lispref/modes.texi'
--- a/doc/lispref/modes.texi    2013-02-15 06:35:54 +0000
+++ b/doc/lispref/modes.texi    2013-06-19 13:51:47 +0000
@@ -1800,7 +1800,7 @@
 characters which have no @code{face} properties are displayed, by
 default, in the face @code{mode-line} or @code{mode-line-inactive}
 (@pxref{Standard Faces,,, emacs, The GNU Emacs Manual}).  The
address@hidden and @code{local-map} properties in @var{string} have
address@hidden and @code{keymap} properties in @var{string} have
 special meanings.  @xref{Properties in Mode}.
 
 @item @var{symbol}
@@ -2205,7 +2205,7 @@
   Certain text properties are meaningful in the
 mode line.  The @code{face} property affects the appearance of text; the
 @code{help-echo} property associates help strings with the text, and
address@hidden can make the text mouse-sensitive.
address@hidden can make the text mouse-sensitive.
 
   There are four ways to specify text properties for text in the mode
 line:
@@ -2229,7 +2229,7 @@
 property.
 @end enumerate
 
-  You can use the @code{local-map} property to specify a keymap.  This
+  You can use the @code{keymap} property to specify a keymap.  This
 keymap only takes real effect for mouse clicks; binding character keys
 and function keys to it has no effect, since it is impossible to move
 point into the mode line.