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