diff options
author | Chong Yidong <cyd@gnu.org> | 2011-10-19 20:41:15 -0400 |
---|---|---|
committer | Chong Yidong <cyd@gnu.org> | 2011-10-19 20:41:15 -0400 |
commit | 6e317956b7dda5a9460937b5edc7a322c57c3804 (patch) | |
tree | 69476cc2649d1b90a167a792bc42850629d30ce4 /doc/emacs | |
parent | ac6c8639bdb115cf57c65a383b4564aa98505389 (diff) | |
download | emacs-6e317956b7dda5a9460937b5edc7a322c57c3804.tar.gz |
Adapt to new minor mode function behavior in manual examples.
* doc/emacs/custom.texi (Hooks, Init Examples):
* doc/emacs/display.texi (Font Lock):
* doc/emacs/fixit.texi (Spelling):
* doc/emacs/rmail.texi (Rmail Display): Minor mode function with no arg now
enables it.
* doc/emacs/fixit.texi (Spelling): Fix description of inline completion.
Diffstat (limited to 'doc/emacs')
-rw-r--r-- | doc/emacs/ChangeLog | 10 | ||||
-rw-r--r-- | doc/emacs/custom.texi | 21 | ||||
-rw-r--r-- | doc/emacs/display.texi | 8 | ||||
-rw-r--r-- | doc/emacs/fixit.texi | 93 | ||||
-rw-r--r-- | doc/emacs/fortran-xtra.texi | 2 | ||||
-rw-r--r-- | doc/emacs/rmail.texi | 2 |
6 files changed, 63 insertions, 73 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 63afcd228ad..5b07d4d692a 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog @@ -1,3 +1,13 @@ +2011-10-20 Chong Yidong <cyd@gnu.org> + + * custom.texi (Hooks, Init Examples): + * display.texi (Font Lock): + * fixit.texi (Spelling): + * rmail.texi (Rmail Display): Minor mode function with no arg now + enables it. + + * fixit.texi (Spelling): Fix description of inline completion. + 2011-10-19 Chong Yidong <cyd@gnu.org> * search.texi (Repeat Isearch, Error in Isearch): Add kindex diff --git a/doc/emacs/custom.texi b/doc/emacs/custom.texi index 6af77374d07..d87c22ec28e 100644 --- a/doc/emacs/custom.texi +++ b/doc/emacs/custom.texi @@ -770,7 +770,7 @@ here's how to set up a hook to turn on Auto Fill mode when entering Text mode and other modes based on Text mode: @example -(add-hook 'text-mode-hook 'turn-on-auto-fill) +(add-hook 'text-mode-hook 'auto-fill-mode) @end example Here is another example, showing how to use a hook to customize the @@ -2174,8 +2174,7 @@ Turn off Line Number mode, a global minor mode. Turn on Auto Fill mode automatically in Text mode and related modes. @example -(add-hook 'text-mode-hook - '(lambda () (auto-fill-mode 1))) +(add-hook 'text-mode-hook 'auto-fill-mode) @end example This shows how to add a hook function to a normal hook variable @@ -2183,19 +2182,9 @@ This shows how to add a hook function to a normal hook variable @code{lambda}, with a single-quote in front of it to make it a list constant rather than an expression. -It's beyond the scope of this manual to explain Lisp functions, but for -this example it is enough to know that the effect is to execute -@code{(auto-fill-mode 1)} when Text mode is entered. You can replace -that with any other expression that you like, or with several -expressions in a row. - -Emacs comes with a function named @code{turn-on-auto-fill} whose -definition is @code{(lambda () (auto-fill-mode 1))}. Thus, a simpler -way to write the above example is as follows: - -@example -(add-hook 'text-mode-hook 'turn-on-auto-fill) -@end example +It's beyond the scope of this manual to explain Lisp functions, but +for this example it is enough to know that the effect is to execute +the @code{auto-fill-mode} function when Text mode is entered. @item Load the installed Lisp library named @file{foo} (actually a file diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi index 082a7325652..254f9465690 100644 --- a/doc/emacs/display.texi +++ b/doc/emacs/display.texi @@ -703,16 +703,14 @@ file: (global-font-lock-mode 0) @end example -@findex turn-on-font-lock @noindent If you have disabled Global Font Lock mode, you can still enable Font Lock for specific major modes by adding the function -@code{turn-on-font-lock} to the mode hooks (@pxref{Hooks}). For -example, to enable Font Lock mode for editing C files, you can do -this: +@code{font-lock-mode} to the mode hooks (@pxref{Hooks}). For example, +to enable Font Lock mode for editing C files, you can do this: @example -(add-hook 'c-mode-hook 'turn-on-font-lock) +(add-hook 'c-mode-hook 'font-lock-mode) @end example Font Lock mode uses several specifically named faces to do its job, diff --git a/doc/emacs/fixit.texi b/doc/emacs/fixit.texi index 7a605100796..bae78d94744 100644 --- a/doc/emacs/fixit.texi +++ b/doc/emacs/fixit.texi @@ -7,17 +7,14 @@ @cindex typos, fixing @cindex mistakes, correcting - In this chapter we describe the commands that are especially useful -when you catch a mistake in your text after you have made it, or -change your mind while composing text on the fly. - - The most fundamental command for correcting erroneous editing is the -undo command @kbd{C-/} (which is also bound to @kbd{C-x u} and -@kbd{C-_}). This undoes a single command, or a part of a command (as -in the case of @code{query-replace}), or several consecutive -self-inserting characters. Consecutive repetitions of @kbd{C-/} undo -earlier and earlier changes, back to the limit of the undo information -available. + In this chapter we describe commands that are useful when you catch +a mistake while editing. The most fundamental command for correcting +erroneous editing is the undo command @kbd{C-/} (which is also bound +to @kbd{C-x u} and @kbd{C-_}). This undoes a single command, or a +part of a command (as in the case of @code{query-replace}), or several +consecutive character insertions. Consecutive repetitions of +@kbd{C-/} undo earlier and earlier changes, back to the limit of the +undo information available. Aside from the commands described here, you can erase text using deletion commands such as @key{DEL} (@code{delete-backward-char}). @@ -231,18 +228,19 @@ case-convert it and go on typing. @xref{Case}.@refill This section describes the commands to check the spelling of a single word or of a portion of a buffer. These commands only work if the spelling checker program Aspell, Ispell or Hunspell is installed. -Aspell, Ispell or Hunspell are not part of Emacs, but one or the other -is usually installed in GNU/Linux and other free operating systems. +These programs are not part of Emacs, but one of them is usually +installed in GNU/Linux and other free operating systems. @ifnottex @xref{Top, Aspell,, aspell, The Aspell Manual}. @end ifnottex @table @kbd @item M-$ -Check and correct spelling of the active region or the word at point -(@code{ispell-word}). +Check and correct spelling of the word at point (@code{ispell-word}). +If the region is active, do it for all words in the region instead. @item M-x ispell -Check and correct spelling in the active region or the entire buffer. +Check and correct spelling of all words in the buffer. If the region +is active, do it for all words in the region instead. @item M-x ispell-buffer Check and correct spelling in the buffer. @item M-x ispell-region @@ -355,14 +353,13 @@ Show the list of options. @end table @findex ispell-complete-word - In Text mode and related modes, the command @kbd{M-@key{TAB}} -(@code{ispell-complete-word}) shows a list of completions based on + In Text mode and related modes, @kbd{M-@key{TAB}} +(@code{ispell-complete-word}) performs in-buffer completion based on spelling correction. Insert the beginning of a word, and then type -@kbd{M-@key{TAB}}; the command displays a completion list window. (If -your window manager intercepts @kbd{M-@key{TAB}}, type @kbd{@key{ESC} -@key{TAB}} or @kbd{C-M-i}.) To choose one of the completions listed, -click @kbd{Mouse-2} or @kbd{Mouse-1} fast on it, or move the cursor -there in the completions window and type @key{RET}. @xref{Text Mode}. +@kbd{M-@key{TAB}}; this shows shows a list of completions. (If your +window manager intercepts @kbd{M-@key{TAB}}, type @kbd{@key{ESC} +@key{TAB}} or @kbd{C-M-i}.) Each completion is listed with a digit or +character; type that digit or character to choose it. @cindex @code{ispell} program @findex ispell-kill-ispell @@ -370,29 +367,27 @@ there in the completions window and type @key{RET}. @xref{Text Mode}. to run, waiting for something to do, so that subsequent spell checking commands complete more quickly. If you want to get rid of the process, use @kbd{M-x ispell-kill-ispell}. This is not usually -necessary, since the process uses no time except when you do spelling -correction. +necessary, since the process uses no processor time except when you do +spelling correction. @vindex ispell-dictionary @vindex ispell-local-dictionary @vindex ispell-personal-dictionary -@vindex ispell-complete-word-dict - Ispell, Aspell and Hunspell use two dictionaries together for spell checking: -the standard dictionary and your private dictionary. The standard -dictionary is specified by @code{ispell-local-dictionary} or, -if @code{nil}, by @code{ispell-dictionary}. If both are @code{nil} -the default dictionary is selected. The command -@kbd{M-x ispell-change-dictionary} sets the standard dictionary for -the buffer and then restarts the subprocess, so that it will use a -different standard dictionary. Personal dictionary is specified by -@code{ispell-personal-dictionary}. If @code{nil}, default value is -used. - - Set variable @code{ispell-dictionary} to select a specific default -dictionary for all your documents. Set variable -@code{ispell-local-dictionary} in the local variables section to -select a specific dictionary for a given document. +@findex ispell-change-dictionary + Ispell, Aspell and Hunspell look up spelling in two dictionaries: +the standard dictionary and your personal dictionary. The standard +dictionary is specified by the variable @code{ispell-local-dictionary} +or, if that is @code{nil}, by the variable @code{ispell-dictionary}. +If both are @code{nil}, the spelling program's default dictionary is +used. The command @kbd{M-x ispell-change-dictionary} sets the +standard dictionary for the buffer and then restarts the subprocess, +so that it will use a different standard dictionary. Your personal +dictionary is specified by the variable +@code{ispell-personal-dictionary}. If that is @code{nil}, the +spelling program looks for a personal dictionary in a default +location. +@vindex ispell-complete-word-dict A separate dictionary is used for word completion. The variable @code{ispell-complete-word-dict} specifies the file name of this dictionary. The completion dictionary must be different because it @@ -400,16 +395,14 @@ cannot use root and affix information. For some languages, there is a spell checking dictionary but no word completion dictionary. @cindex Flyspell mode +@cindex mode, Flyspell @findex flyspell-mode -@findex turn-on-flyspell - Flyspell mode is a fully-automatic way to check spelling as you edit -in Emacs. It operates by checking words as you change or insert them. -When it finds a word that it does not recognize, it highlights that -word. This does not interfere with your editing, but when you see the -highlighted word, you can move to it and fix it. Type @kbd{M-x -flyspell-mode} to enable or disable this mode in the current buffer. -To enable Flyspell mode in all text mode buffers, add -@code{turn-on-flyspell} to @code{text-mode-hook}. + Flyspell mode is a minor mode that performs automatic spell checking +as you type. When it finds a word that it does not recognize, it +highlights that word. Type @kbd{M-x flyspell-mode} to toggle Flyspell +mode in the current buffer. To enable Flyspell mode in all text mode +buffers, add @code{flyspell-mode} to @code{text-mode-hook}. +@xref{Hooks}. When Flyspell mode highlights a word as misspelled, you can click on it with @kbd{Mouse-2} to display a menu of possible corrections and diff --git a/doc/emacs/fortran-xtra.texi b/doc/emacs/fortran-xtra.texi index ee417624120..e5853a17dd0 100644 --- a/doc/emacs/fortran-xtra.texi +++ b/doc/emacs/fortran-xtra.texi @@ -479,7 +479,7 @@ variable @code{fortran-break-before-delimiters} is @code{nil}. Otherwise (and by default), the break comes before the delimiter. To enable Auto Fill in all Fortran buffers, add -@code{turn-on-auto-fill} to @code{fortran-mode-hook}. +@code{auto-fill-mode} to @code{fortran-mode-hook}. @iftex @xref{Hooks,,, emacs, the Emacs Manual}. @end iftex diff --git a/doc/emacs/rmail.texi b/doc/emacs/rmail.texi index b894d01b9bb..9e30b657284 100644 --- a/doc/emacs/rmail.texi +++ b/doc/emacs/rmail.texi @@ -1198,7 +1198,7 @@ Address mode: @c FIXME goto-addr.el commentary says to use goto-address instead. @smallexample -(add-hook 'rmail-show-message-hook (lambda () (goto-address-mode 1))) +(add-hook 'rmail-show-message-hook 'goto-address-mode) @end smallexample @noindent |