changeset 74586:30655edb57ac

(refer-find-entry): Doc fix. (refer-bib-files-regexp, refer-bib-directory, refer-bib-files, (refer-cache-bib-files, refer-find-next-entry, refer-yank-key): Fix tipos in docstrings.
author Juanma Barranquero <lekktu@gmail.com>
date Mon, 11 Dec 2006 01:36:09 +0000
parents 402a04b0362f
children 3d9741bb11f1
files lisp/textmodes/refer.el
diffstat 1 files changed, 20 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/textmodes/refer.el	Mon Dec 11 01:28:02 2006 +0000
+++ b/lisp/textmodes/refer.el	Mon Dec 11 01:36:09 2006 +0000
@@ -79,19 +79,19 @@
   :group 'wp)
 
 (defcustom refer-bib-directory nil
-  "Directory, or list of directories, to search for \\.bib files. Can
-be set to 'bibinputs or 'texinputs, in which case the environment
+  "Directory, or list of directories, to search for \\.bib files.
+Can be set to 'bibinputs or 'texinputs, in which case the environment
 variable BIBINPUTS or TEXINPUTS, respectively, is used to obtain a
-list of directories.  Useful only if refer-bib-files is set to 'dir or
-a list of file names (without directory). A value of nil indicates the
+list of directories.  Useful only if `refer-bib-files' is set to 'dir or
+a list of file names (without directory).  A value of nil indicates the
 current working directory.
 
-If refer-bib-directory is 'bibinputs or 'texinputs, it is setq'd to
+If `refer-bib-directory' is 'bibinputs or 'texinputs, it is setq'd to
 the appropriate list of directories when it is first used.
 
 Note that an empty directory is interpreted by BibTeX as indicating
-the default search path. Since Refer does not know that default path,
-it cannot search it. Include that path explicitly in your BIBINPUTS
+the default search path.  Since Refer does not know that default path,
+it cannot search it.  Include that path explicitly in your BIBINPUTS
 environment if you really want it searched (which is not likely to
 happen anyway)."
   :type '(choice (repeat directory) (const bibinputs) (const texinputs))
@@ -102,24 +102,24 @@
 or one of the following special values:
 nil  = prompt for \\.bib file (if visiting a \\.bib file, use it as default)
 auto = read \\.bib file names from appropriate command in buffer (see
-       refer-bib-files-regexp) unless the buffer's mode is bibtex-mode,
+       `refer-bib-files-regexp') unless the buffer's mode is `bibtex-mode',
        in which case only the buffer is searched
-dir  = use all \\.bib files in directories referenced by refer-bib-directory.
+dir  = use all \\.bib files in directories referenced by `refer-bib-directory'.
 
 If a specified file doesn't exist and has no extension, a \\.bib extension
 is automatically tried.
 
-If refer-bib-files is nil, auto or dir, it is setq'd to the appropriate
-list of files when it is first used if refer-cache-bib-files is t.  If
-refer-cache-bib-files is nil, the list of \\.bib files to use is re-read
+If `refer-bib-files' is nil, auto or dir, it is setq'd to the appropriate
+list of files when it is first used if `refer-cache-bib-files' is t.  If
+`refer-cache-bib-files' is nil, the list of \\.bib files to use is re-read
 each time it is needed."
   :type '(choice (repeat file) (const nil) (const auto) (const dir))
   :group 'refer)
 
 (defcustom refer-cache-bib-files t
-  "*Variable determining whether the value of refer-bib-files should be cached.
+  "*Variable determining whether the value of `refer-bib-files' should be cached.
 If t, initialize the value of refer-bib-files the first time it is used.  If
-nil, re-read the list of \\.bib files depending on the value of refer-bib-files
+nil, re-read the list of \\.bib files depending on the value of `refer-bib-files'
 each time it is needed."
   :type 'boolean
   :group 'refer)
@@ -128,8 +128,8 @@
   "*Regexp matching a bibliography file declaration.
 The current buffer is expected to contain a line such as
 \\bibliography{file1,file2,file3}
-which is read to set up refer-bib-files.  The regexp must specify the command
-(such as \\bibliography) that is used to specify the list of bib files.  The
+which is read to set up `refer-bib-files'.  The regexp must specify the command
+\(such as \\bibliography) that is used to specify the list of bib files.  The
 command is expected to specify a file name, or a list of comma-separated file
 names, within curly braces.
 If a specified file doesn't exist and has no extension, a \\.bib extension
@@ -150,8 +150,8 @@
 (defun refer-find-entry (keywords &optional continue)
    "Find entry in refer-bib-files containing KEYWORDS.
 If KEYWORDS is nil, prompt user for blank-separated list of keywords.
-If CONTINUE is t, or if called interactively with a prefix arg, look for next
-entry by continuing search from previous point."
+If CONTINUE is non-nil, or if called interactively with a prefix arg,
+look for next entry by continuing search from previous point."
    (interactive (list nil current-prefix-arg))
    (or keywords (setq keywords (if continue
                                    refer-previous-keywords
@@ -160,13 +160,13 @@
    (refer-find-entry-internal keywords continue))
 
 (defun refer-find-next-entry ()
-   "Find next occurrence of entry in refer-bib-files.  See refer-find-entry."
+   "Find next occurrence of entry in `refer-bib-files'.  See `refer-find-entry'."
    (interactive)
    (refer-find-entry-internal refer-previous-keywords t))
 
 (defun refer-yank-key ()
   "Inserts at point in current buffer the \"key\" field of the entry
-found on the last refer-find-entry or refer-find-next-entry."
+found on the last `refer-find-entry' or `refer-find-next-entry'."
   (interactive)
   (let ((old-point (point)))
     (insert