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