From: Nix Date: Thu, 19 May 2011 06:54:27 +0000 (-0700) Subject: Misc small lispref fixes. X-Git-Tag: emacs-pretest-24.0.90~104^2~618^2~237^2~8 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=35a30759f31addb80faef630001de380cd94a0cf;p=emacs.git Misc small lispref fixes. * windows.texi (Displaying Buffers): pop-to-buffer is not a command. * text.texi (Parsing HTML): Update for function name changes. * syntax.texi (Syntax Flags): Small fix. * keymaps.texi (Active Keymaps): Typo fix. (Changing Key Bindings): Grammar fix. * frames.texi (Minibuffers and Frames): Grammar fix. (Window System Selections): x-select-enable-clipboard now defaults to t. * customize.texi (Common Keywords): * display.texi (Abstract Display): * modes.texi (Auto-Indentation): * nonascii.texi (Converting Representations): Typo fixes. * control.texi (Examples of Catch): Call it "goto" not "go to". --- diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 593b54d088b..198eb1c8ed2 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,24 @@ +2011-05-19 Nix + + * windows.texi (Displaying Buffers): pop-to-buffer is not a command. + + * text.texi (Parsing HTML): Update for function name changes. + + * syntax.texi (Syntax Flags): Small fix. + + * keymaps.texi (Active Keymaps): Typo fix. + (Changing Key Bindings): Grammar fix. + + * frames.texi (Minibuffers and Frames): Grammar fix. + (Window System Selections): x-select-enable-clipboard now defaults to t. + + * customize.texi (Common Keywords): + * display.texi (Abstract Display): + * modes.texi (Auto-Indentation): + * nonascii.texi (Converting Representations): Typo fixes. + + * control.texi (Examples of Catch): Call it "goto" not "go to". + 2011-05-14 Eli Zaretskii * nonascii.texi (Character Properties): Fix inconsistencies with diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi index b6fdb9dbcbd..875c23658b9 100644 --- a/doc/lispref/control.texi +++ b/doc/lispref/control.texi @@ -623,7 +623,7 @@ error is signaled with data @code{(@var{tag} @var{value})}. @subsection Examples of @code{catch} and @code{throw} One way to use @code{catch} and @code{throw} is to exit from a doubly -nested loop. (In most languages, this would be done with a ``go to.'') +nested loop. (In most languages, this would be done with a ``goto.'') Here we compute @code{(foo @var{i} @var{j})} for @var{i} and @var{j} varying from 0 to 9: diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi index 2f1ea055f82..e58c8c298c9 100644 --- a/doc/lispref/customize.texi +++ b/doc/lispref/customize.texi @@ -174,7 +174,7 @@ For example, the MH-E package updates this alist with the following: The value of @var{package} needs to be unique and it needs to match the @var{package} value appearing in the @code{:package-version} -keyword. Since the user might see the value in a error message, a good +keyword. Since the user might see the value in an error message, a good choice is the official name of the package, such as MH-E or Gnus. @end defvar diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 130f097a85f..338fd421994 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -5201,7 +5201,7 @@ element value into the current buffer. Typically, you define an ewoc with @code{ewoc-create}, and then pass the resulting ewoc structure to other functions in the Ewoc package to build nodes within it, and display it in the buffer. Once it is -displayed in the buffer, other functions determine the correspondance +displayed in the buffer, other functions determine the correspondence between buffer positions and nodes, move point from one node's textual representation to another, and so forth. @xref{Abstract Display Functions}. diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 06c120cc09d..c5136456177 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi @@ -1368,7 +1368,7 @@ minibuffer-window}). However, you can also create a frame with no minibuffer. Such a frame must use the minibuffer window of some other frame. When you create the -frame, you can specify explicitly the minibuffer window to use (in some +frame, you can explicitly specify the minibuffer window to use (in some other frame). If you don't, then the minibuffer is found in the frame which is the value of the variable @code{default-minibuffer-frame}. Its value should be a frame that does have a minibuffer. @@ -2018,8 +2018,8 @@ clipboard as empty. If this is non-@code{nil}, the Emacs yank functions consult the clipboard before the primary selection, and the kill functions store in the clipboard as well as the primary selection. Otherwise they do not -access the clipboard at all. The default is @code{nil} on most systems, -but @code{t} on MS-Windows. +access the clipboard at all. The default is @code{t} on systems with +clipboards. @end defopt @node Drag and Drop diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index 2648c22ca01..2ebce284fd3 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi @@ -686,7 +686,7 @@ bindings, as in @code{lookup-key} (@pxref{Functions for Key Lookup}). When commands are remapped (@pxref{Remapping Commands}), @code{key-binding} normally processes command remappings so as to -returns the remapped command that will actually be executed. However, +return the remapped command that will actually be executed. However, if @var{no-remap} is non-@code{nil}, @code{key-binding} ignores remappings and returns the binding directly specified for @var{key}. @@ -1239,7 +1239,7 @@ local map, that usually affects all buffers using the same major mode. The @code{global-set-key} and @code{local-set-key} functions are convenient interfaces for these operations (@pxref{Key Binding Commands}). You can also use @code{define-key}, a more general -function; then you must specify explicitly the map to change. +function; then you must explicitly specify the map to change. When choosing the key sequences for Lisp programs to rebind, please follow the Emacs conventions for use of various keys (@pxref{Key diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 02f89f93207..609c713194a 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -3256,7 +3256,7 @@ reasonably fast. @end defvar @node Auto-Indentation -@section Auto-indention of code +@section Auto-indentation of code For programming languages, an important feature of a major mode is to provide automatic indentation. This is controlled in Emacs by diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi index a3f25af4719..0328dae9e7b 100644 --- a/doc/lispref/nonascii.texi +++ b/doc/lispref/nonascii.texi @@ -201,7 +201,7 @@ characters. @defun byte-to-string byte @cindex byte to string This function returns a unibyte string containing a single byte of -character data, @var{character}. It signals a error if +character data, @var{character}. It signals an error if @var{character} is not an integer between 0 and 255. @end defun diff --git a/doc/lispref/syntax.texi b/doc/lispref/syntax.texi index 55ee2dec4a4..6582a8dfb0c 100644 --- a/doc/lispref/syntax.texi +++ b/doc/lispref/syntax.texi @@ -374,7 +374,7 @@ character, @samp{/}, does not have the @samp{b} flag. @item @samp{*/} This is a comment-end sequence for ``b'' style because the first -character, @samp{*}, does have the @samp{b} flag. +character, @samp{*}, has the @samp{b} flag. @item newline This is a comment-end sequence for ``a'' style, because the newline diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 6cb271eec88..8205c5fa169 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -4099,17 +4099,16 @@ coding instead. @node Parsing HTML @section Parsing HTML @cindex parsing html -@cindex parsing xml -Emacs provides an interface to the @code{libxml2} library via two -functions: @code{html-parse-buffer} and @code{xml-parse-buffer}. The -HTML function will parse ``real world'' HTML and try to return a -sensible parse tree, while the XML function is somewhat stricter about -syntax. +@defun libxml-parse-html-region start end &optional base-url +This function provides HTML parsing via the @code{libxml2} library. +It parses ``real world'' HTML and tries to return a sensible parse tree +regardless. -They both take a two optional parameter. The first is a buffer, and -the second is a base URL to be used to expand relative URLs in the -document, if any. +In addition to @var{start} and @var{end} (specifying the start and end +of the region to act on), it takes an optional parameter, +@var{base-url}, which is used to expand relative URLs in the document, +if any. Here's an example demonstrating the structure of the parsed data you get out. Given this HTML document: @@ -4138,12 +4137,21 @@ values. Attributes are coded the same way as child nodes, but with @samp{:} as the first character. +@end defun + +@cindex parsing xml +@defun libxml-parse-xml-region start end &optional base-url + +This is much the same as @code{libxml-parse-html-region} above, but +operates on XML instead of HTML, and is correspondingly stricter about +syntax. +@end defun @node Atomic Changes @section Atomic Change Groups @cindex atomic changes - In data base terminology, an @dfn{atomic} change is an indivisible + In database terminology, an @dfn{atomic} change is an indivisible change---it can succeed entirely or it can fail entirely, but it cannot partly succeed. A Lisp program can make a series of changes to one or several buffers as an @dfn{atomic change group}, meaning that diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 9ce00de4abc..93f2035eca6 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi @@ -826,8 +826,8 @@ This function updates the buffer list just like @code{switch-to-buffer} unless @var{norecord} is non-@code{nil}. @end deffn -@deffn Command pop-to-buffer buffer-or-name &optional other-window norecord -This command makes @var{buffer-or-name} the current buffer and switches +@defun pop-to-buffer buffer-or-name &optional other-window norecord +This function makes @var{buffer-or-name} the current buffer and switches to it in some window, preferably not the window previously selected. The ``popped-to'' window becomes the selected window. Its frame is given the X server's focus, if possible; see @ref{Input Focus}. The @@ -866,7 +866,7 @@ All the variables that affect @code{display-buffer} affect This function updates the buffer list just like @code{switch-to-buffer} unless @var{norecord} is non-@code{nil}. -@end deffn +@end defun @deffn Command replace-buffer-in-windows &optional buffer-or-name This function replaces @var{buffer-or-name} in all windows displaying