aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref
diff options
context:
space:
mode:
authorLars Ingebrigtsen2016-04-29 14:36:23 +0200
committerLars Ingebrigtsen2016-05-01 19:27:08 +0200
commit3cbc1e342791ce11b1fe2ce9e3d66f7431c656c2 (patch)
tree8dfd225b864c60be53b9a73002ed86b99d7774a1 /doc/lispref
parentde8349e125d24e1e53cdb5c54d45a32582682ff2 (diff)
downloademacs-3cbc1e342791ce11b1fe2ce9e3d66f7431c656c2.tar.gz
emacs-3cbc1e342791ce11b1fe2ce9e3d66f7431c656c2.zip
Change all occurrences of "Mouse-[0-9]" to "mouse-[0-9]"
* doc/emacs/*.texi: Change all occurrences of "Mouse-[0-9]" to "mouse-[0-9]". These are case sensitive, and the keys are lower case (bug#14554). (cherry picked from commit e4c26271f2c2fe08f8490e25c63a436ab2a804ca)
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/display.texi4
-rw-r--r--doc/lispref/text.texi42
2 files changed, 23 insertions, 23 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 010dcb2fd1f..c80f78c0e3b 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -5820,7 +5820,7 @@ A string displayed by the Emacs tool-tip help system; by default,
5820 5820
5821@item follow-link 5821@item follow-link
5822@kindex follow-link @r{(button property)} 5822@kindex follow-link @r{(button property)}
5823The follow-link property, defining how a @key{Mouse-1} click behaves 5823The follow-link property, defining how a @key{mouse-1} click behaves
5824on this button, @xref{Clickable Text}. 5824on this button, @xref{Clickable Text}.
5825 5825
5826@item button 5826@item button
@@ -6007,7 +6007,7 @@ additionally available in the keymap stored in
6007@code{button-buffer-map} as a parent keymap for its keymap. 6007@code{button-buffer-map} as a parent keymap for its keymap.
6008 6008
6009If the button has a non-@code{nil} @code{follow-link} property, and 6009If the button has a non-@code{nil} @code{follow-link} property, and
6010@code{mouse-1-click-follows-link} is set, a quick @key{Mouse-1} click 6010@code{mouse-1-click-follows-link} is set, a quick @key{mouse-1} click
6011will also activate the @code{push-button} command. 6011will also activate the @code{push-button} command.
6012@xref{Clickable Text}. 6012@xref{Clickable Text}.
6013 6013
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 1ad665f0e5b..ab55c2037d7 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -3707,7 +3707,7 @@ properties. For simplicity, we will refer to the clickable text as a
3707 3707
3708 Implementing a link involves three separate steps: (1) indicating 3708 Implementing a link involves three separate steps: (1) indicating
3709clickability when the mouse moves over the link; (2) making @key{RET} 3709clickability when the mouse moves over the link; (2) making @key{RET}
3710or @kbd{Mouse-2} on that link do something; and (3) setting up a 3710or @kbd{mouse-2} on that link do something; and (3) setting up a
3711@code{follow-link} condition so that the link obeys 3711@code{follow-link} condition so that the link obeys
3712@code{mouse-1-click-follows-link}. 3712@code{mouse-1-click-follows-link}.
3713 3713
@@ -3729,10 +3729,10 @@ names are clickable:
3729 help-echo "mouse-2: visit this file in other window"))) 3729 help-echo "mouse-2: visit this file in other window")))
3730@end smallexample 3730@end smallexample
3731 3731
3732 To make the link clickable, bind @key{RET} and @kbd{Mouse-2} to 3732 To make the link clickable, bind @key{RET} and @kbd{mouse-2} to
3733commands that perform the desired action. Each command should check 3733commands that perform the desired action. Each command should check
3734to see whether it was called on a link, and act accordingly. For 3734to see whether it was called on a link, and act accordingly. For
3735instance, Dired's major mode keymap binds @kbd{Mouse-2} to the 3735instance, Dired's major mode keymap binds @kbd{mouse-2} to the
3736following command: 3736following command:
3737 3737
3738@smallexample 3738@smallexample
@@ -3775,12 +3775,12 @@ bind it within the link text, using the @code{keymap} text property
3775@noindent 3775@noindent
3776With this method, you can easily define different commands for 3776With this method, you can easily define different commands for
3777different links. Furthermore, the global definition of @key{RET} and 3777different links. Furthermore, the global definition of @key{RET} and
3778@kbd{Mouse-2} remain available for the rest of the text in the buffer. 3778@kbd{mouse-2} remain available for the rest of the text in the buffer.
3779 3779
3780@vindex mouse-1-click-follows-link 3780@vindex mouse-1-click-follows-link
3781 The basic Emacs command for clicking on links is @kbd{Mouse-2}. 3781 The basic Emacs command for clicking on links is @kbd{mouse-2}.
3782However, for compatibility with other graphical applications, Emacs 3782However, for compatibility with other graphical applications, Emacs
3783also recognizes @kbd{Mouse-1} clicks on links, provided the user 3783also recognizes @kbd{mouse-1} clicks on links, provided the user
3784clicks on the link quickly without moving the mouse. This behavior is 3784clicks on the link quickly without moving the mouse. This behavior is
3785controlled by the user option @code{mouse-1-click-follows-link}. 3785controlled by the user option @code{mouse-1-click-follows-link}.
3786@xref{Mouse References,,, emacs, The GNU Emacs Manual}. 3786@xref{Mouse References,,, emacs, The GNU Emacs Manual}.
@@ -3794,9 +3794,9 @@ mode keymap or a local keymap specified via the @code{keymap} text
3794property). The value of the @code{follow-link} property, or the 3794property). The value of the @code{follow-link} property, or the
3795binding for the @code{follow-link} event, acts as a condition for 3795binding for the @code{follow-link} event, acts as a condition for
3796the link action. This condition tells Emacs two things: the 3796the link action. This condition tells Emacs two things: the
3797circumstances under which a @kbd{Mouse-1} click should be regarded as 3797circumstances under which a @kbd{mouse-1} click should be regarded as
3798occurring inside the link, and how to compute an action code 3798occurring inside the link, and how to compute an action code
3799that says what to translate the @kbd{Mouse-1} click into. The link 3799that says what to translate the @kbd{mouse-1} click into. The link
3800action condition can be one of the following: 3800action condition can be one of the following:
3801 3801
3802@table @asis 3802@table @asis
@@ -3805,7 +3805,7 @@ If the condition is the symbol @code{mouse-face}, a position is inside
3805a link if there is a non-@code{nil} @code{mouse-face} property at that 3805a link if there is a non-@code{nil} @code{mouse-face} property at that
3806position. The action code is always @code{t}. 3806position. The action code is always @code{t}.
3807 3807
3808For example, here is how Info mode handles @key{Mouse-1}: 3808For example, here is how Info mode handles @key{mouse-1}:
3809 3809
3810@smallexample 3810@smallexample
3811(define-key Info-mode-map [follow-link] 'mouse-face) 3811(define-key Info-mode-map [follow-link] 'mouse-face)
@@ -3817,7 +3817,7 @@ is inside a link if @code{(@var{func} @var{pos})} evaluates to
3817non-@code{nil}. The value returned by @var{func} serves as the action 3817non-@code{nil}. The value returned by @var{func} serves as the action
3818code. 3818code.
3819 3819
3820For example, here is how pcvs enables @kbd{Mouse-1} to follow links on 3820For example, here is how pcvs enables @kbd{mouse-1} to follow links on
3821file names only: 3821file names only:
3822 3822
3823@smallexample 3823@smallexample
@@ -3835,27 +3835,27 @@ to the entire buffer).
3835@end table 3835@end table
3836 3836
3837@noindent 3837@noindent
3838The action code tells @kbd{Mouse-1} how to follow the link: 3838The action code tells @kbd{mouse-1} how to follow the link:
3839 3839
3840@table @asis 3840@table @asis
3841@item a string or vector 3841@item a string or vector
3842If the action code is a string or vector, the @kbd{Mouse-1} event is 3842If the action code is a string or vector, the @kbd{mouse-1} event is
3843translated into the first element of the string or vector; i.e., the 3843translated into the first element of the string or vector; i.e., the
3844action of the @kbd{Mouse-1} click is the local or global binding of 3844action of the @kbd{mouse-1} click is the local or global binding of
3845that character or symbol. Thus, if the action code is @code{"foo"}, 3845that character or symbol. Thus, if the action code is @code{"foo"},
3846@kbd{Mouse-1} translates into @kbd{f}. If it is @code{[foo]}, 3846@kbd{mouse-1} translates into @kbd{f}. If it is @code{[foo]},
3847@kbd{Mouse-1} translates into @key{foo}. 3847@kbd{mouse-1} translates into @key{foo}.
3848 3848
3849@item anything else 3849@item anything else
3850For any other non-@code{nil} action code, the @kbd{Mouse-1} event is 3850For any other non-@code{nil} action code, the @kbd{mouse-1} event is
3851translated into a @kbd{Mouse-2} event at the same position. 3851translated into a @kbd{mouse-2} event at the same position.
3852@end table 3852@end table
3853 3853
3854 To define @kbd{Mouse-1} to activate a button defined with 3854 To define @kbd{mouse-1} to activate a button defined with
3855@code{define-button-type}, give the button a @code{follow-link} 3855@code{define-button-type}, give the button a @code{follow-link}
3856property. The property value should be a link action condition, as 3856property. The property value should be a link action condition, as
3857described above. @xref{Buttons}. For example, here is how Help mode 3857described above. @xref{Buttons}. For example, here is how Help mode
3858handles @kbd{Mouse-1}: 3858handles @kbd{mouse-1}:
3859 3859
3860@smallexample 3860@smallexample
3861(define-button-type 'help-xref 3861(define-button-type 'help-xref
@@ -3863,11 +3863,11 @@ handles @kbd{Mouse-1}:
3863 'action #'help-button-action) 3863 'action #'help-button-action)
3864@end smallexample 3864@end smallexample
3865 3865
3866 To define @kbd{Mouse-1} on a widget defined with 3866 To define @kbd{mouse-1} on a widget defined with
3867@code{define-widget}, give the widget a @code{:follow-link} property. 3867@code{define-widget}, give the widget a @code{:follow-link} property.
3868The property value should be a link action condition, as described 3868The property value should be a link action condition, as described
3869above. For example, here is how the @code{link} widget specifies that 3869above. For example, here is how the @code{link} widget specifies that
3870a @key{Mouse-1} click shall be translated to @key{RET}: 3870a @key{mouse-1} click shall be translated to @key{RET}:
3871 3871
3872@smallexample 3872@smallexample
3873(define-widget 'link 'item 3873(define-widget 'link 'item