home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 2: Applications / Linux Cubed Series 2 - Applications.iso / editors / emacs / xemacs / xemacs-1.006 / xemacs-1 / lib / xemacs-19.13 / lisp / hm--html-menus / README < prev    next >
Encoding:
Text File  |  1995-08-26  |  8.0 KB  |  232 lines
  1. This README file describes the emacs lisp package hm--html-menus-4.13.
  2.  
  3. The package provides various popup and pulldown menus and functions
  4. for the html-mode from Marc Andreessen, and support for the w3-package
  5. from William M. Perry and the file html-view.el from Ron Tapia.
  6.  
  7. Look at the file NEWS, to see what is new in this release. 
  8.  
  9. You should (but need not) also get the w3 package from:
  10.  
  11.  cs.indiana.edu:/pub/elisp/w3/w3.tar.z
  12.  
  13. which provides an world wide web browser mode for the xemacs, emacs
  14. and epoch.
  15.  
  16.  
  17. This package is tested with the xemacs 19.10 on Suns with
  18. SunOS 4.1.3 and on PC's with linux. But it should work also on other
  19. (possibly only UNIX ?) platforms.
  20.  
  21. Read the file README-EMACS-19, if you want to use this package with 
  22. GNU Emacs 19.
  23.  
  24. Thanks to Richard Stallman, who has helped me to port this package to
  25. the Emacs 19 and thanks to John Ladwig, who has corrected a lot of the
  26. text and comments in this package and to all the other people, who had
  27. provided code, ideas, bug fixes or bug reports for this package.
  28.  
  29.  
  30. The package consists of the following files:
  31.  
  32. README                : this file;
  33. README-EMACS-19            : only for the GNU Emacs 19 user;
  34. ANNOUNCEMENT            : Text of the announcement of this package;
  35. LSM                : Entry for the Linux Software Map;
  36. NEWS                : Change logfile;
  37. adapt.el            : provides functions to use this package 
  38.                   with the GNU Emacs 19
  39. hm--html.el            : provides functions to write html pages;
  40.                   some of these functions are similar to
  41.                   functions of the html-mode.el;
  42. hm--html-keys.el        : provides the new keybindings;
  43. hm--html-menu.el        : provides the menus; this is the main file;
  44. hm--html-configuration.el    : configuration file for the html mode;
  45.                   choose this as system configuration file
  46. hm--date.el            : Defines the function hm--date, which 
  47.                   returns the date in the format 
  48.                   "day-month-year" like "30-Jun-1993".
  49. html-mode.el            : Marc Andreessen's html-mode file; use this
  50.                   one if your html-mode.el is older or 
  51.                   doesn't work together with my files;
  52.                   I've changed it, to fix a bug !
  53. html-view.el            : Ron Tapia's html-view.el to view html-pages
  54.                   in the Xmosaic; it is patched for use
  55.                   with the xemacs;
  56. templates.doc            : describes the syntax of the templates 
  57.                   provided in the file tmpl-minor-mode.el
  58. tmpl-minor-mode.el        : provides functions for the tmpl-minor-mode;
  59.                   with this mode you can expand templates,
  60.                   which are described in the file
  61.                   templates-syntax.doc (look at the files
  62.                   command-description.tmpl and frame.tmpl for
  63.                   examples);
  64.                   templates can be expanded automatically, if
  65.                   you include a file with templates via the
  66.                   html pulldown menu item "Templates ...";
  67. command-description.tmpl    : Templatefile for the use with the
  68.                   tmpl-minor-mode;
  69. frame.tmpl            : Templatefile, provides a simple frame;
  70. emacs-19/*            : only for the GNU emacs 19 user;
  71.  
  72.  
  73.  
  74.  
  75.  
  76. INSTALLATION:
  77. =============
  78.  
  79. Note: In this version the setting of the environment variables 
  80. HTML_CONFIG_FILE and HTML_USER_CONFIG_FILE are no longer necessary,
  81. if you put the user configuration file in the home directrory and
  82. the system (site) configuration file in one of the load path directories
  83. of your xemacs or GNU Emacs 19.
  84.  
  85. 1.    Put all the *.el files (except .hm--html-configuration.el and
  86.     the files in the subdirectory emacs-19)
  87.     in one of your xemacs (or emacs) lisp load directories 
  88.     (i.e. lisp/packages).
  89.  
  90. 2.    Put the following in your .emacs (or default.el or site-init.el):
  91.  
  92.     (autoload 'html-mode "hm--html-menu" "HTML major mode." t)
  93.       (or (assoc "\\.html$" auto-mode-alist)
  94.             (setq auto-mode-alist (cons '("\\.html$" . html-mode) 
  95.                         auto-mode-alist)))
  96.  
  97.     (autoload 'tmpl-expand-templates-in-buffer "tmpl-minor-mode"
  98.       "Expand all templates in the current buffer." t)
  99.  
  100.         (autoload 'html-view-start-mosaic "html-view" "Start Xmosaic." t)
  101.         (autoload 'html-view-view-buffer 
  102.       "html-view"
  103.       "View the current buffer in Xmosaic."
  104.       t)
  105.         (autoload 'html-view-view-file 
  106.       "html-view"
  107.       "View a file in Xmosaic."
  108.       t)
  109.         (autoload 'html-view-goto-url
  110.       "html-view"
  111.       "Goto url in Xmosaic."
  112.       t)
  113.         (autoload 'html-view-get-display
  114.       "html-view"
  115.       "Get the display for Xmosaic (i.e. hostxy:0.0)."
  116.       t)
  117.         (autoload 'w3-preview-this-buffer "w3" "WWW Previewer" t)
  118.     (autoload 'w3 "w3" "WWW Browser" t)
  119.     (autoload 'w3-open-local "w3" "Open local file for WWW browsing" t)
  120.     (autoload 'w3-fetch "w3" "Open remote file for WWW browsing" t)
  121.     (autoload 'w3-use-hotlist "w3" "Use shortcuts to view WWW docs" t)
  122.  
  123.     The above lines assume that you have not installed the older
  124.     html-mode.el.  You should remove the appropriate (old) lines,
  125.     if that isn't true. It could also be, that you've already the
  126.         autoload lines for the w3 package in your emacs.
  127.  
  128. 3.    Set the environment variable HTML_CONFIG_FILE to the html system 
  129.     configuration file i.e.:    
  130.     setenv HTML_CONFIG_FILE /usr/xemacs/lisp/hm--html-configuration.el
  131.  
  132. 4.    Set (if you want) the environment variable HTML_USER_CONFIG_FILE to 
  133.     the html user configuration file i.e.:
  134.     setenv HTML_USER_CONFIG_FILE ~/.hm--html-configuration.el
  135.     And put the file .hm--html-configuration.el in your Home directory.
  136.     An example for this user specific file is given below.
  137.  
  138. 5.    Check the files hm--html-configuration.el and 
  139.     .hm--html-configuration.el whether all variables are set suitable for 
  140.     you and your site or not. You can make changes in both of these files.
  141.     Note that .hm--html-configuration.el precedes the settings in
  142.     hm--html-configuration.el, because it is the user specific
  143.     configuration file. So you should made site specific changes in 
  144.     hm--html-configuration.el.
  145.  
  146.     Look at first at the following variables:
  147.  
  148.         hm--html-signaturefile
  149.         hm--html-username
  150.         hm--html-template-dir
  151.         hm--html-favorite-http-server-host-name
  152.         html-document-previewer
  153.         html-view-html-document-previewermosaic-command
  154.         w3-default-homepage
  155.  
  156. 6.    If you want to use templatefiles, you should put these files
  157.     in the directory to which `hm--html-template-dir' points.
  158.     You can use the file command-description.tmpl as
  159.     an example.
  160.  
  161. 7.    If you don't want to use the feature of adding html comments
  162.     about the creation date and author and with a change log, then
  163.     you should set the following three variables to nil:
  164.           hm--html-automatic-changed-comment
  165.          hm--html-automatic-created-comment
  166.  
  167. 8.      If you don't want to set a date in the title line, than you should
  168.         set the following to nil:
  169.          hm--html-automatic-new-date
  170.  
  171. The following is an example for a user specific configuration file
  172. called .hm--html-configuration.el. You should put such a file in your
  173. home directory and put all the variable settings in it, which are user
  174. specific. 
  175.  
  176. ---- BEGIN of .hm--html-configuration.el ----
  177. ;;; Private html configuration file
  178.  
  179. ;; Signature file
  180. (setq hm--html-signature-file 
  181.       "http://www.tnt.uni-hannover.de:80/data/info/www/tnt/org/tnt/whois/wissmit/muenkel.html")
  182.  
  183. ;; Username (Only necessary if it differs from the passwd entry)
  184. (setq hm--html-username "Heiko Mⁿnkel")
  185.  
  186.  
  187. ;; X Window System display for the html-view
  188. (setq html-view-display "daedalus:0.0")
  189.  
  190.  
  191. ;; Use the expert menus?
  192. (setq hm--html-expert t)
  193.  
  194.  
  195. ;; Delete the automounter path prefix /tmp_mount
  196. (setq hm--html-delete-wrong-path-prefix "/tmp_mount")
  197.  
  198.  
  199. ;;;
  200. ;
  201. ; W3 
  202.  
  203. ;; Default Home Page for w3-mode in lemacs or GNU Emacs
  204. (setq w3-default-homepage "file:/home/muenkel/data/docs/www/home.html")
  205. ---- END of .hm--html-configuration.el ----
  206.  
  207.  
  208. Every hm--*.el file has a description and installation part. Look at first
  209. at these parts, if you have any questions.
  210.  
  211. Look at first at the configuration files, if you have problems with
  212. this package!
  213.  
  214.  
  215. Sorry, I know that the documentation of this package isn't so good as
  216. it should be, but at the moment I've not the time to make a better
  217. one.
  218.  
  219. There is also a html documentation about the package. You can find it on:
  220. http://www.tnt.uni-hannover.de:80/data/info/www/tnt/soft/info/www/html-editors/hm--html-menus/overview.html
  221.  
  222.  
  223. Please send any bug reports, fixes or comments to 
  224.         muenkel@daedalus.tnt.uni-hannover.de
  225.  
  226.  
  227. I hope these files will be useful,
  228.  
  229. Heiko
  230.  
  231.  
  232.