Mercurial > hg > xemacs-beta

comparison lisp/hm--html-menus/README @ 98:0d2f883870bc r20-1b1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r20-1b1
author cvs
date Mon, 13 Aug 2007 09:13:56 +0200
parents 131b0175ea99
children 4be1180a9e89
comparison
equal deleted inserted replaced
97:498bf5da1c90 98:0d2f883870bc
1 This README file describes the emacs lisp package hm--html-menus-5.0. 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 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. 4 for a html mode called hm--html-mode, a mode for writing html pages.
5 5
6 It has an interface to view the html documents in a W3 browser with 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 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 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 9 interface, which makes it very easy to insert links or images, by just
10 clicking on them. 10 clicking on them.
11 11
12 Look at the file NEWS, to see what is new in this release. One of the 12 Look at the file NEWS, to see what is new in this release. Some
13 main changes is, that it is no longer based on the html-mode.el 13 of the major changes are also listed in the ANNOUNCEMENT file.
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 14
18 You should (but don't need) also get the w3 package from: 15 You should (but don't need) also get the w3 package from:
19 16
20 cs.indiana.edu:/pub/elisp/w3/w3.tar.z 17 cs.indiana.edu:/pub/elisp/w3/w3.tar.z
21 18
22 which provides an world wide web browser mode for the xemacs, emacs 19 which provides an world wide web browser mode for the xemacs, emacs
23 and epoch. 20 and epoch.
24 21
25 22
26 This package is tested with the xemacs 19.14 and the emacs 19.30 on 23 This package is tested with the xemacs 19.15 on Suns with SunOS 5.5
27 Suns with SunOS 4.1.3 and 5.5 and on PC's with linux. But it should 24 and on PC's with linux. But it should work also on other (possibly
28 work also on other (possibly only UNIX ?) platforms. 25 only UNIX ?) platforms.
29 26
30 Read the file README-EMACS-19, if you want to use this package with 27 NOTE: The current release isn't tested with the Emacs 19 (5.0 is but
31 GNU Emacs 19. 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.
32 35
33 Thanks to Richard Stallman, who has helped me to port this package to 36 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 37 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 38 text and comments in this package and to all the other people like
36 provided code, ideas, bug fixes or bug reports for this package. 39 Jerry G. DeLapp, Andreas Ernst and so on, who had provided code,
40 ideas, bug fixes or bug reports for this package.
37 41
38 42
39 The package consists of the following files: 43 The package consists of the following files:
40 44
41 README : this file; 45 README : this file;
46 adapt.el : provides functions to use this package 50 adapt.el : provides functions to use this package
47 with the GNU Emacs 19 51 with the GNU Emacs 19
48 hm--html.el : provides functions to write html pages; 52 hm--html.el : provides functions to write html pages;
49 some of these functions are similar to 53 some of these functions are similar to
50 functions of the html-mode.el; 54 functions of the html-mode.el;
55 hm--html-indentation.el : provides the indentation stuff;
51 hm--html-keys.el : provides the new keybindings; 56 hm--html-keys.el : provides the new keybindings;
52 hm--html-menu.el : provides the menus; 57 hm--html-menu.el : provides the menus;
53 hm--html-mode.el : provides the functions for the definition 58 hm--html-mode.el : provides the functions for the definition
54 of the hm--html-mode; this is now the 59 of the hm--html-mode; this is now the
55 main file of the package; 60 main file of the package;
56 hm--html-configuration.el : configuration file for the html mode; 61 hm--html-configuration.el : configuration file for the html mode;
57 choose this as system configuration file; 62 choose this as system configuration file;
58 hm--html-drag-and-drop.el : defines the HTML- specific functions 63 hm--html-drag-and-drop.el : defines the HTML- specific functions
59 for the drag and drop interface; 64 for the drag and drop interface;
65 hm--html-indentation.el : defines functions for the indentation of
66 HTML elements;
60 hm--date.el : defines the function hm--date, which 67 hm--date.el : defines the function hm--date, which
61 returns the date in the format 68 returns the date in the format
62 "day-month-year" like "30-Jun-1993". 69 "day-month-year" like "30-Jun-1993".
63 html-view.el : Ron Tapia's html-view.el to view html-pages 70 html-view.el : Ron Tapia's html-view.el to view html-pages
64 in the Xmosaic; it is patched for use 71 in the Xmosaic; it is patched for use
70 provided in the file tmpl-minor-mode.el 77 provided in the file tmpl-minor-mode.el
71 tmpl-minor-mode.el : provides functions for the tmpl-minor-mode; 78 tmpl-minor-mode.el : provides functions for the tmpl-minor-mode;
72 with this mode you can expand templates, 79 with this mode you can expand templates,
73 which are described in the file 80 which are described in the file
74 templates-syntax.doc (look at the files 81 templates-syntax.doc (look at the files
75 command-description.tmpl and frame.tmpl for 82 command-description.tmpl and
76 examples); 83 frame.html.tmpl for examples);
77 templates can be expanded automatically, if 84 templates can be expanded automatically, if
78 you include a file with templates via the 85 you include a file with templates via the
79 html pulldown menu item "Templates ..."; 86 html pulldown menu item "Templates ..."
80 command-description.tmpl : Templatefile for the use with the 87 or with the item "Templates (fixed dirs)...";
88 command-description.html.tmpl : Templatefile for the use with the
81 tmpl-minor-mode; 89 tmpl-minor-mode;
82 frame.tmpl : Templatefile, provides a simple frame; 90 frame.html.tmpl : Templatefile, provides a simple frame;
83 91
84 92
85 93
86 94
87 95
144 auto-mode-alist))) 152 auto-mode-alist)))
145 153
146 It could also be, that you've already the autoload lines for 154 It could also be, that you've already the autoload lines for
147 the w3 package in your emacs. 155 the w3 package in your emacs.
148 156
149 3. Set the environment variable HTML_CONFIG_FILE to the html system 157 3. Set (if you want) the environment variable HTML_CONFIG_FILE
150 configuration file i.e.: 158 to the html system configuration file i.e.:
151 setenv HTML_CONFIG_FILE /usr/xemacs/lisp/hm--html-configuration.el 159 setenv HTML_CONFIG_FILE /usr/xemacs/lisp/hm--html-configuration.el
152 160
153 4. Set (if you want) the environment variable HTML_USER_CONFIG_FILE to 161 4. Set (if you want) the environment variable HTML_USER_CONFIG_FILE to
154 the html user configuration file i.e.: 162 the html user configuration file i.e.:
155 setenv HTML_USER_CONFIG_FILE ~/.hm--html-configuration.el 163 setenv HTML_USER_CONFIG_FILE ~/.hm--html-configuration.el
156 And put the file .hm--html-configuration.el in your Home directory. 164 And put the file .hm--html-configuration.el in your Home directory.
157 An example for this user specific file is given below. 165 An example for this user specific file is given below.
158 166
159 5. Check the files hm--html-configuration.el and 167 5. Check the files hm--html-configuration.el and
160 .hm--html-configuration.el whether all variables are set suitable for 168 .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. 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.
162 Note that .hm--html-configuration.el precedes the settings in 178 Note that .hm--html-configuration.el precedes the settings in
163 hm--html-configuration.el, because it is the user specific 179 hm--html-site-config-file.el, which precedes the settings in
164 configuration file. So you should made site specific changes in 180 hm--html-configuration.el (user specific configuration overwrites
165 hm--html-configuration.el. 181 site specific configuration and site specific configuration
182 overwrites the settings made by the package).
166 183
167 Look at first at the following variables: 184 Look at first at the following variables:
168 185
169 hm--html-signaturefile 186 hm--html-signaturefile
170 hm--html-username 187 hm--html-username
174 html-view-mosaic-command 191 html-view-mosaic-command
175 w3-default-homepage 192 w3-default-homepage
176 193
177 6. If you want to use templatefiles, you should put these files 194 6. If you want to use templatefiles, you should put these files
178 in the directory to which `hm--html-template-dir' points. 195 in the directory to which `hm--html-template-dir' points.
179 You can use the file command-description.tmpl as 196 You can use the file command-description.html.tmpl as
180 an example. 197 an example.
181 198
182 7. If you don't want to use the feature of adding html comments 199 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 200 about the creation date and author and with a change log, then
184 you should set the following three variables to nil: 201 you should set the following three variables to nil:
235 252
236 Sorry, I know that the documentation of this package isn't so good as 253 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 254 it should be, but at the moment I've not the time to make a better
238 one. 255 one.
239 256
240 There is also a html documentation about the package. You can find it on: 257 There is also a (small) html documentation about the package. You can
241 http://www.tnt.uni-hannover.de:80/data/info/www/tnt/soft/info/www/html-editors/hm--html-menus/overview.html 258 find it on:
259 http://www.tnt.uni-hannover.de/~muenkel/software/own/hm--html-menus/overview.html
242 260
243 261
244 Please send any bug reports, fixes or comments to 262 Please send any bug reports, fixes or comments to
245 muenkel@daedalus.tnt.uni-hannover.de 263 muenkel@daedalus.tnt.uni-hannover.de
246 264