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