[AUCTeX-commit] Changes to reftex/doc/reftex.texi,v

[Ralf Angeli]

CVSROOT:        /sources/auctex
Module name:    reftex
Changes by:     Ralf Angeli <angeli>    07/03/28 20:28:24

Index: reftex.texi
===================================================================
RCS file: /sources/auctex/reftex/doc/reftex.texi,v
retrieving revision 1.49
retrieving revision 1.50
diff -u -b -r1.49 -r1.50
--- reftex.texi 8 Mar 2007 22:06:38 -0000       1.49
+++ reftex.texi 28 Mar 2007 20:28:24 -0000      1.50
@@ -105,7 +105,7 @@
 * Faces::                            Fontification of RefTeX's buffers.
 * Multifile Documents::              Document spread over many files.
 * Language Support::                 How to support other languages.
-* Finding Files::                    Included @TeX{} files and BibTeX .bib 
files.
+* Finding Files::                    Included @TeX{} files and @BibTeX{} .bib 
files.
 * AUCTeX::                           Cooperation with @AUCTeX{}.
 * Optimizations::                    When RefTeX is too slow.
 * Problems and Work-Arounds::        First Aid.
@@ -204,7 +204,7 @@
 references, citations, and the index in @LaTeX{}.  @RefTeX{} wraps
 itself round 4 @LaTeX{} macros: @code{\label}, @code{\ref}, @code{\cite},
 and @code{\index}.  Using these macros usually requires looking up
-different parts of the document and searching through BibTeX database
+different parts of the document and searching through @BibTeX{} database
 files.  @RefTeX{} automates these time--consuming tasks almost
 entirely.  It also provides functions to display the structure of a
 document and to move around in this structure quickly.
