Mercurial > hg > xemacs-beta
diff lisp/hm--html-menus/README @ 98:0d2f883870bc r20-1b1
Import from CVS: tag r20-1b1
author | cvs |
---|---|
date | Mon, 13 Aug 2007 09:13:56 +0200 |
parents | 131b0175ea99 |
children | 4be1180a9e89 |
line wrap: on
line diff
--- a/lisp/hm--html-menus/README Mon Aug 13 09:12:43 2007 +0200 +++ b/lisp/hm--html-menus/README Mon Aug 13 09:13:56 2007 +0200 @@ -1,4 +1,4 @@ -This README file describes the emacs lisp package hm--html-menus-5.0. +This README file describes the emacs lisp package hm--html-menus-5.1. The package provides functions and various popup and pulldown menus for a html mode called hm--html-mode, a mode for writing html pages. @@ -9,11 +9,8 @@ interface, which makes it very easy to insert links or images, by just clicking on them. -Look at the file NEWS, to see what is new in this release. One of the -main changes is, that it is no longer based on the html-mode.el -package from Marc Andreessen. Therefore the name of the mode has -changed to hm--html-mode and also the way to install the package is a -little bit different. So please read the installtion hints CAREFULLY! +Look at the file NEWS, to see what is new in this release. Some +of the major changes are also listed in the ANNOUNCEMENT file. You should (but don't need) also get the w3 package from: @@ -23,17 +20,24 @@ and epoch. -This package is tested with the xemacs 19.14 and the emacs 19.30 on -Suns with SunOS 4.1.3 and 5.5 and on PC's with linux. But it should -work also on other (possibly only UNIX ?) platforms. +This package is tested with the xemacs 19.15 on Suns with SunOS 5.5 +and on PC's with linux. But it should work also on other (possibly +only UNIX ?) platforms. -Read the file README-EMACS-19, if you want to use this package with -GNU Emacs 19. +NOTE: The current release isn't tested with the Emacs 19 (5.0 is but +5.1 isn't). One of the next releases in the near future :-) will be a +bug fix only release for the Emacs 19. So please report any bugs to +muenkel@tnt.uni-hannover.de to shorten the time until the Emacs 19 +related bugs are fixed. + +Read the file README-EMACS-19, if you want to use this package with +GNU Emacs 19. Thanks to Richard Stallman, who has helped me to port this package to the Emacs 19 and thanks to John Ladwig, who has corrected a lot of the -text and comments in this package and to all the other people, who had -provided code, ideas, bug fixes or bug reports for this package. +text and comments in this package and to all the other people like +Jerry G. DeLapp, Andreas Ernst and so on, who had provided code, +ideas, bug fixes or bug reports for this package. The package consists of the following files: @@ -48,6 +52,7 @@ hm--html.el : provides functions to write html pages; some of these functions are similar to functions of the html-mode.el; +hm--html-indentation.el : provides the indentation stuff; hm--html-keys.el : provides the new keybindings; hm--html-menu.el : provides the menus; hm--html-mode.el : provides the functions for the definition @@ -57,6 +62,8 @@ choose this as system configuration file; hm--html-drag-and-drop.el : defines the HTML- specific functions for the drag and drop interface; +hm--html-indentation.el : defines functions for the indentation of + HTML elements; hm--date.el : defines the function hm--date, which returns the date in the format "day-month-year" like "30-Jun-1993". @@ -72,14 +79,15 @@ with this mode you can expand templates, which are described in the file templates-syntax.doc (look at the files - command-description.tmpl and frame.tmpl for - examples); + command-description.tmpl and + frame.html.tmpl for examples); templates can be expanded automatically, if you include a file with templates via the - html pulldown menu item "Templates ..."; -command-description.tmpl : Templatefile for the use with the + html pulldown menu item "Templates ..." + or with the item "Templates (fixed dirs)..."; +command-description.html.tmpl : Templatefile for the use with the tmpl-minor-mode; -frame.tmpl : Templatefile, provides a simple frame; +frame.html.tmpl : Templatefile, provides a simple frame; @@ -146,8 +154,8 @@ It could also be, that you've already the autoload lines for the w3 package in your emacs. -3. Set the environment variable HTML_CONFIG_FILE to the html system - configuration file i.e.: +3. Set (if you want) the environment variable HTML_CONFIG_FILE + to the html system configuration file i.e.: setenv HTML_CONFIG_FILE /usr/xemacs/lisp/hm--html-configuration.el 4. Set (if you want) the environment variable HTML_USER_CONFIG_FILE to @@ -158,11 +166,20 @@ 5. Check the files hm--html-configuration.el and .hm--html-configuration.el whether all variables are set suitable for - you and your site or not. You can make changes in both of these files. + you and your site or not. You can make changes in both of these files + and you can also create a site specific configuration file, called + hm--html-site-config-file.el and specified by the lisp variable + hm--html-site-config-file or the environment variable + HTML_SITE_CONFIG_FILE, and put your site specific settings in this + file. A site specific configuration file is useful, if you're a + system administrator and want to make site specific settings + without changing a file of this package or use the normal emacs + configuration files. Note that .hm--html-configuration.el precedes the settings in - hm--html-configuration.el, because it is the user specific - configuration file. So you should made site specific changes in - hm--html-configuration.el. + hm--html-site-config-file.el, which precedes the settings in + hm--html-configuration.el (user specific configuration overwrites + site specific configuration and site specific configuration + overwrites the settings made by the package). Look at first at the following variables: @@ -176,7 +193,7 @@ 6. If you want to use templatefiles, you should put these files in the directory to which `hm--html-template-dir' points. - You can use the file command-description.tmpl as + You can use the file command-description.html.tmpl as an example. 7. If you don't want to use the feature of adding html comments @@ -237,8 +254,9 @@ it should be, but at the moment I've not the time to make a better one. -There is also a html documentation about the package. You can find it on: -http://www.tnt.uni-hannover.de:80/data/info/www/tnt/soft/info/www/html-editors/hm--html-menus/overview.html +There is also a (small) html documentation about the package. You can +find it on: +http://www.tnt.uni-hannover.de/~muenkel/software/own/hm--html-menus/overview.html Please send any bug reports, fixes or comments to