comparison lisp/hm--html-menus/README @ 2:ac2d302a0011 r19-15b2

Import from CVS: tag r19-15b2
author cvs
date Mon, 13 Aug 2007 08:46:35 +0200
parents 376386a54a3c
children 8fc7fe29b841
comparison
equal deleted inserted replaced
1:c0c6a60d29db 2:ac2d302a0011
1 This README file describes the emacs lisp package hm--html-menus-4.16. 1 This README file describes the emacs lisp package hm--html-menus-5.0.
2 2
3 The package provides various popup and pulldown menus and functions 3 The package provides functions and various popup and pulldown menus
4 for the html-mode from Marc Andreessen, and support for the w3-package 4 for a html mode called hm--html-mode, a mode for writing html pages.
5 from William M. Perry and the file html-view.el from Ron Tapia. 5
6 6 It has an interface to view the html documents in a W3 browser with
7 Look at the file NEWS, to see what is new in this release. 7 Netscape, the w3-package from William M. Perry and Mosaic with the
8 8 file html-view.el from Ron Tapia. It provides also a drag and drop
9 You should (but need not) also get the w3 package from: 9 interface, which makes it very easy to insert links or images, by just
10 clicking on them.
11
12 Look at the file NEWS, to see what is new in this release. One of the
13 main changes is, that it is no longer based on the html-mode.el
14 package from Marc Andreessen. Therefore the name of the mode has
15 changed to hm--html-mode and also the way to install the package is a
16 little bit different. So please read the installtion hints CAREFULLY!
17
18 You should (but don't need) also get the w3 package from:
10 19
11 cs.indiana.edu:/pub/elisp/w3/w3.tar.z 20 cs.indiana.edu:/pub/elisp/w3/w3.tar.z
12 21
13 which provides an world wide web browser mode for the xemacs, emacs 22 which provides an world wide web browser mode for the xemacs, emacs
14 and epoch. 23 and epoch.
15 24
16 25
17 This package is tested with the xemacs 19.13 on Suns with 26 This package is tested with the xemacs 19.14 and the emacs 19.30 on
18 SunOS 4.1.3 and on PC's with linux. But it should work also on other 27 Suns with SunOS 4.1.3 and 5.5 and on PC's with linux. But it should
19 (possibly only UNIX ?) platforms. 28 work also on other (possibly only UNIX ?) platforms.
20 29
21 Read the file README-EMACS-19, if you want to use this package with 30 Read the file README-EMACS-19, if you want to use this package with
22 GNU Emacs 19. 31 GNU Emacs 19.
23 32
24 Thanks to Richard Stallman, who has helped me to port this package to 33 Thanks to Richard Stallman, who has helped me to port this package to
38 with the GNU Emacs 19 47 with the GNU Emacs 19
39 hm--html.el : provides functions to write html pages; 48 hm--html.el : provides functions to write html pages;
40 some of these functions are similar to 49 some of these functions are similar to
41 functions of the html-mode.el; 50 functions of the html-mode.el;
42 hm--html-keys.el : provides the new keybindings; 51 hm--html-keys.el : provides the new keybindings;
43 hm--html-menu.el : provides the menus; this is the main file; 52 hm--html-menu.el : provides the menus;
53 hm--html-mode.el : provides the functions for the definition
54 of the hm--html-mode; this is now the
55 main file of the package;
44 hm--html-configuration.el : configuration file for the html mode; 56 hm--html-configuration.el : configuration file for the html mode;
45 choose this as system configuration file 57 choose this as system configuration file;
46 hm--date.el : Defines the function hm--date, which 58 hm--html-drag-and-drop.el : defines the HTML- specific functions
59 for the drag and drop interface;
60 hm--date.el : defines the function hm--date, which
47 returns the date in the format 61 returns the date in the format
48 "day-month-year" like "30-Jun-1993". 62 "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 63 html-view.el : Ron Tapia's html-view.el to view html-pages
54 in the Xmosaic; it is patched for use 64 in the Xmosaic; it is patched for use
55 with the xemacs; 65 with the xemacs;
66 internal-drag-and-drop.el : provides the general (html-mode
67 independend functions) of the drag and
68 drop interface;
56 templates.doc : describes the syntax of the templates 69 templates.doc : describes the syntax of the templates
57 provided in the file tmpl-minor-mode.el 70 provided in the file tmpl-minor-mode.el
58 tmpl-minor-mode.el : provides functions for the tmpl-minor-mode; 71 tmpl-minor-mode.el : provides functions for the tmpl-minor-mode;
59 with this mode you can expand templates, 72 with this mode you can expand templates,
60 which are described in the file 73 which are described in the file
65 you include a file with templates via the 78 you include a file with templates via the
66 html pulldown menu item "Templates ..."; 79 html pulldown menu item "Templates ...";
67 command-description.tmpl : Templatefile for the use with the 80 command-description.tmpl : Templatefile for the use with the
68 tmpl-minor-mode; 81 tmpl-minor-mode;
69 frame.tmpl : Templatefile, provides a simple frame; 82 frame.tmpl : Templatefile, provides a simple frame;
70 emacs-19/* : only for the GNU emacs 19 user;
71 83
72 84
73 85
74 86
75 87
80 HTML_CONFIG_FILE and HTML_USER_CONFIG_FILE are no longer necessary, 92 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 93 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 94 the system (site) configuration file in one of the load path directories
83 of your xemacs or GNU Emacs 19. 95 of your xemacs or GNU Emacs 19.
84 96
85 1. Put all the *.el files (except .hm--html-configuration.el and 97 1. Put all the *.el files in one of your xemacs (or emacs) lisp load
86 the files in the subdirectory emacs-19) 98 directories (i.e. lisp/packages).
87 in one of your xemacs (or emacs) lisp load directories
88 (i.e. lisp/packages).
89 99
90 2. Put the following in your .emacs (or default.el or site-init.el): 100 2. Put the following in your .emacs (or default.el or site-init.el):
91 101
92 (autoload 'html-mode "hm--html-menu" "HTML major mode." t) 102 (autoload 'hm--html-mode "hm--html-mode" "HTML major mode." t)
93 (or (assoc "\\.html$" auto-mode-alist) 103 (autoload 'hm--html-minor-mode "hm--html-mode" "HTML minor mode." t)
94 (setq auto-mode-alist (cons '("\\.html$" . html-mode) 104 (or (assoc "\\.html$" auto-mode-alist)
105 (setq auto-mode-alist (cons '("\\.html$" . hm--html-mode)
95 auto-mode-alist))) 106 auto-mode-alist)))
96 107
97 (autoload 'tmpl-expand-templates-in-buffer "tmpl-minor-mode" 108 (autoload 'tmpl-expand-templates-in-buffer "tmpl-minor-mode"
98 "Expand all templates in the current buffer." t) 109 "Expand all templates in the current buffer." t)
99 110
118 (autoload 'w3 "w3" "WWW Browser" t) 129 (autoload 'w3 "w3" "WWW Browser" t)
119 (autoload 'w3-open-local "w3" "Open local file for WWW browsing" t) 130 (autoload 'w3-open-local "w3" "Open local file for WWW browsing" t)
120 (autoload 'w3-fetch "w3" "Open remote file for WWW browsing" t) 131 (autoload 'w3-fetch "w3" "Open remote file for WWW browsing" t)
121 (autoload 'w3-use-hotlist "w3" "Use shortcuts to view WWW docs" t) 132 (autoload 'w3-use-hotlist "w3" "Use shortcuts to view WWW docs" t)
122 133
123 The above lines assume that you have not installed the older 134 The above lines assume that you have not installed already another
124 html-mode.el. You should remove the appropriate (old) lines, 135 html mode. If this isn't true, then you should use the following
125 if that isn't true. It could also be, that you've already the 136
126 autoload lines for the w3 package in your emacs. 137 (setq auto-mode-alist (cons '("\\.html$" . hm--html-mode)
138 auto-mode-alist))
139
140 instead of
141
142 (or (assoc "\\.html$" auto-mode-alist)
143 (setq auto-mode-alist (cons '("\\.html$" . hm--html-mode)
144 auto-mode-alist)))
145
146 It could also be, that you've already the autoload lines for
147 the w3 package in your emacs.
127 148
128 3. Set the environment variable HTML_CONFIG_FILE to the html system 149 3. Set the environment variable HTML_CONFIG_FILE to the html system
129 configuration file i.e.: 150 configuration file i.e.:
130 setenv HTML_CONFIG_FILE /usr/xemacs/lisp/hm--html-configuration.el 151 setenv HTML_CONFIG_FILE /usr/xemacs/lisp/hm--html-configuration.el
131 152
148 hm--html-signaturefile 169 hm--html-signaturefile
149 hm--html-username 170 hm--html-username
150 hm--html-template-dir 171 hm--html-template-dir
151 hm--html-favorite-http-server-host-name 172 hm--html-favorite-http-server-host-name
152 html-document-previewer 173 html-document-previewer
153 html-view-html-document-previewermosaic-command 174 html-view-mosaic-command
154 w3-default-homepage 175 w3-default-homepage
155 176
156 6. If you want to use templatefiles, you should put these files 177 6. If you want to use templatefiles, you should put these files
157 in the directory to which `hm--html-template-dir' points. 178 in the directory to which `hm--html-template-dir' points.
158 You can use the file command-description.tmpl as 179 You can use the file command-description.tmpl as