Commit c8de140b authored by Juanma Barranquero's avatar Juanma Barranquero
Browse files

Fix typos in docstrings.

* image-dired.el (image-dired-display-thumbs): Fix typo in docstring.
  (image-dired-read-comment): Doc fix.

* json.el (json-object-type, json-array-type, json-key-type, json-false)
  (json-null, json-read-number):
* minibuffer.el (completion-in-region-functions):
* calendar/cal-tex.el (cal-tex-daily-end, cal-tex-number-weeks)
  (cal-tex-cursor-week):
* emacs-lisp/trace.el (trace-function):
* eshell/em-basic.el (eshell/printnl):
* eshell/em-dirs.el (eshell-last-dir-ring, eshell-parse-drive-letter)
  (eshell-read-last-dir-ring, eshell-write-last-dir-ring):
* obsolete/levents.el (allocate-event, event-key, event-object)
  (event-point, event-process, event-timestamp, event-to-character)
  (event-window, event-x, event-x-pixel, event-y, event-y-pixel):
* textmodes/reftex-vars.el (reftex-index-macros-builtin)
  (reftex-section-levels, reftex-auto-recenter-toc, reftex-toc-mode-hook)
  (reftex-cite-punctuation, reftex-search-unrecursed-path-first)
  (reftex-highlight-selection): Fix typos in docstrings.
