From ad8d30b3d83547b1ac056cac3dd6e6721de8554e Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sat, 31 Mar 2007 17:28:11 +0000 Subject: [PATCH] Improve indexing. --- lispref/ChangeLog | 25 +++++++++++++++++++++++++ lispref/advice.texi | 1 + lispref/commands.texi | 4 ++++ lispref/debugging.texi | 4 ++++ lispref/display.texi | 2 ++ lispref/files.texi | 7 +++++++ lispref/frames.texi | 1 + lispref/functions.texi | 1 + lispref/help.texi | 1 + lispref/internals.texi | 1 + lispref/intro.texi | 6 +++--- lispref/markers.texi | 2 +- lispref/minibuf.texi | 1 + lispref/modes.texi | 6 ++++++ lispref/os.texi | 1 + lispref/positions.texi | 2 ++ lispref/symbols.texi | 2 ++ lispref/text.texi | 2 ++ lispref/tips.texi | 5 +++++ lispref/variables.texi | 6 ++++-- lispref/windows.texi | 3 ++- 21 files changed, 76 insertions(+), 7 deletions(-) diff --git a/lispref/ChangeLog b/lispref/ChangeLog index 74a7591a48..61595bb651 100644 --- a/lispref/ChangeLog +++ b/lispref/ChangeLog @@ -1,5 +1,30 @@ 2007-03-31 Eli Zaretskii + * intro.texi (nil and t): + * symbols.texi (Plists and Alists): + * variables.texi (Variable Aliases, Constant Variables): + * functions.texi (Defining Functions): + * advice.texi (Advising Primitives): + * debugging.texi (Syntax Errors, Compilation Errors): + * minibuf.texi (Minibuffer Windows): + * commands.texi (Adjusting Point): + * modes.texi (Syntactic Font Lock, Faces for Font Lock) + (Auto Major Mode, Major Mode Conventions): + * help.texi (Describing Characters): + * files.texi (Create/Delete Dirs, Information about Files) + (File Locks, Writing to Files, Reading from Files) + (Saving Buffers): + * windows.texi (Resizing Windows, Cyclic Window Ordering): + * frames.texi (Finding All Frames): + * positions.texi (Buffer End, Motion): + * markers.texi (The Region): + * text.texi (Deletion, Near Point): + * display.texi (Displaying Messages, Truncation): + * os.texi (Processor Run Time): + * tips.texi (Key Binding Conventions, Programming Tips) + (Warning Tips, Documentation Tips, Comment Tips): + * internals.texi (Memory Usage): Improve indexing. + * variables.texi (Frame-Local Variables): * functions.texi (Argument List): * loading.texi (Library Search): diff --git a/lispref/advice.texi b/lispref/advice.texi index 003e12ad83..ec8d666a42 100644 --- a/lispref/advice.texi +++ b/lispref/advice.texi @@ -673,6 +673,7 @@ Instead they are implemented specially by the advice mechanism. @node Advising Primitives @section Advising Primitives +@cindex advising primitives Advising a primitive function (also called a ``subr'') is risky. Some primitive functions are used by the advice mechanism; advising diff --git a/lispref/commands.texi b/lispref/commands.texi index 89bb570c5c..e6a995cca4 100644 --- a/lispref/commands.texi +++ b/lispref/commands.texi @@ -865,6 +865,10 @@ If the last event came from a keyboard macro, the value is @code{macro}. @node Adjusting Point @section Adjusting Point After Commands +@cindex adjust point +@cindex invisible or intangible text, and point display +@cindex @code{display} property, and point display +@cindex @code{composition} property, and point display It is not easy to display a value of point in the middle of a sequence of text that has the @code{display}, @code{composition} or diff --git a/lispref/debugging.texi b/lispref/debugging.texi index cce112a0aa..766fa64c00 100644 --- a/lispref/debugging.texi +++ b/lispref/debugging.texi @@ -675,6 +675,7 @@ If @var{frame-number} is out of range, @code{backtrace-frame} returns @node Syntax Errors @section Debugging Invalid Lisp Syntax +@cindex debugging invalid Lisp syntax The Lisp reader reports invalid syntax, but cannot say where the real problem is. For example, the error ``End of file during parsing'' in @@ -690,6 +691,8 @@ technique is to try @kbd{C-M-e} at the beginning of each defun, and see if it goes to the place where that defun appears to end. If it does not, there is a problem in that defun. +@cindex unbalanced parentheses +@cindex parentheses mismatch However, unmatched parentheses are the most common syntax errors in Lisp, and we can give further advice for those cases. (In addition, just moving point through the code with Show Paren mode enabled might @@ -798,6 +801,7 @@ never return. If it ever does return, you get a run-time error. @node Compilation Errors @section Debugging Problems in Compilation +@cindex debugging byte compilation problems When an error happens during byte compilation, it is normally due to invalid syntax in the program you are compiling. The compiler prints a diff --git a/lispref/display.texi b/lispref/display.texi index 0f4eae0a6d..893ef922c5 100644 --- a/lispref/display.texi +++ b/lispref/display.texi @@ -126,6 +126,7 @@ Returns @code{t} if redisplay was performed, or @code{nil} otherwise. @node Truncation @section Truncation @cindex line wrapping +@cindex line truncation @cindex continuation lines @cindex @samp{$} in display @cindex @samp{\} in display @@ -216,6 +217,7 @@ explicitly. @node Displaying Messages @subsection Displaying Messages in the Echo Area +@cindex display message in echo area This section describes the functions for explicitly producing echo area messages. Many other Emacs features display messages there, too. diff --git a/lispref/files.texi b/lispref/files.texi index f13888197c..f4cb3be8a5 100644 --- a/lispref/files.texi +++ b/lispref/files.texi @@ -296,6 +296,7 @@ in the list @code{find-file-hook}. @node Saving Buffers @section Saving Buffers +@cindex saving buffers When you edit a file in Emacs, you are actually working on a buffer that is visiting that file---that is, the contents of the file are @@ -481,6 +482,7 @@ Name}). @node Reading from Files @comment node-name, next, previous, up @section Reading from Files +@cindex reading from files You can copy a file from the disk and insert it into a buffer using the @code{insert-file-contents} function. Don't use the user-level @@ -544,6 +546,7 @@ program can read the file, use the function @code{file-local-copy}; see @node Writing to Files @comment node-name, next, previous, up @section Writing to Files +@cindex writing to files You can write the contents of a buffer, or part of a buffer, directly to a file on disk using the @code{append-to-file} and @@ -647,6 +650,7 @@ with-temp-buffer,, The Current Buffer}. @node File Locks @section File Locks @cindex file locks +@cindex lock file When two users edit the same file at the same time, they are likely to interfere with each other. Emacs tries to prevent this situation @@ -736,6 +740,8 @@ for its usual definition is in @file{userlock.el}. @node Information about Files @section Information about Files +@cindex information about files +@cindex file, information about The functions described in this section all operate on strings that designate file names. With a few exceptions, all the functions have @@ -2459,6 +2465,7 @@ which generate the listing with Lisp code. @node Create/Delete Dirs @section Creating and Deleting Directories +@cindex creating and deleting directories @c Emacs 19 features Most Emacs Lisp file-manipulation functions get errors when used on diff --git a/lispref/frames.texi b/lispref/frames.texi index e48eafcf87..5699c8f410 100644 --- a/lispref/frames.texi +++ b/lispref/frames.texi @@ -959,6 +959,7 @@ calls the function @code{delete-frame}. @xref{Misc Events}. @node Finding All Frames @section Finding All Frames +@cindex finding all frames @defun frame-list The function @code{frame-list} returns a list of all the frames that diff --git a/lispref/functions.texi b/lispref/functions.texi index d873ea5d35..045aa454c9 100644 --- a/lispref/functions.texi +++ b/lispref/functions.texi @@ -584,6 +584,7 @@ defined is often done deliberately, and there is no way to distinguish deliberate redefinition from unintentional redefinition. @end defspec +@cindex function aliases @defun defalias name definition &optional docstring @anchor{Definition of defalias} This special form defines the symbol @var{name} as a function, with diff --git a/lispref/help.texi b/lispref/help.texi index 0939d384a4..56fbb34440 100644 --- a/lispref/help.texi +++ b/lispref/help.texi @@ -388,6 +388,7 @@ C-g abort-recursive-edit @node Describing Characters @section Describing Characters for Help Messages +@cindex describe characters and events These functions convert events, key sequences, or characters to textual descriptions. These descriptions are useful for including diff --git a/lispref/internals.texi b/lispref/internals.texi index 59aa19db12..0af945c034 100644 --- a/lispref/internals.texi +++ b/lispref/internals.texi @@ -441,6 +441,7 @@ point number. @node Memory Usage @section Memory Usage +@cindex memory usage These functions and variables give information about the total amount of memory allocation that Emacs has done, broken down by data type. diff --git a/lispref/intro.texi b/lispref/intro.texi index 7beb324a42..35566603b7 100644 --- a/lispref/intro.texi +++ b/lispref/intro.texi @@ -170,11 +170,11 @@ being described, are formatted like this: @var{first-number}. @node nil and t @subsection @code{nil} and @code{t} -@cindex @code{nil}, uses of @cindex truth value @cindex boolean -@cindex false +@cindex @code{nil} +@cindex false In Lisp, the symbol @code{nil} has three separate meanings: it is a symbol with the name @samp{nil}; it is the logical truth value @var{false}; and it is the empty list---the list of zero elements. @@ -197,7 +197,7 @@ in Lisp programs also. (setq foo-flag nil) ; @r{Emphasize the truth value @var{false}} @end example -@cindex @code{t}, uses of +@cindex @code{t} @cindex true In contexts where a truth value is expected, any non-@code{nil} value is considered to be @var{true}. However, @code{t} is the preferred way diff --git a/lispref/markers.texi b/lispref/markers.texi index b955538fe0..1cf3501d46 100644 --- a/lispref/markers.texi +++ b/lispref/markers.texi @@ -629,7 +629,7 @@ more marks than this are pushed onto the @code{mark-ring}, @node The Region @section The Region -@cindex region, the +@cindex region between mark and point The text between point and the mark is known as @dfn{the region}. Various functions operate on text delimited by point and the mark, but diff --git a/lispref/minibuf.texi b/lispref/minibuf.texi index 950bd446cc..efe2d7575c 100644 --- a/lispref/minibuf.texi +++ b/lispref/minibuf.texi @@ -1786,6 +1786,7 @@ regular expression). @node Minibuffer Windows @section Minibuffer Windows +@cindex minibuffer windows These functions access and select minibuffer windows and test whether they are active. diff --git a/lispref/modes.texi b/lispref/modes.texi index 6eba02d5a0..98a2882995 100644 --- a/lispref/modes.texi +++ b/lispref/modes.texi @@ -252,6 +252,8 @@ Fundamental mode. Rmail mode is a complicated and specialized mode. @node Major Mode Conventions @subsection Major Mode Conventions +@cindex major mode conventions +@cindex conventions for writing major modes The code for existing major modes follows various coding conventions, including conventions for local keymap and syntax table initialization, @@ -495,6 +497,7 @@ Even if you never load the file more than once, someone else will. @node Auto Major Mode @subsection How Emacs Chooses a Major Mode +@cindex major mode, automatic selection Based on information in the file name or in the file itself, Emacs automatically selects a major mode for the new buffer when a file is @@ -2855,6 +2858,8 @@ set the variable @code{font-lock-defaults}. @node Faces for Font Lock @subsection Faces for Font Lock +@cindex faces for font lock +@cindex font lock faces You can make Font Lock mode use any face, but several faces are defined specifically for Font Lock mode. Each of these symbols is both @@ -2927,6 +2932,7 @@ directives in C. @node Syntactic Font Lock @subsection Syntactic Font Lock +@cindex syntactic font lock Syntactic fontification uses the syntax table to find comments and string constants (@pxref{Syntax Tables}). It highlights them using diff --git a/lispref/os.texi b/lispref/os.texi index c1e16c70d6..479920ac83 100644 --- a/lispref/os.texi +++ b/lispref/os.texi @@ -1310,6 +1310,7 @@ the inverse conversion, use @code{float-time}. @node Processor Run Time @section Processor Run time +@cindex processor run time @defun get-internal-run-time This function returns the processor run time used by Emacs as a list diff --git a/lispref/positions.texi b/lispref/positions.texi index 25ffbd2e1d..618886a40f 100644 --- a/lispref/positions.texi +++ b/lispref/positions.texi @@ -123,6 +123,7 @@ size of @var{buffer}. @node Motion @section Motion +@cindex motion by characters, words, lines, lists Motion functions change the value of point, either relative to the current value of point, relative to the beginning or end of the buffer, @@ -235,6 +236,7 @@ If this variable is non-@code{nil}, certain motion functions including @node Buffer End Motion @subsection Motion to an End of the Buffer +@cindex move to beginning or end of buffer To move point to the beginning of the buffer, write: diff --git a/lispref/symbols.texi b/lispref/symbols.texi index 4cd4bd4259..eb826b444c 100644 --- a/lispref/symbols.texi +++ b/lispref/symbols.texi @@ -436,6 +436,8 @@ names, and the other two elements are the corresponding values. @node Plists and Alists @subsection Property Lists and Association Lists +@cindex plist vs alist +@cindex alist vs plist @cindex property lists vs association lists Association lists (@pxref{Association Lists}) are very similar to diff --git a/lispref/text.texi b/lispref/text.texi index 11cf3cf218..c57fc500f4 100644 --- a/lispref/text.texi +++ b/lispref/text.texi @@ -64,6 +64,7 @@ the character after point. @node Near Point @section Examining Text Near Point +@cindex text near point Many functions are provided to look at the characters around point. Several simple functions are described here. See also @code{looking-at} @@ -537,6 +538,7 @@ newlines and tabs like any other characters). @node Deletion @section Deleting Text +@cindex text deletion @cindex deletion vs killing Deletion means removing part of the text in a buffer, without saving diff --git a/lispref/tips.texi b/lispref/tips.texi index 5f4479a5fd..bbfc6f515e 100644 --- a/lispref/tips.texi +++ b/lispref/tips.texi @@ -295,6 +295,7 @@ Otherwise, use your name. See also @xref{Library Headers}. @node Key Binding Conventions @section Key Binding Conventions +@cindex key binding, conventions for @itemize @bullet @item @@ -374,6 +375,7 @@ after @key{ESC}. In these states, you should define @kbd{@key{ESC} @node Programming Tips @section Emacs Programming Tips +@cindex programming conventions Following these conventions will make your program fit better into Emacs when it runs. @@ -559,6 +561,7 @@ the speed. @xref{Inline Functions}. @node Warning Tips @section Tips for Avoiding Compiler Warnings +@cindex byte compiler warnings, how to avoid @itemize @bullet @item @@ -599,6 +602,7 @@ is to put a call to @code{with-no-warnings} around it. @node Documentation Tips @section Tips for Documentation Strings +@cindex documentation strings, conventions and tips @findex checkdoc-minor-mode Here are some tips and conventions for the writing of documentation @@ -863,6 +867,7 @@ describe the most important commands in your major mode, and then use @node Comment Tips @section Tips on Writing Comments +@cindex comments, convention for We recommend these conventions for where to put comments and how to indent them: diff --git a/lispref/variables.texi b/lispref/variables.texi index 9a846fde3c..33c9f1db14 100644 --- a/lispref/variables.texi +++ b/lispref/variables.texi @@ -100,10 +100,11 @@ x @node Constant Variables @section Variables that Never Change -@vindex nil -@vindex t @kindex setting-constant @cindex keyword symbol +@cindex constant variables +@cindex symbols that evaluate to themselves +@cindex symbols with constant values In Emacs Lisp, certain symbols normally evaluate to themselves. These include @code{nil} and @code{t}, as well as any symbol whose name starts @@ -1779,6 +1780,7 @@ properties from string values specified for file local variables. @node Variable Aliases @section Variable Aliases +@cindex variable aliases It is sometimes useful to make two variables synonyms, so that both variables always have the same value, and changing either one also diff --git a/lispref/windows.texi b/lispref/windows.texi index 1897414dd1..9668fd08d6 100644 --- a/lispref/windows.texi +++ b/lispref/windows.texi @@ -572,7 +572,7 @@ In general, within each set of siblings at any level in the window tree, the order is left to right, or top to bottom. @defun next-window &optional window minibuf all-frames -@cindex minibuffer window +@cindex minibuffer window, and @code{next-window} This function returns the window following @var{window} in the cyclic ordering of windows. This is the window that @kbd{C-x o} would select if typed when @var{window} is selected. If @var{window} is the only @@ -1987,6 +1987,7 @@ in character lines and columns. @node Resizing Windows @section Changing the Size of a Window @cindex window resizing +@cindex resize window @cindex changing window size @cindex window size, changing -- 2.20.1