[AUCTeX-diffs] Changes to auctex/doc/auctex.texi,v

[Ralf Angeli]

CVSROOT:        /cvsroot/auctex
Module name:    auctex
Changes by:     Ralf Angeli <angeli>    10/06/24 20:59:03

Index: auctex.texi
===================================================================
RCS file: /cvsroot/auctex/auctex/doc/auctex.texi,v
retrieving revision 1.304
retrieving revision 1.305
diff -u -b -r1.304 -r1.305
--- auctex.texi 24 May 2010 17:29:48 -0000      1.304
+++ auctex.texi 24 Jun 2010 20:59:03 -0000      1.305
@@ -4227,103 +4227,103 @@
 @raisesections
 
 @node Texinfo mode
address@hidden Features specific to @AUCTeX{} Texinfo major mode
address@hidden Features specific to @AUCTeX{}'s Texinfo major mode
 
address@hidden comprises a Texinfo major mode to edit Texinfo file. This major
address@hidden includes a major mode for editting Texinfo files.  This major
 mode is not the same mode as the native Texinfo mode (@pxref{(texinfo)
 Texinfo Mode}) of Emacs, although they have the same name. However,
 @AUCTeX{} still relies on a number of functions from the native Texinfo
 mode.
 
-This information is therefore usefull in two kind of symmetrical
-situations:
-
address@hidden
address@hidden
-For @AUCTeX{} users not familiar with Texinfo editing, so that they can
-seek more easily in the native Texinfo manual what @AUCTeX{} reuses,
-without being confused by what @AUCTeX{} does not use
address@hidden
-For native Texinfo users, not familiar with @AUCTeX{}, so that they know
-where @AUCTeX{} comes into the place, and what changes in accessing native
-Texinfo.
address@hidden itemize
+The following text describes which functionality is offered by @AUCTeX{}
+and which by the native Texinfo mode.  This should enable you to decide
+when to consult the @AUCTeX{} manual and when the manual of the native
+mode.  And in case you are a seasoned user of the native mode, the
+information should help you to swiftly get to know the
address@hidden commands.
 
 @menu
-* Working with native Texinfo::  How @AUCTeX{} and native Texinfo work
-  together
-* Superseeding native Texinfo::  Where @AUCTeX{} superseeds native Texinfo
-* Mapping to native Texinfo::   Where @AUCTeX{} maps keybinding to native
-  Texinfo commands
-* Unbound native Texinfo::      Which native Texinfo commands are no longer
-  bound to keys in @AUCTeX{} Texinfo
+* Exploiting::                  How @AUCTeX{} and the native mode work together
+* Superseding::                 Where the native mode is superseded
+* Mapping::                     Where key bindings are mapped to the native 
mode
+* Unbinding::                   Which native mode key bindings are missing
 @end menu
 
address@hidden Working with native Texinfo
address@hidden How @AUCTeX{} and native Texinfo work together
address@hidden Exploiting
address@hidden How @AUCTeX{} and the native mode work together
 
-In a nutshell the split between @AUCTeX{} Texinfo mode, and native Texinfo
-mode is as follows:
+In a nutshell the split between @AUCTeX{} Texinfo mode, and native
+Texinfo mode is as follows:
 
 @itemize
 @item
-all pure edition (environment creation, commenting, font command
-insertions) and/or processing commands (compiling, printing, etc.@:) are
-handled in @AUCTeX{} in a very similar way as for LaTeX mode, while
+Most of the editing (environment creation, commenting, font command
+insertions) and/or processing commands (e.g. compiling or printing)
+which are available in other @AUCTeX{} modes are also handled by
address@hidden in Texinfo mode.
+
 @item
- Texinfo specific feature (all that is connected with info node linkage,
-menu auotmated creation) still relies on the native Texinfo
-commands. There, @AUCTeX{} just provides the keybindings to reach these
-functions, with keeping the same keys as in native Texinfo whenever
-possible, or similar ones otherwise.
+Texinfo-related features (e.g. info node linkage or menu creation) rely
+on the commands provided by the native Texinfo mode.  @AUCTeX{} provides
+the key bindings to reach these functions, keeping the same keys as in
+native Texinfo whenever possible, or similar ones otherwise.
 @end itemize
 
address@hidden Superseeding native Texinfo
address@hidden Where @AUCTeX{} superseeds native Texinfo
address@hidden Superseding
address@hidden Where the native mode is superseded
 
-This node is intended to native Texinfo users switching to @AUCTeX{}. It
-follows the native Texinfo mode summary (@pxref{(texinfo) Texinfo Mode
-Summary}) and lists which native texinfo commands are no longer of use.
+This section is directed to users of the native Texinfo mode switching
+to @AUCTeX{}.  It follows the summary of the native mode
+(@pxref{(texinfo) Texinfo Mode Summary}) and lists which of its commands
+are no longer of use.
 
 @table @asis
