aboutsummaryrefslogtreecommitdiffstats
path: root/lisp/docref.el
diff options
context:
space:
mode:
authorStephen Eglen1998-03-07 18:19:38 +0000
committerStephen Eglen1998-03-07 18:19:38 +0000
commit4bef911093051ec6dfca2e1415e42baee60f8e37 (patch)
tree01e2642e0ce7282e95907bc908e065a2817d30c1 /lisp/docref.el
parent14d4446b73f2f52becebc28d96e82f6ff5fe8e57 (diff)
downloademacs-4bef911093051ec6dfca2e1415e42baee60f8e37.tar.gz
emacs-4bef911093051ec6dfca2e1415e42baee60f8e37.zip
Customized.
Diffstat (limited to 'lisp/docref.el')
-rw-r--r--lisp/docref.el34
1 files changed, 24 insertions, 10 deletions
diff --git a/lisp/docref.el b/lisp/docref.el
index 363ce6c33d5..9aa6a604b22 100644
--- a/lisp/docref.el
+++ b/lisp/docref.el
@@ -60,17 +60,27 @@
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.
66Under window system it highlights them with face defined by 72Under 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
68look like cross-references in info mode.") 74look like cross-references in info mode."
75 :type 'boolean
76 :group 'docref)
69 77
70(defvar docref-highlight-face 'highlight 78(defcustom docref-highlight-face 'highlight
71 "*Face used to highlight cross-references (used by \\(f@docref-subst))") 79 "*Face used to highlight cross-references (used by \\(f@docref-subst))"
80 :type 'face
81 :group 'docref)
72 82
73(defvar docref-methods-alist 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
@@ -81,10 +91,14 @@ look like cross-references in info mode.")
81 91
82The car of each element is a string that serves as `type' in cross-references. 92The 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,
84to be called to find this reference.") 94to 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.