X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/94cc397c541f50af6b049af6c42806daa2be2709..0c06a6a6fd74fa552ffcbe06fd916bafac18587e:/lisp/help-mode.el

diff --git a/lisp/help-mode.el b/lisp/help-mode.el
index 0f4c5cd61e..91fb4f9925 100644
--- a/lisp/help-mode.el
+++ b/lisp/help-mode.el
@@ -1,17 +1,17 @@
 ;;; help-mode.el --- `help-mode' used by *Help* buffers
 
 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002,
-;;   2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;;   2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
 ;; Keywords: help, internal
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -19,9 +19,7 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
@@ -32,6 +30,7 @@
 
 (require 'button)
 (require 'view)
+(eval-when-compile (require 'easymenu))
 
 (defvar help-mode-map (make-sparse-keymap)
   "Keymap for help mode.")
@@ -45,6 +44,20 @@
 ;; Documentation only, since we use minor-mode-overriding-map-alist.
 (define-key help-mode-map "\r" 'help-follow)
 
+(easy-menu-define help-mode-menu help-mode-map
+  "Menu for Help Mode."
+  '("Help-Mode"
+    ["Show Help for Symbol" help-follow-symbol
+     :help "Show the docs for the symbol at point"]
+    ["Previous Topic" help-go-back
+     :help "Go back to previous topic in this help buffer"]
+    ["Next Topic" help-go-forward
+     :help "Go back to next topic in this help buffer"]
+    ["Move to Previous Button" backward-button
+     :help "Move to the Next Button in the help buffer"]
+    ["Move to Next Button" forward-button
+      :help "Move to the Next Button in the help buffer"]))
+
 (defvar help-xref-stack nil
   "A stack of ways by which to return to help buffers after following xrefs.
 Used by `help-follow' and `help-xref-go-back'.
@@ -54,7 +67,7 @@ To use the element, do (apply FUNCTION ARGS) then goto the point.")
 (make-variable-buffer-local 'help-xref-stack)
 
 (defvar help-xref-forward-stack nil
-  "The stack of used to navigate help forwards  after using the back button.
+  "A stack used to navigate help forwards after using the back button.
 Used by `help-follow' and `help-xref-go-forward'.
 An element looks like (POSITION FUNCTION ARGS...).
 To use the element, do (apply FUNCTION ARGS) then goto the point.")
@@ -144,6 +157,12 @@ The format is (FUNCTION ARGS...).")
   'help-function #'help-xref-go-forward
   'help-echo (purecopy "mouse-2, RET: move forward to next help buffer"))
 
+(define-button-type 'help-info-variable
+  :supertype 'help-xref
+  ;; the name of the variable is put before the argument to Info
+  'help-function (lambda (a v) (info v))
+  'help-echo (purecopy "mouse-2, RET: read this Info node"))
+
 (define-button-type 'help-info
   :supertype 'help-xref
   'help-function #'info
@@ -339,6 +358,11 @@ restore it properly when going back."
 
 ;;;###autoload
 (defun help-buffer ()
+  "Return the name of a buffer for inserting help.
+If `help-xref-following' is non-nil, this is the name of the
+current buffer.
+Otherwise, it is *Help*; if no buffer with that name currently
+exists, it is created."
   (buffer-name				;for with-output-to-temp-buffer
    (if help-xref-following
        (current-buffer)