Source

ecb / ecb-help.el

Diff from to

ecb-help.el

 ;;; ecb-help.el --- online help for ECB and bug reporting
 
-;; Copyright (C) 2001 Jesper Nordenberg
-;; Copyright (C) 2001 Free Software Foundation, Inc.
-;; Copyright (C) 2001 Klaus Berndl <klaus.berndl@sdm.de>
+;; Copyright (C) 2000 - 2003 Jesper Nordenberg,
+;;                           Klaus Berndl,
+;;                           Kevin A. Burton,
+;;                           Free Software Foundation, Inc.
 
-;; Author: Klaus Berndl <klaus.berndl@sdm.de>
+;; Author: Jesper Nordenberg <mayhem@home.se>
+;;         Klaus Berndl <klaus.berndl@sdm.de>
+;;         Kevin A. Burton <burton@openprivacy.org>
 ;; Maintainer: Klaus Berndl <klaus.berndl@sdm.de>
-;; Keywords: java, class, browser
+;;             Kevin A. Burton <burton@openprivacy.org>
+;; Keywords: browser, code, programming, tools
+;; Created: 2001
 
-;; This program 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 2, or (at your option) any later
-;; version.
+;; This program 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 2, or (at your option) any later version.
 
 ;; This program is distributed in the hope that it will be useful, but WITHOUT
-;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
-;; more details.
+;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+;; FOR A PARTICULAR PURPOSE.  See the 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
+;; 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
+;; $Id$
+
 ;;; Commentary:
 ;;
 ;; Contains all online-help for ECB (stolen something from recentf.el)
 ;; For the ChangeLog of this file see the CVS-repository. For a complete
 ;; history of the ECB-package see the file NEWS.
 