address@hidden Font insertion commands
- Native Texinfo @kbd{C-c C-c @var{k}} font insertion commands, with
address@hidden one of @kbd{c} (@@code), @kbd{d} (@@dfn), @kbd{k} (@@kbd),
address@hidden (@@samp), or @kbd{v} (@@var), are replaced by @code{C-c C-f
address@hidden or @code{C-c C-f address@hidden in @AUCTeX{} calling the
address@hidden command (@@kbd, @@samp and @@var are the one needing the
address@hidden prefix).
-
address@hidden has a number of other font insertion commands, @kbd{C-c C-f
address@hidden to get a list.
address@hidden Insert commands
+In the native Texinfo mode, frequently used Texinfo commands can be
+inserted with key bindings of the form @kbd{C-c C-c @var{k}} where
address@hidden differs for each Texinfo command; @kbd{c} inserts @@code,
address@hidden inserts @@dfn, @kbd{k} @@kbd, etc.
+
+In @AUCTeX{} commands are inserted with the key binding @kbd{C-c C-m}
+instead which prompts for the macro to be inserted.  For font selection
+commands (like @@b, @@i, or @@emph) and a few related ones (like @@var,
+@@key or @@code) there are bindings which insert the respective macros
+directly.  They have the form @code{C-c C-f @var{k}} or @code{C-c C-f
address@hidden and call the function @code{TeX-font}.  Type @kbd{C-c C-f
address@hidden to get a list of supported commands.
 
 Note that the prefix argument is not handled the same way by @AUCTeX{}.
-
address@hidden Brace insertion
-Native Texinfo @kbd{C-c @{} brace insertion is replaced by @AUCTeX{}
address@hidden with same keybinding.
-
address@hidden Environment insertion
-Native Texinfo @kbd{C-c C-c @var{k}} environment insertion command, with
address@hidden one of @kbd{x} (@@example), @kbd{t} (@@table) are replaced all
-together by the @AUCTeX{} @kbd{C-c C-e} environnement insertion command
-which tackles more environments.
-
address@hidden Macro insertion
-Native Texinfo @kbd{C-c C-c @var{k}} macro insertion commands, with
address@hidden one of @kbd{o} (@@noindent), @kbd{n} (@@node) are replaced all
-together by the @AUCTeX{} @kbd{C-c C-m} macro insertion command which
-tackles more macros.
-
-Note that the native Texinfo @code{texinfo-insert-@@node} node insertion
-can still accessed by the Texinfo menu.
-
address@hidden Formatting info files with Makeinfo/TeX
-Native Texinfo @kbd{C-c C-m C-b} command (@code{makeinfo-buffer}) and
address@hidden C-t C-b} command (@code{texinfo-tex-buffer}) are superseeded by
-the @AUCTeX{} @kbd{C-c C-c} (@code{TeX-command-master}) command. After
-typing @kbd{C-c C-c}, select respectively @samp{Makeinfo} or
address@hidden Note that you can make, say @samp{Makeinfo}, the default by
+Note also that the node insertion command from the native mode
+(@code{texinfo-insert-@@node}) can still accessed from the Texinfo menu
+in @AUCTeX{}.
+
address@hidden Insert braces
+In @AUCTeX{} braces can be inserted with the same key binding as in the
+native Texinfo mode: @kbd{C-c @{}.  But @AUCTeX{} uses its own function
+for the feature: @code{TeX-insert-braces}.
+
address@hidden Insert environments
+The native Texinfo mode does not insert full environments.  Instead, it
+provides the function @code{texinfo-insert-@@end} (mapped to @kbd{C-c
+C-c e}) for closing an open environment with a matching @@end statement.
+
+In @AUCTeX{} you can insert full environments, i.e. both the opening and
+closing statements, with the function @code{Texinfo-environment} (mapped
+to @kbd{C-c C-e}).
+
address@hidden Format info files with makeinfo and @TeX{}
+In the native Texinfo mode there are various functions and bindings to
+format a region or the whole buffer for info or to typeset the
+respective text.  For example, there is @code{makeinfo-buffer} (mapped
+to @kbd{C-c C-m C-b}) which runs @samp{makeinfo} on the buffer or there
+is @code{texinfo-tex-buffer} (mapped to @kbd{C-c C-t C-b}) which runs
address@hidden on the buffer in order to produce a @acronym{DVI} file.
+
+In @AUCTeX{} different commands for formatting or typesetting can be
+invoked through the function @code{TeX-command-master} (mapped to
address@hidden C-c}).  After typing @kbd{C-c C-c}, you can select the desired
+command, e.g @samp{Makeinfo} or @samp{TeX}, through a prompt in the mini
+buffer.  Note that you can make, say @samp{Makeinfo}, the default by
 adding this statement in your init file:
 
 @lisp
@@ -4331,95 +4331,94 @@
           (lambda () (setq TeX-command-default "Makeinfo")))
 @end lisp
 
-Note also that @kbd{C-c C-c Makeinfo @key{ret}} is not completely
-functionally equivalent to @kbd{M-x makeinfo-buffer} as @kbd{M-x
-makeinfo-buffer} will view the info file with Emacs in same node as
-pointed in texi source file just after a successful compilatation. This
-is why, while using @AUCTeX{}, typing @kbd{M-x makeinfo-buffer} may still
-be more convenient.
-
-Note also that in the case of a multifile document, the @AUCTeX{} @kbd{C-c
-C-c} will work on the whole document (provided that local variable
address@hidden is set correctly), while native Texinfo @kbd{M-x
-makeinfo-buffer} will process only the current buffer, provided at the
address@hidden@@setfilename} statement is provided.
-
address@hidden Making indexes/Printing
-The native Texinfo commands @kbd{C-c C-t C-i} (@code{texinfo-texindex}),
- @kbd{C-c C-t C-p} (@code{texinfo-tex-print}), and @kbd{C-c C-t C-q}
- (@code{tex-show-print-queue}) are all superseeded by the @AUCTeX{}
- @kbd{C-c C-c} (@code{TeX-command-master}) command. Select respectively
- @kbd{Index}, @kbd{Print}, or @kbd{Queue}.
-
address@hidden Killing jobs
-The native Texinfo command @kbd{C-c C-t C-k} (@code{tex-kill-job}) is
-superseeded by @AUCTeX{} @kbd{C-c C-k} (@code{TeX-kill-job}).
+Note also that @kbd{C-c C-c Makeinfo @key{RET}} is not completely
+functionally equivalent to @code{makeinfo-buffer} as the latter will
+display the resulting info file in Emacs, showing the node corresponding
+to the position in the source file, just after a successful compilation.
+This is why, while using @AUCTeX{}, invoking @code{makeinfo-buffer}
+might still be more convenient.
+
+Note also that in the case of a multifile document, @kbd{C-c C-c} in
address@hidden will work on the whole document (provided that the file
+variable @code{TeX-master} is set correctly), while
address@hidden in the native mode will process only the current
+buffer, provided at the @code{@@setfilename} statement is provided.
+
address@hidden Produce indexes and print
+The native Texinfo mode provides the binding @kbd{C-c C-t C-i}
+(@code{texinfo-texindex}) for producing an index and the bindings
address@hidden C-t C-p} (@code{texinfo-tex-print}) and @kbd{C-c C-t C-q}
+(@code{tex-show-print-queue}) for printing and showing the printer
+queue.  These are superseded by the respective commands available
+through @kbd{C-c C-c} (@code{TeX-command-master}) in @AUCTeX{}: Index,
+Print, and Queue.
+
address@hidden Kill jobs
+The command @kbd{C-c C-t C-k} (@code{tex-kill-job}) in the native mode
+is superseded by @kbd{C-c C-k} (@code{TeX-kill-job}) in @AUCTeX{}.
 @end table
 
address@hidden Mapping to native Texinfo
address@hidden Where @AUCTeX{} maps keybinding to native Texinfo commands
address@hidden Mapping
address@hidden Where key bindings are mapped to the native mode
 
 This node follows the native Texinfo mode summary (@pxref{(texinfo)
 Texinfo Mode Summary}) and lists only those commands to which @AUCTeX{}
-provide a keybinding. 
+provides a keybinding.
 
-Basically all native Texinfo commands connected with menu making and
-node inter-linking are mapped to same or similar keys by @AUCTeX{}, while a
-few insertion commands are mapped to @AUCTeX{}-like keys.
+Basically all commands of the native mode related to producing menus and
+interlinking nodes are mapped to same or similar keys in @AUCTeX{},
+while a few insertion commands are mapped to @AUCTeX{}-like keys.
 
 @table @asis
 
 @item @code{@@item} insertion
-Native Texinfo @kbd{C-c C-c i} for @code{@@item} insertion is mapped by
address@hidden to @address@hidden or @kbd{C-c C-j}, similar to other @AUCTeX{}
-modes.
+The binding @kbd{C-c C-c i} for the insertion of @code{@@item} in the
+native mode is mapped to @address@hidden or @kbd{C-c C-j} in
address@hidden, similar to other @AUCTeX{} modes.
 
 @item @code{@@end} insertion
-Native Texinfo @kbd{C-c C-c e} for closing some @kbd{@@@var{foo}} by a
-corresponding @code{@@end @var{foo}} is now mapped to @kbd{C-c C-]},
-similar to other @AUCTeX{} modes.
-
address@hidden go out of-brace
-The @address@hidden (@code{up-list}) command is available the same way in
-native Texinfo and in @AUCTeX{} texinfo (this command is actually not
-provided by either native or @AUCTeX{} texinfo). However, in @AUCTeX{}
-Texinfo, you cannot use @kbd{C-]} for this, as it is used for
address@hidden@@end} insertion.
-
address@hidden Node linking update
-Native Texinfo @kbd{C-c C-u C-n} (@code{texinfo-update-node}), and
address@hidden C-u C-e} (@code{texinfo-every-node-update}) commands can be
-accessed with same key bindings in @AUCTeX{} Texinfo.
-
address@hidden Menu updating/creation 
-Native Texinfo @kbd{C-c C-u m} (@code{texinfo-master-menu}), @kbd{C-c
-C-u C-m} (@code{texinfo-make-menu}), @kbd{C-c C-u C-a}
-(@code{texinfo-all-menus-update}) commands can be accessed with same key
-bindings in @AUCTeX{} address@hidden @c eol 
-Native Texinfo @code{texinfo-start-menu-description} is bound to
address@hidden C-u C-d} in @AUCTeX{} (instead of @kbd{C-c C-c C-d} with native
-Texinfo)
-
+The binding @kbd{C-c C-c e} for closing a @code{@@@var{foo}} command by
+a corresponding @code{@@end @var{foo}} statement in the native mode is
+mapped to @kbd{C-c C-]} in @AUCTeX{}, similar to other @AUCTeX{} modes.
+
address@hidden Move out of balanced braces
+The binding @address@hidden (@code{up-list}) is available both in the native
+mode and in @AUCTeX{}.  (This is because the command is not implemented
+in either mode but a native Emacs command.)  However, in @AUCTeX{}, you
+cannot use @kbd{C-]} for this, as it is used for @code{@@end} insertion.
+
address@hidden Update pointers
+The bindings @kbd{C-c C-u C-n} (@code{texinfo-update-node}) and @kbd{C-c
+C-u C-e} (@code{texinfo-every-node-update}) from the native mode are
+available in @AUCTeX{} as well.
+
address@hidden Update menus
+The bindings @kbd{C-c C-u m} (@code{texinfo-master-menu}), @kbd{C-c C-u
+C-m} (@code{texinfo-make-menu}), and @kbd{C-c C-u C-a}
+(@code{texinfo-all-menus-update}) from the native mode are available in
address@hidden as well.  The command @code{texinfo-start-menu-description},
+bound to @kbd{C-c C-c C-d} in the native mode, is bound to @kbd{C-c C-u
+C-d} in @AUCTeX{} instead.
 @end table
 
