Mercurial > emacs
comparison man/reftex.texi @ 49600:23a1cea22d13
Trailing whitespace deleted.
author | Juanma Barranquero <lekktu@gmail.com> |
---|---|
date | Tue, 04 Feb 2003 14:56:31 +0000 |
parents | 0a70200bde27 |
children | 695cf19ef79e d7ddb3e565de |
comparison
equal
deleted
inserted
replaced
49599:5ade352e8d1c | 49600:23a1cea22d13 |
---|---|
114 | 114 |
115 Introduction | 115 Introduction |
116 | 116 |
117 * Installation:: How to install and activate RefTeX. | 117 * Installation:: How to install and activate RefTeX. |
118 * RefTeX in a Nutshell:: A brief summary and quick guide. | 118 * RefTeX in a Nutshell:: A brief summary and quick guide. |
119 | 119 |
120 Labels and References | 120 Labels and References |
121 | 121 |
122 * Creating Labels:: | 122 * Creating Labels:: |
123 * Referencing Labels:: | 123 * Referencing Labels:: |
124 * Builtin Label Environments:: The environments RefTeX knows about. | 124 * Builtin Label Environments:: The environments RefTeX knows about. |
285 additional labeled environments you have defined yourself (variable | 285 additional labeled environments you have defined yourself (variable |
286 @code{reftex-label-alist}).@refill | 286 @code{reftex-label-alist}).@refill |
287 | 287 |
288 @itemize @bullet | 288 @itemize @bullet |
289 @item | 289 @item |
290 @b{Creating Labels}@* | 290 @b{Creating Labels}@* |
291 Type @kbd{C-c (} (@code{reftex-label}) to insert a label at point. | 291 Type @kbd{C-c (} (@code{reftex-label}) to insert a label at point. |
292 @b{Ref@TeX{}} will either | 292 @b{Ref@TeX{}} will either |
293 @itemize @minus | 293 @itemize @minus |
294 @item | 294 @item |
295 derive a label from context (default for section labels) | 295 derive a label from context (default for section labels) |
296 @item | 296 @item |
297 prompt for a label string (default for figures and tables) or | 297 prompt for a label string (default for figures and tables) or |
298 @item | 298 @item |
299 insert a simple label made of a prefix and a number (all other | 299 insert a simple label made of a prefix and a number (all other |
300 environments)@refill | 300 environments)@refill |
301 @end itemize | 301 @end itemize |
302 @noindent | 302 @noindent |
303 Which labels are created how is configurable with the variable | 303 Which labels are created how is configurable with the variable |
413 until you have picked up the key bindings. For an overview of what you | 413 until you have picked up the key bindings. For an overview of what you |
414 can do in each of the different special buffers, press @kbd{?}. Read | 414 can do in each of the different special buffers, press @kbd{?}. Read |
415 the manual if you get stuck, of if you are curious what else might be | 415 the manual if you get stuck, of if you are curious what else might be |
416 available. The first part of the manual explains in | 416 available. The first part of the manual explains in |
417 a tutorial way how to use and customize @b{Ref@TeX{}}. The second | 417 a tutorial way how to use and customize @b{Ref@TeX{}}. The second |
418 part is a command and variable reference.@refill | 418 part is a command and variable reference.@refill |
419 @end enumerate | 419 @end enumerate |
420 | 420 |
421 @node Table of Contents, Labels and References, Introduction, Top | 421 @node Table of Contents, Labels and References, Introduction, Top |
422 @chapter Table of Contents | 422 @chapter Table of Contents |
423 @cindex @file{*toc*} buffer | 423 @cindex @file{*toc*} buffer |
512 Kill the @file{*toc*} buffer, return to the position where | 512 Kill the @file{*toc*} buffer, return to the position where |
513 @code{reftex-toc} was last called.@refill | 513 @code{reftex-toc} was last called.@refill |
514 | 514 |
515 @item C-c > | 515 @item C-c > |
516 Switch to the @file{*Index*} buffer of this document. With prefix | 516 Switch to the @file{*Index*} buffer of this document. With prefix |
517 @samp{2}, restrict the index to the section at point in the @file{*toc*} | 517 @samp{2}, restrict the index to the section at point in the @file{*toc*} |
518 buffer. | 518 buffer. |
519 | 519 |
520 @tablesubheading{Controlling what gets displayed} | 520 @tablesubheading{Controlling what gets displayed} |
521 | 521 |
522 @item t | 522 @item t |
548 @vindex reftex-toc-include-index-entries | 548 @vindex reftex-toc-include-index-entries |
549 Toggle the display of index entries in the @file{*toc*} buffer. The | 549 Toggle the display of index entries in the @file{*toc*} buffer. The |
550 default for this flag can be set with the variable | 550 default for this flag can be set with the variable |
551 @code{reftex-toc-include-index-entries}. When called with a prefix | 551 @code{reftex-toc-include-index-entries}. When called with a prefix |
552 argument, @b{Ref@TeX{}} will prompt for a specific index and include | 552 argument, @b{Ref@TeX{}} will prompt for a specific index and include |
553 only entries in the selected index in the @file{*toc*} buffer. The mode | 553 only entries in the selected index in the @file{*toc*} buffer. The mode |
554 line @samp{I<>} indicator shows which index is used.@refill | 554 line @samp{I<>} indicator shows which index is used.@refill |
555 | 555 |
556 @item c | 556 @item c |
557 @vindex reftex-toc-include-context | 557 @vindex reftex-toc-include-context |
558 Toggle the display of label and index context in the @file{*toc*} | 558 Toggle the display of label and index context in the @file{*toc*} |
797 | 797 |
798 @item C-c C-p | 798 @item C-c C-p |
799 Goto previous section heading. | 799 Goto previous section heading. |
800 | 800 |
801 @item N z | 801 @item N z |
802 Jump to section N, using the prefix arg. For example @kbd{3 z} jumps to | 802 Jump to section N, using the prefix arg. For example @kbd{3 z} jumps to |
803 section 3.@refill | 803 section 3.@refill |
804 | 804 |
805 @tablesubheading{Displaying Context} | 805 @tablesubheading{Displaying Context} |
806 @item @key{SPC} | 806 @item @key{SPC} |
807 Show the surroundings of the definition of the current label in another | 807 Show the surroundings of the definition of the current label in another |
891 Exit the selection process without inserting any reference into the | 891 Exit the selection process without inserting any reference into the |
892 buffer.@refill | 892 buffer.@refill |
893 | 893 |
894 @tablesubheading{Controlling what gets displayed} | 894 @tablesubheading{Controlling what gets displayed} |
895 @vindex reftex-label-menu-flags | 895 @vindex reftex-label-menu-flags |
896 The defaults for the following flags can be configured with the variable | 896 The defaults for the following flags can be configured with the variable |
897 @code{reftex-label-menu-flags} (@pxref{Options (Referencing Labels)}). | 897 @code{reftex-label-menu-flags} (@pxref{Options (Referencing Labels)}). |
898 | 898 |
899 @item c | 899 @item c |
900 Toggle the display of the one-line label definition context in the | 900 Toggle the display of the one-line label definition context in the |
901 selection buffer.@refill | 901 selection buffer.@refill |
904 Toggle the display of the file borders of a multifile document in the | 904 Toggle the display of the file borders of a multifile document in the |
905 selection buffer.@refill | 905 selection buffer.@refill |
906 | 906 |
907 @item t | 907 @item t |
908 Toggle the display of the table of contents in the selection buffer. | 908 Toggle the display of the table of contents in the selection buffer. |
909 With prefix @var{arg}, change the maximum level of toc entries displayed | 909 With prefix @var{arg}, change the maximum level of toc entries displayed |
910 to @var{arg}. Chapters are level 1, section are level 2.@refill | 910 to @var{arg}. Chapters are level 1, section are level 2.@refill |
911 | 911 |
912 @item # | 912 @item # |
913 Toggle the display of a label counter in the selection buffer.@refill | 913 Toggle the display of a label counter in the selection buffer.@refill |
914 | 914 |
1318 Again, here the configuration in the customization buffer: | 1318 Again, here the configuration in the customization buffer: |
1319 | 1319 |
1320 @example | 1320 @example |
1321 [INS] [DEL] Package or Detailed : [Value Menu] Detailed: | 1321 [INS] [DEL] Package or Detailed : [Value Menu] Detailed: |
1322 Environment or \macro : [Value Menu] String: \myfig[]@{@}@{@}@{*@}@{@} | 1322 Environment or \macro : [Value Menu] String: \myfig[]@{@}@{@}@{*@}@{@} |
1323 Type specification : [Value Menu] Char : f | 1323 Type specification : [Value Menu] Char : f |
1324 Label prefix string : [Value Menu] Default | 1324 Label prefix string : [Value Menu] Default |
1325 Label reference format: [Value Menu] Default | 1325 Label reference format: [Value Menu] Default |
1326 Context method : [Value Menu] Macro arg nr: 3 | 1326 Context method : [Value Menu] Macro arg nr: 3 |
1327 Magic words: | 1327 Magic words: |
1328 [INS] | 1328 [INS] |
1415 ;; Setup entry in reftex-label-alist, using all defaults for equations | 1415 ;; Setup entry in reftex-label-alist, using all defaults for equations |
1416 (setq reftex-label-alist '((detect-be-ee ?e nil nil nil nil))) | 1416 (setq reftex-label-alist '((detect-be-ee ?e nil nil nil nil))) |
1417 | 1417 |
1418 (defun detect-be-ee (bound) | 1418 (defun detect-be-ee (bound) |
1419 ;; Search backward for the macros or an empty line | 1419 ;; Search backward for the macros or an empty line |
1420 (if (re-search-backward | 1420 (if (re-search-backward |
1421 "\\(^[ \t]*\n\\|\\\\ee\\>\\)\\|\\(\\\\be\\>\\)" bound t) | 1421 "\\(^[ \t]*\n\\|\\\\ee\\>\\)\\|\\(\\\\be\\>\\)" bound t) |
1422 (if (match-beginning 2) | 1422 (if (match-beginning 2) |
1423 (match-beginning 2) ; Return start of environment | 1423 (match-beginning 2) ; Return start of environment |
1424 nil) ; Return nil because env is closed | 1424 nil) ; Return nil because env is closed |
1425 nil)) ; Return nil for not found | 1425 nil)) ; Return nil for not found |
1454 '((detect-linguex ?x "ex:" "~\\ref@{%s@}" nil ("Example" "Ex.")))) | 1454 '((detect-linguex ?x "ex:" "~\\ref@{%s@}" nil ("Example" "Ex.")))) |
1455 | 1455 |
1456 (defun detect-linguex (bound) | 1456 (defun detect-linguex (bound) |
1457 (let ((cnt 0)) | 1457 (let ((cnt 0)) |
1458 (catch 'exit | 1458 (catch 'exit |
1459 (while | 1459 (while |
1460 ;; Search backward for all possible delimiters | 1460 ;; Search backward for all possible delimiters |
1461 (re-search-backward | 1461 (re-search-backward |
1462 (concat "\\(^[ \t]*\n\\)\\|\\(\\\\z\\.\\)\\|" | 1462 (concat "\\(^[ \t]*\n\\)\\|\\(\\\\z\\.\\)\\|" |
1463 "\\(\\ex[ig]?\\.\\)\\|\\(\\\\a\\.\\)") | 1463 "\\(\\ex[ig]?\\.\\)\\|\\(\\\\a\\.\\)") |
1464 nil t) | 1464 nil t) |
1465 ;; Check which delimiter was matched. | 1465 ;; Check which delimiter was matched. |
1466 (cond | 1466 (cond |
1467 ((match-beginning 1) | 1467 ((match-beginning 1) |
1468 ;; empty line terminates all - return nil | 1468 ;; empty line terminates all - return nil |
1469 (throw 'exit nil)) | 1469 (throw 'exit nil)) |
1470 ((match-beginning 2) | 1470 ((match-beginning 2) |
1471 ;; \z. terminates one list level - decrease nesting count | 1471 ;; \z. terminates one list level - decrease nesting count |
1782 [y] \citeyear@{%l@} | 1782 [y] \citeyear@{%l@} |
1783 @end example | 1783 @end example |
1784 | 1784 |
1785 Following the most generic of these packages, @code{natbib}, the builtin | 1785 Following the most generic of these packages, @code{natbib}, the builtin |
1786 citation packages always accept the @kbd{t} key for a @emph{textual} | 1786 citation packages always accept the @kbd{t} key for a @emph{textual} |
1787 citation (like: @code{Jones et al. (1997) have shown...}) as well as | 1787 citation (like: @code{Jones et al. (1997) have shown...}) as well as |
1788 the @kbd{p} key for a parenthetical citation (like: @code{As shown | 1788 the @kbd{p} key for a parenthetical citation (like: @code{As shown |
1789 earlier (Jones et al, 1997)}).@refill | 1789 earlier (Jones et al, 1997)}).@refill |
1790 | 1790 |
1791 To make one of these styles the default, customize the variable | 1791 To make one of these styles the default, customize the variable |
1792 @code{reftex-cite-format} or put into @file{.emacs}: | 1792 @code{reftex-cite-format} or put into @file{.emacs}: |
2013 @cindex Index phrases, collection | 2013 @cindex Index phrases, collection |
2014 @cindex Phrases, collecting | 2014 @cindex Phrases, collecting |
2015 | 2015 |
2016 Phrases for indexing can be collected while writing the document. The | 2016 Phrases for indexing can be collected while writing the document. The |
2017 command @kbd{C-c \} (@code{reftex-index-phrase-selection-or-word}) | 2017 command @kbd{C-c \} (@code{reftex-index-phrase-selection-or-word}) |
2018 copies the current selection (if active) or the word near point into the | 2018 copies the current selection (if active) or the word near point into the |
2019 phrases buffer. It then selects this buffer, so that the phrase line | 2019 phrases buffer. It then selects this buffer, so that the phrase line |
2020 can be edited. To return to the LaTeX document, press @kbd{C-c C-c} | 2020 can be edited. To return to the LaTeX document, press @kbd{C-c C-c} |
2021 (@code{reftex-index-phrases-save-and-return}). | 2021 (@code{reftex-index-phrases-save-and-return}). |
2022 | 2022 |
2023 You can also prepare the list of index phrases in a different way and | 2023 You can also prepare the list of index phrases in a different way and |
2024 copy it into the phrases file. For example you might want to start from | 2024 copy it into the phrases file. For example you might want to start from |
2025 a word list of the document and remove all words which should not be | 2025 a word list of the document and remove all words which should not be |
2026 indexed. | 2026 indexed. |
2027 | 2027 |
2028 The phrase lines in the phrase buffer must have a specific format. | 2028 The phrase lines in the phrase buffer must have a specific format. |
2029 @b{Ref@TeX{}} will use font-lock to indicate if a line has the proper | 2029 @b{Ref@TeX{}} will use font-lock to indicate if a line has the proper |
2030 format. A phrase line looks like this: | 2030 format. A phrase line looks like this: |
2031 | 2031 |
2032 @example | 2032 @example |
2033 [@var{key}] <TABs> @var{phrase} [<TABs> @var{arg}[&&@var{arg}]... [ || @var{arg}]...] | 2033 [@var{key}] <TABs> @var{phrase} [<TABs> @var{arg}[&&@var{arg}]... [ || @var{arg}]...] |
2034 @end example | 2034 @end example |
2035 | 2035 |
2036 @code{<TABs>} stands for white space containing at least one @key{TAB}. | 2036 @code{<TABs>} stands for white space containing at least one @key{TAB}. |
2037 @var{key} must be at the start of the line and is the character | 2037 @var{key} must be at the start of the line and is the character |
2038 identifying one of the macros defined in the file header. It is | 2038 identifying one of the macros defined in the file header. It is |
2122 may not last long enough to do everything in one go.@refill | 2122 may not last long enough to do everything in one go.@refill |
2123 | 2123 |
2124 @b{Ref@TeX{}} will start at the first phrase line and search the phrase | 2124 @b{Ref@TeX{}} will start at the first phrase line and search the phrase |
2125 globally in the whole document. At each match it will stop, compute the | 2125 globally in the whole document. At each match it will stop, compute the |
2126 replacement string and offer you the following choices@footnote{Windows | 2126 replacement string and offer you the following choices@footnote{Windows |
2127 users: Restrict yourself to the described keys during indexing. Pressing | 2127 users: Restrict yourself to the described keys during indexing. Pressing |
2128 @key{Help} at the indexing prompt can apparently hang Emacs.}:@refill | 2128 @key{Help} at the indexing prompt can apparently hang Emacs.}:@refill |
2129 | 2129 |
2130 @table @kbd | 2130 @table @kbd |
2131 @item y | 2131 @item y |
2132 Replace this match with the proposed string. | 2132 Replace this match with the proposed string. |
2236 Prefix argument. | 2236 Prefix argument. |
2237 | 2237 |
2238 @tablesubheading{Moving around} | 2238 @tablesubheading{Moving around} |
2239 @item ! A..Z | 2239 @item ! A..Z |
2240 Pressing any capital letter will jump to the corresponding section in | 2240 Pressing any capital letter will jump to the corresponding section in |
2241 the @file{*Index*} buffer. The exclamation mark is special and jumps to | 2241 the @file{*Index*} buffer. The exclamation mark is special and jumps to |
2242 the first entries alphabetically sorted below @samp{A}. These are | 2242 the first entries alphabetically sorted below @samp{A}. These are |
2243 usually non-alphanumeric characters.@refill | 2243 usually non-alphanumeric characters.@refill |
2244 @item n | 2244 @item n |
2245 Go to next entry.@refill | 2245 Go to next entry.@refill |
2246 @item p | 2246 @item p |
2247 Go to previous entry.@refill | 2247 Go to previous entry.@refill |
2248 | 2248 |
2249 @tablesubheading{Access to document locations} | 2249 @tablesubheading{Access to document locations} |
2250 @item @key{SPC} | 2250 @item @key{SPC} |
2251 Show the place in the document where this index entry is defined.@refill | 2251 Show the place in the document where this index entry is defined.@refill |
2252 | 2252 |
2253 @item @key{TAB} | 2253 @item @key{TAB} |
2254 Go to the definition of the current index entry in another | 2254 Go to the definition of the current index entry in another |
2255 window.@refill | 2255 window.@refill |
2256 | 2256 |
2297 appearance of the entry in the index. When called with @kbd{C-u} | 2297 appearance of the entry in the index. When called with @kbd{C-u} |
2298 prefix, kill the entire @var{visual} part.@refill | 2298 prefix, kill the entire @var{visual} part.@refill |
2299 | 2299 |
2300 @item ( | 2300 @item ( |
2301 Toggle the beginning of page range property @samp{|(} of the | 2301 Toggle the beginning of page range property @samp{|(} of the |
2302 entry.@refill | 2302 entry.@refill |
2303 | 2303 |
2304 @item ) | 2304 @item ) |
2305 Toggle the end of page range property @samp{|)} of the entry.@refill | 2305 Toggle the end of page range property @samp{|)} of the entry.@refill |
2306 | 2306 |
2307 @item _ | 2307 @item _ |
2308 Make the current entry a subentry. This command will prompt for the | 2308 Make the current entry a subentry. This command will prompt for the |
2309 superordinate entry and insert it.@refill | 2309 superordinate entry and insert it.@refill |
2310 | 2310 |
2311 @item ^ | 2311 @item ^ |
2312 Remove the highest superordinate entry. If the current entry is a | 2312 Remove the highest superordinate entry. If the current entry is a |
2313 subitem (@samp{aaa!bbb!ccc}), this function moves it up the hierarchy | 2313 subitem (@samp{aaa!bbb!ccc}), this function moves it up the hierarchy |
2314 (@samp{bbb!ccc}).@refill | 2314 (@samp{bbb!ccc}).@refill |
2315 | 2315 |
2316 @tablesubheading{Exiting} | 2316 @tablesubheading{Exiting} |
2317 @item q | 2317 @item q |
2318 Hide the @file{*Index*} buffer.@refill | 2318 Hide the @file{*Index*} buffer.@refill |
2319 | 2319 |
2362 Reparse the @emph{entire} LaTeX document and rebuild the @file{*Index*} | 2362 Reparse the @emph{entire} LaTeX document and rebuild the @file{*Index*} |
2363 buffer.@refill | 2363 buffer.@refill |
2364 | 2364 |
2365 @item s | 2365 @item s |
2366 Switch to a different index (for documents with multiple | 2366 Switch to a different index (for documents with multiple |
2367 indices).@refill | 2367 indices).@refill |
2368 @end table | 2368 @end table |
2369 | 2369 |
2370 | 2370 |
2371 @node Builtin Index Macros, Defining Index Macros, Displaying and Editing the Index, Index Support | 2371 @node Builtin Index Macros, Defining Index Macros, Displaying and Editing the Index, Index Support |
2372 @section Builtin Index Macros | 2372 @section Builtin Index Macros |
2425 The character arguments @code{?x}, @code{?n}, and @code{?o} are for | 2425 The character arguments @code{?x}, @code{?n}, and @code{?o} are for |
2426 quick identification of these macros when @b{Ref@TeX{}} inserts new | 2426 quick identification of these macros when @b{Ref@TeX{}} inserts new |
2427 index entries with @code{reftex-index}. These codes need to be | 2427 index entries with @code{reftex-index}. These codes need to be |
2428 unique. @code{?i}, @code{?I}, and @code{?g} are reserved for the | 2428 unique. @code{?i}, @code{?I}, and @code{?g} are reserved for the |
2429 @code{\index}, @code{\index*}, and @code{\glossary} macros, | 2429 @code{\index}, @code{\index*}, and @code{\glossary} macros, |
2430 respectively. | 2430 respectively. |
2431 | 2431 |
2432 The following string is empty unless your macro adds a superordinate | 2432 The following string is empty unless your macro adds a superordinate |
2433 entry to the index key - this is the case for the @code{\astobj} macro. | 2433 entry to the index key - this is the case for the @code{\astobj} macro. |
2434 | 2434 |
2435 The next entry can be a hook function to exclude certain matches, it | 2435 The next entry can be a hook function to exclude certain matches, it |
2448 Repeat: | 2448 Repeat: |
2449 [INS] [DEL] List: | 2449 [INS] [DEL] List: |
2450 Macro with args: \ix@{*@} | 2450 Macro with args: \ix@{*@} |
2451 Index Tag : [Value Menu] String: idx | 2451 Index Tag : [Value Menu] String: idx |
2452 Access Key : x | 2452 Access Key : x |
2453 Key Prefix : | 2453 Key Prefix : |
2454 Exclusion hook : nil | 2454 Exclusion hook : nil |
2455 Repeat Outside : [Toggle] off (nil) | 2455 Repeat Outside : [Toggle] off (nil) |
2456 [INS] [DEL] List: | 2456 [INS] [DEL] List: |
2457 Macro with args: \nindex@{*@} | 2457 Macro with args: \nindex@{*@} |
2458 Index Tag : [Value Menu] String: name | 2458 Index Tag : [Value Menu] String: name |
2459 Access Key : n | 2459 Access Key : n |
2460 Key Prefix : | 2460 Key Prefix : |
2461 Exclusion hook : nil | 2461 Exclusion hook : nil |
2462 Repeat Outside : [Toggle] off (nil) | 2462 Repeat Outside : [Toggle] off (nil) |
2463 [INS] [DEL] List: | 2463 [INS] [DEL] List: |
2464 Macro with args: \astobj@{*@} | 2464 Macro with args: \astobj@{*@} |
2465 Index Tag : [Value Menu] String: idx | 2465 Index Tag : [Value Menu] String: idx |
2556 | 2556 |
2557 @vindex reftex-view-crossref-extra | 2557 @vindex reftex-view-crossref-extra |
2558 While the display of cross referencing information for the above | 2558 While the display of cross referencing information for the above |
2559 mentioned macros is hard--coded, you can configure additional relations | 2559 mentioned macros is hard--coded, you can configure additional relations |
2560 in the variable @code{reftex-view-crossref-extra}. | 2560 in the variable @code{reftex-view-crossref-extra}. |
2561 | 2561 |
2562 @iftex | 2562 @iftex |
2563 @chapter All the Rest | 2563 @chapter All the Rest |
2564 @end iftex | 2564 @end iftex |
2565 | 2565 |
2566 @node RefTeXs Menu, Key Bindings, Viewing Cross-References, Top | 2566 @node RefTeXs Menu, Key Bindings, Viewing Cross-References, Top |
2746 different in every language. For an example of how to add magic words, | 2746 different in every language. For an example of how to add magic words, |
2747 see @ref{Adding Magic Words}. | 2747 see @ref{Adding Magic Words}. |
2748 | 2748 |
2749 @vindex reftex-multiref-punctuation | 2749 @vindex reftex-multiref-punctuation |
2750 @vindex reftex-cite-punctuation | 2750 @vindex reftex-cite-punctuation |
2751 @item | 2751 @item |
2752 @b{Ref@TeX{}} inserts ``punctuation'' for multiple references and | 2752 @b{Ref@TeX{}} inserts ``punctuation'' for multiple references and |
2753 for the author list in citations. Some of this may be language | 2753 for the author list in citations. Some of this may be language |
2754 dependent. See the variables @code{reftex-multiref-punctuation} and | 2754 dependent. See the variables @code{reftex-multiref-punctuation} and |
2755 @code{reftex-cite-punctuation}. | 2755 @code{reftex-cite-punctuation}. |
2756 @end itemize | 2756 @end itemize |
2800 | 2800 |
2801 @item | 2801 @item |
2802 Specify the full search path directly in @b{Ref@TeX{}}'s variables. | 2802 Specify the full search path directly in @b{Ref@TeX{}}'s variables. |
2803 | 2803 |
2804 @lisp | 2804 @lisp |
2805 (setq reftex-texpath-environment-variables | 2805 (setq reftex-texpath-environment-variables |
2806 '("./inp:/home/cd/tex//:/usr/local/tex//")) | 2806 '("./inp:/home/cd/tex//:/usr/local/tex//")) |
2807 (setq reftex-bibpath-environment-variables | 2807 (setq reftex-bibpath-environment-variables |
2808 '("/home/cd/tex/lit/")) | 2808 '("/home/cd/tex/lit/")) |
2809 @end lisp | 2809 @end lisp |
2810 | 2810 |
2818 | 2818 |
2819 @lisp | 2819 @lisp |
2820 (setq reftex-use-external-file-finders t) | 2820 (setq reftex-use-external-file-finders t) |
2821 (setq reftex-external-file-finders | 2821 (setq reftex-external-file-finders |
2822 '(("tex" . "kpsewhich -format=.tex %f") | 2822 '(("tex" . "kpsewhich -format=.tex %f") |
2823 ("bib" . "kpsewhich -format=.bib %f"))) | 2823 ("bib" . "kpsewhich -format=.bib %f"))) |
2824 @end lisp | 2824 @end lisp |
2825 @end itemize | 2825 @end itemize |
2826 | 2826 |
2827 @cindex Noweb files | 2827 @cindex Noweb files |
2828 @vindex reftex-file-extensions | 2828 @vindex reftex-file-extensions |
2833 @code{reftex-file-extensions}. When working with AUCTeX as major mode, | 2833 @code{reftex-file-extensions}. When working with AUCTeX as major mode, |
2834 the new extension must also be known to AUCTeX via the variable | 2834 the new extension must also be known to AUCTeX via the variable |
2835 @code{TeX-file-extension}. For example: | 2835 @code{TeX-file-extension}. For example: |
2836 | 2836 |
2837 @lisp | 2837 @lisp |
2838 (setq reftex-file-extensions | 2838 (setq reftex-file-extensions |
2839 '(("nw" "tex" ".tex" ".ltx") ("bib" ".bib"))) | 2839 '(("nw" "tex" ".tex" ".ltx") ("bib" ".bib"))) |
2840 (setq TeX-file-extensions | 2840 (setq TeX-file-extensions |
2841 '( "nw" "tex" "sty" "cls" "ltx" "texi" "texinfo")) | 2841 '( "nw" "tex" "sty" "cls" "ltx" "texi" "texinfo")) |
2842 @end lisp | 2842 @end lisp |
2843 | 2843 |
2844 @node Optimizations, Problems and Work-Arounds, Finding Files, Top | 2844 @node Optimizations, Problems and Work-Arounds, Finding Files, Top |
2845 @section Optimizations | 2845 @section Optimizations |
3146 (lambda () | 3146 (lambda () |
3147 (if (fboundp 'reftex-set-cite-format) | 3147 (if (fboundp 'reftex-set-cite-format) |
3148 (reftex-set-cite-format 'natbib)))) | 3148 (reftex-set-cite-format 'natbib)))) |
3149 @end lisp | 3149 @end lisp |
3150 | 3150 |
3151 @findex reftex-add-index-macros | 3151 @findex reftex-add-index-macros |
3152 The hook may contain a call to @code{reftex-add-index-macros} to | 3152 The hook may contain a call to @code{reftex-add-index-macros} to |
3153 define additional @code{\index}-like macros. The argument must have | 3153 define additional @code{\index}-like macros. The argument must have |
3154 the same format as @code{reftex-index-macros}. It may be a symbol, to | 3154 the same format as @code{reftex-index-macros}. It may be a symbol, to |
3155 trigger support for one of the builtin index packages. For example, | 3155 trigger support for one of the builtin index packages. For example, |
3156 the style @file{multind.el} contains | 3156 the style @file{multind.el} contains |
3280 parts of a multifile document, because @b{Ref@TeX{}} visits these files | 3280 parts of a multifile document, because @b{Ref@TeX{}} visits these files |
3281 literally for speed reasons. Then both short context and section | 3281 literally for speed reasons. Then both short context and section |
3282 headings may look different from what you usually see on your screen. | 3282 headings may look different from what you usually see on your screen. |
3283 In rare cases @code{reftex-toc} may have problems to jump to an affected | 3283 In rare cases @code{reftex-toc} may have problems to jump to an affected |
3284 section heading. There are three possible ways to deal with | 3284 section heading. There are three possible ways to deal with |
3285 this:@refill | 3285 this:@refill |
3286 @itemize @minus | 3286 @itemize @minus |
3287 @item | 3287 @item |
3288 @vindex reftex-keep-temporary-buffers | 3288 @vindex reftex-keep-temporary-buffers |
3289 @code{(setq reftex-keep-temporary-buffers t)}@* | 3289 @code{(setq reftex-keep-temporary-buffers t)}@* |
3290 This implies that @b{Ref@TeX{}} will load all parts of a multifile | 3290 This implies that @b{Ref@TeX{}} will load all parts of a multifile |
3330 @code{step+} environment we actually tell @b{Ref@TeX{}} to look for the | 3330 @code{step+} environment we actually tell @b{Ref@TeX{}} to look for the |
3331 @emph{macro} @samp{\begin@{step+@}} and interpret the @emph{first} | 3331 @emph{macro} @samp{\begin@{step+@}} and interpret the @emph{first} |
3332 argument (which really is a second argument to the macro @code{\begin}) | 3332 argument (which really is a second argument to the macro @code{\begin}) |
3333 as a label of type @code{?p}. Argument count for this macro starts only | 3333 as a label of type @code{?p}. Argument count for this macro starts only |
3334 after the @samp{@{step+@}}, also when specifying how to get | 3334 after the @samp{@{step+@}}, also when specifying how to get |
3335 context.@refill | 3335 context.@refill |
3336 | 3336 |
3337 @item | 3337 @item |
3338 @b{Idle timers in XEmacs}@* | 3338 @b{Idle timers in XEmacs}@* |
3339 @cindex Idle timer restart | 3339 @cindex Idle timer restart |
3340 @vindex reftex-use-itimer-in-xemacs | 3340 @vindex reftex-use-itimer-in-xemacs |
3453 buffer.@refill @* | 3453 buffer.@refill @* |
3454 When called with one or two @kbd{C-u} prefixes, first rescans the | 3454 When called with one or two @kbd{C-u} prefixes, first rescans the |
3455 document. When called with a numeric prefix, make that many citations. | 3455 document. When called with a numeric prefix, make that many citations. |
3456 When called with point inside the braces of a @code{\cite} command, it | 3456 When called with point inside the braces of a @code{\cite} command, it |
3457 will add another key, ignoring the value of | 3457 will add another key, ignoring the value of |
3458 @code{reftex-cite-format}.@refill @* | 3458 @code{reftex-cite-format}.@refill @* |
3459 The regular expression uses an expanded syntax: @samp{&&} is interpreted | 3459 The regular expression uses an expanded syntax: @samp{&&} is interpreted |
3460 as @code{and}. Thus, @samp{aaaa&&bbb} matches entries which contain | 3460 as @code{and}. Thus, @samp{aaaa&&bbb} matches entries which contain |
3461 both @samp{aaaa} and @samp{bbb}. While entering the regexp, completion | 3461 both @samp{aaaa} and @samp{bbb}. While entering the regexp, completion |
3462 on knows citation keys is possible. @samp{=} is a good regular | 3462 on knows citation keys is possible. @samp{=} is a good regular |
3463 expression to match all entries in all files.@refill | 3463 expression to match all entries in all files.@refill |
3666 @defopt reftex-auto-recenter-toc | 3666 @defopt reftex-auto-recenter-toc |
3667 Non-@code{nil} means, initially turn automatic recentering of toc on. | 3667 Non-@code{nil} means, initially turn automatic recentering of toc on. |
3668 When active, the @file{*TOC*} buffer will always show the section you | 3668 When active, the @file{*TOC*} buffer will always show the section you |
3669 are currently working in. Recentering happens whenever Emacs is idle | 3669 are currently working in. Recentering happens whenever Emacs is idle |
3670 for more than `reftex-idle-time' seconds. | 3670 for more than `reftex-idle-time' seconds. |
3671 This feature can be turned on and off from the menu | 3671 This feature can be turned on and off from the menu |
3672 (Ref->Options). | 3672 (Ref->Options). |
3673 @end defopt | 3673 @end defopt |
3674 | 3674 |
3675 @defopt reftex-toc-split-windows-horizontally | 3675 @defopt reftex-toc-split-windows-horizontally |
3676 Non-@code{nil} means, create TOC window by splitting window | 3676 Non-@code{nil} means, create TOC window by splitting window |
4152 called.@refill | 4152 called.@refill |
4153 @end deffn | 4153 @end deffn |
4154 | 4154 |
4155 @deffn {Normal Hook} reftex-select-label-mode-hook | 4155 @deffn {Normal Hook} reftex-select-label-mode-hook |
4156 Normal hook which is run when a selection buffer enters | 4156 Normal hook which is run when a selection buffer enters |
4157 @code{reftex-select-label-mode}.@refill | 4157 @code{reftex-select-label-mode}.@refill |
4158 @end deffn | 4158 @end deffn |
4159 | 4159 |
4160 @deffn Keymap reftex-select-label-map | 4160 @deffn Keymap reftex-select-label-map |
4161 The keymap which is active in the labels selection process | 4161 The keymap which is active in the labels selection process |
4162 (@pxref{Referencing Labels}).@refill | 4162 (@pxref{Referencing Labels}).@refill |
4285 @item | 4285 @item |
4286 normal names separator, like @samp{, } in Jones, Brown and Miller | 4286 normal names separator, like @samp{, } in Jones, Brown and Miller |
4287 @item | 4287 @item |
4288 final names separator, like @samp{ and } in Jones, Brown and Miller | 4288 final names separator, like @samp{ and } in Jones, Brown and Miller |
4289 @item | 4289 @item |
4290 The @samp{et al.} string, like @samp{ @{\it et al.@}} in | 4290 The @samp{et al.} string, like @samp{ @{\it et al.@}} in |
4291 Jones @{\it et al.@} | 4291 Jones @{\it et al.@} |
4292 @end enumerate | 4292 @end enumerate |
4293 @end defopt | 4293 @end defopt |
4294 | 4294 |
4295 @deffn {Normal Hook} reftex-select-bib-mode-hook | 4295 @deffn {Normal Hook} reftex-select-bib-mode-hook |
4296 Normal hook which is run when a selection buffer enters | 4296 Normal hook which is run when a selection buffer enters |
4297 @code{reftex-select-bib-mode}.@refill | 4297 @code{reftex-select-bib-mode}.@refill |
4298 @end deffn | 4298 @end deffn |
4299 | 4299 |
4300 @deffn Keymap reftex-select-bib-map | 4300 @deffn Keymap reftex-select-bib-map |
4301 The keymap which is active in the citation-key selection process | 4301 The keymap which is active in the citation-key selection process |
4302 (@pxref{Creating Citations}).@refill | 4302 (@pxref{Creating Citations}).@refill |
4316 document.@refill | 4316 document.@refill |
4317 @end defopt | 4317 @end defopt |
4318 | 4318 |
4319 @defopt reftex-index-special-chars | 4319 @defopt reftex-index-special-chars |
4320 List of special characters in index entries, given as strings. These | 4320 List of special characters in index entries, given as strings. These |
4321 correspond to the @code{MakeIndex} keywords | 4321 correspond to the @code{MakeIndex} keywords |
4322 @code{(@var{level} @var{encap} @var{actual} @var{quote} @var{escape})}. | 4322 @code{(@var{level} @var{encap} @var{actual} @var{quote} @var{escape})}. |
4323 @end defopt | 4323 @end defopt |
4324 | 4324 |
4325 @defopt reftex-index-macros | 4325 @defopt reftex-index-macros |
4326 List of macros which define index entries. The structure of each entry | 4326 List of macros which define index entries. The structure of each entry |
4531 Macros which can be used for the display of cross references. | 4531 Macros which can be used for the display of cross references. |
4532 This is used when `reftex-view-crossref' is called with point in an | 4532 This is used when `reftex-view-crossref' is called with point in an |
4533 argument of a macro. Note that crossref viewing for citations, | 4533 argument of a macro. Note that crossref viewing for citations, |
4534 references (both ways) and index entries is hard-coded. This variable | 4534 references (both ways) and index entries is hard-coded. This variable |
4535 is only to configure additional structures for which crossreference | 4535 is only to configure additional structures for which crossreference |
4536 viewing can be useful. Each entry has the structure | 4536 viewing can be useful. Each entry has the structure |
4537 @example | 4537 @example |
4538 (@var{macro-re} @var{search-re} @var{highlight}). | 4538 (@var{macro-re} @var{search-re} @var{highlight}). |
4539 @end example | 4539 @end example |
4540 @var{macro-re} is matched against the macro. @var{search-re} is the | 4540 @var{macro-re} is matched against the macro. @var{search-re} is the |
4541 regexp used to search for cross references. @samp{%s} in this regexp is | 4541 regexp used to search for cross references. @samp{%s} in this regexp is |
4554 display. This feature can be turned on and off from the menu | 4554 display. This feature can be turned on and off from the menu |
4555 (Ref->Options).@refill | 4555 (Ref->Options).@refill |
4556 @end defopt | 4556 @end defopt |
4557 | 4557 |
4558 @defopt reftex-idle-time | 4558 @defopt reftex-idle-time |
4559 Time (secs) Emacs has to be idle before automatic crossref display | 4559 Time (secs) Emacs has to be idle before automatic crossref display |
4560 or toc recentering is done.@refill | 4560 or toc recentering is done.@refill |
4561 @end defopt | 4561 @end defopt |
4562 | 4562 |
4563 @defopt reftex-cite-view-format | 4563 @defopt reftex-cite-view-format |
4564 Citation format used to display citation info in the message area. See | 4564 Citation format used to display citation info in the message area. See |
4624 be expanded recursively. See also @code{reftex-use-external-file-finders}. | 4624 be expanded recursively. See also @code{reftex-use-external-file-finders}. |
4625 @end defopt | 4625 @end defopt |
4626 | 4626 |
4627 @defopt reftex-file-extensions | 4627 @defopt reftex-file-extensions |
4628 Association list with file extensions for different file types. | 4628 Association list with file extensions for different file types. |
4629 This is a list of items, each item is like: | 4629 This is a list of items, each item is like: |
4630 @code{(@var{type} . (@var{def-ext} @var{other-ext} ...))} | 4630 @code{(@var{type} . (@var{def-ext} @var{other-ext} ...))} |
4631 @example | 4631 @example |
4632 @var{type}: @r{File type like @code{"bib"} or @code{"tex"}.} | 4632 @var{type}: @r{File type like @code{"bib"} or @code{"tex"}.} |
4633 @var{def-ext}: @r{The default extension for that file type, like @code{".tex"} or @code{".bib"}.} | 4633 @var{def-ext}: @r{The default extension for that file type, like @code{".tex"} or @code{".bib"}.} |
4634 @var{other-ext}: @r{Any number of other legal extensions for this file type.} | 4634 @var{other-ext}: @r{Any number of other legal extensions for this file type.} |
5248 @noindent @b{Version 3.23} | 5248 @noindent @b{Version 3.23} |
5249 @itemize @bullet | 5249 @itemize @bullet |
5250 @item | 5250 @item |
5251 Parse files @file{MASTER.rel} made compatible between Emacs and XEmacs. | 5251 Parse files @file{MASTER.rel} made compatible between Emacs and XEmacs. |
5252 @item | 5252 @item |
5253 @code{kill-emacs-hook} and @code{kill-buffer-hook} now write the parse | 5253 @code{kill-emacs-hook} and @code{kill-buffer-hook} now write the parse |
5254 file. | 5254 file. |
5255 @item | 5255 @item |
5256 The cursor inside a @code{\ref} or @code{\cite} macro can now trigger | 5256 The cursor inside a @code{\ref} or @code{\cite} macro can now trigger |
5257 automatic display of crossref information in the echo area. See | 5257 automatic display of crossref information in the echo area. See |
5258 variable @code{reftex-auto-view-crossref}. | 5258 variable @code{reftex-auto-view-crossref}. |
5355 @noindent @b{Version 3.33} | 5355 @noindent @b{Version 3.33} |
5356 @itemize @bullet | 5356 @itemize @bullet |
5357 @item | 5357 @item |
5358 Multiple selection buffers are now hidden buffers (they start with a | 5358 Multiple selection buffers are now hidden buffers (they start with a |
5359 SPACE). | 5359 SPACE). |
5360 @item | 5360 @item |
5361 Fixed bug with file search when TEXINPUTS environment variable is empty. | 5361 Fixed bug with file search when TEXINPUTS environment variable is empty. |
5362 @end itemize | 5362 @end itemize |
5363 @noindent @b{Version 3.34} | 5363 @noindent @b{Version 3.34} |
5364 @itemize @bullet | 5364 @itemize @bullet |
5365 @item | 5365 @item |
5390 @end itemize | 5390 @end itemize |
5391 @noindent @b{Version 3.41} | 5391 @noindent @b{Version 3.41} |
5392 @itemize @bullet | 5392 @itemize @bullet |
5393 @item | 5393 @item |
5394 New options @code{reftex-texpath-environment-variables}, | 5394 New options @code{reftex-texpath-environment-variables}, |
5395 @code{reftex-use-external-file-finders}, | 5395 @code{reftex-use-external-file-finders}, |
5396 @code{reftex-external-file-finders}, | 5396 @code{reftex-external-file-finders}, |
5397 @code{reftex-search-unrecursed-path-first}. | 5397 @code{reftex-search-unrecursed-path-first}. |
5398 @item | 5398 @item |
5399 @emph{kpathsearch} support. See new options and | 5399 @emph{kpathsearch} support. See new options and |
5400 @code{reftex-bibpath-environment-variables}. | 5400 @code{reftex-bibpath-environment-variables}. |
5401 @end itemize | 5401 @end itemize |
5402 @noindent @b{Version 3.42} | 5402 @noindent @b{Version 3.42} |
5428 Reading a parse file now checks consistency. | 5428 Reading a parse file now checks consistency. |
5429 @end itemize | 5429 @end itemize |
5430 @noindent @b{Version 4.00} | 5430 @noindent @b{Version 4.00} |
5431 @itemize @bullet | 5431 @itemize @bullet |
5432 @item | 5432 @item |
5433 RefTeX has been split into several smaller files which are autoloaded on | 5433 RefTeX has been split into several smaller files which are autoloaded on |
5434 demand. | 5434 demand. |
5435 @item | 5435 @item |
5436 Index support, along with many new options. | 5436 Index support, along with many new options. |
5437 @item | 5437 @item |
5438 The selection of keys for @code{\ref} and @code{\cite} now allows to | 5438 The selection of keys for @code{\ref} and @code{\cite} now allows to |
5478 @noindent @b{Version 4.09} | 5478 @noindent @b{Version 4.09} |
5479 @itemize @bullet | 5479 @itemize @bullet |
5480 @item | 5480 @item |
5481 New option @code{reftex-toc-max-level} to limit the depth of the toc. | 5481 New option @code{reftex-toc-max-level} to limit the depth of the toc. |
5482 New key binding @kbd{t} in the @file{*toc*} buffer to change this | 5482 New key binding @kbd{t} in the @file{*toc*} buffer to change this |
5483 setting.@refill | 5483 setting.@refill |
5484 @item | 5484 @item |
5485 RefTeX maintains an @file{Index Phrases} file in which phrases can be | 5485 RefTeX maintains an @file{Index Phrases} file in which phrases can be |
5486 collected. When the document is ready, RefTeX can search all | 5486 collected. When the document is ready, RefTeX can search all |
5487 these phrases and assist indexing all matches.@refill | 5487 these phrases and assist indexing all matches.@refill |
5488 @item | 5488 @item |
5489 The variables @code{reftex-index-macros} and | 5489 The variables @code{reftex-index-macros} and |
5490 @code{reftex-index-default-macro} have changed their syntax slightly. | 5490 @code{reftex-index-default-macro} have changed their syntax slightly. |
5495 The variable @code{reftex-section-levels} no longer contains the | 5495 The variable @code{reftex-section-levels} no longer contains the |
5496 default stuff which has been moved to a constant.@refill | 5496 default stuff which has been moved to a constant.@refill |
5497 @item | 5497 @item |
5498 Environments like theorems can be placed into the TOC by putting | 5498 Environments like theorems can be placed into the TOC by putting |
5499 entries for @samp{"begin@{theorem@}"} in | 5499 entries for @samp{"begin@{theorem@}"} in |
5500 @code{reftex-setion-levels}.@refill | 5500 @code{reftex-setion-levels}.@refill |
5501 @end itemize | 5501 @end itemize |
5502 @noindent @b{Version 4.10} | 5502 @noindent @b{Version 4.10} |
5503 @itemize @bullet | 5503 @itemize @bullet |
5504 @item | 5504 @item |
5505 Renamed @file{reftex-vcr.el} to @file{reftex-dcr.el} because of conflict | 5505 Renamed @file{reftex-vcr.el} to @file{reftex-dcr.el} because of conflict |
5529 Improved interaction with Emacs LaTeX mode. | 5529 Improved interaction with Emacs LaTeX mode. |
5530 @end itemize | 5530 @end itemize |
5531 @end ignore | 5531 @end ignore |
5532 @noindent @b{Version 4.17} | 5532 @noindent @b{Version 4.17} |
5533 @itemize @bullet | 5533 @itemize @bullet |
5534 @item | 5534 @item |
5535 The toc window can be split off horizontally. See new options | 5535 The toc window can be split off horizontally. See new options |
5536 @code{reftex-toc-split-windows-horizontally}, | 5536 @code{reftex-toc-split-windows-horizontally}, |
5537 @code{reftex-toc-split-windows-horizontally-fraction}. | 5537 @code{reftex-toc-split-windows-horizontally-fraction}. |
5538 @item | 5538 @item |
5539 It is possible to specify a function which verifies an index match | 5539 It is possible to specify a function which verifies an index match |