-;; $Id$
-
 ;;; Code
 
 (eval-when-compile
   :group 'ecb)
 
 (defcustom ecb-show-help-format 'info
-  "*The format `ecb-show-help' shows its online help. Allowed values are 'info
-\(for the Info format) and 'html \(for HTML format). If the value is 'html
-then `browse-url-browser-function' says which browser is used.
+  "*The format `ecb-show-help' shows its online help.
+Allowed values are 'info \(for the Info format) and 'html \(for HTML format).
+If the value is 'html then `browse-url-browser-function' says which browser is
+used.
 
 Note: If you got ECB as a standard XEmacs-package maybe the
 HTML-online-documentation is not included."
   "*Path where the ECB online help in info format resides.
 This must be the location of the file \"ecb.info\" which comes with the ECB
 distribution. If is installed by unpacking the archive available on the ECB
-website then this is the subdir `ecb-help-info-subdir' of the installation
+web-site then this is the subdir `ecb-help-info-subdir' of the installation
 directory of ECB. If it is installed as XEmacs-package \(e.g. via the package
 manager of XEmacs) then this is probably the directory \"../../info/\"
-\(relativ to the elisp directory of ECB).
+\(relativ to the Elisp directory of ECB).
 
-The path can either be an absolute path or a path relativ to the directory
-where the elisp files of ECB are.
+The path can either be an absolute path or a path relative to the directory
+where the Elisp files of ECB are.
 
 Normally there should be no need to change this option!"
   :group 'ecb-help
   "*Path where the ECB online help in HTML format resides.
 This must be the location of the file \"index.html\" which comes with the ECB
 distribution. If is installed by unpacking the archive available on the ECB
-website then this is the subdir `ecb-help-html-subdir' of the installation
+web-site then this is the subdir `ecb-help-html-subdir' of the installation
 directory of ECB. If it is installed as XEmacs-package \(e.g. via the package
 manager of XEmacs) then this is probably either the directory \"../../html/\" or
-\"../../etc/ecb/html/\" \(both relativ to the elisp directory of ECB).
+\"../../etc/ecb/html/\" \(both relative to the Elisp directory of ECB).
 
-The path can either be an absolute path or a path relativ to the directory
-where the elisp files of ECB are.
+The path can either be an absolute path or a path relative to the directory
+where the Elisp files of ECB are.
 
 Normally there should be no need to change this option!"
   :group 'ecb-help
 
 ;;;###autoload
 (defun ecb-show-help (&optional format)
-  "Shows the online help of ECB in Info or HTML-format depending on the value
-of the option `ecb-show-help-format'. If called with prefix argument, i.e. if
-FORMAT is not nil then the user is prompted to choose the format of the help
-\(Info or Html).
+  "Shows the online help of ECB in Info or HTML-format.
+The format depends on the setting in `ecb-show-help-format'. If called with
+prefix argument, i.e. if FORMAT is not nil then the user is prompted to choose
+the format of the help \(Info or Html).
 
 If an error about not finding the needed help-file occurs please take a look
 at the options `ecb-help-info-start-file' and `ecb-help-html-start-file'!
   "Please enter the details of your bug report here")
 
 (defun ecb-submit-problem-report()
-  "Submit a problem report for the ECB to the ECB mailing-list. This command
-generates in the edit-window a problem-report which contains already the
-current values of all ECB options, the current backtrace-buffer if there is
-any and the current message-buffer. You will be asked for a problem-report
-subject and then you must insert a description of the problem. Please describe
-the problem as detailed as possible!"
+  "Submit a problem report for the ECB to the ECB mailing-list.
+This command generates in the edit-window a problem-report which contains
+already the current values of all ECB options, the current backtrace-buffer if
+there is any and the current message-buffer. You will be asked for a
+problem-report subject and then you must insert a description of the problem.
+Please describe the problem as detailed as possible!"
   (interactive)
   (if (and (equal ecb-frame (selected-frame))
            (not (ecb-point-in-edit-window)))
        ;;prepare the basic buffer
        (reporter-submit-bug-report
         ecb-problem-report-mail-address
-        (format "ECB: %s, semantic: %s, eieio: %s, JDEE: %s"
+        (format "ECB: %s, semantic: %s, eieio: %s, speedbar: %s, JDEE: %s"
                 ecb-version
                 semantic-version
                 eieio-version
+                speedbar-version
                 (if (boundp 'jde-version)
                     jde-version
                   "No JDEE"))
     (if (re-search-forward "^--[ \t]*$" nil t)
         (progn
           (beginning-of-line)
-          (insert-string "\n\n\n")
+          (insert "\n\n\n")
           (forward-line -2))
       (goto-char (point-max))
-      (insert-string "\n\n")) 
+      (insert "\n\n")) 
     (let* ((messages-buffer 
 	    (get-buffer
 	     (if ecb-running-xemacs " *Message-Log*" "*Messages*")))
 	   (backtrace-buffer (get-buffer "*Backtrace*")))
 
       ;;insert the contents of the backtrace buffer if it is there. 
-      (insert-string "\n\n-----------------------------------------------------\n")
+      (insert "\n\n-----------------------------------------------------\n")
       (if backtrace-buffer
           (progn
-            (insert-string "The contents of the *Backtrace* buffer were\n\n")
+            (insert "The contents of the *Backtrace* buffer were\n\n")
 	    (insert-buffer backtrace-buffer)
             ;; we must force the mark
 	    (goto-char (mark t))
-            (insert-string "\nEnd Insert *Backtrace* buffer" ))
-        (insert-string "There was no *Backtrace* buffer" ))
-      (insert-string "\n-----------------------------------------------------\n\n")
+            (insert "\nEnd Insert *Backtrace* buffer" ))
+        (insert "There was no *Backtrace* buffer" ))
+      (insert "\n-----------------------------------------------------\n\n")
 
       ;;insert the contents of the messages buffer if it is there. 
-      (insert-string "-----------------------------------------------------\n")
+      (insert "-----------------------------------------------------\n")
       (if messages-buffer
           (progn
-            (insert-string "The contents of the *Messages* buffer were\n\n")
+            (insert "The contents of the *Messages* buffer were\n\n")
 	    (insert-buffer messages-buffer)
 	    (goto-char (mark t))
-            (insert-string "\nEnd Insert *Messages* buffer" ))
-        (insert-string "There was no *Messages* buffer" ))
-      (insert-string  "\n-----------------------------------------------------\n\n"))))
+            (insert "\nEnd Insert *Messages* buffer" ))
+        (insert "There was no *Messages* buffer" ))
+      (insert  "\n-----------------------------------------------------\n\n"))))
 
 
 (defun ecb-problem-report-list-all-variables()
                                     compilation-mode-hook
                                     truncate-partial-width-windows
                                     truncate-lines
+                                    ,(if (boundp 'compilation-window-height)
+                                         'compilation-window-height)
+                                    ,(if (boundp 'temp-buffer-max-height)
+                                         'temp-buffer-max-height)
                                     auto-mode-alist
                                     ,(if (boundp 'c-mode-hook)
                                          'c-mode-hook)
                              (function (lambda (l r)
                                          (string< (symbol-name l)
                                                   (symbol-name r))))))
+        (speedbar-vars (sort '(speedbar-dynamic-tags-function-list
+                               speedbar-tag-hierarchy-method
+                               speedbar-tag-group-name-minimum-length
+                               speedbar-tag-split-minimum-length
+                               speedbar-tag-regroup-maximum-length
+                               speedbar-fetch-etags-command
+                               speedbar-fetch-etags-arguments
+                               speedbar-fetch-etags-parse-list)
+                             (function (lambda (l r)
+                                         (string< (symbol-name l)
+                                                  (symbol-name r))))))
         (ecb-options (mapcar
                       'intern
                       (sort
                                    ecb-use-semantic-grouping
                                    ecb-idle-timer-alist
                                    ecb-post-command-hooks
-                                   ecb-old-compilation-window-height
                                    ecb-minor-mode
                                    ecb-toggle-layout-state)
                                  (function (lambda (l r)
                                              (string< (symbol-name l)
                                                       (symbol-name r)))))))
-    (append emacs-vars semantic-vars ecb-internal-vars ecb-options)))
+    (append emacs-vars semantic-vars speedbar-vars
+            ecb-internal-vars ecb-options)))
 
 
 (silentcomp-provide 'ecb-help)