@@ -295,7 +295,7 @@
 @item
 @address@hidden
 Typing @kbd{C-c [} (@code{reftex-citation}) will let you specify a
-regular expression to search in current BibTeX database files (as
+regular expression to search in current @BibTeX{} database files (as
 specified in the @code{\bibliography} command) and pull out a list of
 matches for you to choose from.  The list is @emph{formatted} and
 sorted.  The selected article is referenced as @address@hidden@address@hidden
@@ -338,9 +338,9 @@
 @item @b{Viewing address@hidden
 When point is on the @var{key} argument of a cross--referencing macro
 (@code{\label}, @code{\ref}, @code{\cite}, @code{\bibitem},
address@hidden, and variations) or inside a BibTeX database entry, you
address@hidden, and variations) or inside a @BibTeX{} database entry, you
 can press @kbd{C-c &} (@code{reftex-view-crossref}) to display
-corresponding locations in the document and associated BibTeX database
+corresponding locations in the document and associated @BibTeX{} database
 files. @*
 When the enclosing macro is @code{\cite} or @code{\ref} and no other
 message occupies the echo area, information about the citation or label
@@ -1632,7 +1632,7 @@
 
 Citations in @LaTeX{} are done with the @code{\cite} macro or variations of
 it.  The argument of the macro is a citation key which identifies an
-article or book in either a BibTeX database file or in an explicit
+article or book in either a @BibTeX{} database file or in an explicit
 @code{thebibliography} environment in the document.  @RefTeX{}'s
 support for citations helps to select the correct key quickly.
 
@@ -1674,16 +1674,16 @@
 @cindex @code{thebibliography}, LaTeX environment
 @cindex @code{BIBINPUTS}, environment variable
 @cindex @code{TEXBIB}, environment variable
address@hidden prefers to use BibTeX database files specified with a
address@hidden prefers to use @BibTeX{} database files specified with a
 @code{\bibliography} macro to collect its information.  Just like
-BibTeX, it will search for the specified files in the current directory
address@hidden, it will search for the specified files in the current directory
 and along the path given in the environment variable @code{BIBINPUTS}.
-If you do not use BibTeX, but the document contains an explicit
+If you do not use @BibTeX{}, but the document contains an explicit
 @code{thebibliography} environment, @RefTeX{} will collect its
 information from there.  Note that in this case the information
 presented in the selection buffer will just be a copy of relevant
 @code{\bibitem} entries, not the structured listing available with
-BibTeX database files.
address@hidden database files.
 
 @kindex ?
 In the selection buffer, the following keys provide special commands.  A
@@ -1713,7 +1713,7 @@
 @item f
 Toggle follow mode.  When follow mode is active, the other window will
 always display the full database entry of the current article.  This is
-equivalent to pressing @key{SPC} after each cursor motion.  With BibTeX
+equivalent to pressing @key{SPC} after each cursor motion.  With @BibTeX{}
 entries, follow mode can be rather slow.
 
 @tablesubheading{Selecting entries and creating the citation}
@@ -1744,12 +1744,12 @@
 separate @code{\cite} macro for each of it.
 
 @item e
-Create a new BibTeX database file which contains all @i{marked} entries
+Create a new @BibTeX{} database file which contains all @i{marked} entries
 in the selection buffer.  If no entries are marked, all entries are
 selected. 
 
 @item E
-Create a new BibTeX database file which contains all @i{unmarked}
+Create a new @BibTeX{} database file which contains all @i{unmarked}
 entries in the selection buffer.  If no entries are marked, all entries
 are selected. 
 
@@ -1863,9 +1863,9 @@
 information about the article cited there.  Note that the information is
 only displayed if the echo area is not occupied by a different message.
 
address@hidden can also display the @code{\bibitem} or BibTeX database
address@hidden can also display the @code{\bibitem} or @BibTeX{} database
 entry corresponding to a @code{\cite} macro, or all citation locations
-corresponding to a @code{\bibitem} or BibTeX database entry.
+corresponding to a @code{\bibitem} or @BibTeX{} database entry.
 @xref{Viewing Cross-References}.
 
 @node Chapterbib and Bibunits, Citations Outside LaTeX, Citation Info, 
Citations
@@ -1876,7 +1876,7 @@
 
 @code{chapterbib} and @code{bibunits} are two @LaTeX{} packages which
 produce multiple bibliographies in a document.  This is no problem for
address@hidden as long as all bibliographies use the same BibTeX database
address@hidden as long as all bibliographies use the same @BibTeX{} database
 files.  If they do not, it is best to have each document part in a
 separate file (as it is required for @code{chapterbib} anyway).  Then
 @RefTeX{} will still scan the locally relevant databases correctly.  If
@@ -1891,7 +1891,7 @@
 The command @code{reftex-citation} can also be executed outside a @LaTeX{}
 buffer.  This can be useful to reference articles in the mail buffer and
 other documents.  You should @emph{not} enter @code{reftex-mode} for
-this, just execute the command.  The list of BibTeX files will in this
+this, just execute the command.  The list of @BibTeX{} files will in this
 case be taken from the variable @code{reftex-default-bibliography}.
 Setting the variable @code{reftex-cite-format} to the symbol
 @code{locally} does a decent job of putting all relevant information
@@ -1913,7 +1913,7 @@
 @cindex BibTeX database subsets
 @findex reftex-create-bibtex-file
 
address@hidden offers two ways to create a new BibTeX database file.
address@hidden offers two ways to create a new @BibTeX{} database file.
 
 The first option produces a file which contains only the entries
 actually referenced in the current document.  This can be useful if
@@ -1923,14 +1923,14 @@
 the entire (possibly very large) database.  To create the file, use
 @kbd{M-x reftex-create-bibtex-file}, also available from the menu
 under @code{Ref->Global Actions->Create Bibtex File}.  The command will
-prompt for a BibTeX file name and write the extracted entries to that
+prompt for a @BibTeX{} file name and write the extracted entries to that
 file.
 
 The second option makes use of the selection process started by the
 command @kbd{C-c [} (@pxref{Creating Citations}).  This command uses a
 regular expression to select entries, and lists them in a formatted
 selection buffer.  After pressing the @kbd{e} key (mnemonics: Export),
-the command will prompt for the name of a new BibTeX file and write
+the command will prompt for the name of a new @BibTeX{} file and write
 the selected entries to that file.  You can also first mark some
 entries in the selection buffer with the @kbd{m} key and then export
 either the @i{marked} entries (with the @kbd{e} key) or the
@@ -2569,7 +2569,7 @@
 if two document locations are linked, @RefTeX{} can display the
 matching location(s) in another window.  The @code{\label} and @code{\ref}
 macros are one way of establishing such a link.  Also, a @code{\cite}
-macro is linked to the corresponding @code{\bibitem} macro or a BibTeX
+macro is linked to the corresponding @code{\bibitem} macro or a @BibTeX{}
 database entry.
 
 The feature is invoked by pressing @kbd{C-c &}
@@ -2600,7 +2600,7 @@
 
 @item @code{\cite}
 @cindex @code{\cite}
-Display the corresponding BibTeX database entry or @code{\bibitem}.
+Display the corresponding @BibTeX{} database entry or @code{\bibitem}.
 All usual address@hidden macros that either start or end with
 @samp{cite}} of the @code{\cite} macro are active for cross--reference
 display.
@@ -2611,10 +2611,10 @@
 @kbd{C-c &} several times moves through the entire document and finds
 all locations.
 
address@hidden BibTeX
address@hidden @BibTeX{}
 @cindex BibTeX buffer, viewing cite locations from
 @cindex Viewing cite locations from BibTeX buffer
address@hidden &} is also active in BibTeX buffers.  All locations in a
address@hidden &} is also active in @BibTeX{} buffers.  All locations in a
 document where the database entry at point is cited will be displayed.
 On first use, @RefTeX{} will prompt for a buffer which belongs to
 the document you want to search.  Subsequent calls will use the same
