aboutsummaryrefslogtreecommitdiffstats
path: root/lisp
diff options
context:
space:
mode:
authorJuanma Barranquero2010-03-22 17:50:29 +0100
committerJuanma Barranquero2010-03-22 17:50:29 +0100
commitc8de140b340e26e507d55005621684d6e7657ecd (patch)
tree5f0916c0d2436ac389c0b8c207221970c5b08dad /lisp
parent5f76fe28b98ceec8ab3a7aacc4a0281679d818ee (diff)
downloademacs-c8de140b340e26e507d55005621684d6e7657ecd.tar.gz
emacs-c8de140b340e26e507d55005621684d6e7657ecd.zip
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.
Diffstat (limited to 'lisp')
-rw-r--r--lisp/ChangeLog22
-rw-r--r--lisp/calendar/cal-tex.el8
-rw-r--r--lisp/emacs-lisp/trace.el2
-rw-r--r--lisp/eshell/em-basic.el2
-rw-r--r--lisp/eshell/em-dirs.el8
-rw-r--r--lisp/image-dired.el5
-rw-r--r--lisp/json.el12
-rw-r--r--lisp/minibuffer.el2
-rw-r--r--lisp/obsolete/levents.el24
-rw-r--r--lisp/textmodes/reftex-vars.el80
10 files changed, 93 insertions, 72 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 23cf3f7a623..1d650a2ef58 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,25 @@
12010-03-22 Juanma Barranquero <lekktu@gmail.com>
2
3 * image-dired.el (image-dired-display-thumbs): Fix typo in docstring.
4 (image-dired-read-comment): Doc fix.
5
6 * json.el (json-object-type, json-array-type, json-key-type, json-false)
7 (json-null, json-read-number):
8 * minibuffer.el (completion-in-region-functions):
9 * calendar/cal-tex.el (cal-tex-daily-end, cal-tex-number-weeks)
10 (cal-tex-cursor-week):
11 * emacs-lisp/trace.el (trace-function):
12 * eshell/em-basic.el (eshell/printnl):
13 * eshell/em-dirs.el (eshell-last-dir-ring, eshell-parse-drive-letter)
14 (eshell-read-last-dir-ring, eshell-write-last-dir-ring):
15 * obsolete/levents.el (allocate-event, event-key, event-object)
16 (event-point, event-process, event-timestamp, event-to-character)
17 (event-window, event-x, event-x-pixel, event-y, event-y-pixel):
18 * textmodes/reftex-vars.el (reftex-index-macros-builtin)
19 (reftex-section-levels, reftex-auto-recenter-toc, reftex-toc-mode-hook)
20 (reftex-cite-punctuation, reftex-search-unrecursed-path-first)
21 (reftex-highlight-selection): Fix typos in docstrings.
22
12010-03-19 Juanma Barranquero <lekktu@gmail.com> 232010-03-19 Juanma Barranquero <lekktu@gmail.com>
2 24
3 * minibuffer.el (completion-in-region-functions): Fix docstring typos. 25 * minibuffer.el (completion-in-region-functions): Fix docstring typos.
diff --git a/lisp/calendar/cal-tex.el b/lisp/calendar/cal-tex.el
index 0e320ff8f90..bbddc1ff38c 100644
--- a/lisp/calendar/cal-tex.el
+++ b/lisp/calendar/cal-tex.el
@@ -134,7 +134,7 @@ At present, this only affects `cal-tex-cursor-day'."
134 134
135(defcustom cal-tex-daily-end 20 135(defcustom cal-tex-daily-end 20
136 "The last hour of the daily LaTeX calendar page. 136 "The last hour of the daily LaTeX calendar page.
137At present, this only affects `cal-tex-cursor-day'" 137At present, this only affects `cal-tex-cursor-day'."
138 :type 'integer 138 :type 'integer
139 :group 'calendar-tex) 139 :group 'calendar-tex)
140 140
@@ -654,7 +654,7 @@ in the calendar starting in MONTH YEAR."
654 654
655(defun cal-tex-number-weeks (month year n) 655(defun cal-tex-number-weeks (month year n)
656 "Determine the number of weeks in a range of dates. 656 "Determine the number of weeks in a range of dates.
657Compute the number of weeks in the calendar starting with MONTH and YEAR, 657Compute the number of weeks in the calendar starting with MONTH and YEAR,
658and lasting N months, including only the days in WHICH-DAYS. As it stands, 658and lasting N months, including only the days in WHICH-DAYS. As it stands,
659this is only an upper bound." 659this is only an upper bound."
660 (let ((d (list month 1 year))) 660 (let ((d (list month 1 year)))
@@ -683,7 +683,7 @@ this is only an upper bound."
683(defun cal-tex-cursor-week (&optional n event) 683(defun cal-tex-cursor-week (&optional n event)
684 "Make a LaTeX calendar buffer for a two-page one-week calendar. 684 "Make a LaTeX calendar buffer for a two-page one-week calendar.
685It applies to the week that point is in. The optional prefix 685It applies to the week that point is in. The optional prefix
686argument N specifies the number of weeks (default 1). The calendar 686argument N specifies number of weeks (default 1). The calendar
687shows holidays if `cal-tex-holidays' is non-nil (note that diary 687shows holidays if `cal-tex-holidays' is non-nil (note that diary
688entries are not shown). The calendar shows the hours 8-12am, 1-5pm." 688entries are not shown). The calendar shows the hours 8-12am, 1-5pm."
689 (interactive (list (prefix-numeric-value current-prefix-arg) 689 (interactive (list (prefix-numeric-value current-prefix-arg)
@@ -1778,7 +1778,7 @@ Add trailing COMMENT if present."
1778 (cal-tex-comment "end framebox")) 1778 (cal-tex-comment "end framebox"))
1779 1779
1780 1780
1781(defun cal-tex-b-makebox ( width position ) 1781(defun cal-tex-b-makebox (width position)
1782 "Insert makebox with parameters WIDTH and POSITION (clr)." 1782 "Insert makebox with parameters WIDTH and POSITION (clr)."
1783 (insert "\\makebox[" width "][" position "]{" ) 1783 (insert "\\makebox[" width "][" position "]{" )
1784 (cal-tex-comment)) 1784 (cal-tex-comment))
diff --git a/lisp/emacs-lisp/trace.el b/lisp/emacs-lisp/trace.el
index 9b143cbf18c..194afe10815 100644
--- a/lisp/emacs-lisp/trace.el
+++ b/lisp/emacs-lisp/trace.el
@@ -253,7 +253,7 @@
253For every call of FUNCTION Lisp-style trace messages that display argument 253For every call of FUNCTION Lisp-style trace messages that display argument
254and return values will be inserted into BUFFER. This function generates the 254and return values will be inserted into BUFFER. This function generates the
255trace advice for FUNCTION and activates it together with any other advice 255trace advice for FUNCTION and activates it together with any other advice
256there might be!! The trace BUFFER will popup whenever FUNCTION is called. 256there might be!! The trace BUFFER will popup whenever FUNCTION is called.
257Do not use this to trace functions that switch buffers or do any other 257Do not use this to trace functions that switch buffers or do any other
258display oriented stuff, use `trace-function-background' instead." 258display oriented stuff, use `trace-function-background' instead."
259 (interactive 259 (interactive
diff --git a/lisp/eshell/em-basic.el b/lisp/eshell/em-basic.el
index 775b67a3fa3..a4074011f58 100644
--- a/lisp/eshell/em-basic.el
+++ b/lisp/eshell/em-basic.el
@@ -125,7 +125,7 @@ or `eshell-printn' for display."
125 (eshell-echo args output-newline))) 125 (eshell-echo args output-newline)))
126 126
127(defun eshell/printnl (&rest args) 127(defun eshell/printnl (&rest args)
128 "Print out each of the argument, separated by newlines." 128 "Print out each of the arguments, separated by newlines."
129 (let ((elems (eshell-flatten-list args))) 129 (let ((elems (eshell-flatten-list args)))
130 (while elems 130 (while elems
131 (eshell-printn (eshell-echo (list (car elems)))) 131 (eshell-printn (eshell-echo (list (car elems))))
diff --git a/lisp/eshell/em-dirs.el b/lisp/eshell/em-dirs.el
index 3104bb11b17..43bc3ffaa6f 100644
--- a/lisp/eshell/em-dirs.el
+++ b/lisp/eshell/em-dirs.el
@@ -178,7 +178,7 @@ thing again."
178Thus, this does not include the current directory.") 178Thus, this does not include the current directory.")
179 179
180(defvar eshell-last-dir-ring nil 180(defvar eshell-last-dir-ring nil
181 "The last directory that eshell was in.") 181 "The last directory that Eshell was in.")
182 182
183;;; Functions: 183;;; Functions:
184 184
@@ -267,7 +267,7 @@ Thus, this does not include the current directory.")
267 (char-to-string (char-before)))) 267 (char-to-string (char-before))))
268 268
269(defun eshell-parse-drive-letter () 269(defun eshell-parse-drive-letter ()
270 "An argument beginning X:[^/] is a drive letter reference." 270 "An argument beginning with X:[^/] is a drive letter reference."
271 (when (and (not eshell-current-argument) 271 (when (and (not eshell-current-argument)
272 (looking-at "\\([A-Za-z]:\\)\\([^/\\\\]\\|\\'\\)")) 272 (looking-at "\\([A-Za-z]:\\)\\([^/\\\\]\\|\\'\\)"))
273 (goto-char (match-end 1)) 273 (goto-char (match-end 1))
@@ -517,7 +517,7 @@ in the minibuffer:
517 msg))) 517 msg)))
518 518
519(defun eshell-read-last-dir-ring () 519(defun eshell-read-last-dir-ring ()
520 "Sets the buffer's `eshell-last-dir-ring' from a history file." 520 "Set the buffer's `eshell-last-dir-ring' from a history file."
521 (let ((file eshell-last-dir-ring-file-name)) 521 (let ((file eshell-last-dir-ring-file-name))
522 (cond 522 (cond
523 ((or (null file) 523 ((or (null file)
@@ -545,7 +545,7 @@ in the minibuffer:
545 (setq eshell-last-dir-ring ring)))))) 545 (setq eshell-last-dir-ring ring))))))
546 546
547(defun eshell-write-last-dir-ring () 547(defun eshell-write-last-dir-ring ()
548 "Writes the buffer's `eshell-last-dir-ring' to a history file." 548 "Write the buffer's `eshell-last-dir-ring' to a history file."
549 (let ((file eshell-last-dir-ring-file-name)) 549 (let ((file eshell-last-dir-ring-file-name))
550 (cond 550 (cond
551 ((or (null file) 551 ((or (null file)
diff --git a/lisp/image-dired.el b/lisp/image-dired.el
index 8eb1d127819..f006e2e9edd 100644
--- a/lisp/image-dired.el
+++ b/lisp/image-dired.el
@@ -801,7 +801,7 @@ you have the dired buffer in the left window and the
801With optional argument APPEND, append thumbnail to thumbnail buffer 801With optional argument APPEND, append thumbnail to thumbnail buffer
802instead of erasing it first. 802instead of erasing it first.
803 803
804Option argument DO-NOT-POP controls if `pop-to-buffer' should be 804Optional argument DO-NOT-POP controls if `pop-to-buffer' should be
805used or not. If non-nil, use `display-buffer' instead of 805used or not. If non-nil, use `display-buffer' instead of
806`pop-to-buffer'. This is used from functions like 806`pop-to-buffer'. This is used from functions like
807`image-dired-next-line-and-display' and 807`image-dired-next-line-and-display' and
@@ -2113,8 +2113,7 @@ FILE-COMMENTS is an alist on the following form:
2113 2113
2114(defun image-dired-read-comment (&optional file) 2114(defun image-dired-read-comment (&optional file)
2115 "Read comment for an image. 2115 "Read comment for an image.
2116Read comment for an image, optionally using old comment from FILE 2116Optionally use old comment from FILE as initial value."
2117as initial value."
2118 (let ((comment 2117 (let ((comment
2119 (read-string 2118 (read-string
2120 "Comment: " 2119 "Comment: "
diff --git a/lisp/json.el b/lisp/json.el
index 39c1fd32337..6228b99f3e2 100644
--- a/lisp/json.el
+++ b/lisp/json.el
@@ -62,12 +62,12 @@
62 62
63(defvar json-object-type 'alist 63(defvar json-object-type 'alist
64 "Type to convert JSON objects to. 64 "Type to convert JSON objects to.
65Must be one of `alist', `plist', or `hash-table'. Consider let-binding 65Must be one of `alist', `plist', or `hash-table'. Consider let-binding
66this around your call to `json-read' instead of `setq'ing it.") 66this around your call to `json-read' instead of `setq'ing it.")
67 67
68(defvar json-array-type 'vector 68(defvar json-array-type 'vector
69 "Type to convert JSON arrays to. 69 "Type to convert JSON arrays to.
70Must be one of `vector' or `list'. Consider let-binding this around 70Must be one of `vector' or `list'. Consider let-binding this around
71your call to `json-read' instead of `setq'ing it.") 71your call to `json-read' instead of `setq'ing it.")
72 72
73(defvar json-key-type nil 73(defvar json-key-type nil
@@ -83,19 +83,19 @@ If nil, `json-read' will guess the type based on the value of
83 `plist' `keyword' 83 `plist' `keyword'
84 84
85Note that values other than `string' might behave strangely for 85Note that values other than `string' might behave strangely for
86Sufficiently Weird keys. Consider let-binding this around your call to 86Sufficiently Weird keys. Consider let-binding this around your call to
87`json-read' instead of `setq'ing it.") 87`json-read' instead of `setq'ing it.")
88 88
89(defvar json-false :json-false 89(defvar json-false :json-false
90 "Value to use when reading JSON `false'. 90 "Value to use when reading JSON `false'.
91If this has the same value as `json-null', you might not be able to tell 91If this has the same value as `json-null', you might not be able to tell
92the difference between `false' and `null'. Consider let-binding this 92the difference between `false' and `null'. Consider let-binding this
93around your call to `json-read' instead of `setq'ing it.") 93around your call to `json-read' instead of `setq'ing it.")
94 94
95(defvar json-null nil 95(defvar json-null nil
96 "Value to use when reading JSON `null'. 96 "Value to use when reading JSON `null'.
97If this has the same value as `json-false', you might not be able to 97If this has the same value as `json-false', you might not be able to
98tell the difference between `false' and `null'. Consider let-binding 98tell the difference between `false' and `null'. Consider let-binding
99this around your call to `json-read' instead of `setq'ing it.") 99this around your call to `json-read' instead of `setq'ing it.")
100 100
101 101
@@ -218,7 +218,7 @@ KEYWORD is the keyword expected."
218 218
219(defun json-read-number (&optional sign) 219(defun json-read-number (&optional sign)
220 "Read the JSON number following point. 220 "Read the JSON number following point.
221The optional SIGN argument is for internal use. 221The optional SIGN argument is for internal use.
222 222
223N.B.: Only numbers which can fit in Emacs Lisp's native number 223N.B.: Only numbers which can fit in Emacs Lisp's native number
224representation will be parsed correctly." 224representation will be parsed correctly."
diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el
index 1990f4f63d7..43838a32ceb 100644
--- a/lisp/minibuffer.el
+++ b/lisp/minibuffer.el
@@ -1103,7 +1103,7 @@ variables.")
1103The functions on this special hook are called with 5 arguments: 1103The functions on this special hook are called with 5 arguments:
1104 NEXT-FUN START END COLLECTION PREDICATE. 1104 NEXT-FUN START END COLLECTION PREDICATE.
1105NEXT-FUN is a function of four arguments (START END COLLECTION PREDICATE) 1105NEXT-FUN is a function of four arguments (START END COLLECTION PREDICATE)
1106that performs the default operation. The other four argument are like 1106that performs the default operation. The other four arguments are like
1107the ones passed to `completion-in-region'. The functions on this hook 1107the ones passed to `completion-in-region'. The functions on this hook
1108are expected to perform completion on START..END using COLLECTION 1108are expected to perform completion on START..END using COLLECTION
1109and PREDICATE, either by calling NEXT-FUN or by doing it themselves.") 1109and PREDICATE, either by calling NEXT-FUN or by doing it themselves.")
diff --git a/lisp/obsolete/levents.el b/lisp/obsolete/levents.el
index 652994ebd7a..1715185ac05 100644
--- a/lisp/obsolete/levents.el
+++ b/lisp/obsolete/levents.el
@@ -61,7 +61,7 @@
61(put 'timeout 'event-symbol-elements '(eval)) 61(put 'timeout 'event-symbol-elements '(eval))
62 62
63(defun allocate-event () 63(defun allocate-event ()
64 "Returns an empty event structure. 64 "Return an empty event structure.
65In this emulation, it returns nil." 65In this emulation, it returns nil."
66 nil) 66 nil)
67 67
@@ -142,7 +142,7 @@ It will be the next event read after all pending events."
142 (nth 1 event)) 142 (nth 1 event))
143 143
144(defun event-key (event) 144(defun event-key (event)
145 "Returns the KeySym of the given key-press event. 145 "Return the KeySym of the given key-press event.
146The value is an ASCII printing character (not upper case) or a symbol." 146The value is an ASCII printing character (not upper case) or a symbol."
147 (if (symbolp event) 147 (if (symbolp event)
148 (car (get event 'event-symbol-elements)) 148 (car (get event 'event-symbol-elements))
@@ -150,11 +150,11 @@ The value is an ASCII printing character (not upper case) or a symbol."
150 (downcase (if (< base 32) (logior base 64) base))))) 150 (downcase (if (< base 32) (logior base 64) base)))))
151 151
152(defun event-object (event) 152(defun event-object (event)
153 "Returns the function argument of the given timeout, menu, or eval event." 153 "Return the function argument of the given timeout, menu, or eval event."
154 (nth 2 event)) 154 (nth 2 event))
155 155
156(defun event-point (event) 156(defun event-point (event)
157 "Returns the character position of the given mouse-related event. 157 "Return the character position of the given mouse-related event.
158If the event did not occur over a window, or did 158If the event did not occur over a window, or did
159not occur over text, then this returns nil. Otherwise, it returns an index 159not occur over text, then this returns nil. Otherwise, it returns an index
160into the buffer visible in the event's window." 160into the buffer visible in the event's window."
@@ -201,18 +201,18 @@ or for window WINDOW if that is specified."
201 (window-start start-window))))) 201 (window-start start-window)))))
202 202
203(defun event-process (event) 203(defun event-process (event)
204 "Returns the process of the given process-output event." 204 "Return the process of the given process-output event."
205 (nth 1 event)) 205 (nth 1 event))
206 206
207(defun event-timestamp (event) 207(defun event-timestamp (event)
208 "Returns the timestamp of the given event object. 208 "Return the timestamp of the given event object.
209In Lucid Emacs, this works for any kind of event. 209In Lucid Emacs, this works for any kind of event.
210In this emulation, it returns nil for non-mouse-related events." 210In this emulation, it returns nil for non-mouse-related events."
211 (and (listp event) 211 (and (listp event)
212 (posn-timestamp (event-end event)))) 212 (posn-timestamp (event-end event))))
213 213
214(defun event-to-character (event &optional lenient) 214(defun event-to-character (event &optional lenient)
215 "Returns the closest ASCII approximation to the given event object. 215 "Return the closest ASCII approximation to the given event object.
216If the event isn't a keypress, this returns nil. 216If the event isn't a keypress, this returns nil.
217If the second argument is non-nil, then this is lenient in its 217If the second argument is non-nil, then this is lenient in its
218translation; it will ignore modifier keys other than control and meta, 218translation; 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."
229 event nil))) 229 event nil)))
230 230
231(defun event-window (event) 231(defun event-window (event)
232 "Returns the window of the given mouse-related event object." 232 "Return the window of the given mouse-related event object."
233 (posn-window (event-end event))) 233 (posn-window (event-end event)))
234 234
235(defun event-x (event) 235(defun event-x (event)
236 "Returns the X position in characters of the given mouse-related event." 236 "Return the X position in characters of the given mouse-related event."
237 (/ (car (posn-col-row (event-end event))) 237 (/ (car (posn-col-row (event-end event)))
238 (frame-char-width (window-frame (event-window event))))) 238 (frame-char-width (window-frame (event-window event)))))
239 239
240(defun event-x-pixel (event) 240(defun event-x-pixel (event)
241 "Returns the X position in pixels of the given mouse-related event." 241 "Return the X position in pixels of the given mouse-related event."
242 (car (posn-col-row (event-end event)))) 242 (car (posn-col-row (event-end event))))
243 243
244(defun event-y (event) 244(defun event-y (event)
245 "Returns the Y position in characters of the given mouse-related event." 245 "Return the Y position in characters of the given mouse-related event."
246 (/ (cdr (posn-col-row (event-end event))) 246 (/ (cdr (posn-col-row (event-end event)))
247 (frame-char-height (window-frame (event-window event))))) 247 (frame-char-height (window-frame (event-window event)))))
248 248
249(defun event-y-pixel (event) 249(defun event-y-pixel (event)
250 "Returns the Y position in pixels of the given mouse-related event." 250 "Return the Y position in pixels of the given mouse-related event."
251 (cdr (posn-col-row (event-end event)))) 251 (cdr (posn-col-row (event-end event))))
252 252
253(defun key-press-event-p (obj) 253(defun key-press-event-p (obj)
diff --git a/lisp/textmodes/reftex-vars.el b/lisp/textmodes/reftex-vars.el
index 4ec46183776..ce0ac32492d 100644
--- a/lisp/textmodes/reftex-vars.el
+++ b/lisp/textmodes/reftex-vars.el
@@ -100,22 +100,22 @@
100 100
101 ("enumerate" ?i "item:" "~\\ref{%s}" item 101 ("enumerate" ?i "item:" "~\\ref{%s}" item
102 (regexp "items?" "Punkte?")) 102 (regexp "items?" "Punkte?"))
103 103
104 ("equation" ?e "eq:" "~(\\ref{%s})" t 104 ("equation" ?e "eq:" "~(\\ref{%s})" t
105 (regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?" "Gl\\.")) 105 (regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?" "Gl\\."))
106 ("eqnarray" ?e "eq:" nil eqnarray-like) 106 ("eqnarray" ?e "eq:" nil eqnarray-like)
107 107
108 ("figure" ?f "fig:" "~\\ref{%s}" caption 108 ("figure" ?f "fig:" "~\\ref{%s}" caption
109 (regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\.")) 109 (regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\."))
110 ("figure*" ?f nil nil caption) 110 ("figure*" ?f nil nil caption)
111 111
112 ("table" ?t "tab:" "~\\ref{%s}" caption 112 ("table" ?t "tab:" "~\\ref{%s}" caption
113 (regexp "tables?" "tab\\." "Tabellen?")) 113 (regexp "tables?" "tab\\." "Tabellen?"))
114 ("table*" ?t nil nil caption) 114 ("table*" ?t nil nil caption)
115 115
116 ("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2 116 ("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2
117 (regexp "footnotes?" "Fussnoten?")) 117 (regexp "footnotes?" "Fussnoten?"))
118 118
119 ("any" ?\ " " "~\\ref{%s}" nil) 119 ("any" ?\ " " "~\\ref{%s}" nil)
120 120
121 ;; The label macro is hard coded, but it *could* be defined like this: 121 ;; 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:
207`?t' should point to a textual citation (citation as a noun). 207`?t' should point to a textual citation (citation as a noun).
208`?p' should point to a parenthetical citation.") 208`?p' should point to a parenthetical citation.")
209 209
210(defconst reftex-index-macros-builtin 210(defconst reftex-index-macros-builtin
211 '((default "Default \\index and \\glossary macros" 211 '((default "Default \\index and \\glossary macros"
212 (("\\index{*}" "idx" ?i "" nil t) 212 (("\\index{*}" "idx" ?i "" nil t)
213 ("\\glossary{*}" "glo" ?g "" nil t))) 213 ("\\glossary{*}" "glo" ?g "" nil t)))
@@ -219,9 +219,9 @@ The following conventions are valid for all alist entries:
219 (Index-Shortcut "index.sty with \\shortindexingon" 219 (Index-Shortcut "index.sty with \\shortindexingon"
220 (("\\index[]{*}" 1 ?i "" nil t) 220 (("\\index[]{*}" 1 ?i "" nil t)
221 ("\\index*[]{*}" 1 ?I "" nil nil) 221 ("\\index*[]{*}" 1 ?I "" nil nil)
222 ("^[]{*}" 1 ?^ "" texmathp t) 222 ("^[]{*}" 1 ?^ "" texmathp t)
223 ("_[]{*}" 1 ?_ "" texmathp nil)))) 223 ("_[]{*}" 1 ?_ "" texmathp nil))))
224 "Builtin stuff for reftex-index-macros. 224 "Builtin stuff for `reftex-index-macros'.
225Lower-case symbols correspond to a style file of the same name in the LaTeX 225Lower-case symbols correspond to a style file of the same name in the LaTeX
226distribution. Mixed-case symbols are convenience aliases.") 226distribution. Mixed-case symbols are convenience aliases.")
227) 227)
@@ -231,7 +231,7 @@ distribution. Mixed-case symbols are convenience aliases.")
231(defgroup reftex nil 231(defgroup reftex nil
232 "LaTeX label and citation support." 232 "LaTeX label and citation support."
233 :tag "RefTeX" 233 :tag "RefTeX"
234 :link '(url-link :tag "Home Page" 234 :link '(url-link :tag "Home Page"
235 "http://staff.science.uva.nl/~dominik/Tools/reftex/") 235 "http://staff.science.uva.nl/~dominik/Tools/reftex/")
236 :link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el") 236 :link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el")
237 :link '(custom-manual "(reftex)Top") 237 :link '(custom-manual "(reftex)Top")
@@ -280,7 +280,7 @@ the backslash). The cdr is a number indicating its level. A negative
280level means the same level as the positive value, but the section will 280level means the same level as the positive value, but the section will
281never get a number. The cdr may also be a function which will be called 281never get a number. The cdr may also be a function which will be called
282to after the section-re matched to determine the level. 282to after the section-re matched to determine the level.
283This list is also used for promotion and demption of sectioning commands. 283This list is also used for promotion and demotion of sectioning commands.
284If you are using a document class which has several sets of sectioning 284If you are using a document class which has several sets of sectioning
285commands, promotion only works correctly if this list is sorted first 285commands, promotion only works correctly if this list is sorted first
286by set, then within each set by level. The promotion commands always 286by 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
318more than `reftex-idle-time' seconds. 318more than `reftex-idle-time' seconds.
319 319
320Value t means, turn on immediately when RefTeX gets started. Then, 320Value t means, turn on immediately when RefTeX gets started. Then,
321recentering will work for any toc window created during the session. 321recentering will work for any TOC window created during the session.
322 322
323Value 'frame (the default) means, turn automatic recentering on only while the 323Value 'frame (the default) means, turn automatic recentering on only while the
324dedicated TOC frame does exist, and do the recentering only in that frame. So 324dedicated 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
326automatic recentering is turned on. When the frame gets destroyed, automatic 326automatic recentering is turned on. When the frame gets destroyed, automatic
327recentering is turned off again. 327recentering is turned off again.
328 328
329This feature can be turned on and off from the menu 329This feature can be turned on and off from the menu
330\(Ref->Options)." 330\(Ref->Options)."
331 :group 'reftex-table-of-contents-browser 331 :group 'reftex-table-of-contents-browser
332 :type '(choice 332 :type '(choice
333 (const :tag "never" nil) 333 (const :tag "never" nil)
334 (const :tag "always" t) 334 (const :tag "always" t)
335 (const :tag "in dedicated frame only" frame))) 335 (const :tag "in dedicated frame only" frame)))
336 336
337(defcustom reftex-toc-split-windows-horizontally nil 337(defcustom reftex-toc-split-windows-horizontally nil
338 "*Non-nil means, create TOC window by splitting window horizontally." 338 "*Non-nil means, create TOC window by splitting window horizontally."
339 :group 'reftex-table-of-contents-browser 339 :group 'reftex-table-of-contents-browser
@@ -407,7 +407,7 @@ When nil, follow-mode will be suspended for stuff in unvisited files."
407 :type 'boolean) 407 :type 'boolean)
408 408
409(defcustom reftex-toc-mode-hook nil 409(defcustom reftex-toc-mode-hook nil
410 "Mode hook for reftex-toc-mode." 410 "Mode hook for `reftex-toc-mode'."
411 :group 'reftex-table-of-contents-browser 411 :group 'reftex-table-of-contents-browser
412 :type 'hook) 412 :type 'hook)
413 413
@@ -425,7 +425,7 @@ When nil, follow-mode will be suspended for stuff in unvisited files."
425 '(amsmath endnotes fancybox floatfig longtable picinpar 425 '(amsmath endnotes fancybox floatfig longtable picinpar
426 rotating sidecap subfigure supertab wrapfig LaTeX) 426 rotating sidecap subfigure supertab wrapfig LaTeX)
427 "Default label alist specifications. LaTeX should always be the last entry. 427 "Default label alist specifications. LaTeX should always be the last entry.
428The value of this variable is a list of symbols with associations in the 428The value of this variable is a list of symbols with associations in the
429constant `reftex-label-alist-builtin'. Check that constant for a full list 429constant `reftex-label-alist-builtin'. Check that constant for a full list
430of options." 430of options."
431 :group 'reftex-defining-label-environments 431 :group 'reftex-defining-label-environments
@@ -624,7 +624,7 @@ list. However, builtin defaults should normally be set with the variable
624(defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:")) 624(defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:"))
625 "Prefixes for section labels. 625 "Prefixes for section labels.
626When the label prefix given in an entry in `reftex-label-alist' contains `%S', 626When the label prefix given in an entry in `reftex-label-alist' contains `%S',
627this list is used to determine the correct prefix string depending on the 627this list is used to determine the correct prefix string depending on the
628current section level. 628current section level.
629The list is an alist, with each entry of the form (KEY . PREFIX) 629The list is an alist, with each entry of the form (KEY . PREFIX)
630Possible keys are sectioning macro names like `chapter', section levels 630Possible keys are sectioning macro names like `chapter', section levels
@@ -686,7 +686,7 @@ non-footnote labels."
686 (regexp) 686 (regexp)
687 (repeat :tag "List" 687 (repeat :tag "List"
688 (string :tag "prefix (with colon)")))) 688 (string :tag "prefix (with colon)"))))
689 689
690(defcustom reftex-special-environment-functions nil 690(defcustom reftex-special-environment-functions nil
691 "List of functions to be called when trying to figure out current environment. 691 "List of functions to be called when trying to figure out current environment.
692These are special functions to detect \"environments\" which do not 692These are special functions to detect \"environments\" which do not
@@ -732,7 +732,7 @@ And here is the setup for RefTeX:
732 (let ((pos (point)) p1) 732 (let ((pos (point)) p1)
733 (save-excursion 733 (save-excursion
734 ;; Search for any of the linguex item macros at the beginning of a line 734 ;; Search for any of the linguex item macros at the beginning of a line
735 (if (re-search-backward 735 (if (re-search-backward
736 \"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t) 736 \"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t)
737 (progn 737 (progn
738 (setq p1 (match-beginning 1)) 738 (setq p1 (match-beginning 1))
@@ -742,7 +742,7 @@ And here is the setup for RefTeX:
742 nil 742 nil
743 ;; OK, we got it 743 ;; OK, we got it
744 (cons \"linguex\" p1))) 744 (cons \"linguex\" p1)))
745 ;; Return nil for not found 745 ;; Return nil for not found
746 nil)))) 746 nil))))
747 747
7483. Tell RefTeX to use this function 7483. Tell RefTeX to use this function
@@ -941,7 +941,7 @@ This is used to string together whole reference sets, like
941 941
942(defcustom reftex-vref-is-default nil 942(defcustom reftex-vref-is-default nil
943 "*Non-nil means, the varioref macro \\vref is used as default. 943 "*Non-nil means, the varioref macro \\vref is used as default.
944In the selection buffer, the `v' key toggles the reference macro between 944In the selection buffer, the `v' key toggles the reference macro between
945`\\ref' and `\\vref'. The value of this variable determines the default 945`\\ref' and `\\vref'. The value of this variable determines the default
946which is active when entering the selection process. 946which is active when entering the selection process.
947Instead of nil or t, this may also be a string of type letters indicating 947Instead 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."
952 952
953(defcustom reftex-fref-is-default nil 953(defcustom reftex-fref-is-default nil
954 "*Non-nil means, the fancyref macro \\fref is used as default. 954 "*Non-nil means, the fancyref macro \\fref is used as default.
955In the selection buffer, the `V' key toggles the reference macro between 955In the selection buffer, the `V' key toggles the reference macro between
956`\\ref', `\\fref' and `\\Fref'. The value of this variable determines 956`\\ref', `\\fref' and `\\Fref'. The value of this variable determines
957the default which is active when entering the selection process. 957the default which is active when entering the selection process.
958Instead of nil or t, this may also be a string of type letters indicating 958Instead 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."
979 979
980(defcustom reftex-format-ref-function nil 980(defcustom reftex-format-ref-function nil
981 "Function which produces the string to insert as a reference. 981 "Function which produces the string to insert as a reference.
982Normally should be nil, because the format to insert a reference can 982Normally should be nil, because the format to insert a reference can
983already be specified in `reftex-label-alist'. 983already be specified in `reftex-label-alist'.
984This hook also is used by the special commands to insert `\\vref' and `\\fref' 984This hook also is used by the special commands to insert `\\vref' and `\\fref'
985references, so even if you set this, your setting will be ignored by 985references, 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:
1060%i institution %j journal %k key %m month 1060%i institution %j journal %k key %m month
1061%n number %o organization %p pages %P first page 1061%n number %o organization %p pages %P first page
1062%r address %s school %u publisher %t title 1062%r address %s school %u publisher %t title
1063%v volume %y year 1063%v volume %y year
1064%B booktitle, abbreviated %T title, abbreviated 1064%B booktitle, abbreviated %T title, abbreviated
1065 1065
1066Usually, only %l is needed. The other stuff is mainly for the echo area 1066Usually, only %l is needed. The other stuff is mainly for the echo area
1067display, and for (setq reftex-comment-citations t). 1067display, and for (setq reftex-comment-citations t).
1068 1068
1069%< as a special operator kills punctuation and space around it after the 1069%< as a special operator kills punctuation and space around it after the
1070string has been formatted. 1070string has been formatted.
1071 1071
1072A pair of square brackets indicates an optional argument, and RefTeX 1072A 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
1081strings. 1081strings.
1082 In order to configure this variable, you can either set 1082 In order to configure this variable, you can either set
1083`reftex-cite-format' directly yourself or set it to the SYMBOL of one of 1083`reftex-cite-format' directly yourself or set it to the SYMBOL of one of
1084the predefined styles. The predefined symbols are those which have an 1084the predefined styles. The predefined symbols are those which have an
1085association in the constant `reftex-cite-format-builtin'. 1085association in the constant `reftex-cite-format-builtin'.
1086E.g.: (setq reftex-cite-format 'natbib)" 1086E.g.: (setq reftex-cite-format 'natbib)"
1087 :group 'reftex-citation-support 1087 :group 'reftex-citation-support
@@ -1164,8 +1164,8 @@ possible percent escapes."
1164(defcustom reftex-cite-punctuation '(", " " \\& " " {\\it et al.}") 1164(defcustom reftex-cite-punctuation '(", " " \\& " " {\\it et al.}")
1165 "Punctuation for formatting of name lists in citations. 1165 "Punctuation for formatting of name lists in citations.
1166This is a list of 3 strings. 1166This is a list of 3 strings.
11671. normal names separator, like \", \" in Jones, Brown and Miller 11671. Normal names separator, like \", \" in Jones, Brown and Miller
11682. final names separator, like \" and \" in Jones, Brown and Miller 11682. Final names separator, like \" and \" in Jones, Brown and Miller
11693. The \"et al\" string, like \" {\\it et al.}\" in Jones {\\it et al.}" 11693. The \"et al\" string, like \" {\\it et al.}\" in Jones {\\it et al.}"
1170 :group 'reftex-citation-support 1170 :group 'reftex-citation-support
1171 :type '(list 1171 :type '(list
@@ -1175,7 +1175,7 @@ This is a list of 3 strings.
1175 1175
1176(defcustom reftex-format-cite-function nil 1176(defcustom reftex-format-cite-function nil
1177 "Function which produces the string to insert as a citation. 1177 "Function which produces the string to insert as a citation.
1178Normally should be nil, because the format to insert a reference can 1178Normally should be nil, because the format to insert a reference can
1179already be specified in `reftex-cite-format'. 1179already be specified in `reftex-cite-format'.
1180The function will be called with two arguments, the CITATION KEY and the 1180The function will be called with two arguments, the CITATION KEY and the
1181DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function 1181DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function
@@ -1258,7 +1258,7 @@ package here."
1258 :group 'reftex-index-support 1258 :group 'reftex-index-support
1259 :set 'reftex-set-dirty 1259 :set 'reftex-set-dirty
1260 :type `(list 1260 :type `(list
1261 (repeat 1261 (repeat
1262 :inline t 1262 :inline t
1263 (list :value ("" "idx" ?a "" nil) 1263 (list :value ("" "idx" ?a "" nil)
1264 (string :tag "Macro with args") 1264 (string :tag "Macro with args")
@@ -1285,7 +1285,7 @@ package here."
1285This is a list with (MACRO-KEY DEFAULT-TAG). 1285This is a list with (MACRO-KEY DEFAULT-TAG).
1286 1286
1287MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'. 1287MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'.
1288DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument. 1288DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument.
1289 When this is nil and a TAG is needed, RefTeX will ask for it. 1289 When this is nil and a TAG is needed, RefTeX will ask for it.
1290 When this is the empty string and the TAG argument of the index 1290 When this is the empty string and the TAG argument of the index
1291 macro is optional, the TAG argument will be omitted." 1291 macro is optional, the TAG argument will be omitted."
@@ -1426,7 +1426,7 @@ to that section."
1426 1426
1427(defcustom reftex-index-include-context nil 1427(defcustom reftex-index-include-context nil
1428 "*Non-nil means, display the index definition context in the index buffer. 1428 "*Non-nil means, display the index definition context in the index buffer.
1429This flag may also be toggled from the index buffer with the `c' key." 1429This flag may also be toggled from the index buffer with the `c' key."
1430 :group 'reftex-index-support 1430 :group 'reftex-index-support
1431 :type 'boolean) 1431 :type 'boolean)
1432 1432
@@ -1449,7 +1449,7 @@ This is used when `reftex-view-crossref' is called with point in an
1449argument of a macro. Note that crossref viewing for citations, 1449argument of a macro. Note that crossref viewing for citations,
1450references (both ways) and index entries is hard-coded. This variable 1450references (both ways) and index entries is hard-coded. This variable
1451is only to configure additional structures for which crossreference 1451is only to configure additional structures for which crossreference
1452viewing can be useful. Each entry has the structure 1452viewing can be useful. Each entry has the structure
1453 1453
1454\(MACRO-RE SEARCH-RE HIGHLIGHT). 1454\(MACRO-RE SEARCH-RE HIGHLIGHT).
1455 1455
@@ -1470,7 +1470,7 @@ argument of a \\ref or \\cite macro, and no other message is being
1470displayed, the echo area will display information about that cross 1470displayed, the echo area will display information about that cross
1471reference. You can also set the variable to the symbol `window'. In 1471reference. You can also set the variable to the symbol `window'. In
1472this case a small temporary window is used for the display. 1472this case a small temporary window is used for the display.
1473This feature can be turned on and off from the menu 1473This feature can be turned on and off from the menu
1474\(Ref->Options)." 1474\(Ref->Options)."
1475 :group 'reftex-viewing-cross-references 1475 :group 'reftex-viewing-cross-references
1476 :type '(choice (const :tag "off" nil) 1476 :type '(choice (const :tag "off" nil)
@@ -1516,7 +1516,7 @@ Several entries are possible.
1516- If an element is the name of an environment variable, its content is used. 1516- If an element is the name of an environment variable, its content is used.
1517- If an element starts with an exclamation mark, it is used as a command 1517- If an element starts with an exclamation mark, it is used as a command
1518 to retrieve the path. A typical command with the kpathsearch library would 1518 to retrieve the path. A typical command with the kpathsearch library would
1519 be `!kpsewhich -show-path=.tex'. 1519 be `!kpsewhich -show-path=.tex'.
1520- Otherwise the element itself is interpreted as a path. 1520- Otherwise the element itself is interpreted as a path.
1521Multiple directories can be separated by the system dependent `path-separator'. 1521Multiple directories can be separated by the system dependent `path-separator'.
1522Directories ending in `//' or `!!' will be expanded recursively. 1522Directories ending in `//' or `!!' will be expanded recursively.
@@ -1531,7 +1531,7 @@ Several entries are possible.
1531- If an element is the name of an environment variable, its content is used. 1531- If an element is the name of an environment variable, its content is used.
1532- If an element starts with an exclamation mark, it is used as a command 1532- If an element starts with an exclamation mark, it is used as a command
1533 to retrieve the path. A typical command with the kpathsearch library would 1533 to retrieve the path. A typical command with the kpathsearch library would
1534 be `!kpsewhich -show-path=.bib'. 1534 be `!kpsewhich -show-path=.bib'.
1535- Otherwise the element itself is interpreted as a path. 1535- Otherwise the element itself is interpreted as a path.
1536Multiple directories can be separated by the system dependent `path-separator'. 1536Multiple directories can be separated by the system dependent `path-separator'.
1537Directories ending in `//' or `!!' will be expanded recursively. 1537Directories 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."
1575 "*Non-nil means, search all specified directories before trying recursion. 1575 "*Non-nil means, search all specified directories before trying recursion.
1576Thus, in a path \".//:/tex/\", search first \"./\", then \"/tex/\" and then 1576Thus, in a path \".//:/tex/\", search first \"./\", then \"/tex/\" and then
1577all subdirectories of \"./\". If this option is nil, the subdirectories of 1577all subdirectories of \"./\". If this option is nil, the subdirectories of
1578\"./\" are searched before \"/tex/\". This is mainly for speed - most of the 1578\"./\" are searched before \"/tex/\". This is mainly for speed - most of the
1579time the recursive path is for the system files and not for the user files. 1579time the recursive path is for the system files and not for the user files.
1580Set this to nil if the default makes RefTeX finding files with equal names 1580Set this to nil if the default makes RefTeX finding files with equal names
1581in wrong sequence." 1581in wrong sequence."
@@ -1588,7 +1588,7 @@ Normally, RefTeX searches the paths given in the environment variables
1588TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files. 1588TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files.
1589With this option turned on, it calls an external program specified in the 1589With this option turned on, it calls an external program specified in the
1590option `reftex-external-file-finders' instead. As a side effect, 1590option `reftex-external-file-finders' instead. As a side effect,
1591the variables `reftex-texpath-environment-variables' and 1591the variables `reftex-texpath-environment-variables' and
1592`reftex-bibpath-environment-variables' will be ignored." 1592`reftex-bibpath-environment-variables' will be ignored."
1593 :group 'reftex-finding-files 1593 :group 'reftex-finding-files
1594 :type 'boolean) 1594 :type 'boolean)
@@ -1679,7 +1679,7 @@ list."
1679(defcustom reftex-save-parse-info nil 1679(defcustom reftex-save-parse-info nil
1680 "*Non-nil means, save information gathered with parsing in a file. 1680 "*Non-nil means, save information gathered with parsing in a file.
1681The file MASTER.rel in the same directory as MASTER.tex is used to save the 1681The file MASTER.rel in the same directory as MASTER.tex is used to save the
1682information. When this variable is t, 1682information. When this variable is t,
1683- accessing the parsing information for the first time in an editing session 1683- accessing the parsing information for the first time in an editing session
1684 will read that file (if available) instead of parsing the document. 1684 will read that file (if available) instead of parsing the document.
1685- exiting Emacs or killing a buffer in reftex-mode will cause a new version 1685- 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
1753highlighted. This is the entry most keys in the selction and *toc* 1753highlighted. This is the entry most keys in the selction and *toc*
1754buffers act on. However, if you mainly use the mouse to select an 1754buffers act on. However, if you mainly use the mouse to select an
1755item, you may find it nice to have mouse-triggered highlighting 1755item, you may find it nice to have mouse-triggered highlighting
1756instead or as well. The variable may have one of these values: 1756instead or as well. The variable may have one of these values:
1757 1757
1758 nil No highlighting. 1758 nil No highlighting.
1759 cursor Highlighting is cursor driven. 1759 cursor Highlighting is cursor driven.
@@ -1882,7 +1882,7 @@ RefTeX uses `fset' to take over the function calls. Changing the variable
1882may require a restart of Emacs in order to become effective." 1882may require a restart of Emacs in order to become effective."
1883 :group 'reftex-miscellaneous-configurations 1883 :group 'reftex-miscellaneous-configurations
1884 :group 'LaTeX 1884 :group 'LaTeX
1885 :type '(choice 1885 :type '(choice
1886 (const :tag "No plug-ins" nil) 1886 (const :tag "No plug-ins" nil)
1887 (const :tag "All possible plug-ins" t) 1887 (const :tag "All possible plug-ins" t)
1888 (list 1888 (list