Mercurial > emacs
comparison lisp/docref.el @ 21088:ac1673121774
Customized.
| author | Stephen Eglen <stephen@gnu.org> |
|---|---|
| date | Sat, 07 Mar 1998 18:19:38 +0000 |
| parents | 83f275dcd93a |
| children |
comparison
equal
deleted
inserted
replaced
| 21087:c297faa167f5 | 21088:ac1673121774 |
|---|---|
| 58 ;; to your .emacs. | 58 ;; to your .emacs. |
| 59 | 59 |
| 60 ;;; Code: | 60 ;;; Code: |
| 61 | 61 |
| 62 ;; User customizable variables | 62 ;; User customizable variables |
| 63 | 63 (defgroup docref nil |
| 64 (defvar docref-highlight-p t | 64 "Simple cross references for Elisp documentation strings." |
| 65 :prefix "docref-" | |
| 66 :group 'help | |
| 67 :group 'lisp | |
| 68 :group 'docs) | |
| 69 | |
| 70 (defcustom docref-highlight-p t | |
| 65 "*If non-nil, \\(f@docref-subst) highlights cross-references. | 71 "*If non-nil, \\(f@docref-subst) highlights cross-references. |
| 66 Under window system it highlights them with face defined by | 72 Under window system it highlights them with face defined by |
| 67 \\(v@docref-highlight-face), on character terminal highlighted references | 73 \\(v@docref-highlight-face), on character terminal highlighted references |
| 68 look like cross-references in info mode.") | 74 look like cross-references in info mode." |
| 69 | 75 :type 'boolean |
| 70 (defvar docref-highlight-face 'highlight | 76 :group 'docref) |
| 71 "*Face used to highlight cross-references (used by \\(f@docref-subst))") | 77 |
| 72 | 78 (defcustom docref-highlight-face 'highlight |
| 73 (defvar docref-methods-alist | 79 "*Face used to highlight cross-references (used by \\(f@docref-subst))" |
| 80 :type 'face | |
| 81 :group 'docref) | |
| 82 | |
| 83 (defcustom docref-methods-alist | |
| 74 '(("f" . docref-describe-function) ; reference to a function documentation | 84 '(("f" . docref-describe-function) ; reference to a function documentation |
| 75 ("v" . docref-describe-variable) ; reference to a variable documentation | 85 ("v" . docref-describe-variable) ; reference to a variable documentation |
| 76 ("F" . docref-read-file) ; reference to a file contents | 86 ("F" . docref-read-file) ; reference to a file contents |
| 77 ("s" . docref-use-string) ; reference to a string | 87 ("s" . docref-use-string) ; reference to a string |
| 78 ("V" . docref-use-variable-value) ; reference to variable value | 88 ("V" . docref-use-variable-value) ; reference to variable value |
| 79 ("0" . beep)) ; just highlighted text | 89 ("0" . beep)) ; just highlighted text |
| 80 "Alist which maps cross-reference ``types'' to retrieval functions. | 90 "Alist which maps cross-reference ``types'' to retrieval functions. |
| 81 | 91 |
| 82 The car of each element is a string that serves as `type' in cross-references. | 92 The car of each element is a string that serves as `type' in cross-references. |
| 83 \(See \\(f@docref-subst)). The cdr is a function of one argument, | 93 \(See \\(f@docref-subst)). The cdr is a function of one argument, |
| 84 to be called to find this reference.") | 94 to be called to find this reference." |
| 85 | 95 :type '(repeat (cons string function)) |
| 86 (defvar docref-back-label "\nback" | 96 :group 'docref) |
| 87 "Label to use by \\(f@docref-subst) for the go-back reference.") | 97 |
| 98 (defcustom docref-back-label "\nback" | |
| 99 "Label to use by \\(f@docref-subst) for the go-back reference." | |
| 100 :type 'string | |
| 101 :group 'docref) | |
| 88 | 102 |
| 89 (defvar docref-back-reference nil | 103 (defvar docref-back-reference nil |
| 90 "If non-nil, this is a go-back reference to add to the current buffer. | 104 "If non-nil, this is a go-back reference to add to the current buffer. |
| 91 The value specifies how to go back. It should be suitable for use | 105 The value specifies how to go back. It should be suitable for use |
| 92 as the second argument to \\(f@docref-insert-label). | 106 as the second argument to \\(f@docref-insert-label). |