X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/3a12f2ed99734eff668f83f630c7108000e0b399..f3d2dedeba37d899be72a37339d0370aa3ae4c70:/doc/misc/reftex.texi

diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi
index 7a1b224fee..ff7011c5a7 100644
--- a/doc/misc/reftex.texi
+++ b/doc/misc/reftex.texi
@@ -2,7 +2,7 @@
 @c %**start of header
 @setfilename ../../info/reftex.info
 @settitle RefTeX User Manual
-@documentencoding UTF-8
+@include docstyle.texi
 @synindex ky cp
 @syncodeindex vr cp
 @syncodeindex fn cp
@@ -46,7 +46,7 @@ This manual documents @RefTeX{} (version @value{VERSION}), a package
 to do labels, references, citations and indices for LaTeX documents
 with Emacs.
 
-Copyright @copyright{} 1997--2014 Free Software Foundation, Inc.
+Copyright @copyright{} 1997--2016 Free Software Foundation, Inc.
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
@@ -608,7 +608,7 @@ Show calling point in another window.  This is the point from where
 
 @item <
 Promote the current section.  This will convert @code{\section} to
-@code{\chapter}, @code{\subsection} to @code{\section} etc. If there is
+@code{\chapter}, @code{\subsection} to @code{\section} etc.  If there is
 an active region, all sections in the region will be promoted, including
 the one at point.  To avoid mistakes, @RefTeX{} requires a fresh
 document scan before executing this command; if necessary, it will
@@ -1000,7 +1000,7 @@ In eqs. (1), (2), (3)--(4), (5) and (6)
 @item u
 Unmark a marked entry.
 
-@c FIXME: Do we need `A' as well for consistency?
+@c FIXME: Do we need 'A' as well for consistency?
 @cindex LaTeX packages, @code{saferef}
 @cindex @code{saferef}, LaTeX package
 @item a
@@ -1567,7 +1567,7 @@ Here is the setup:
 @cindex @code{linguex}, LaTeX package
 @cindex LaTeX packages, @code{linguex}
 A more complex example is the @file{linguex.sty} package which defines
-list macros @samp{\ex.}, @samp{\a.}, @samp{\b.} etc. for lists which are
+list macros @samp{\ex.}, @samp{\a.}, @samp{\b.} etc.@: for lists which are
 terminated by @samp{\z.} or by an empty line.
 
 @example
@@ -2893,6 +2893,9 @@ default.  If you want to have these key bindings available, set in your
 (setq reftex-extra-bindings t)
 @end lisp
 
+Note that this variable has to be set before @RefTeX{} is loaded to
+have an effect.
+
 @vindex reftex-load-hook
 Changing and adding to @RefTeX{}'s key bindings is best done in the hook
 @code{reftex-load-hook}.  For information on the keymaps
@@ -2961,6 +2964,12 @@ label itself in order to be processed correctly by @RefTeX{}.  The only
 exception is that section labels referring to a section statement
 outside the current file can still use that section title as
 context.
+
+@item
+@vindex reftex-include-file-commands
+@RefTeX{} knows about the @code{\include} and @code{\input} macros.
+In case you use different commands to include files in a multifile
+document, customize the variable @code{reftex-include-file-commands}.
 @end itemize
 
 @node Language Support
@@ -3893,6 +3902,10 @@ Lisp (and even if you are) you might find it more comfortable to use
 @code{customize} to look at and change these variables. @kbd{M-x
 reftex-customize} will get you there.
 
+In case you don't use the @code{customize} interface, here's a caveat:
+Changing (mostly parsing-related) options might require a call to
+@code{reftex-compile-variables} in order to become effective.
+
 @menu
 * Options - Table of Contents::
 * Options - Defining Label Environments::
@@ -4182,7 +4195,7 @@ List of magic words which identify a reference to be of this type.  If
 the word before point is equal to one of these words when calling
 @code{reftex-reference}, the label list offered will be automatically
 restricted to labels of the correct type.  If the first element of this
-word list is the symbol `regexp', the strings are interpreted as regular
+word list is the symbol @code{regexp}, the strings are interpreted as regular
 expressions.
 
 @item @var{toc-level}
@@ -4237,7 +4250,7 @@ but this process can be slow when a document contains thousands of
 labels.  If you use label prefixes consistently, you may speed up
 document parsing by setting this variable to a non-@code{nil} value.  RefTeX
 will then compare the label prefix with the prefixes found in
-`reftex-label-alist' and derive the correct label type in this way.
+@code{reftex-label-alist} and derive the correct label type in this way.
 Possible values for this option are:
 
 @example
@@ -4903,7 +4916,7 @@ The keymap which is active in the @file{*Index*} buffer
 
 @defopt reftex-view-crossref-extra
 Macros which can be used for the display of cross references.
-This is used when `reftex-view-crossref' is called with point in an
+This is used when @code{reftex-view-crossref} is called with point in an
 argument of a macro.  Note that crossref viewing for citations,
 references (both ways) and index entries is hard-coded.  This variable
 is only to configure additional structures for which crossreference
@@ -5200,7 +5213,7 @@ mouse    @r{Highlighting is mouse driven.}
 both     @r{Both cursor and mouse trigger highlighting.}
 @end example
 
-Changing this variable requires to rebuild the selection and *toc*
+Changing this variable requires rebuilding the selection and *toc*
 buffers to become effective (keys @kbd{g} or @kbd{r}).
 @end defopt
 
@@ -5408,8 +5421,8 @@ after words.  Disabled indexing in comment lines.
 New command @code{reftex-create-bibtex-file} to create a new database
 with all entries referenced in the current document.
 @item
-New keys @kbd{e} and @kbd{E} allow to produce a BibTeX database file
-from entries marked in a citation selection buffer.
+New keys @kbd{e} and @kbd{E} allow you to produce a BibTeX database
+file from entries marked in a citation selection buffer.
 @end itemize
 
 @noindent @b{Version 4.21}
@@ -5437,7 +5450,7 @@ deleted from the toc buffer with the @kbd{d} key.
 @noindent @b{Version 4.19}
 @itemize @bullet
 @item
-New command `reftex-toc-recenter' (@kbd{C-c -}) which shows the current
+New command @code{reftex-toc-recenter} (@kbd{C-c -}) which shows the current
 section in the TOC buffer without selecting the TOC window.
 @item
 Recentering happens automatically in idle time when the option
@@ -5449,7 +5462,7 @@ buffer.
 The highlight in the TOC buffer stays when the focus moves to a
 different window.
 @item
-New command `reftex-goto-label'.
+New command @code{reftex-goto-label}.
 @item
 Part numbers are no longer included in chapter numbers, and a new
 part does not reset the chapter counter.  See new option
@@ -5597,8 +5610,8 @@ demand.
 @item
 Index support, along with many new options.
 @item
-The selection of keys for @code{\ref} and @code{\cite} now allows to
-select multiple items by marking entries with the @kbd{m} key.
+The selection of keys for @code{\ref} and @code{\cite} now allows you
+to select multiple items by marking entries with the @kbd{m} key.
 @item
 Fancyref support.
 @end itemize
@@ -5896,7 +5909,7 @@ When no BibTeX database files are specified, citations can also use
 @noindent @b{Version 3.11}
 @itemize @bullet
 @item
-Fixed bug which led to naked label in (e.g.@:) footnotes.
+Fixed bug which led to naked label in (e.g.)@: footnotes.
 @item
 Added scroll-other-window functions to RefTeX-Select.
 @end itemize