diff options
| author | Juanma Barranquero | 2006-12-11 01:36:09 +0000 |
|---|---|---|
| committer | Juanma Barranquero | 2006-12-11 01:36:09 +0000 |
| commit | e864595938ff3e7d0ff7dba732860e4ec0426483 (patch) | |
| tree | 1aea3db68f34d70b71b5d123385fe8a3882b51d2 | |
| parent | 4601d7c4544636174f18e028b64f7b1e5a531275 (diff) | |
| download | emacs-e864595938ff3e7d0ff7dba732860e4ec0426483.tar.gz emacs-e864595938ff3e7d0ff7dba732860e4ec0426483.zip | |
(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.
| -rw-r--r-- | lisp/textmodes/refer.el | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/lisp/textmodes/refer.el b/lisp/textmodes/refer.el index ce0f96956df..474b6f7be60 100644 --- a/lisp/textmodes/refer.el +++ b/lisp/textmodes/refer.el | |||
| @@ -79,19 +79,19 @@ | |||
| 79 | :group 'wp) | 79 | :group 'wp) |
| 80 | 80 | ||
| 81 | (defcustom refer-bib-directory nil | 81 | (defcustom refer-bib-directory nil |
| 82 | "Directory, or list of directories, to search for \\.bib files. Can | 82 | "Directory, or list of directories, to search for \\.bib files. |
| 83 | be set to 'bibinputs or 'texinputs, in which case the environment | 83 | Can be set to 'bibinputs or 'texinputs, in which case the environment |
| 84 | variable BIBINPUTS or TEXINPUTS, respectively, is used to obtain a | 84 | variable BIBINPUTS or TEXINPUTS, respectively, is used to obtain a |
| 85 | list of directories. Useful only if refer-bib-files is set to 'dir or | 85 | list of directories. Useful only if `refer-bib-files' is set to 'dir or |
| 86 | a list of file names (without directory). A value of nil indicates the | 86 | a list of file names (without directory). A value of nil indicates the |
| 87 | current working directory. | 87 | current working directory. |
| 88 | 88 | ||
| 89 | If refer-bib-directory is 'bibinputs or 'texinputs, it is setq'd to | 89 | If `refer-bib-directory' is 'bibinputs or 'texinputs, it is setq'd to |
| 90 | the appropriate list of directories when it is first used. | 90 | the appropriate list of directories when it is first used. |
| 91 | 91 | ||
| 92 | Note that an empty directory is interpreted by BibTeX as indicating | 92 | Note that an empty directory is interpreted by BibTeX as indicating |
| 93 | the default search path. Since Refer does not know that default path, | 93 | the default search path. Since Refer does not know that default path, |
| 94 | it cannot search it. Include that path explicitly in your BIBINPUTS | 94 | it cannot search it. Include that path explicitly in your BIBINPUTS |
| 95 | environment if you really want it searched (which is not likely to | 95 | environment if you really want it searched (which is not likely to |
| 96 | happen anyway)." | 96 | happen anyway)." |
| 97 | :type '(choice (repeat directory) (const bibinputs) (const texinputs)) | 97 | :type '(choice (repeat directory) (const bibinputs) (const texinputs)) |
| @@ -102,24 +102,24 @@ happen anyway)." | |||
| 102 | or one of the following special values: | 102 | or one of the following special values: |
| 103 | nil = prompt for \\.bib file (if visiting a \\.bib file, use it as default) | 103 | nil = prompt for \\.bib file (if visiting a \\.bib file, use it as default) |
| 104 | auto = read \\.bib file names from appropriate command in buffer (see | 104 | auto = read \\.bib file names from appropriate command in buffer (see |
| 105 | refer-bib-files-regexp) unless the buffer's mode is bibtex-mode, | 105 | `refer-bib-files-regexp') unless the buffer's mode is `bibtex-mode', |
| 106 | in which case only the buffer is searched | 106 | in which case only the buffer is searched |
| 107 | dir = use all \\.bib files in directories referenced by refer-bib-directory. | 107 | dir = use all \\.bib files in directories referenced by `refer-bib-directory'. |
| 108 | 108 | ||
| 109 | If a specified file doesn't exist and has no extension, a \\.bib extension | 109 | If a specified file doesn't exist and has no extension, a \\.bib extension |
| 110 | is automatically tried. | 110 | is automatically tried. |
| 111 | 111 | ||
| 112 | If refer-bib-files is nil, auto or dir, it is setq'd to the appropriate | 112 | If `refer-bib-files' is nil, auto or dir, it is setq'd to the appropriate |
| 113 | list of files when it is first used if refer-cache-bib-files is t. If | 113 | list of files when it is first used if `refer-cache-bib-files' is t. If |
| 114 | refer-cache-bib-files is nil, the list of \\.bib files to use is re-read | 114 | `refer-cache-bib-files' is nil, the list of \\.bib files to use is re-read |
| 115 | each time it is needed." | 115 | each time it is needed." |
| 116 | :type '(choice (repeat file) (const nil) (const auto) (const dir)) | 116 | :type '(choice (repeat file) (const nil) (const auto) (const dir)) |
| 117 | :group 'refer) | 117 | :group 'refer) |
| 118 | 118 | ||
| 119 | (defcustom refer-cache-bib-files t | 119 | (defcustom refer-cache-bib-files t |
| 120 | "*Variable determining whether the value of refer-bib-files should be cached. | 120 | "*Variable determining whether the value of `refer-bib-files' should be cached. |
| 121 | If t, initialize the value of refer-bib-files the first time it is used. If | 121 | If t, initialize the value of refer-bib-files the first time it is used. If |
| 122 | nil, re-read the list of \\.bib files depending on the value of refer-bib-files | 122 | nil, re-read the list of \\.bib files depending on the value of `refer-bib-files' |
| 123 | each time it is needed." | 123 | each time it is needed." |
| 124 | :type 'boolean | 124 | :type 'boolean |
| 125 | :group 'refer) | 125 | :group 'refer) |
| @@ -128,8 +128,8 @@ each time it is needed." | |||
| 128 | "*Regexp matching a bibliography file declaration. | 128 | "*Regexp matching a bibliography file declaration. |
| 129 | The current buffer is expected to contain a line such as | 129 | The current buffer is expected to contain a line such as |
| 130 | \\bibliography{file1,file2,file3} | 130 | \\bibliography{file1,file2,file3} |
| 131 | which is read to set up refer-bib-files. The regexp must specify the command | 131 | which is read to set up `refer-bib-files'. The regexp must specify the command |
| 132 | (such as \\bibliography) that is used to specify the list of bib files. The | 132 | \(such as \\bibliography) that is used to specify the list of bib files. The |
| 133 | command is expected to specify a file name, or a list of comma-separated file | 133 | command is expected to specify a file name, or a list of comma-separated file |
| 134 | names, within curly braces. | 134 | names, within curly braces. |
| 135 | If a specified file doesn't exist and has no extension, a \\.bib extension | 135 | If a specified file doesn't exist and has no extension, a \\.bib extension |
| @@ -150,8 +150,8 @@ is automatically tried." | |||
| 150 | (defun refer-find-entry (keywords &optional continue) | 150 | (defun refer-find-entry (keywords &optional continue) |
| 151 | "Find entry in refer-bib-files containing KEYWORDS. | 151 | "Find entry in refer-bib-files containing KEYWORDS. |
| 152 | If KEYWORDS is nil, prompt user for blank-separated list of keywords. | 152 | If KEYWORDS is nil, prompt user for blank-separated list of keywords. |
| 153 | If CONTINUE is t, or if called interactively with a prefix arg, look for next | 153 | If CONTINUE is non-nil, or if called interactively with a prefix arg, |
| 154 | entry by continuing search from previous point." | 154 | look for next entry by continuing search from previous point." |
| 155 | (interactive (list nil current-prefix-arg)) | 155 | (interactive (list nil current-prefix-arg)) |
| 156 | (or keywords (setq keywords (if continue | 156 | (or keywords (setq keywords (if continue |
| 157 | refer-previous-keywords | 157 | refer-previous-keywords |
| @@ -160,13 +160,13 @@ entry by continuing search from previous point." | |||
| 160 | (refer-find-entry-internal keywords continue)) | 160 | (refer-find-entry-internal keywords continue)) |
| 161 | 161 | ||
| 162 | (defun refer-find-next-entry () | 162 | (defun refer-find-next-entry () |
| 163 | "Find next occurrence of entry in refer-bib-files. See refer-find-entry." | 163 | "Find next occurrence of entry in `refer-bib-files'. See `refer-find-entry'." |
| 164 | (interactive) | 164 | (interactive) |
| 165 | (refer-find-entry-internal refer-previous-keywords t)) | 165 | (refer-find-entry-internal refer-previous-keywords t)) |
| 166 | 166 | ||
| 167 | (defun refer-yank-key () | 167 | (defun refer-yank-key () |
| 168 | "Inserts at point in current buffer the \"key\" field of the entry | 168 | "Inserts at point in current buffer the \"key\" field of the entry |
| 169 | found on the last refer-find-entry or refer-find-next-entry." | 169 | found on the last `refer-find-entry' or `refer-find-next-entry'." |
| 170 | (interactive) | 170 | (interactive) |
| 171 | (let ((old-point (point))) | 171 | (let ((old-point (point))) |
| 172 | (insert | 172 | (insert |