parent 5f76fe28
2010-03-22 Juanma Barranquero <lekktu@gmail.com>
* image-dired.el (image-dired-display-thumbs): Fix typo in docstring.
(image-dired-read-comment): Doc fix.
* json.el (json-object-type, json-array-type, json-key-type, json-false)
(json-null, json-read-number):
* minibuffer.el (completion-in-region-functions):
* calendar/cal-tex.el (cal-tex-daily-end, cal-tex-number-weeks)
(cal-tex-cursor-week):
* emacs-lisp/trace.el (trace-function):
* eshell/em-basic.el (eshell/printnl):
* eshell/em-dirs.el (eshell-last-dir-ring, eshell-parse-drive-letter)
(eshell-read-last-dir-ring, eshell-write-last-dir-ring):
* obsolete/levents.el (allocate-event, event-key, event-object)
(event-point, event-process, event-timestamp, event-to-character)
(event-window, event-x, event-x-pixel, event-y, event-y-pixel):
* textmodes/reftex-vars.el (reftex-index-macros-builtin)
(reftex-section-levels, reftex-auto-recenter-toc, reftex-toc-mode-hook)
(reftex-cite-punctuation, reftex-search-unrecursed-path-first)
(reftex-highlight-selection): Fix typos in docstrings.
2010-03-19 Juanma Barranquero <lekktu@gmail.com>
* minibuffer.el (completion-in-region-functions): Fix docstring typos.
......
......@@ -134,7 +134,7 @@ At present, this only affects `cal-tex-cursor-day'."
(defcustom cal-tex-daily-end 20
"The last hour of the daily LaTeX calendar page.
At present, this only affects `cal-tex-cursor-day'"
At present, this only affects `cal-tex-cursor-day'."
:type 'integer
:group 'calendar-tex)
......@@ -654,7 +654,7 @@ in the calendar starting in MONTH YEAR."
(defun cal-tex-number-weeks (month year n)
"Determine the number of weeks in a range of dates.
Compute the number of weeks in the calendar starting with MONTH and YEAR,
Compute the number of weeks in the calendar starting with MONTH and YEAR,
and lasting N months, including only the days in WHICH-DAYS. As it stands,
this is only an upper bound."
(let ((d (list month 1 year)))
......@@ -683,7 +683,7 @@ this is only an upper bound."
(defun cal-tex-cursor-week (&optional n event)
"Make a LaTeX calendar buffer for a two-page one-week calendar.
It applies to the week that point is in. The optional prefix
argument N specifies the number of weeks (default 1). The calendar
argument N specifies number of weeks (default 1). The calendar
shows holidays if `cal-tex-holidays' is non-nil (note that diary
entries are not shown). The calendar shows the hours 8-12am, 1-5pm."
(interactive (list (prefix-numeric-value current-prefix-arg)
......@@ -1778,7 +1778,7 @@ Add trailing COMMENT if present."
(cal-tex-comment "end framebox"))
(defun cal-tex-b-makebox ( width position )
(defun cal-tex-b-makebox (width position)
"Insert makebox with parameters WIDTH and POSITION (clr)."
(insert "\\makebox[" width "][" position "]{" )
(cal-tex-comment))
......
......@@ -253,7 +253,7 @@
For every call of FUNCTION Lisp-style trace messages that display argument
and return values will be inserted into BUFFER. This function generates the
trace advice for FUNCTION and activates it together with any other advice
there might be!! The trace BUFFER will popup whenever FUNCTION is called.
there might be!! The trace BUFFER will popup whenever FUNCTION is called.
Do not use this to trace functions that switch buffers or do any other
display oriented stuff, use `trace-function-background' instead."
(interactive
......
......@@ -125,7 +125,7 @@ or `eshell-printn' for display."
(eshell-echo args output-newline)))
(defun eshell/printnl (&rest args)
"Print out each of the argument, separated by newlines."
"Print out each of the arguments, separated by newlines."
(let ((elems (eshell-flatten-list args)))
(while elems
(eshell-printn (eshell-echo (list (car elems))))
......
......@@ -178,7 +178,7 @@ thing again."
Thus, this does not include the current directory.")
(defvar eshell-last-dir-ring nil
"The last directory that eshell was in.")
"The last directory that Eshell was in.")
;;; Functions:
......@@ -267,7 +267,7 @@ Thus, this does not include the current directory.")
(char-to-string (char-before))))
(defun eshell-parse-drive-letter ()
"An argument beginning X:[^/] is a drive letter reference."
"An argument beginning with X:[^/] is a drive letter reference."
(when (and (not eshell-current-argument)
(looking-at "\\([A-Za-z]:\\)\\([^/\\\\]\\|\\'\\)"))
(goto-char (match-end 1))
......@@ -517,7 +517,7 @@ in the minibuffer:
msg)))
(defun eshell-read-last-dir-ring ()
"Sets the buffer's `eshell-last-dir-ring' from a history file."
"Set the buffer's `eshell-last-dir-ring' from a history file."
(let ((file eshell-last-dir-ring-file-name))
(cond
((or (null file)
......@@ -545,7 +545,7 @@ in the minibuffer:
(setq eshell-last-dir-ring ring))))))
(defun eshell-write-last-dir-ring ()
"Writes the buffer's `eshell-last-dir-ring' to a history file."
"Write the buffer's `eshell-last-dir-ring' to a history file."
(let ((file eshell-last-dir-ring-file-name))
(cond
((or (null file)
......
......@@ -801,7 +801,7 @@ you have the dired buffer in the left window and the
With optional argument APPEND, append thumbnail to thumbnail buffer
instead of erasing it first.
Option argument DO-NOT-POP controls if `pop-to-buffer' should be
Optional argument DO-NOT-POP controls if `pop-to-buffer' should be
used or not. If non-nil, use `display-buffer' instead of
`pop-to-buffer'. This is used from functions like
`image-dired-next-line-and-display' and
......@@ -2113,8 +2113,7 @@ FILE-COMMENTS is an alist on the following form:
(defun image-dired-read-comment (&optional file)
"Read comment for an image.
Read comment for an image, optionally using old comment from FILE
as initial value."
Optionally use old comment from FILE as initial value."
(let ((comment
(read-string
"Comment: "
......
......@@ -62,12 +62,12 @@
(defvar json-object-type 'alist
"Type to convert JSON objects to.
Must be one of `alist', `plist', or `hash-table'. Consider let-binding
Must be one of `alist', `plist', or `hash-table'. Consider let-binding
this around your call to `json-read' instead of `setq'ing it.")
(defvar json-array-type 'vector
"Type to convert JSON arrays to.
Must be one of `vector' or `list'. Consider let-binding this around
Must be one of `vector' or `list'. Consider let-binding this around
your call to `json-read' instead of `setq'ing it.")
(defvar json-key-type nil
......@@ -83,19 +83,19 @@ If nil, `json-read' will guess the type based on the value of
`plist' `keyword'
Note that values other than `string' might behave strangely for
Sufficiently Weird keys. Consider let-binding this around your call to
Sufficiently Weird keys. Consider let-binding this around your call to
`json-read' instead of `setq'ing it.")
(defvar json-false :json-false
"Value to use when reading JSON `false'.
If this has the same value as `json-null', you might not be able to tell
the difference between `false' and `null'. Consider let-binding this
the difference between `false' and `null'. Consider let-binding this
around your call to `json-read' instead of `setq'ing it.")
(defvar json-null nil
"Value to use when reading JSON `null'.
If this has the same value as `json-false', you might not be able to
tell the difference between `false' and `null'. Consider let-binding
tell the difference between `false' and `null'. Consider let-binding
this around your call to `json-read' instead of `setq'ing it.")
......@@ -218,7 +218,7 @@ KEYWORD is the keyword expected."
(defun json-read-number (&optional sign)
"Read the JSON number following point.
The optional SIGN argument is for internal use.
The optional SIGN argument is for internal use.
N.B.: Only numbers which can fit in Emacs Lisp's native number
representation will be parsed correctly."
......
......@@ -1103,7 +1103,7 @@ variables.")
The functions on this special hook are called with 5 arguments:
NEXT-FUN START END COLLECTION PREDICATE.
NEXT-FUN is a function of four arguments (START END COLLECTION PREDICATE)
that performs the default operation. The other four argument are like
that performs the default operation. The other four arguments are like
the ones passed to `completion-in-region'. The functions on this hook
are expected to perform completion on START..END using COLLECTION
and PREDICATE, either by calling NEXT-FUN or by doing it themselves.")
......
......@@ -61,7 +61,7 @@
(put 'timeout 'event-symbol-elements '(eval))
(defun allocate-event ()
"Returns an empty event structure.
"Return an empty event structure.
In this emulation, it returns nil."
nil)
......@@ -142,7 +142,7 @@ It will be the next event read after all pending events."
(nth 1 event))
(defun event-key (event)
"Returns the KeySym of the given key-press event.
"Return the KeySym of the given key-press event.
The value is an ASCII printing character (not upper case) or a symbol."
(if (symbolp event)
(car (get event 'event-symbol-elements))
......@@ -150,11 +150,11 @@ The value is an ASCII printing character (not upper case) or a symbol."
(downcase (if (< base 32) (logior base 64) base)))))
(defun event-object (event)
"Returns the function argument of the given timeout, menu, or eval event."
"Return the function argument of the given timeout, menu, or eval event."
(nth 2 event))
(defun event-point (event)
"Returns the character position of the given mouse-related event.
"Return the character position of the given mouse-related event.
If the event did not occur over a window, or did
not occur over text, then this returns nil. Otherwise, it returns an index
into the buffer visible in the event's window."
......@@ -201,18 +201,18 @@ or for window WINDOW if that is specified."
(window-start start-window)))))
(defun event-process (event)
"Returns the process of the given process-output event."
"Return the process of the given process-output event."
(nth 1 event))
(defun event-timestamp (event)
"Returns the timestamp of the given event object.
"Return the timestamp of the given event object.
In Lucid Emacs, this works for any kind of event.
In this emulation, it returns nil for non-mouse-related events."
(and (listp event)
(posn-timestamp (event-end event))))
(defun event-to-character (event &optional lenient)
"Returns the closest ASCII approximation to the given event object.
"Return the closest ASCII approximation to the given event object.
If the event isn't a keypress, this returns nil.
If the second argument is non-nil, then this is lenient in its
translation; it will ignore modifier keys other than control and meta,
......@@ -229,25 +229,25 @@ will be returned for events which have no direct ASCII equivalent."
event nil)))
(defun event-window (event)
"Returns the window of the given mouse-related event object."
"Return the window of the given mouse-related event object."
(posn-window (event-end event)))
(defun event-x (event)
"Returns the X position in characters of the given mouse-related event."
"Return the X position in characters of the given mouse-related event."
(/ (car (posn-col-row (event-end event)))
(frame-char-width (window-frame (event-window event)))))
(defun event-x-pixel (event)
"Returns the X position in pixels of the given mouse-related event."
"Return the X position in pixels of the given mouse-related event."
(car (posn-col-row (event-end event))))
(defun event-y (event)
"Returns the Y position in characters of the given mouse-related event."
"Return the Y position in characters of the given mouse-related event."
(/ (cdr (posn-col-row (event-end event)))
(frame-char-height (window-frame (event-window event)))))
(defun event-y-pixel (event)
"Returns the Y position in pixels of the given mouse-related event."
"Return the Y position in pixels of the given mouse-related event."
(cdr (posn-col-row (event-end event))))
(defun key-press-event-p (obj)
......
......@@ -100,22 +100,22 @@
("enumerate" ?i "item:" "~\\ref{%s}" item
(regexp "items?" "Punkte?"))
("equation" ?e "eq:" "~(\\ref{%s})" t
(regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?" "Gl\\."))
("eqnarray" ?e "eq:" nil eqnarray-like)
("figure" ?f "fig:" "~\\ref{%s}" caption
(regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\."))
("figure*" ?f nil nil caption)
("table" ?t "tab:" "~\\ref{%s}" caption
(regexp "tables?" "tab\\." "Tabellen?"))
("table*" ?t nil nil caption)
("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2
(regexp "footnotes?" "Fussnoten?"))
("any" ?\ " " "~\\ref{%s}" nil)
;; The label macro is hard coded, but it *could* be defined like this:
......@@ -207,7 +207,7 @@ The following conventions are valid for all alist entries:
`?t' should point to a textual citation (citation as a noun).
`?p' should point to a parenthetical citation.")
(defconst reftex-index-macros-builtin
(defconst reftex-index-macros-builtin
'((default "Default \\index and \\glossary macros"
(("\\index{*}" "idx" ?i "" nil t)
("\\glossary{*}" "glo" ?g "" nil t)))
......@@ -219,9 +219,9 @@ The following conventions are valid for all alist entries:
(Index-Shortcut "index.sty with \\shortindexingon"
(("\\index[]{*}" 1 ?i "" nil t)
("\\index*[]{*}" 1 ?I "" nil nil)
("^[]{*}" 1 ?^ "" texmathp t)
("^[]{*}" 1 ?^ "" texmathp t)
("_[]{*}" 1 ?_ "" texmathp nil))))
"Builtin stuff for reftex-index-macros.
"Builtin stuff for `reftex-index-macros'.
Lower-case symbols correspond to a style file of the same name in the LaTeX
distribution. Mixed-case symbols are convenience aliases.")
)
......@@ -231,7 +231,7 @@ distribution. Mixed-case symbols are convenience aliases.")
(defgroup reftex nil
"LaTeX label and citation support."
:tag "RefTeX"
:link '(url-link :tag "Home Page"
:link '(url-link :tag "Home Page"
"http://staff.science.uva.nl/~dominik/Tools/reftex/")
:link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el")
:link '(custom-manual "(reftex)Top")
......@@ -280,7 +280,7 @@ the backslash). The cdr is a number indicating its level. A negative
level means the same level as the positive value, but the section will
never get a number. The cdr may also be a function which will be called
to after the section-re matched to determine the level.
This list is also used for promotion and demption of sectioning commands.
This list is also used for promotion and demotion of sectioning commands.
If you are using a document class which has several sets of sectioning
commands, promotion only works correctly if this list is sorted first
by set, then within each set by level. The promotion commands always
......@@ -318,7 +318,7 @@ are currently working in. Recentering happens whenever Emacs is idle for
more than `reftex-idle-time' seconds.
Value t means, turn on immediately when RefTeX gets started. Then,
recentering will work for any toc window created during the session.
recentering will work for any TOC window created during the session.
Value 'frame (the default) means, turn automatic recentering on only while the
dedicated TOC frame does exist, and do the recentering only in that frame. So
......@@ -326,14 +326,14 @@ when creating that frame (with \"d\" key in an ordinary TOC window), the
automatic recentering is turned on. When the frame gets destroyed, automatic
recentering is turned off again.
This feature can be turned on and off from the menu
This feature can be turned on and off from the menu
\(Ref->Options)."
:group 'reftex-table-of-contents-browser
:type '(choice
(const :tag "never" nil)
(const :tag "always" t)
(const :tag "in dedicated frame only" frame)))
(defcustom reftex-toc-split-windows-horizontally nil
"*Non-nil means, create TOC window by splitting window horizontally."
:group 'reftex-table-of-contents-browser
......@@ -407,7 +407,7 @@ When nil, follow-mode will be suspended for stuff in unvisited files."
:type 'boolean)
(defcustom reftex-toc-mode-hook nil
"Mode hook for reftex-toc-mode."
"Mode hook for `reftex-toc-mode'."
:group 'reftex-table-of-contents-browser
:type 'hook)
......@@ -425,7 +425,7 @@ When nil, follow-mode will be suspended for stuff in unvisited files."
'(amsmath endnotes fancybox floatfig longtable picinpar
rotating sidecap subfigure supertab wrapfig LaTeX)
"Default label alist specifications. LaTeX should always be the last entry.
The value of this variable is a list of symbols with associations in the
The value of this variable is a list of symbols with associations in the
constant `reftex-label-alist-builtin'. Check that constant for a full list
of options."
:group 'reftex-defining-label-environments
......@@ -624,7 +624,7 @@ list. However, builtin defaults should normally be set with the variable
(defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:"))
"Prefixes for section labels.
When the label prefix given in an entry in `reftex-label-alist' contains `%S',
this list is used to determine the correct prefix string depending on the
this list is used to determine the correct prefix string depending on the
current section level.
The list is an alist, with each entry of the form (KEY . PREFIX)
Possible keys are sectioning macro names like `chapter', section levels
......@@ -686,7 +686,7 @@ non-footnote labels."
(regexp)
(repeat :tag "List"
(string :tag "prefix (with colon)"))))
(defcustom reftex-special-environment-functions nil
"List of functions to be called when trying to figure out current environment.
These are special functions to detect \"environments\" which do not
......@@ -732,7 +732,7 @@ And here is the setup for RefTeX:
(let ((pos (point)) p1)
(save-excursion
;; Search for any of the linguex item macros at the beginning of a line
(if (re-search-backward
(if (re-search-backward
\"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t)
(progn
(setq p1 (match-beginning 1))
......@@ -742,7 +742,7 @@ And here is the setup for RefTeX:
nil
;; OK, we got it
(cons \"linguex\" p1)))
;; Return nil for not found
;; Return nil for not found
nil))))
3. Tell RefTeX to use this function
......@@ -941,7 +941,7 @@ This is used to string together whole reference sets, like
(defcustom reftex-vref-is-default nil
"*Non-nil means, the varioref macro \\vref is used as default.
In the selection buffer, the `v' key toggles the reference macro between
In the selection buffer, the `v' key toggles the reference macro between
`\\ref' and `\\vref'. The value of this variable determines the default
which is active when entering the selection process.
Instead of nil or t, this may also be a string of type letters indicating
......@@ -952,7 +952,7 @@ the label types for which it should be true."
(defcustom reftex-fref-is-default nil
"*Non-nil means, the fancyref macro \\fref is used as default.
In the selection buffer, the `V' key toggles the reference macro between
In the selection buffer, the `V' key toggles the reference macro between
`\\ref', `\\fref' and `\\Fref'. The value of this variable determines
the default which is active when entering the selection process.
Instead of nil or t, this may also be a string of type letters indicating
......@@ -979,7 +979,7 @@ a label type. If you set this variable to nil, RefTeX will always prompt."
(defcustom reftex-format-ref-function nil
"Function which produces the string to insert as a reference.
Normally should be nil, because the format to insert a reference can
Normally should be nil, because the format to insert a reference can
already be specified in `reftex-label-alist'.
This hook also is used by the special commands to insert `\\vref' and `\\fref'
references, so even if you set this, your setting will be ignored by
......@@ -1060,13 +1060,13 @@ It is also possible to access all other BibTeX database fields:
%i institution %j journal %k key %m month
%n number %o organization %p pages %P first page
%r address %s school %u publisher %t title
%v volume %y year
%v volume %y year
%B booktitle, abbreviated %T title, abbreviated
Usually, only %l is needed. The other stuff is mainly for the echo area
display, and for (setq reftex-comment-citations t).
%< as a special operator kills punctuation and space around it after the
%< as a special operator kills punctuation and space around it after the
string has been formatted.
A pair of square brackets indicates an optional argument, and RefTeX
......@@ -1081,7 +1081,7 @@ will be prompted for a character to select one of the possible format
strings.
In order to configure this variable, you can either set
`reftex-cite-format' directly yourself or set it to the SYMBOL of one of
the predefined styles. The predefined symbols are those which have an
the predefined styles. The predefined symbols are those which have an
association in the constant `reftex-cite-format-builtin'.
E.g.: (setq reftex-cite-format 'natbib)"
:group 'reftex-citation-support
......@@ -1164,8 +1164,8 @@ possible percent escapes."
(defcustom reftex-cite-punctuation '(", " " \\& " " {\\it et al.}")
"Punctuation for formatting of name lists in citations.
This is a list of 3 strings.
1. normal names separator, like \", \" in Jones, Brown and Miller
2. final names separator, like \" and \" in Jones, Brown and Miller
1. Normal names separator, like \", \" in Jones, Brown and Miller
2. Final names separator, like \" and \" in Jones, Brown and Miller
3. The \"et al\" string, like \" {\\it et al.}\" in Jones {\\it et al.}"
:group 'reftex-citation-support
:type '(list
......@@ -1175,7 +1175,7 @@ This is a list of 3 strings.
(defcustom reftex-format-cite-function nil
"Function which produces the string to insert as a citation.
Normally should be nil, because the format to insert a reference can
Normally should be nil, because the format to insert a reference can
already be specified in `reftex-cite-format'.
The function will be called with two arguments, the CITATION KEY and the
DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function
......@@ -1258,7 +1258,7 @@ package here."
:group 'reftex-index-support
:set 'reftex-set-dirty
:type `(list
(repeat
(repeat
:inline t
(list :value ("" "idx" ?a "" nil)
(string :tag "Macro with args")
......@@ -1285,7 +1285,7 @@ package here."
This is a list with (MACRO-KEY DEFAULT-TAG).
MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'.
DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument.
DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument.
When this is nil and a TAG is needed, RefTeX will ask for it.
When this is the empty string and the TAG argument of the index
macro is optional, the TAG argument will be omitted."
......@@ -1426,7 +1426,7 @@ to that section."
(defcustom reftex-index-include-context nil
"*Non-nil means, display the index definition context in the index buffer.
This flag may also be toggled from the index buffer with the `c' key."
This flag may also be toggled from the index buffer with the `c' key."
:group 'reftex-index-support
:type 'boolean)
......@@ -1449,7 +1449,7 @@ This is used when `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
viewing can be useful. Each entry has the structure
viewing can be useful. Each entry has the structure
\(MACRO-RE SEARCH-RE HIGHLIGHT).
......@@ -1470,7 +1470,7 @@ argument of a \\ref or \\cite macro, and no other message is being
displayed, the echo area will display information about that cross
reference. You can also set the variable to the symbol `window'. In
this case a small temporary window is used for the display.
This feature can be turned on and off from the menu
This feature can be turned on and off from the menu
\(Ref->Options)."
:group 'reftex-viewing-cross-references
:type '(choice (const :tag "off" nil)
......@@ -1516,7 +1516,7 @@ Several entries are possible.
- If an element is the name of an environment variable, its content is used.
- If an element starts with an exclamation mark, it is used as a command
to retrieve the path. A typical command with the kpathsearch library would
be `!kpsewhich -show-path=.tex'.
be `!kpsewhich -show-path=.tex'.
- Otherwise the element itself is interpreted as a path.
Multiple directories can be separated by the system dependent `path-separator'.
Directories ending in `//' or `!!' will be expanded recursively.
......@@ -1531,7 +1531,7 @@ Several entries are possible.
- If an element is the name of an environment variable, its content is used.
- If an element starts with an exclamation mark, it is used as a command
to retrieve the path. A typical command with the kpathsearch library would
be `!kpsewhich -show-path=.bib'.
be `!kpsewhich -show-path=.bib'.
- Otherwise the element itself is interpreted as a path.
Multiple directories can be separated by the system dependent `path-separator'.
Directories ending in `//' or `!!' will be expanded recursively.
......@@ -1575,7 +1575,7 @@ Note that if you are using external file finders, this option has no effect."
"*Non-nil means, search all specified directories before trying recursion.
Thus, in a path \".//:/tex/\", search first \"./\", then \"/tex/\" and then
all subdirectories of \"./\". If this option is nil, the subdirectories of
\"./\" are searched before \"/tex/\". This is mainly for speed - most of the
\"./\" are searched before \"/tex/\". This is mainly for speed - most of the
time the recursive path is for the system files and not for the user files.
Set this to nil if the default makes RefTeX finding files with equal names
in wrong sequence."
......@@ -1588,7 +1588,7 @@ Normally, RefTeX searches the paths given in the environment variables
TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files.
With this option turned on, it calls an external program specified in the
option `reftex-external-file-finders' instead. As a side effect,
the variables `reftex-texpath-environment-variables' and
the variables `reftex-texpath-environment-variables' and
`reftex-bibpath-environment-variables' will be ignored."
:group 'reftex-finding-files
:type 'boolean)
......@@ -1679,7 +1679,7 @@ list."
(defcustom reftex-save-parse-info nil
"*Non-nil means, save information gathered with parsing in a file.
The file MASTER.rel in the same directory as MASTER.tex is used to save the
information. When this variable is t,
information. When this variable is t,
- accessing the parsing information for the first time in an editing session
will read that file (if available) instead of parsing the document.
- exiting Emacs or killing a buffer in reftex-mode will cause a new version
......@@ -1753,7 +1753,7 @@ Normally, the text near the cursor is the selected text, and it is
highlighted. This is the entry most keys in the selction and *toc*
buffers act on. However, if you mainly use the mouse to select an
item, you may find it nice to have mouse-triggered highlighting
instead or as well. The variable may have one of these values:
instead or as well. The variable may have one of these values:
nil No highlighting.
cursor Highlighting is cursor driven.
......@@ -1882,7 +1882,7 @@ RefTeX uses `fset' to take over the function calls. Changing the variable
may require a restart of Emacs in order to become effective."
:group 'reftex-miscellaneous-configurations
:group 'LaTeX
:type '(choice
:type '(choice
(const :tag "No plug-ins" nil)
(const :tag "All possible plug-ins" t)
(list
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment