aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman1993-09-14 18:20:59 +0000
committerRichard M. Stallman1993-09-14 18:20:59 +0000
commit8669cecff5590342ca9c07c4760ac576a4000be8 (patch)
tree4b8755915339eb809a3c8bb454774c33b49b71d4
parentbf4de26a0372ae78c53a9a405f298844b9b40ad9 (diff)
downloademacs-8669cecff5590342ca9c07c4760ac576a4000be8.tar.gz
emacs-8669cecff5590342ca9c07c4760ac576a4000be8.zip
Fix lots of doc strings.
(iso-accents-mode): Positive arg means enable. No arg means toggle.
-rw-r--r--lisp/international/iso-acc.el36
1 files changed, 21 insertions, 15 deletions
diff --git a/lisp/international/iso-acc.el b/lisp/international/iso-acc.el
index 26d55ab1e30..acf45f40564 100644
--- a/lisp/international/iso-acc.el
+++ b/lisp/international/iso-acc.el
@@ -47,8 +47,8 @@
47;; self-insert-command, the dead-key code is terminated, the 47;; self-insert-command, the dead-key code is terminated, the
48;; pseudo-accent inserted 'as is' and the bell is rung to signal this. 48;; pseudo-accent inserted 'as is' and the bell is rung to signal this.
49;; 49;;
50;; Function `iso-accents' can be used to enable the iso accents 50;; Function `iso-accents-mode' can be used to enable the iso accents
51;; minor mode, or disable it when called with a non-null argument. 51;; minor mode, or disable it.
52 52
53;;; Code: 53;;; Code:
54 54
@@ -104,10 +104,10 @@
104 ((?\" ? ) ?\") 104 ((?\" ? ) ?\")
105 ((?\" ?\") ?\250) 105 ((?\" ?\") ?\250)
106 ) 106 )
107 "Association list for iso accent combinations.") 107 "Association list for ISO accent combinations.")
108 108
109(defun iso-accents-dead-key () 109(defun iso-accents-dead-key ()
110 "Emulate typewriter dead keys." 110 "Modify the following character by adding an accent to it."
111 (interactive) 111 (interactive)
112 112
113 ;; Pick up the dead-key. 113 ;; Pick up the dead-key.
@@ -135,10 +135,11 @@
135 (beep 1)))))) 135 (beep 1))))))
136 136
137(defvar iso-accents-minor-mode nil 137(defvar iso-accents-minor-mode nil
138 "Buffer local variable that denotes 'dead key' minor mode.") 138 "*Non-nil enables ISO-accents mode.
139See `iso-accents-mode'."
139 140
140(defvar iso-accents-prefix-map nil 141(defvar iso-accents-prefix-map nil
141 "Keymap for 'dead key' minor mode.") 142 "Keymap for ISO-accents minor mode.")
142 143
143;; It is a matter of taste if you want the minor mode indicated 144;; It is a matter of taste if you want the minor mode indicated
144;; in the mode line... 145;; in the mode line...
@@ -149,13 +150,15 @@
149;; '((iso-accents-minor-mode " ISO-Acc"))))) 150;; '((iso-accents-minor-mode " ISO-Acc")))))
150 151
151;;;###autoload 152;;;###autoload
152(defun iso-accents (&optional arg) 153(defun iso-accents-mode (&optional arg)
153 "Allow easy insertion of accented characters according to ISO-8859-1. 154 "Toggle a minor mode in which accent modify the following letter.
154When called without an argument, or with a null argument, pseudo-accent 155This permits easy insertion of accented characters according to ISO-8859-1.
155keys (', \", ^ and ~) will behave like dead typewriter keys: when 156When Iso-accents mode is enabled, accent character keys
156followed by an appropriate character the combination will be replaced 157\(', \", ^ and ~) do not self-insert; instead, they modify the following
157by the corresponding ISO character code for the accented character. 158letter key so that it inserts an ISO accented letter.
158Calling `iso-accents' with an argument will make all keys normal again." 159
160With an argument, a positive argument enables ISO-accents mode,
161and a negative argument disables it."
159;; When called, a buffer local variable iso-accents-minor-mode is created 162;; When called, a buffer local variable iso-accents-minor-mode is created
160;; to record iso-accents-minor-mode status. 163;; to record iso-accents-minor-mode status.
161;; A minor mode map `iso-accents-prefix-map' is used to activate the dead 164;; A minor mode map `iso-accents-prefix-map' is used to activate the dead
@@ -166,8 +169,11 @@ Calling `iso-accents' with an argument will make all keys normal again."
166 ;; Create buffer local variable iso-accents-minor-mode. 169 ;; Create buffer local variable iso-accents-minor-mode.
167 (make-local-variable 'iso-accents-minor-mode) 170 (make-local-variable 'iso-accents-minor-mode)
168 171
169 (if arg 172 (if (if arg
170 ;; Switch it off. 173 ;; Negative arg means switch it off.
174 (<= (prefix-numeric-value arg) 0)
175 ;; No arg means toggle.
176 iso-accents-minor-mode)
171 (setq iso-accents-minor-mode nil) 177 (setq iso-accents-minor-mode nil)
172 178
173 ;; Enable electric accents. 179 ;; Enable electric accents.