[Emacs-diffs] Changes to emacs/lisp/textmodes/reftex-vars.el

[Juanma Barranquero]

Index: emacs/lisp/textmodes/reftex-vars.el
diff -c emacs/lisp/textmodes/reftex-vars.el:1.16 
emacs/lisp/textmodes/reftex-vars.el:1.17
*** emacs/lisp/textmodes/reftex-vars.el:1.16    Wed Oct 16 14:37:52 2002
--- emacs/lisp/textmodes/reftex-vars.el Tue Feb  4 08:30:45 2003
***************
*** 99,120 ****
  
        ("enumerate" ?i "item:" "~\\ref{%s}" item
         (regexp "items?" "Punkte?"))
!       
        ("equation"  ?e "eq:" "~(\\ref{%s})" t
         (regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?"  "Gl\\."))
        ("eqnarray"  ?e "eq:" nil eqnarray-like)
!       
        ("figure"    ?f "fig:" "~\\ref{%s}" caption
         (regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\."))
        ("figure*"   ?f nil nil caption)
!       
        ("table"     ?t "tab:" "~\\ref{%s}" caption
         (regexp "tables?" "tab\\." "Tabellen?"))
        ("table*"    ?t nil nil caption)
!       
        ("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2
         (regexp "footnotes?" "Fussnoten?"))
!       
        ("any"       ?\  " "   "~\\ref{%s}" nil)
  
        ;; The label macro is hard coded, but it *could* be defined like this:
--- 99,120 ----
  
        ("enumerate" ?i "item:" "~\\ref{%s}" item
         (regexp "items?" "Punkte?"))
! 
        ("equation"  ?e "eq:" "~(\\ref{%s})" t
         (regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?"  "Gl\\."))
        ("eqnarray"  ?e "eq:" nil eqnarray-like)
! 
        ("figure"    ?f "fig:" "~\\ref{%s}" caption
         (regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\."))
        ("figure*"   ?f nil nil caption)
! 
        ("table"     ?t "tab:" "~\\ref{%s}" caption
         (regexp "tables?" "tab\\." "Tabellen?"))
        ("table*"    ?t nil nil caption)
! 
        ("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2
         (regexp "footnotes?" "Fussnoten?"))
! 
        ("any"       ?\  " "   "~\\ref{%s}" nil)
  
        ;; The label macro is hard coded, but it *could* be defined like this:
***************
*** 178,184 ****
  `?t'    should point to a textual citation (citation as a noun).
  `?p'    should point to a parenthetical citation.")
  
! (defconst reftex-index-macros-builtin 
    '((default "Default \\index and \\glossary macros"
        (("\\index{*}" "idx" ?i "" nil t)
         ("\\glossary{*}" "glo" ?g "" nil t)))
--- 178,184 ----
  `?t'    should point to a textual citation (citation as a noun).
  `?p'    should point to a parenthetical citation.")
  
! (defconst reftex-index-macros-builtin
    '((default "Default \\index and \\glossary macros"
        (("\\index{*}" "idx" ?i "" nil t)
         ("\\glossary{*}" "glo" ?g "" nil t)))
***************
*** 190,196 ****
      (Index-Shortcut "index.sty with \\shortindexingon"
         (("\\index[]{*}" 1 ?i "" nil t)
        ("\\index*[]{*}" 1 ?I "" nil nil)
!       ("^[]{*}" 1 ?^ "" texmathp t)   
        ("_[]{*}" 1 ?_ "" texmathp nil))))
    "Builtin stuff for reftex-index-macros.
  Lower-case symbols correspond to a style file of the same name in the LaTeX
--- 190,196 ----
      (Index-Shortcut "index.sty with \\shortindexingon"
         (("\\index[]{*}" 1 ?i "" nil t)
        ("\\index*[]{*}" 1 ?I "" nil nil)
!       ("^[]{*}" 1 ?^ "" texmathp t)
        ("_[]{*}" 1 ?_ "" texmathp nil))))
    "Builtin stuff for reftex-index-macros.
  Lower-case symbols correspond to a style file of the same name in the LaTeX
***************
*** 202,208 ****
  (defgroup reftex nil
    "LaTeX label and citation support."
    :tag "RefTeX"
!   :link '(url-link :tag "Home Page" 
                   "http://strw.leidenuniv.nl/~dominik/Tools/";)
    :link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el")
    :link '(custom-manual "(reftex)Top")
--- 202,208 ----
  (defgroup reftex nil
    "LaTeX label and citation support."
    :tag "RefTeX"
!   :link '(url-link :tag "Home Page"
                   "http://strw.leidenuniv.nl/~dominik/Tools/";)
    :link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el")
    :link '(custom-manual "(reftex)Top")
***************
*** 283,289 ****
  When active, the *TOC* buffer will always show the section you
  are currently working in.  Recentering happens whenever Emacs is idle for
  more than `reftex-idle-time' seconds.
! This feature can be turned on and off from the menu 
  (Ref->Options)."
    :group 'reftex-table-of-contents-browser
    :type 'boolean)
--- 283,289 ----
  When active, the *TOC* buffer will always show the section you
  are currently working in.  Recentering happens whenever Emacs is idle for
  more than `reftex-idle-time' seconds.
! This feature can be turned on and off from the menu
  (Ref->Options)."
    :group 'reftex-table-of-contents-browser
    :type 'boolean)
***************
*** 365,371 ****
    '(amsmath endnotes fancybox floatfig longtable picinpar
            rotating sidecap subfigure supertab wrapfig LaTeX)
    "Default label alist specifications.  LaTeX should always be the last entry.
! The value of this variable is a list of symbols with associations in the 
  constant `reftex-label-alist-builtin'.  Check that constant for a full list
  of options."
    :group 'reftex-defining-label-environments
--- 365,371 ----
    '(amsmath endnotes fancybox floatfig longtable picinpar
            rotating sidecap subfigure supertab wrapfig LaTeX)
    "Default label alist specifications.  LaTeX should always be the last entry.
! The value of this variable is a list of symbols with associations in the
  constant `reftex-label-alist-builtin'.  Check that constant for a full list
  of options."
    :group 'reftex-defining-label-environments
***************
*** 562,568 ****
  (defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:"))
    "Prefixes for section labels.
  When the label prefix given in an entry in `reftex-label-alist' contains `%S',
! this list is used to determine the correct prefix string depending on the 
  current section level.
  The list is an alist, with each entry of the form (KEY . PREFIX)
  Possible keys are sectioning macro names like `chapter', section levels
--- 562,568 ----
  (defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:"))
    "Prefixes for section labels.
  When the label prefix given in an entry in `reftex-label-alist' contains `%S',
! this list is used to determine the correct prefix string depending on the
  current section level.
  The list is an alist, with each entry of the form (KEY . PREFIX)
  Possible keys are sectioning macro names like `chapter', section levels
***************
*** 587,593 ****
  or macro."
    :group 'reftex-defining-label-environments
    :type '(repeat (cons (symbol) (regexp))))
!   
  (defcustom reftex-special-environment-functions nil
    "List of functions to be called when trying to figure out current 
environment.
  These are special functions to detect \"environments\" which do not
--- 587,593 ----
  or macro."
    :group 'reftex-defining-label-environments
    :type '(repeat (cons (symbol) (regexp))))
! 
  (defcustom reftex-special-environment-functions nil
    "List of functions to be called when trying to figure out current 
environment.
  These are special functions to detect \"environments\" which do not
***************
*** 633,639 ****
       (let ((pos (point)) p1)
         (save-excursion
           ;; Search for any of the linguex item macros at the beginning of a 
line
!          (if (re-search-backward 
                \"^[ 
\\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\"
 bound t)
               (progn
                 (setq p1 (match-beginning 1))
--- 633,639 ----
       (let ((pos (point)) p1)
         (save-excursion
           ;; Search for any of the linguex item macros at the beginning of a 
line
!          (if (re-search-backward
                \"^[ 
\\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\"
 bound t)
               (progn
                 (setq p1 (match-beginning 1))
***************
*** 643,649 ****
                     nil
                   ;; OK, we got it
                   (cons \"linguex\" p1)))
!            ;; Return nil for not found 
             nil))))
  
  3. Tell RefTeX to use this function
--- 643,649 ----
                     nil
                   ;; OK, we got it
                   (cons \"linguex\" p1)))
!            ;; Return nil for not found
             nil))))
  
  3. Tell RefTeX to use this function
***************
*** 842,848 ****
  
  (defcustom reftex-vref-is-default nil
    "*Non-nil means, the varioref macro \\vref is used as default.
! In the selection buffer, the `v' key toggles the reference macro between 
  `\\ref' and `\\vref'.  The value of this variable determines the default
  which is active when entering the selection process.
  Instead of nil or t, this may also be a string of type letters indicating
--- 842,848 ----
  
  (defcustom reftex-vref-is-default nil
    "*Non-nil means, the varioref macro \\vref is used as default.
! In the selection buffer, the `v' key toggles the reference macro between
  `\\ref' and `\\vref'.  The value of this variable determines the default
  which is active when entering the selection process.
  Instead of nil or t, this may also be a string of type letters indicating
***************
*** 852,858 ****
  
  (defcustom reftex-fref-is-default nil
    "*Non-nil means, the fancyref macro \\fref is used as default.
! In the selection buffer, the `V' key toggles the reference macro between 
  `\\ref', `\\fref' and `\\Fref'.  The value of this variable determines
  the default which is active when entering the selection process.
  Instead of nil or t, this may also be a string of type letters indicating
--- 852,858 ----
  
  (defcustom reftex-fref-is-default nil
    "*Non-nil means, the fancyref macro \\fref is used as default.
! In the selection buffer, the `V' key toggles the reference macro between
  `\\ref', `\\fref' and `\\Fref'.  The value of this variable determines
  the default which is active when entering the selection process.
  Instead of nil or t, this may also be a string of type letters indicating
***************
*** 876,882 ****
  
  (defcustom reftex-format-ref-function nil
    "Function which produces the string to insert as a reference.
! Normally should be nil, because the format to insert a reference can 
  already be specified in `reftex-label-alist'.
  This hook also is used by the special commands to insert `\\vref' and `\\fref'
  references, so even if you set this, your setting will be ignored by
--- 876,882 ----
  
  (defcustom reftex-format-ref-function nil
    "Function which produces the string to insert as a reference.
! Normally should be nil, because the format to insert a reference can
  already be specified in `reftex-label-alist'.
  This hook also is used by the special commands to insert `\\vref' and `\\fref'
  references, so even if you set this, your setting will be ignored by
***************
*** 957,969 ****
  %i institution   %j journal        %k key        %m month
  %n number        %o organization   %p pages      %P first page
  %r address       %s school         %u publisher  %t title
! %v volume        %y year          
  %B booktitle, abbreviated          %T title, abbreviated
  
  Usually, only %l is needed.  The other stuff is mainly for the echo area
  display, and for (setq reftex-comment-citations t).
  
! %< as a special operator kills punctuation and space around it after the 
  string has been formatted.
  
  Beware that all this only works with BibTeX database files.  When
--- 957,969 ----
  %i institution   %j journal        %k key        %m month
  %n number        %o organization   %p pages      %P first page
  %r address       %s school         %u publisher  %t title
! %v volume        %y year
  %B booktitle, abbreviated          %T title, abbreviated
  
  Usually, only %l is needed.  The other stuff is mainly for the echo area
  display, and for (setq reftex-comment-citations t).
  
! %< as a special operator kills punctuation and space around it after the
  string has been formatted.
  
  Beware that all this only works with BibTeX database files.  When
***************
*** 975,981 ****
  strings.
    In order to configure this variable, you can either set
  `reftex-cite-format' directly yourself or set it to the SYMBOL of one of
! the predefined styles.  The predefined symbols are those which have an 
  association in the constant `reftex-cite-format-builtin'.
  E.g.: (setq reftex-cite-format 'natbib)"
    :group 'reftex-citation-support
--- 975,981 ----
  strings.
    In order to configure this variable, you can either set
  `reftex-cite-format' directly yourself or set it to the SYMBOL of one of
! the predefined styles.  The predefined symbols are those which have an
  association in the constant `reftex-cite-format-builtin'.
  E.g.: (setq reftex-cite-format 'natbib)"
    :group 'reftex-citation-support
***************
*** 1033,1039 ****
  
  (defcustom reftex-format-cite-function nil
    "Function which produces the string to insert as a citation.
! Normally should be nil, because the format to insert a reference can 
  already be specified in `reftex-cite-format'.
  The function will be called with two arguments, the CITATION KEY and the
  DEFAULT FORMAT, which is taken from `reftex-cite-format'.  The function
--- 1033,1039 ----
  
  (defcustom reftex-format-cite-function nil
    "Function which produces the string to insert as a citation.
! Normally should be nil, because the format to insert a reference can
  already be specified in `reftex-cite-format'.
  The function will be called with two arguments, the CITATION KEY and the
  DEFAULT FORMAT, which is taken from `reftex-cite-format'.  The function
***************
*** 1116,1122 ****
    :group 'reftex-index-support
    :set 'reftex-set-dirty
    :type `(list
!         (repeat 
           :inline t
           (list :value ("" "idx" ?a "" nil)
                 (string  :tag "Macro with args")
--- 1116,1122 ----
    :group 'reftex-index-support
    :set 'reftex-set-dirty
    :type `(list
!         (repeat
           :inline t
           (list :value ("" "idx" ?a "" nil)
                 (string  :tag "Macro with args")
***************
*** 1143,1149 ****
  This is a list with (MACRO-KEY DEFAULT-TAG).
  
  MACRO-KEY:   Character identifying an index macro - see `reftex-index-macros'.
! DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument. 
 
               When this is nil and a TAG is needed, RefTeX will ask for it.
               When this is the empty string and the TAG argument of the index
               macro is optional, the TAG argument will be omitted."
--- 1143,1149 ----
  This is a list with (MACRO-KEY DEFAULT-TAG).
  
  MACRO-KEY:   Character identifying an index macro - see `reftex-index-macros'.
! DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument.
               When this is nil and a TAG is needed, RefTeX will ask for it.
               When this is the empty string and the TAG argument of the index
               macro is optional, the TAG argument will be omitted."
***************
*** 1282,1288 ****
  
  (defcustom reftex-index-include-context nil
    "*Non-nil means, display the index definition context in the index buffer.
! This flag may also be toggled from the index buffer with the `c' key." 
    :group 'reftex-index-support
    :type 'boolean)
  
--- 1282,1288 ----
  
  (defcustom reftex-index-include-context nil
    "*Non-nil means, display the index definition context in the index buffer.
! This flag may also be toggled from the index buffer with the `c' key."
    :group 'reftex-index-support
    :type 'boolean)
  
***************
*** 1305,1311 ****
  argument of a macro.  Note that crossref viewing for citations,
  references (both ways) and index entries is hard-coded.  This variable
  is only to configure additional structures for which crossreference
! viewing can be useful.  Each entry has the structure 
  
  (MACRO-RE SEARCH-RE HIGHLIGHT).
  
--- 1305,1311 ----
  argument of a macro.  Note that crossref viewing for citations,
  references (both ways) and index entries is hard-coded.  This variable
  is only to configure additional structures for which crossreference
! viewing can be useful.  Each entry has the structure
  
  (MACRO-RE SEARCH-RE HIGHLIGHT).
  
***************
*** 1326,1332 ****
  displayed, the echo area will display information about that cross
  reference.  You can also set the variable to the symbol `window'.  In
  this case a small temporary window is used for the display.
! This feature can be turned on and off from the menu 
  (Ref->Options)."
    :group 'reftex-viewing-cross-references
    :type '(choice (const :tag "off" nil)
--- 1326,1332 ----
  displayed, the echo area will display information about that cross
  reference.  You can also set the variable to the symbol `window'.  In
  this case a small temporary window is used for the display.
! This feature can be turned on and off from the menu
  (Ref->Options)."
    :group 'reftex-viewing-cross-references
    :type '(choice (const :tag "off" nil)
***************
*** 1372,1378 ****
  - If an element is the name of an environment variable, its content is used.
  - If an element starts with an exclamation mark, it is used as a command
    to retrieve the path.  A typical command with the kpathsearch library would
!   be `!kpsewhich -show-path=.tex'. 
  - Otherwise the element itself is interpreted as a path.
  Multiple directories can be separated by the system dependent 
`path-separator'.
  Directories ending in `//' or `!!' will be expanded recursively.
--- 1372,1378 ----
  - If an element is the name of an environment variable, its content is used.
  - If an element starts with an exclamation mark, it is used as a command
    to retrieve the path.  A typical command with the kpathsearch library would
!   be `!kpsewhich -show-path=.tex'.
  - Otherwise the element itself is interpreted as a path.
  Multiple directories can be separated by the system dependent 
`path-separator'.
  Directories ending in `//' or `!!' will be expanded recursively.
***************
*** 1387,1393 ****
  - If an element is the name of an environment variable, its content is used.
  - If an element starts with an exclamation mark, it is used as a command
    to retrieve the path.  A typical command with the kpathsearch library would
!   be `!kpsewhich -show-path=.bib'. 
  - Otherwise the element itself is interpreted as a path.
  Multiple directories can be separated by the system dependent 
`path-separator'.
  Directories ending in `//' or `!!' will be expanded recursively.
--- 1387,1393 ----
  - If an element is the name of an environment variable, its content is used.
  - If an element starts with an exclamation mark, it is used as a command
    to retrieve the path.  A typical command with the kpathsearch library would
!   be `!kpsewhich -show-path=.bib'.
  - Otherwise the element itself is interpreted as a path.
  Multiple directories can be separated by the system dependent 
`path-separator'.
  Directories ending in `//' or `!!' will be expanded recursively.
***************
*** 1432,1438 ****
  TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files.
  With this option turned on, it calls an external program specified in the
  option `reftex-external-file-finders' instead.  As a side effect,
! the variables `reftex-texpath-environment-variables' and 
  `reftex-bibpath-environment-variables' will be ignored."
    :group 'reftex-finding-files
    :type 'boolean)
--- 1432,1438 ----
  TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files.
  With this option turned on, it calls an external program specified in the
  option `reftex-external-file-finders' instead.  As a side effect,
! the variables `reftex-texpath-environment-variables' and
  `reftex-bibpath-environment-variables' will be ignored."
    :group 'reftex-finding-files
    :type 'boolean)
***************
*** 1523,1529 ****
  (defcustom reftex-save-parse-info nil
    "*Non-nil means, save information gathered with parsing in a file.
  The file MASTER.rel in the same directory as MASTER.tex is used to save the
! information.  When this variable is t, 
  - accessing the parsing information for the first time in an editing session
    will read that file (if available) instead of parsing the document.
  - exiting Emacs or killing a buffer in reftex-mode will cause a new version
--- 1523,1529 ----
  (defcustom reftex-save-parse-info nil
    "*Non-nil means, save information gathered with parsing in a file.
  The file MASTER.rel in the same directory as MASTER.tex is used to save the
! information.  When this variable is t,
  - accessing the parsing information for the first time in an editing session
    will read that file (if available) instead of parsing the document.
  - exiting Emacs or killing a buffer in reftex-mode will cause a new version
***************
*** 1716,1722 ****
  may require a restart of Emacs in order to become effective."
    :group 'reftex-miscellaneous-configurations
    :group 'LaTeX
!   :type '(choice 
          (const :tag "No plug-ins" nil)
          (const :tag "All possible plug-ins" t)
          (list
--- 1716,1722 ----
  may require a restart of Emacs in order to become effective."
    :group 'reftex-miscellaneous-configurations
    :group 'LaTeX
!   :type '(choice
          (const :tag "No plug-ins" nil)
          (const :tag "All possible plug-ins" t)
          (list