address@hidden Unbound native Texinfo
address@hidden Which native Texinfo commands are no longer bound to keys in 
@AUCTeX{} Texinfo
address@hidden Unbinding
address@hidden Which native mode key bindings are missing
 
-Here we list only those native Texinfo commands that are still of some
-usefullness when working with @AUCTeX{}, and which you cannot access by a
-keybinding any longer.
+The following commands from the native commands might still be useful
+when working with @AUCTeX{}, however, they are not accessible with a
+key binding any longer.
 
 @table @asis
 @item @code{@@node} insertion
-Native Texinfo @kbd{C-c C-c n} for node insertion is not mapped to any
-key in @AUCTeX{}, you can still have it by Texinfo menu. Another
-alternative is to use the @AUCTeX{} @kbd{C-c C-m} macro insertion.
-
address@hidden @code{texinfo-show-structure}
-Is not on any key. @kbd{C-c C-s} key is used by @AUCTeX{} for
-sectionning. When this document is written, Reftex does not support
-Texinfo and therefore using Reftex @kbd{C-c =} (@code{reftex-toc}) is
-not an alternative.
+The node insertion command, mapped to @kbd{C-c C-c n} in the native
+mode, is not mapped to any key in @AUCTeX{}.  You can still access it
+through the Texinfo menu, though.  Another alternative is to use the
address@hidden C-m} binding for macro insertion in @AUCTeX{}.
+
address@hidden Show the section structure
+The command @code{texinfo-show-structure} (@kbd{C-c C-s}) from the
+native mode does not have a key binding in @AUCTeX{}.  The binding is
+used by @AUCTeX{} for sectioning.
 @end table
 
 @node Indices