Mercurial > hg > xemacs-beta

comparison lisp/hm--html-menus/README @ 70:131b0175ea99 r20-0b30

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r20-0b30
author cvs
date Mon, 13 Aug 2007 09:02:59 +0200
parents 6a22abad6937
children 0d2f883870bc
comparison
equal deleted inserted replaced
69:804d1389bcd6 70:131b0175ea99
1 This README file describes the emacs lisp package hm--html-menus-5.5. 1 This README file describes the emacs lisp package hm--html-menus-5.0.
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 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
7 XEmacs 19.14.
8 5
9 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
10 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
11 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
12 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
13 clicking on them. 10 clicking on them.
14 11
15 Look at the file NEWS, to see what is new in this release. Some 12 Look at the file NEWS, to see what is new in this release. One of the
16 of the major changes are also listed in the ANNOUNCEMENT file. 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 17
18 You should (but don't need) also get the w3 package from: 18 You should (but don't need) also get the w3 package from:
19 19
20 cs.indiana.edu:/pub/elisp/w3/w3.tar.z 20 cs.indiana.edu:/pub/elisp/w3/w3.tar.z
21 21
22 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
23 and epoch. 23 and epoch.
24 24
25 25
26 This package is tested with the xemacs 19.15 on Suns with SunOS 5.5 26 This package is tested with the xemacs 19.14 and the emacs 19.30 on
27 and on PC's with linux. But it should work also on other (possibly 27 Suns with SunOS 4.1.3 and 5.5 and on PC's with linux. But it should
28 only UNIX ?) platforms. 28 work also on other (possibly only UNIX ?) platforms.
29 29
30 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
31 GNU Emacs 19. 31 GNU Emacs 19.
32 32
33 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
34 the Emacs 19 and thanks to John Ladwig, who has corrected a lot of the 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 like 35 text and comments in this package and to all the other people, who had
36 Jerry G. DeLapp, Andreas Ernst, Bob Weiner and so on, who had provided 36 provided code, ideas, bug fixes or bug reports for this package.
37 code, ideas, bug fixes or bug reports for this package.
38 37
39 38
40 The package consists of the following files: 39 The package consists of the following files:
41 40
42 README : this file; 41 README : this file;
45 LSM : Entry for the Linux Software Map; 44 LSM : Entry for the Linux Software Map;
46 NEWS : Change logfile; 45 NEWS : Change logfile;
47 adapt.el : provides functions to use this package 46 adapt.el : provides functions to use this package
48 with the GNU Emacs 19 47 with the GNU Emacs 19
49 hm--html.el : provides functions to write html pages; 48 hm--html.el : provides functions to write html pages;
50 in this file are all commands defined, 49 some of these functions are similar to
51 which inserts html elements and entities; 50 functions of the html-mode.el;
52 hm--html-indentation.el : provides the indentation stuff; 51 hm--html-keys.el : provides the new keybindings;
53 hm--html-keys.el : provides the keybindings;
54 hm--html-menu.el : provides the menus; 52 hm--html-menu.el : provides the menus;
55 hm--html-mode.el : provides the functions for the definition 53 hm--html-mode.el : provides the functions for the definition
56 of the hm--html-mode; this is now the 54 of the hm--html-mode; this is now the
57 main file of the package; 55 main file of the package;
58 hm--html-not-standard.el : provides functions to insert some
59 non standard html elements;
60 this file is not evaluated by default;
61 hm--html-configuration.el : configuration file for the html mode; 56 hm--html-configuration.el : configuration file for the html mode;
62 choose this as system configuration file; 57 choose this as system configuration file;
63 hm--html-drag-and-drop.el : defines the HTML- specific functions 58 hm--html-drag-and-drop.el : defines the HTML- specific functions
64 for the drag and drop interface; 59 for the drag and drop interface;
65 hm--date.el : defines the function hm--date, which 60 hm--date.el : defines the function hm--date, which
66 returns the date in the format 61 returns the date in the format
67 "day-month-year" like "30-Jun-1993". 62 "day-month-year" like "30-Jun-1993".
68 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
69 in the Xmosaic; it is patched for the use 64 in the Xmosaic; it is patched for use
70 with the xemacs; 65 with the xemacs;
71 internal-drag-and-drop.el : provides the general (html-mode 66 internal-drag-and-drop.el : provides the general (html-mode
72 independend functions) of the drag and 67 independend functions) of the drag and
73 drop interface; 68 drop interface;
74 templates.doc : describes the syntax of the templates 69 templates.doc : describes the syntax of the templates
75 provided in the file tmpl-minor-mode.el 70 provided in the file tmpl-minor-mode.el
76 tmpl-minor-mode.el : provides functions for the tmpl-minor-mode; 71 tmpl-minor-mode.el : provides functions for the tmpl-minor-mode;
77 with this mode you can expand templates, 72 with this mode you can expand templates,
78 which are described in the file 73 which are described in the file
79 templates-syntax.doc (look at the files 74 templates-syntax.doc (look at the files
80 command-description.html.tmpl and 75 command-description.tmpl and frame.tmpl for
81 frame.html.tmpl for examples); 76 examples);
82 templates can be expanded automatically, if 77 templates can be expanded automatically, if
83 you include a file with templates via the 78 you include a file with templates via the
84 html pulldown menu item "Templates ..." 79 html pulldown menu item "Templates ...";
85 or with the item "Templates (fixed dirs)..."; 80 command-description.tmpl : Templatefile for the use with the
86 command-description.html.tmpl : Templatefile for the use with the
87 tmpl-minor-mode; 81 tmpl-minor-mode;
88 frame.html.tmpl : Templatefile, provides a simple frame; 82 frame.tmpl : Templatefile, provides a simple frame;
89 doc/hm--html-mode.texinfo : Package documentation in the Texinfo format; 83
90 doc/umlaute.texinfo : Texinfo include file for german vowel
91 mutation (deutsche Umlaute);
92 84
93 85
94 86
95 87
96 INSTALLATION: 88 INSTALLATION:
97 ============= 89 =============
98 90
99 Note: In this version the setting of the environment variables 91 Note: In this version the setting of the environment variables
100 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,
101 if you put the user configuration file in the home directory and 93 if you put the user configuration file in the home directrory and
102 the system configuration file in one of the load path directories 94 the system (site) configuration file in one of the load path directories
103 of your XEmacs or Emacs 19. 95 of your xemacs or GNU Emacs 19.
104 96
105 1. Put all the *.el files in one of your xemacs (or emacs) lisp load 97 1. Put all the *.el files in one of your xemacs (or emacs) lisp load
106 directories (i.e. lisp/packages). 98 directories (i.e. lisp/packages).
107 99
108 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):
152 auto-mode-alist))) 144 auto-mode-alist)))
153 145
154 It could also be, that you've already the autoload lines for 146 It could also be, that you've already the autoload lines for
155 the w3 package in your emacs. 147 the w3 package in your emacs.
156 148
157 If you want to use this the hm--html-minor-mode together 149 3. Set the environment variable HTML_CONFIG_FILE to the html system
158 with the psgml-html modes, then you should add the following 150 configuration file i.e.:
159 line (works only in XEmacs version >= 19.15 and != 20.0)
160 (add-hook 'html-mode-hook 'hm--html-minor-mode)
161
162 3. Set (if you want) the environment variable HTML_CONFIG_FILE
163 to the html system configuration file i.e.:
164 setenv HTML_CONFIG_FILE /usr/xemacs/lisp/hm--html-configuration.el 151 setenv HTML_CONFIG_FILE /usr/xemacs/lisp/hm--html-configuration.el
165 152
166 4. Set (if you want) the environment variable HTML_USER_CONFIG_FILE to 153 4. Set (if you want) the environment variable HTML_USER_CONFIG_FILE to
167 the html user configuration file i.e.: 154 the html user configuration file i.e.:
168 setenv HTML_USER_CONFIG_FILE ~/.hm--html-configuration.el 155 setenv HTML_USER_CONFIG_FILE ~/.hm--html-configuration.el
169 And put the file .hm--html-configuration.el in your Home directory. 156 And put the file .hm--html-configuration.el in your Home directory.
170 An example for this user specific file is given below. 157 An example for this user specific file is given below.
171 158
172 5. Check the files hm--html-configuration.el and 159 5. Check the files hm--html-configuration.el and
173 .hm--html-configuration.el whether all variables are set suitable for 160 .hm--html-configuration.el whether all variables are set suitable for
174 you and your site or not. You can make changes in both of these files 161 you and your site or not. You can make changes in both of these files.
175 and you can also create a site specific configuration file, called
176 hm--html-site-config-file.el and specified by the lisp variable
177 hm--html-site-config-file or the environment variable
178 HTML_SITE_CONFIG_FILE, and put your site specific settings in this
179 file. A site specific configuration file is useful, if you're a
180 system administrator and want to make site specific settings
181 without changing a file of this package or use the normal emacs
182 configuration files.
183 Note that .hm--html-configuration.el precedes the settings in 162 Note that .hm--html-configuration.el precedes the settings in
184 hm--html-site-config-file.el, which precedes the settings in 163 hm--html-configuration.el, because it is the user specific
185 hm--html-configuration.el (user specific configuration overwrites 164 configuration file. So you should made site specific changes in
186 site specific configuration and site specific configuration 165 hm--html-configuration.el.
187 overwrites the settings made by the package).
188 166
189 Look at first at the following variables: 167 Look at first at the following variables:
190 168
191 hm--html-signaturefile 169 hm--html-signaturefile
192 hm--html-username 170 hm--html-username
196 html-view-mosaic-command 174 html-view-mosaic-command
197 w3-default-homepage 175 w3-default-homepage
198 176
199 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
200 in the directory to which `hm--html-template-dir' points. 178 in the directory to which `hm--html-template-dir' points.
201 You can use the file command-description.html.tmpl as 179 You can use the file command-description.tmpl as
202 an example. 180 an example.
203 181
204 7. If you don't want to use the feature of adding html comments 182 7. If you don't want to use the feature of adding html comments
205 about the creation date and author and with a change log, then 183 about the creation date and author and with a change log, then
206 you should set the following three variables to nil: 184 you should set the following three variables to nil:
257 235
258 Sorry, I know that the documentation of this package isn't so good as 236 Sorry, I know that the documentation of this package isn't so good as
259 it should be, but at the moment I've not the time to make a better 237 it should be, but at the moment I've not the time to make a better
260 one. 238 one.
261 239
262 There is also a (small) html documentation about the package. You can 240 There is also a html documentation about the package. You can find it on:
263 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
264 http://www.tnt.uni-hannover.de/~muenkel/software/own/hm--html-menus/overview.html
265 242
266 243
267 Please send any bug reports, fixes or comments to 244 Please send any bug reports, fixes or comments to
268 muenkel@daedalus.tnt.uni-hannover.de 245 muenkel@daedalus.tnt.uni-hannover.de
269 246