@@ -2838,7 +2838,7 @@
 @code{\include}, @RefTeX{} searches all directories specified in the
 environment variable @code{TEXINPUTS}.  Similarly, it will search the
 path specified in the variables @code{BIBINPUTS} and @code{TEXBIB} for
-BibTeX database files.
address@hidden database files.
 
 When searching, @RefTeX{} will also expand recursive path
 definitions (directories ending in @samp{//} or @samp{!!}).  But it will
@@ -2847,10 +2847,10 @@
 
 @itemize @bullet
 @item
-Most @TeX{} system have a default search path for both @TeX{} files and BibTeX
+Most @TeX{} system have a default search path for both @TeX{} files and 
@BibTeX{}
 files which is defined in some setup file.  Usually this default path is
 for system files which @RefTeX{} does not need to see.  But if your
-document needs @TeX{} files or BibTeX database files in a directory only
+document needs @TeX{} files or @BibTeX{} database files in a directory only
 given in the default search path, @RefTeX{} will fail to find them.
 @item
 Some @TeX{} systems do not use environment variables at all in order to
@@ -2885,7 +2885,7 @@
 
 @item
 Some @TeX{} systems provide stand--alone programs to do the file search just
-like @TeX{} and BibTeX.  E.g. Thomas Esser's @code{teTeX} uses the
+like @TeX{} and @BibTeX{}.  E.g. Thomas Esser's @code{teTeX} uses the
 @code{kpathsearch} library which provides the command @code{kpsewhich}
 to search for files.  @RefTeX{} can be configured to use this
 program.  Note that the exact syntax of the @code{kpsewhich}
@@ -2934,7 +2934,7 @@
 @item
 @b{Removing Lookup address@hidden
 @cindex Removing lookup buffers
address@hidden will load other parts of a multifile document as well as BibTeX
address@hidden will load other parts of a multifile document as well as 
@BibTeX{}
 database files for lookup purposes.  These buffers are kept, so that
 subsequent use of the same files is fast.  If you can't afford keeping
 these buffers around, and if you can live with a speed penalty, try
@@ -3309,7 +3309,7 @@
 mouse functions use @RefTeX{} for displaying references and citations.
 This can be useful in particular when working with the @LaTeX{} @code{xr}
 package or with an explicit @code{thebibliography} environment (rather
-than BibTeX).  Bib-cite cannot handle those, but @RefTeX{} does.  To
+than @BibTeX{}).  Bib-cite cannot handle those, but @RefTeX{} does.  To
 make use of this feature, try
 
 @vindex bib-cite-use-reftex-view-crossref
@@ -3525,8 +3525,8 @@
 @end deffn
 
 @deffn Command reftex-citation
-Make a citation using BibTeX database files.  After prompting for a regular
-expression, scans the buffers with BibTeX entries (taken from the
+Make a citation using @BibTeX{} database files.  After prompting for a regular
+expression, scans the buffers with @BibTeX{} entries (taken from the
 @code{\bibliography} command or a @code{thebibliography} environment)
 and offers the matching entries for selection.  The selected entry is
 formatted according to @code{reftex-cite-format} and inserted into the
@@ -3602,8 +3602,8 @@
 @end deffn
 
 @deffn Command reftex-view-crossref-from-bibtex
-View location in a @LaTeX{} document which cites the BibTeX entry at point.
-Since BibTeX files can be used by many @LaTeX{} documents, this function
+View location in a @LaTeX{} document which cites the @BibTeX{} entry at point.
+Since @BibTeX{} files can be used by many @LaTeX{} documents, this function
 prompts upon first use for a buffer in @RefTeX{} mode.  To reset this
 link to a document, call the function with a prefix arg.  Calling
 this function several times find successive citation locations.
@@ -3669,7 +3669,7 @@
 @end deffn
 
 @deffn Command reftex-create-bibtex-file
-Create a new BibTeX database file with all entries referenced in document.
+Create a new @BibTeX{} database file with all entries referenced in document.
 The command prompts for a filename and writes the collected entries to
 that file.  Only entries referenced in the current document with
 any @code{\cite}-like macros are used. 
@@ -4309,7 +4309,7 @@
 @cindex Creating citations, options
 
 @defopt reftex-bibliography-commands
address@hidden commands which specify the BibTeX databases to use with the 
document.
address@hidden commands which specify the @BibTeX{} databases to use with the 
document.
 @end defopt
 
 @defopt reftex-bibfile-ignore-regexps
@@ -4321,7 +4321,7 @@
 @end defopt
 
 @defopt reftex-default-bibliography
-List of BibTeX database files which should be used if none are specified.
+List of @BibTeX{} database files which should be used if none are specified.
 When @code{reftex-citation} is called from a document with neither
 a @address@hidden@}} statement nor a @code{thebibliography}
 environment, @RefTeX{} will scan these files instead.  Intended for
@@ -4330,7 +4330,7 @@
 @end defopt
 
 @defopt reftex-sort-bibtex-matches
-Sorting of the entries found in BibTeX databases by reftex-citation.
+Sorting of the entries found in @BibTeX{} databases by reftex-citation.
 Possible values:
 @example
 nil          @r{Do not sort entries.}
@@ -4351,7 +4351,7 @@
 
 @table @code
 @item %l
-The BibTeX label of the citation.
+The @BibTeX{} label of the citation.
 @item %a
 List of author names, see also @code{reftex-cite-punctuation}.
 @item %2a
@@ -4363,7 +4363,7 @@
 @samp{%E} work a well).
 @end table
 
-It is also possible to access all other BibTeX database fields:
+It is also possible to access all other @BibTeX{} database fields:
 
 @example
 %b booktitle     %c chapter        %d edition    %h howpublished
@@ -4384,7 +4384,7 @@
 A pair of square brackets indicates an optional argument, and RefTeX
 will prompt for the values of these arguments.
 
-Beware that all this only works with BibTeX database files.  When
+Beware that all this only works with @BibTeX{} database files.  When
 citations are made from the @code{\bibitems} in an explicit
 @code{thebibliography} environment, only @samp{%l} is available.
 
@@ -4739,7 +4739,7 @@
 address@hidden means, automatic citation display will revisit files if
 necessary.  When nil, citation display in echo area will only be active
 for cached echo strings (see @code{reftex-cache-cite-echo}), or for
-BibTeX database files which are already visited by a live associated
address@hidden database files which are already visited by a live associated
 buffers.
 @end defopt
 
@@ -4775,7 +4775,7 @@
 @end defopt
 
 @defopt reftex-bibpath-environment-variables
-List of specifications how to retrieve the search path for BibTeX
+List of specifications how to retrieve the search path for @BibTeX{}
 files.  Several entries are possible.
 @itemize @minus
 @item
@@ -4820,7 +4820,7 @@
 @defopt reftex-use-external-file-finders
 address@hidden means, use external programs to find files.  Normally,
 @RefTeX{} searches the paths given in the environment variables
address@hidden and @code{BIBINPUTS} to find @TeX{} files and BibTeX
address@hidden and @code{BIBINPUTS} to find @TeX{} files and @BibTeX{}
 database files.  With this option turned on, it calls an external
 program specified in the option @code{reftex-external-file-finders}
 instead.  As a side effect, the variables
@@ -4854,7 +4854,7 @@
 Parts of a multifile document loaded when (re)-parsing the
 document.
 @item LOOKUP
-BibTeX database files and @TeX{} files loaded to find a reference, to
address@hidden database files and @TeX{} files loaded to find a reference, to
 display label context, etc.
 @end table
 The created buffers can be kept for later use, or be thrown away