comparison lisp/textmodes/reftex-vars.el @ 26910:489a5439b988

* reftex.el (reftex-compile-variables): respect new structure of `reftex-index-macro' (reftex-compile-variables): Use the changed structure of `reftex-label-alist'. * reftex-vars.el (reftex-index-math-format, (reftex-toc-max-level): New option. reftex-index-phrases-search-whole-words, reftex-index-phrases-case-fold-search, reftex-index-phrases-skip-indexed-matches, reftex-index-phrases-wrap-long-lines, reftex-index-phrases-sort-prefers-entry, reftex-index-phrases-sort-in-blocks): New options. (reftex-index-macros): Option structure changed. (reftex-index-macros-builtin): Added `repeat' item to each entry. (reftex-label-alist): Additional item in each entry to specify if the environment should be listed in the TOC. (eval-when-compile (require 'cl)) added. * reftex-index.el (reftex-index-selection-or-word): No longer deals with "repeat". (reftex-index): "repeat property in `reftex-index-macro-alist' is now used. (reftex-index-phrases-comment-regexp, reftex-index-phrases-macrodef-regexp, reftex-index-phrases-phrase-regexp1, reftex-index-phrases-phrase-regexp2, reftex-index-phrases-phrase-regexp12, reftex-index-phrases-help): New constants. (reftex-index-phrases-macro-data, reftex-index-phrases-files, reftex-index-phrases-font-lock-keywords, reftex-index-phrases-font-lock-defaults, reftex-index-phrases-map, reftex-index-phrases-restrict-file): New variables. (reftex-index-phrase-selection-or-word, reftex-index-visit-phrases-buffer, reftex-index-initialize-phrases-buffer, reftex-index-phrases-save-and-return, reftex-index-phrases-mode, reftex-index-next-phrase, reftex-index-this-phrase, reftex-index-all-phrases, reftex-index-region-phrases, reftex-index-phrases-parse-header, reftex-index-phrases-toggle-restricted, reftex-index-new-phrase, reftex-index-find-next-conflict-phrase, reftex-index-phrases-info, reftex-index-phrases-set-macro-key, reftex-index-sort-phrases, reftex-compare-phrase-lines, reftex-index-make-phrase-regexp, reftex-index-simplify-phrase, reftex-index-phrases-find-dup-re, reftex-index-make-replace-string, reftex-query-index-phrase-globally, reftex-query-index-phrase, reftex-index-phrase-match-is-indexed, reftex-index-phrases-fixup-line, reftex-index-phrases-replace-space, reftex-index-select-phrases-macro): New functions. (reftex-index-globalize, reftex-index-globally): functions removed (eval-when-compile (require 'cl)) added. * reftex-toc.el (reftex-toc-mode): Create new indicator for max level. (reftex-toc-max-level-indicator): New variable. (reftex-toc-max-level): New command. (reftex-toc-map): New keybinding `t'. (reftex-toc-help): Constant updated. (eval-when-compile (require 'cl)) added. * reftex-ref.el (reftex-offer-label-menu): Prefix to `t' command key can change `reftex-toc-max-level' (eval-when-compile (require 'cl)) added. * reftex-sel (reftex-insert-docstruct): Respect `reftex-toc-max-level' (eval-when-compile (require 'cl)) added. * reftex-auc.el (eval-when-compile (require 'cl)) added. * reftex-vcr.el (eval-when-compile (require 'cl)) added. * reftex-cite.el (reftex-citep, reftex-citet): New commands. (reftex-citation, reftex-do-citation, reftex-figure-out-cite-format): Additional argument FORMAT-KEY to preselect a citation format. (eval-when-compile (require 'cl)) added. * reftex-parse.el (reftex-context-substring): Optional parameter to-end (reftex-section-info): Deal with environment matches. (eval-when-compile (require 'cl)) added. * reftex-global.el (eval-when-compile (require 'cl)) added.

26909:5a2ef05e2490

;;; reftex-vars.el - Configuration variables for RefTeX
;;; Version: 4.6
;;;
;;; See main file reftex.el for licensing information

(provide 'reftex-vars)

;; Define the two constants which are needed during compilation

(eval-and-compile

`?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)
       ("\\glossary{*}" "glo" ?g "" nil)))
    (multind "The multind.sty package"
       (("\\index{}{*}" 1 ?i "" nil)))
    (index "The index.sty package"
	   (("\\index[]{*}" 1 ?i "" nil)
	    ("\\index*[]{*}" 1 ?I "" nil)))
    (Index-Shortcut "index.sty with \\shortindexingon"
       (("\\index[]{*}" 1 ?i "" nil)
	("\\index*[]{*}" 1 ?I "" nil)
	("^[]{*}" 1 ?^ "" texmathp)   
	("_[]{*}" 1 ?_ "" texmathp))))
  "Builtin stuff for reftex-index-macros.
Lower-case symbols correspond to a style file of the same name in the LaTeX
distribution.  Mixed-case symbols are convenience aliases.")
)

;; Table of contents configuration --------------------------------------

(defgroup reftex-table-of-contents-browser nil
  "A multifile table of contents browser."
  :group 'reftex)

(defcustom reftex-toc-keep-other-windows t
  "*Non-nil means, split the selected window to display the *toc* buffer.
This helps to keep the window configuration, but makes the *toc* small.
When nil, all other windows except the selected one will be deleted, so

The value of the variable must be a list of items.  Each item is a list
itself and has the following structure:

 (ENV-OR-MACRO TYPE-KEY LABEL-PREFIX REFERENCE-FORMAT CONTEXT-METHOD
           (MAGIC-WORD ... ))

Each list entry describes either an environment carrying a counter for use
with \\label and \\ref, or a LaTeX macro defining a label as (or inside)
one of its arguments.  The elements of each list entry are:

    `reftex-reference', the label list offered will be automatically
    restricted to labels of the correct type.
    If the first element of this wordlist is the symbol `regexp', the
    strings are interpreted as regular expressions.  RefTeX will add
    a \"\\\\W\" to the beginning and other stuff to the end of the regexp.

If the type indicator characters of two or more entries are the same, RefTeX
will use
 - the first non-nil format and prefix
 - the magic words of all involved entries.

		      (const  :tag "Caption in float" caption)
		      (const  :tag "Item in list" item)
		      (const  :tag "Eqnarray-like" eqnarray-like)
		      (const  :tag "Alignat-like" alignat-like)
		      (symbol :tag "Function" my-func))
	   (repeat :tag "Magic words" :extra-offset 2 (string)))
     (choice
      :tag "Package"
      :value AMSTeX
      ,@(mapcar
	 (lambda (x)

	  (string :tag "ESCAPE char     ")))

(defcustom reftex-index-macros nil
  "Macros which define index entries.  The structure is

(MACRO INDEX-TAG KEY PREFIX EXCLUDE)

MACRO is the macro.  Arguments should be denoted by empty braces like
\\index[]{*}.  Use square brackets to denote optional arguments.  The star
marks where the index key is.

prefix should be \"Molecules!\".  See the manual for details.

EXCLUDE can be a function.  If this function exists and returns a non-nil
value, the index entry at point is ignored.  This was implemented to support
the (deprecated) `^' and `_' shortcuts in the LaTeX2e `index' package.

The final entry may also be a symbol if this entry has a association
in the variable `reftex-index-macros-builtin' to specify the main
indexing package you are using.  Legal values are currently
default         The LaTeX default - unnecessary to specify this one

  :set 'reftex-set-dirty
  :type `(list
	  (repeat 
	   :inline t
	   (list :value ("" "idx" ?a "" nil)
		 (string :tag "Macro with args")
		 (choice :tag "Index Tag      "
			 (string)
			 (integer :tag "Macro arg Nr" :value 1))
		 (character :tag "Access Key     ")
		 (string :tag "Key Prefix     ")
		 (symbol :tag "Exclusion hook ")))
	  (option
	   :tag "Package:"
	   (choice :tag "Package"
		   :value index
		   ,@(mapcar

			(list 'const :tag (concat (symbol-name (nth 0 x))
						  ": " (nth 1 x))
			      (nth 0 x)))
		      reftex-index-macros-builtin)))))

(defcustom reftex-index-default-macro '(?i "idx" t)
  "The default index macro for \\[reftex-index-selection-or-word].
This is a list with (MACRO-KEY DEFAULT-TAG REPEAT-WORD).

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.
REPEAT-WORD: Non-nil means, the index macro does not typeset the entry in
             the text, so that the text has to be repeated outside the index
             macro." 
  :group 'reftex-index-support
  :type '(list
	  (character :tag "Character identifying default macro")
	  (choice    :tag "Default index tag                  "
		  (const nil)
		  (string))
	  (boolean   :tag "Word needs to be repeated          ")))

(defcustom reftex-index-default-tag "idx"
  "Default index tag.
When working with multiple indexes, RefTeX queries for an index tag when
creating index entries or displaying a specific index.  This variable controls

through the `format' function.  This can be used to add the math delimiters
(e.g. `$') to the string.
Requires the `texmathp.el' library which is part of AUCTeX."
  :group 'reftex-index-support
  :type 'string)

(defcustom reftex-index-section-letters "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  "The letters which denote sections in the index.
Usually these are all capital letters.  Don't use any downcase letters.
Order is not significant, the index will be sorted by whatever the sort

26910:489a5439b988

;;; reftex-vars.el - Configuration variables for RefTeX
;;; Version: 4.9
;;;
;;; See main file reftex.el for licensing information

(eval-when-compile (require 'cl))
(provide 'reftex-vars)

;; Define the two constants which are needed during compilation

(eval-and-compile

`?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)))
    (multind "The multind.sty package"
       (("\\index{}{*}" 1 ?i "" nil t)))
    (index "The index.sty package"
	   (("\\index[]{*}" 1 ?i "" nil t)
	    ("\\index*[]{*}" 1 ?I "" nil nil)))
    (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
distribution.  Mixed-case symbols are convenience aliases.")
)

;; Table of contents configuration --------------------------------------

(defgroup reftex-table-of-contents-browser nil
  "A multifile table of contents browser."
  :group 'reftex)

(defcustom reftex-toc-max-level 100
  "*The maximum level of toc entries which will be included in the TOC.
Section headings with a bigger level will be ignored.  In RefTeX, chapters
are level 1, sections are level 2 etc.
This variable can be changed from within the *toc* buffer with the `t' key."
  :group 'reftex-table-of-contents-browser
  :type 'integer)

(defcustom reftex-toc-keep-other-windows t
  "*Non-nil means, split the selected window to display the *toc* buffer.
This helps to keep the window configuration, but makes the *toc* small.
When nil, all other windows except the selected one will be deleted, so

The value of the variable must be a list of items.  Each item is a list
itself and has the following structure:

 (ENV-OR-MACRO TYPE-KEY LABEL-PREFIX REFERENCE-FORMAT CONTEXT-METHOD
           (MAGIC-WORD ... ) TOC-LEVEL)

Each list entry describes either an environment carrying a counter for use
with \\label and \\ref, or a LaTeX macro defining a label as (or inside)
one of its arguments.  The elements of each list entry are:

    `reftex-reference', the label list offered will be automatically
    restricted to labels of the correct type.
    If the first element of this wordlist is the symbol `regexp', the
    strings are interpreted as regular expressions.  RefTeX will add
    a \"\\\\W\" to the beginning and other stuff to the end of the regexp.

TOC-LEVEL
    The integer level at which this environment should be added to the
    table of contents.  See also `reftex-section-levels'.  A positive
    value will number the entries mixed with the sectioning commands of
    the same level.  A negative value will make unnumbered entries.
    Useful only for theorem-like environments, will be ignored for macros.
    When omitted or nil, no TOC entries will be made.

If the type indicator characters of two or more entries are the same, RefTeX
will use
 - the first non-nil format and prefix
 - the magic words of all involved entries.

		      (const  :tag "Caption in float" caption)
		      (const  :tag "Item in list" item)
		      (const  :tag "Eqnarray-like" eqnarray-like)
		      (const  :tag "Alignat-like" alignat-like)
		      (symbol :tag "Function" my-func))
	   (repeat :tag "Magic words" :extra-offset 2 (string))
	   (option (choice :tag "Make TOC entry     "
			   (const :tag "No entry" nil)
			   (integer :tag "Level" :value -3))))
     (choice
      :tag "Package"
      :value AMSTeX
      ,@(mapcar
	 (lambda (x)

	  (string :tag "ESCAPE char     ")))

(defcustom reftex-index-macros nil
  "Macros which define index entries.  The structure is

(MACRO INDEX-TAG KEY PREFIX EXCLUDE REPEAT)

MACRO is the macro.  Arguments should be denoted by empty braces like
\\index[]{*}.  Use square brackets to denote optional arguments.  The star
marks where the index key is.

prefix should be \"Molecules!\".  See the manual for details.

EXCLUDE can be a function.  If this function exists and returns a non-nil
value, the index entry at point is ignored.  This was implemented to support
the (deprecated) `^' and `_' shortcuts in the LaTeX2e `index' package.

REPEAT, if non-nil, means the index macro does not typeset the entry in
the text, so that the text has to be repeated outside the index macro.
Needed for `reftex-index-selection-or-word' and for indexing from the
phrase buffer.

The final entry may also be a symbol if this entry has a association
in the variable `reftex-index-macros-builtin' to specify the main
indexing package you are using.  Legal values are currently
default         The LaTeX default - unnecessary to specify this one

  :set 'reftex-set-dirty
  :type `(list
	  (repeat 
	   :inline t
	   (list :value ("" "idx" ?a "" nil)
		 (string  :tag "Macro with args")
		 (choice  :tag "Index Tag      "
			 (string)
			 (integer :tag "Macro arg Nr" :value 1))
		 (character :tag "Access Key     ")
		 (string  :tag "Key Prefix     ")
		 (symbol  :tag "Exclusion hook ")
                 (boolean :tag "Repeat Outside ")))
	  (option
	   :tag "Package:"
	   (choice :tag "Package"
		   :value index
		   ,@(mapcar

			(list 'const :tag (concat (symbol-name (nth 0 x))
						  ": " (nth 1 x))
			      (nth 0 x)))
		      reftex-index-macros-builtin)))))

(defcustom reftex-index-default-macro '(?i "idx")
  "The default index macro for \\[reftex-index-selection-or-word].
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."
  :group 'reftex-index-support
  :type '(list
	  (character :tag "Character identifying default macro")
	  (choice    :tag "Default index tag                  "
		  (const nil)
		  (string))))

(defcustom reftex-index-default-tag "idx"
  "Default index tag.
When working with multiple indexes, RefTeX queries for an index tag when
creating index entries or displaying a specific index.  This variable controls

through the `format' function.  This can be used to add the math delimiters
(e.g. `$') to the string.
Requires the `texmathp.el' library which is part of AUCTeX."
  :group 'reftex-index-support
  :type 'string)

(defcustom reftex-index-phrases-logical-and-regexp " *&& *"
  "Regexp matching the `and' operator for index arguments in phrases file.
When several index arguments in a phrase line are separated by this
operator, each part will generate an index macro.  So each match of
the search phrase will produce *several* different index entries.

Note: make sure this does no match things which are not separators.
This logical `and' has higher priority than the logical `or' specified in
`reftex-index-phrases-logical-or-regexp'."
  :group 'reftex-index-support
  :type 'regexp)

(defcustom reftex-index-phrases-logical-or-regexp " *|| *"
  "Regexp matching the `or' operator for index arguments in phrases file.
When several index arguments in a phrase line are separated by this
operator, the user will be asked to select one of them at each match
of the search phrase.  The first index arg will be the default - a
number key 1-9 must be pressed to switch to another.

Note: make sure this does no match things which are not separators.
The logical `and' specified in `reftex-index-phrases-logical-or-regexp'
has higher priority than this logical `or'."
  :group 'reftex-index-support
  :type 'regexp)

(defcustom reftex-index-phrases-search-whole-words t
  "*Non-nil means phrases search will look for whole words, not subwords.
This works by requiring word boundaries at the beginning and end of
the search string.  When the search phrase already has a non-word-char
at one of these points, no word boundary is required there."
  :group 'reftex-index-support
  :type 'boolean)

(defcustom reftex-index-phrases-case-fold-search t
  "*Non-nil means, searching for index phrases will ignore case."
  :group 'reftex-index-support
  :type 'boolean)

(defcustom reftex-index-phrases-skip-indexed-matches nil
  "*Non-nil means, skip matches which appear to be indexed already.
When doing global indexing from the phrases buffer, searches for some
phrases may match at places where that phrase was already indexed.  In
particular when indexing an already processed document again, this
will even be the norm.  When this variable is non-nil, RefTeX checks if
the match is an index macro argument, or if an index macro is directly
before or after the phrase.  If that is the case, that match will
be ignored."
  :group 'reftex-index-support
  :type 'boolean)

(defcustom reftex-index-phrases-wrap-long-lines nil
  "*Non-nil means, when indexing from the phrases buffer, wrap lines.
Inserting indexing commands in a line makes the line longer - often
so long that it does not fit onto the screen.  When this variable is
non-nil, newlines will be added as necessary before and/or after the
indexing command to keep lines short.  However, the matched text
phrase and its index command will always end up on a single line.")

(defcustom reftex-index-phrases-sort-prefers-entry nil
  "*Non-nil means when sorting phrase lines, the explicit index entry is used.
Phrase lines in the phrases buffer contain a search phrase, and
sorting is normally based on these.  Some phrase lines also have
an explicit index argument specified.  When this variable is non-nil,
the index argument will be used for sorting."
  :group 'reftex-index-support
  :type 'boolean)

(defcustom reftex-index-phrases-sort-in-blocks t
  "*Non-nil means, empty and comment lines separate phrase buffer into blocks.
Sorting will then preserve blocks, so that lines are re-arranged only
within blocks."
  :group 'reftex-index-support
  :type 'boolean)

(defcustom reftex-index-section-letters "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  "The letters which denote sections in the index.
Usually these are all capital letters.  Don't use any downcase letters.
Order is not significant, the index will be sorted by whatever the sort