Mercurial > hg > xemacs-beta
diff man/hm--html-mode.texi @ 46:6a22abad6937 r19-15
Import from CVS: tag r19-15
| author | cvs |
|---|---|
| date | Mon, 13 Aug 2007 08:55:31 +0200 |
| parents | 8b8b7f3559a2 |
| children |
line wrap: on
line diff
--- a/man/hm--html-mode.texi Mon Aug 13 08:55:13 2007 +0200 +++ b/man/hm--html-mode.texi Mon Aug 13 08:55:31 2007 +0200 @@ -4,7 +4,7 @@ @settitle HM HTML Mode @setchapternewpage odd @comment %**end of header (This is for running Texinfo on a region.) -@comment $Id: hm--html-mode.texi,v 1.1 1997/03/23 00:28:12 steve Exp $ +@comment $Id: hm--html-mode.texi,v 1.2 1997/03/27 01:22:34 steve Exp $ @ifinfo This file documents the Elisp package @code{hm--html-menus}. @@ -45,7 +45,7 @@ @sp 4 @center by Heiko Münkel @sp 4 -@center Version 5.4, March 1997 +@center Version 5.6, March 1997 @page @vskip 0pt plus 1filll Copyright @copyright{} 1997 Heiko Münkel @@ -131,65 +131,61 @@ @findex hm--html-mode @findex hm--html-minor-mode -This document describes the Elisp package @emph{hm---html-menus 5.4}. +This document describes the Elisp package @emph{hm---html-menus 5.6}. The version of the document is:@* -$Id: hm--html-mode.texi,v 1.1 1997/03/23 00:28:12 steve Exp $ +$Id: hm--html-mode.texi,v 1.2 1997/03/27 01:22:34 steve Exp $ The package provides commands and various popup and pulldown menus for -a HTML mode called @dfn{hm---html-mode}, a mode for writing HTML pages -for the World Wide Web (WWW). It provides also a minor mode +an HTML mode called @dfn{hm---html-mode}, a mode for writing HTML pages +for the World Wide Web (WWW). It also provides a minor mode (@dfn{hm---html-minor-mode}), which can be used together with another -HTML major mode, like the psgml-html modes in the XEmacs 19.14. +HTML major mode, like the psgml-html modes in XEmacs 19.14. You can easily view the HTML documents by calling the browsers w3 (a -nice elisp package from William M. Perry), Netscape or Mosaic direct +nice elisp package from William M. Perry), Netscape, or Mosaic directly from the pulldown menu of the mode. An integrated (emacs internal) drag and drop interface makes it very easy to insert links or images, by just clicking on them. -If it makes sense, then the commands are working also on selected +When appropriate, identical commands work on selected regions. You'll see the same menu items and can use the same -keystrokes, regardless if the region is activated or not, but if it's -activated, then the commands are working on the region. Therefore, you +keystrokes, whether a region is active or not, but if it's +active, then the commands are operating on the region. Therefore, you don't need to learn different menus or keys for similar functions! -One major design issue of the package was to make it easier to write a +One major design goal of the package was to make it easier to write a HTML page, even if you don't know much about HTML. For that I've tried -to put more knowledge about HTML, URL's and so on in it as an SGML based +to put more knowledge about HTML, URL's and so on in it than an SGML based mode could find out from a DTD file. In most cases the user gets help to -construct a specific link by examples or by a completion list with +construct a specific link by examples, or by a completion list with possible input strings. And you can choose between an expert popup menu and an novice popup menu interactively. The novice menu contains only the basic HTML elements, so that you're not bothered by the quantity of different HTML elements. And if you want to use more HTML elements, then -you could easily switch to the expert menus. +you can easily switch to the expert menus. You can configure the html mode with a special configuration file for -your site and with another file specific for a user. Look at the +your site and with another file specific to a user. Look at the customization chapter for this, @xref{Customization, Customization}. @node Distribution, Installation, Overview, Top @comment node-name, next, previous, up -@chapter Distribution +@chapter Distribution The name of the distribution file is @file{hm--html-menus-<version>.tar.gz}, where @var{<version>} is the -version number. The package is part of the XEmacs. You should find the -latest version of the package always on the following ftp server: - +version number. The package is part of the XEmacs. You should always +find the latest version of the package on the following ftp server: @display @emph{ftp.tnt.uni-hannover.de} in @file{/pub/editors/xemacs/contrib} @end display - You should also find the package in the USA on the ftp server (which is mirrored on many other servers in the world): - @display @emph{sunsite.unc.edu} in @file{/pub/Linux/apps/editors/emacs} @end display - @menu * Contents:: Contents of the distribution @end menu @@ -198,14 +194,13 @@ @comment node-name, next, previous, up @section Contents @cindex contents - The package consists of the following files: @table @file @item README Please, read this first. @itemx README-EMACS-19 -Some special hints only for the GNU Emacs 19 users. +Some special hints only for GNU Emacs 19 users. @itemx ANNOUNCEMENT Text of the announcement of this package. @itemx LSM @@ -214,10 +209,10 @@ The NEWS and Change log file. @itemx adapt.el Provides (emulates XEmacs) functions for the use of this package with -the GNU Emacs 19. +GNU Emacs 19. @itemx hm--html.el Provides functions to write html pages. It defines all commands which -inserts html elements and entities. +insert html elements and entities. @itemx hm--html-indentation.el Provides the lisp code for the indentation. @itemx hm--html-keys.el @@ -234,15 +229,15 @@ Configuration file for the html mode. All the user variables are defined in this file. @itemx hm--html-drag-and-drop.el -Defines the HTML- specific functions for the drag and drop interface. +Defines the HTML-specific functions for the drag and drop interface. @itemx hm--date.el Defines the function hm--date, which returns the date in the format "day-month-year" like "30-Jun-1993". @itemx html-view.el -Ron Tapia's html-view.el to view html-pages in the Mosaic. It is -patched for the use with the xemacs. +Ron Tapia's html-view.el to view html pages in Mosaic. It is +patched for use with XEmacs. @itemx internal-drag-and-drop.el -Provides the general (html mode independent functions) of the drag and +Provides the general (html-mode independent) functions of the drag and drop interface. @itemx templates.doc Describes the syntax of the templates provided in the file @@ -262,7 +257,7 @@ @itemx doc/hm--html-mode.texinfo Package documentation in the Texinfo format. @itemx doc/umlaute.texinfo -Texinfo include file for german vowel mutation (deutsche Umlaute). +Texinfo include file for German vowel mutation (deutsche Umlaute). @end table @node Installation, Customization, Distribution, Top @@ -272,8 +267,8 @@ @enumerate -@item Put all the *.el files in one of your xemacs (or emacs) lisp load -directories (i.e. site-lisp/hm--html-menus). +@item Put all the *.el files in one of your XEmacs (or emacs) lisp load +directories (e.g. site-lisp/hm--html-menus). @item Put the following in your .emacs (or default.el or site-init.el): @lisp @@ -305,7 +300,7 @@ t) @end lisp -The above lines assume that you have not installed already another +The above lines assume that you have not already installed another html mode. If this isn't true, then you should use the following: @lisp (setq auto-mode-alist (cons '("\\.html$" . hm--html-mode) @@ -318,7 +313,7 @@ (setq auto-mode-alist (cons '("\\.html$" . hm--html-mode) auto-mode-alist))) @end lisp -If you want to use the hm---html-minor-mode together +If you want to use the hm--html-minor-mode together with the psgml-html modes, then you should add the following line (works only in XEmacs version >= 19.15 and != 20.0): @lisp @@ -332,7 +327,7 @@ @cindex customization @cindex configuration -You should be able to use the package after it's installation without +You should be able to use the package after its installation without any further customization. But it contains a lot of user variables to adapt the package better to your special needs. How to do this is described in this chapter. @@ -348,10 +343,10 @@ @cindex customization files @cindex configuration files -This package uses 3 different files to customize the mode, but you must +This package uses 3 different files to customize the mode, but you need not use all of them. Only one of them, the file @file{hm--html-configuration.el} is delivered together with the package. -The reason for three different files is to provide the possibility to +The reason for three different files is to provide the opportunity to have different customization for the package, the site and the user. There's also a pulldown menu item to reload all customization files. The files are described in the following sections. @@ -369,20 +364,20 @@ @cindex hm--configuration.el @vindex HTML_CONFIG_FILE -All variables, which can be used to customize the mode, are defined in +All variables which can be used to customize the mode are defined in the package configuration file @file{hm--configuration.el}. You should -take a look at this file, if you don't find how to customize a feature +take a look at this file if you don't find how to customize a feature in this documentation (the documentation of a program is never as -complete as it's program code :-). +complete as its program code :-). This file is searched in one of your lisp load directories. You can change this by setting the environment variable @code{HTML_CONFIG_FILE} to another file. But I don't recommend this. @emph{Note}: This file is loaded before the other customization files, -so that it's definitions could be overwritten. All variables are set by -@code{defvar}, so that it's values could also be overwritten with -@code{setq} in any standard emacs customization files (i.e. in +so that its definitions could be overwritten. All variables are set by +@code{defvar}, so that its values could also be overwritten with +@code{setq} in any standard emacs customization files (e.g. in @file{.emacs}). @@ -394,25 +389,25 @@ @vindex HTML_SITE_CONFIG_FILE @vindex hm--html-site-config-file -In general all users at a site are writing there html pages for the same -WWW server. Therefore it is very likely, that most of the customizations -are site specific and only a few are user specific. But however, you -don't have to use a site specific customization, if you don't like it. +In general all users at a site are writing their html pages for the same +WWW server. Therefore it is very likely that most of the customizations +are site specific, and only a few are user specific. However, you +don't have to use a site specific customization if you don't want one. -If you'd like to make a site specific customization of the -@code{hm--html-mode}, then it's possible to put it in a special file -called @file{hm--site-configuration-file.el}. If you do this, you've to -set either the lisp variable @code{hm--html-site-config-file} or the -environment variable @code{HTML_SITE_CONFIG_FILE} to the file and it's -path. If you write the filename without it's extension (.el), the emacs -tries to load at first a compiled version of the file. +If you'd like to make a site specific customization of +@code{hm--html-mode}, it's possible to put it in a special file called +@file{hm--site-configuration-file.el}. If you do this, you have to set +either the lisp variable @code{hm--html-site-config-file} or the +environment variable @code{HTML_SITE_CONFIG_FILE} to the file and its +path. If you write the filename without its extension (.el), emacs +tries first to load a compiled version of the file. -The environment variables overwrites the lisp variable. +The environment variables overwrite the lisp variables. You can also put the site specific customization in any standard emacs -customization files like @file{default.el}. But an advantage, if you -use @file{hm--site-configuration-file.el} is, that it is very likely, -that you can use this file also together with future versions of the +customization file like, @file{default.el}. But an advantage to +using @file{hm--site-configuration-file.el} is that it is very likely +you will be able to use this file with future versions of the package. I'll try to make it as backward compatible as possible. @emph{Note}: This file is loaded after the package customization file @@ -431,11 +426,11 @@ home directory of the user. This can be overwritten by setting either the environment variable @code{HTML_USER_CONFIG_FILE} or the lisp variable @code{hm--html-user-config-file} to the name of the file and -it's path. If you write the filename without it's extension (.el), the -emacs tries to load at first a compiled version of the file. +its path. If you write the filename without its extension (.el), emacs +tries first to load a compiled version of the file. You can also put the user specific customization in your -@file{.emacs}. It's up to you, to decide which way is the better one. +@file{.emacs}. It's up to you to decide which way is better. @emph{Note}: This file is loaded after the package and the site specific one. Therefore it overwrites all other customization files. @@ -479,11 +474,11 @@ @itemize @bullet @item @code{hm--html-username}: Your real name. This is used as the name of -the signature links. You have only to specify it, if your name in the -file @file{/etc/passwd} isn't the one, you'd like to see in the html -files. Otherwise this could be set to nil. +the signature links. You need only specify it if your name in the +file @file{/etc/passwd} isn't the one you'd like to see in the html +files. Otherwise this may be set to @code{nil}. @item -@code{hm--html-signature-file}: The link, used in your signature. In +@code{hm--html-signature-file}: The link used in your signature. In general this should be a link to your home page. @end itemize @@ -498,8 +493,8 @@ @itemize @bullet @item @code{hm--html-expert}: If you're a html novice and don't want to be -bothered with lot's of possible html elements, then you should use the -novice popup menus. For that you've to set this variable to @code{nil}, +bothered with lots of possible html elements, then you should use the +novice popup menus. For that, set this variable to @code{nil}, which is the default. But if you are more familiar with html and would like to use more html elements, then you should use the expert menus and set this variable to @code{t}. @@ -515,7 +510,7 @@ @itemize @bullet @item @code{hm--html-html-doctype-version}: The HTML version. This is used in -the doctype element. Change this, if you use non HTML 3.2 elements. This +the doctype element. Change this if you use non HTML 3.2 elements. This package (@xref{Overview, version}.) defines by default only HTML 3.2 elements. @end itemize @@ -525,33 +520,33 @@ @subsection Defaults Used For Generating Links @cindex links -One of the main features of the @code{hm--html-mode} are the easy ways -to insert special links to html pages, ftp servers, news servers and so -on. I think, that most people will have their own (this may be site -specific, @xref{Where To Put Site Specific Customization, Where To Put +One of the main features of @code{hm--html-mode} is its easy ways to +insert special links to html pages, ftp servers, news servers and so +on. I think that most people will have their own (this may be site +specific. @xref{Where To Put Site Specific Customization, Where To Put Site Specific Customization}.) favourite servers, directories and so -on. Therefore it should be useful to customize the default values and the -alists with useful alternatives, which are used from the mode in the -inserting functions for the links. +on. You may customize the default values and the alists with useful +alternatives, which are used from the mode in the inserting functions +for the links. @menu * Your Favourite HTTP Server:: -* Links to WWW Server:: +* Links to WWW Servers:: * Links To Files:: -* Links To FTP Server:: +* Links To FTP Servers:: * Links To Emacs Info Files:: -* Links To Gopher Server:: +* Links To Gopher Servers:: * Links To WAIS Gateways:: * Links To The Mail Gateway:: -* Links For Sending Mails:: -* Links To The Program Gateway :: +* Links For Sending Mail:: +* Links To The Program Gateway:: * Links To The Local Program Gateway:: * URL For Forms And Image Tags:: * Marking Of Examples:: @end menu -@node Your Favourite HTTP Server, Links to WWW Server, Defaults Used For Generating Links, Defaults Used For Generating Links +@node Your Favourite HTTP Server, Links to WWW Servers, Defaults Used For Generating Links, Defaults Used For Generating Links @comment node-name, next, previous, up @subsubsection Your Favourite HTTP Server @cindex favourite HTTP server @@ -565,7 +560,7 @@ @end itemize -@node Links to WWW Server, Links To Files, Your Favourite HTTP Server, Defaults Used For Generating Links +@node Links to WWW Servers, Links To Files, Your Favourite HTTP Server, Defaults Used For Generating Links @comment node-name, next, previous, up @subsubsection Links to WWW Server @cindex WWW server links @@ -585,11 +580,11 @@ @code{hm--html-html-path-alist}: Alist with directories for the HTML server. Each alist element must consist of a number and a directory string. The number is used to select the directory during the query -about the directory for a http link. +about the directory for an http link. @end itemize -@node Links To Files, Links To FTP Server, Links to WWW Server, Defaults Used For Generating Links +@node Links To Files, Links To FTP Servers, Links to WWW Servers, Defaults Used For Generating Links @comment node-name, next, previous, up @subsubsection Links To Files @cindex file gateway links @@ -598,15 +593,15 @@ @itemize @bullet @item @code{hm--html-file-path-alist}: Alist with directories for the file -gateway.Each alist element must consist of a number and a directory +gateway. Each alist element must consist of a number and a directory string. The number is used to select the directory during the query about the directory for a file link. @end itemize -@node Links To FTP Server, Links To Emacs Info Files, Links To Files, Defaults Used For Generating Links +@node Links To FTP Servers, Links To Emacs Info Files, Links To Files, Defaults Used For Generating Links @comment node-name, next, previous, up -@subsubsection Links To FTP Server +@subsubsection Links To FTP Servers @cindex FTP links @vindex hm--html-ftp-hostname:port-default @vindex hm--html-ftp-hostname:port-alist @@ -615,22 +610,22 @@ @itemize @bullet @item @code{hm--html-ftp-hostname:port-default}: Default hostname with port -for links to ftp server. This is the default FTP server. In general -you've not to specify a port for this. +for links to an ftp server. This is for the default FTP server. In general +you don't need to specify a port for this. @item @code{hm--html-ftp-hostname:port-alist}: Alist with hostnames and ports for links to ftp servers. It contains useful alternatives. In general -you've not to specify ports for the ftp servers. +you don't need to specify ports for the ftp servers. @item @code{hm--html-ftp-path-alist}: Alist with directories for the ftp server links. It contains useful alternatives with /pub, /pub/gnu and so on. Each alist element must consist of a number and a directory string. The number is used to select the directory during the query -about the directory for a ftp link. +about the directory for an ftp link. @end itemize -@node Links To Emacs Info Files, Links To Gopher Server, Links To FTP Server, Defaults Used For Generating Links +@node Links To Emacs Info Files, Links To Gopher Servers, Links To FTP Servers, Defaults Used For Generating Links @comment node-name, next, previous, up @subsubsection Links To Emacs Info Files @cindex emacs info links @@ -644,16 +639,16 @@ for the Info gateway. @item @code{hm--html-info-hostname:port-alist}: Alist with hostnames and ports -for the Info gateway. It contains useful alternatives. +for Info gateways. It contains useful alternatives. @item @code{hm--html-info-path-alist}: Alist with directories for the Info gateway. This may be a list with all of your emacs info directories. @end itemize -@node Links To Gopher Server, Links To WAIS Gateways, Links To Emacs Info Files, Defaults Used For Generating Links +@node Links To Gopher Servers, Links To WAIS Gateways, Links To Emacs Info Files, Defaults Used For Generating Links @comment node-name, next, previous, up -@subsubsection Links To Gopher Server +@subsubsection Links To Gopher Servers @cindex Gopher gateway links @vindex hm--html-gopher-hostname:port-default @vindex hm--html-gopher-hostname:port-alist @@ -661,37 +656,37 @@ @vindex hm--html-gopher-doctype-alist @vindex hm--html-gopher-anchor-alist -There are a lot of useful gopher information server in the Internet. +There are a lot of useful gopher information servers on the Internet. You can access them with a gopher browser or with a WWW browser. In the -second case you've to use the gopher gateway. +latter case you have to use the gopher gateway. @itemize @bullet @item @code{hm--html-gopher-hostname:port-default}: Default hostname with port -for links to gopher server. +for links to the default gopher server. @item @code{hm--html-gopher-hostname:port-alist}: Alist with hostnames and -ports for links to gopher server. It contains useful alternatives. +ports for links to gopher servers. It contains useful alternatives. @item -@code{hm--html-gopher-doctype-default}: For gopher links you've to +@code{hm--html-gopher-doctype-default}: For gopher links you have to specify the doctype. In most cases this should be the string \"/1\". -Therefore this is the default doctype, but you might change it to -another doctype. +Therefore this is the default doctype, but you can change it to +another. @item @code{hm--html-gopher-doctype-alist}: Alist with doctype strings for links -to gopher server. The strings \"/1\", \"/11\" and \"/00\" are the only -doctype strings that I know. Please let me know, if there are other +to a gopher server. The strings \"/1\", \"/11\" and \"/00\" are the only +doctype strings that I know. Please let me know if there are other strings. @item @code{hm--html-gopher-anchor-alist}: Alist with directories for links to -gopher server. It contains useful alternatives on the main gopher +a gopher server. It contains useful alternatives for the main gopher servers. Each alist element must consist of a number and a directory string. The number is used to select the directory during the query about the directory for a local program gateway link. @end itemize -@node Links To WAIS Gateways, Links To The Mail Gateway, Links To Gopher Server, Defaults Used For Generating Links +@node Links To WAIS Gateways, Links To The Mail Gateway, Links To Gopher Servers, Defaults Used For Generating Links @comment node-name, next, previous, up @subsubsection Links To WAIS Gateways @cindex WAIS gateway links @@ -701,13 +696,13 @@ @vindex hm--html-wais-servername:port-default @vindex hm--html-wais-path-alist -You can either make a link direct to a WAIS server (it may be, that not -all WWW browsers support this), or a http link to a server (relay host) +You can either make a link direct to a WAIS server (it may be that not +all WWW browsers support this) or an http link to a server (relay host) which queries the WAIS server. The variables @code{hm--html-wais-hostname:port-default} and -@code{hm--html-wais-hostname} refers to these relay hosts and the +@code{hm--html-wais-hostname} refer to these relay hosts and the variables @code{hm--html-wais-servername:port-default} and -@code{hm--html-wais-servername:port-alist} are refers to the WAIS servers. +@code{hm--html-wais-servername:port-alist} refer to the WAIS servers. @itemize @bullet @item @@ -728,7 +723,7 @@ @end itemize -@node Links To The Mail Gateway, Links For Sending Mails, Links To WAIS Gateways, Defaults Used For Generating Links +@node Links To The Mail Gateway, Links For Sending Mail, Links To WAIS Gateways, Defaults Used For Generating Links @comment node-name, next, previous, up @subsubsection Links To The Mail Gateway @cindex Mail gateway links @@ -737,8 +732,8 @@ @vindex hm--html-mail-hostname:port-alist @vindex hm--html-mail-path-alist -The following variables are for customizing the insert of links to mail -folder. You need a special server for this, which sends the emails back +The following variables are for customizing the insertion of links to a mail +folder. You need a special server for this, which sends the email back to the browser. @itemize @bullet @@ -750,16 +745,16 @@ for the mail gateway. It contains useful alternatives. @item @code{hm--html-mail-path-alist}: Alist with directories for the mail -gateway. In these directories you'll find probably mail folder. Each +gateway. In these directories you'll probably find mail folders. Each alist element must consist of a number and a directory string. The number is used to select the directory during the query about the directory for a mail folder link. @end itemize -@node Links For Sending Mails, Links To The Program Gateway , Links To The Mail Gateway, Defaults Used For Generating Links +@node Links For Sending Mail, Links To The Program Gateway, Links To The Mail Gateway, Defaults Used For Generating Links @comment node-name, next, previous, up -@subsubsection Links For Sending Mails +@subsubsection Links For Sending Mail @cindex mailto links @vindex hm--html-mailto-alist @@ -771,7 +766,7 @@ @end itemize -@node Links To The Program Gateway , Links To The Local Program Gateway, Links For Sending Mails, Defaults Used For Generating Links +@node Links To The Program Gateway, Links To The Local Program Gateway, Links For Sending Mail, Defaults Used For Generating Links @comment node-name, next, previous, up @subsubsection Links To The Program Gateway @cindex program gateway links @@ -781,9 +776,9 @@ The program gateway is a special TNT site specific gateway for starting programs out of a html page. The programs are started by a special -server, which looks in an allowed file, to determine if it is allowed to -start the program. This is necessary, because the programs are running -under the user id of the server. We've only allowed to start simple +server, which looks in an allowed file to determine if it is allowed to +start the program. This is necessary because the programs are running +under the user id of the server. We're only allowed to start simple display programs like man, ls and so on. @itemize @bullet @@ -799,7 +794,7 @@ @end itemize -@node Links To The Local Program Gateway, URL For Forms And Image Tags, Links To The Program Gateway , Defaults Used For Generating Links +@node Links To The Local Program Gateway, URL For Forms And Image Tags, Links To The Program Gateway, Defaults Used For Generating Links @comment node-name, next, previous, up @subsubsection Links To The Local Program Gateway @cindex local program gateway links @@ -866,7 +861,7 @@ @vindex hm--html-frame-template-file @vindex hm--html-automatic-expand-templates -For inserting html template files you can customize, where you've your +For inserting html template files you can customize where you keep your templates. @itemize @bullet @@ -874,14 +869,14 @@ @code{hm--html-template-dir}: A directory with template files. It is now also possible to use it as a list of directories. Look at the variable @code{tmpl-template-dir-list} for further descriptions. If this -variable is set to a non existing directory, than it is set to a -directory, where the package in the XEmacs is. This is done during +variable is set to a non-existent directory, then it defaults to the +directory where the package is in XEmacs. This is done during loading the file @file{hm--html-configuration.el} (@xref{Where Are All The Customization Variables Defined, Where Are All The Customization -Variables Defined}.). This may only be useful, in the XEmacs >= 19.12. +Variables Defined}.). This may only be useful in XEmacs >= 19.12. @item -@code{hm--html-frame-template-file}: File, which is used as template for -a html frame. Such a file is in the package +@code{hm--html-frame-template-file}: File which is used as template for +a html frame. An example is in the package @emph{hm--html-menus}. @xref{Contents, Contents}. @item @code{hm--html-automatic-expand-templates}: Automatic expansion of @@ -902,15 +897,15 @@ @itemize @bullet @item -@code{hm--html-delete-wrong-path-prefix}: If non nil, it specifies path-prefixes, which should be deleted in paths. +@code{hm--html-delete-wrong-path-prefix}: If non-nil, it specifies path-prefixes which should be deleted in paths. The Sun automounter adds a temporary prefix to the automounted directories - (At our site the prefix is /tmp_mnt). But you can't select such a path, -if the automounter has currently not mounted the directory and so you -can't follow a html-link, which consists of such a path. To overcome + (at our site the prefix is /tmp_mnt). But you can't select such a path +if the automounter has currently not mounted the directory, and so you +can't follow an html link which consists of such a path. To overcome this behaviour, you can set this variable to the prefix -(eg "/tmp_mnt"). After that, the prefix should be stripped from the +(e.g. "/tmp_mnt"). After that, the prefix should be stripped from the paths during the creation of the links. ATTENTION: This variable is -used as regular expression ! It can be set to a string or to a list of +used as a regular expression! It can be set to a string or to a list of strings. @end itemize @@ -925,8 +920,8 @@ @vindex hm--html-automatic-changed-comment @vindex hm--html-automatic-created-comment -The @code{hm--html-mode} automatic inserts some useful informations in -html pages. This behaviour could be changed by the following variables. +The @code{hm--html-mode} automatically inserts some useful information in +html pages. This behaviour can be changed by the following variables. @itemize @bullet @item @@ -953,8 +948,8 @@ @item @code{hm--html-bind-latin-1-char-entities}: Set this to nil, if you don't want to use the ISO Latin 1 character entities. This is only -useful, if `hm--html-use-old-keymap' is set to nil. It is only used -during loading the html package the first time. +useful if `hm--html-use-old-keymap' is set to nil. It is only used +when loading the html package the first time. @end itemize @@ -968,7 +963,7 @@ @itemize @bullet @item @code{hm--html-idd-create-relative-links}: If t, then the -@code{hm--html-idd-*} functions are creating relative links. Otherwise +@code{hm--html-idd-*} functions create relative links. Otherwise absolute links are used. The idd functions are used for drag and drop. @item @code{hm--html-idd-actions}: The action list for the destination mode @@ -1009,10 +1004,10 @@ @itemize @bullet @item @code{hm--html-minor-mode-prefix-key}: The prefix key for the key tables -in the @code{hm--html-minor-mode}. +in @code{hm--html-minor-mode}. @item @code{hm--html-mode-prefix-key}: The prefix key for the hm--html keys in -the @code{hm--html-mode}. +@code{hm--html-mode}. @end itemize @@ -1023,7 +1018,7 @@ @vindex hm--html-minor-mode-pulldown-menu-name @vindex hm--html-mode-pulldown-menu-name -It may be, that You'd like to change the names to get the same menu +Perhaps you'd like to change the names to get the same menu names in the major and in the minor modes of the @code{hm--html-menus} package. @@ -1048,11 +1043,11 @@ @itemize @bullet @item -@code{hm--html-mode-hook}: This hook will be called each time, when the +@code{hm--html-mode-hook}: This hook will be called each time @code{hm--html-mode} is invoked. @item @code{hm--html-load-hook}: Hook variable to execute functions after -loading the package +loading the package. @end itemize @@ -1063,10 +1058,10 @@ @vindex html-view-mosaic-command @vindex html-sigusr1-signal-value -The following two variables are only used, if you preview the html +The following two variables are only used, if you preview html documents with @code{Mosaic}. There are also some other variables in -@file{hmtl-view.el}, @xref{Contents, Contents}. Look at that file, if -you've trouble with the functions to preview the html document with the +@file{hmtl-view.el}. @xref{Contents, Contents}. Look at that file if +you have trouble with the functions to preview the html document with @code{Mosaic}. @itemize @bullet @@ -1077,7 +1072,7 @@ @code{html-sigusr1-signal-value}: Value for the SIGUSR1 signal on your system. See, usually, @file{/usr/include/sys/signal.h}. @example - SunOS 4.1.x : (setq html-sigusr1-signal-value 30) + SunOS 4.1.x : (setq html-sigusr1-signal-value 30) SunOS 5.x : (setq html-sigusr1-signal-value 16) Linux : (setq html-sigusr1-signal-value 10)) @end example @@ -1112,9 +1107,9 @@ @itemize @bullet @item -@code{hm--html-disable-indentation}: Set this to t, if you want to -disable the indentation in the @code{hm--html-mode}. And may be send me -(@emph{muenkel@@tnt.uni-hannover.de}) a note, why you've done this. +@code{hm--html-disable-indentation}: Set this to t if you want to +disable indentation in @code{hm--html-mode}. And maybe send me +(@emph{muenkel@@tnt.uni-hannover.de}) a note why you did this. @item @code{hm--html-inter-tag-indent}: The indentation after a start tag. @item @@ -1123,11 +1118,11 @@ @code{hm--html-intra-tag-indent}: The indentation after the start of a tag. @item -@code{hm--html-tag-name-alist}: An alist with tag names known by the -@code{hm--html-mode}. It is used to determine, if a tag is a one element +@code{hm--html-tag-name-alist}: An alist with tag names known by +@code{hm--html-mode}. It is used to determine if a tag is a one element tag or not. In the future it should also be used to get possible parameters of the tag. Use lower case characters in this list!!!! If -you've problems with the indentation of +you have problems with the indentation of @code{:hm--html-one-or-two-element-tag} elements, then you should set them to either @code{:hm--html-one-element-tag} or @code{:hm--html-two-element-tag}, depending on how you use these @@ -1143,9 +1138,9 @@ @cindex non standard html @vindex hm--html-tag-name-alist -If you'd like to add new HTML elements to this package, you should take -at first a look at the file @file{hm--html-not-standard.el}, which -contains already some non standard elements. If you find your tags +If you'd like to add new HTML elements to this package, you should first take +a look at the file @file{hm--html-not-standard.el}, which +already contains some non-standard elements. If you find your tags there, you should uncomment the line @code{(require 'hm--html-not-standard)} in the file @file{hm--html-mode.el}. There are also menu entries for these elements in the file @@ -1157,29 +1152,29 @@ @enumerate @item -Search a tag, which is similar to the one you want to add. Similar -means, that it is inserted in the way you want to insert the new +Locate a tag which is similar to the one you want to add. "Similar" +means that it is inserted in the way you want to insert the new tags. Now let's assume, that you chose @samp{<strong></strong>}. @item Look at the file @file{hm--html.el} and search the function(s) which -inserts the "similar tags". If the HTML element consists of only one +inserts the similar tag(s). If the HTML element consists of only one tag, then there should be only one function for inserting the tag. If the element consists of a start and an end tag, there are at least two functions. Only in some special cases, if it is possible to insert -elements with different attribute values, there are more than two +elements with different attribute values, are there more than two functions. In the case of @samp{<strong></strong>}, there are the two functions @code{hm--html-add-strong} and -@code{hm--html-add-strong-to-region}. The first one is used, if no -region is active and the second if a region is active. The naming scheme -of these functions are always @var{hm--html-add-<tagname>} and +@code{hm--html-add-strong-to-region}. The first one is used if no +region is active, and the second if a region is active. The naming scheme +of these functions is always @var{hm--html-add-<tagname>} and @var{hm--html-add-<tagname>-to-region}. @var{<tagname>} is not in all -cases the tagname. Sometimes a more human readable name is used (eg: +cases the tagname. Sometimes a more human readable name is used (e.g. bold instead of b). @item To get the right indentation for the new tags you should add an entry -for it to the variable @code{hm--html-tag-name-alist}, which is defined -in @file{hm--html-configuration.el}. Lets assume, that the new tagname -is @samp{foo}, then the entry in @code{hm--html-tag-name-alist} should +for them to the variable @code{hm--html-tag-name-alist}, which is defined +in @file{hm--html-configuration.el}. Let's assume that the new tagname +is @samp{foo}. The entry in @code{hm--html-tag-name-alist} should be @lisp ("foo" (:hm--html-one-element-tag t)) @@ -1194,8 +1189,8 @@ @lisp ("foo" (:hm--html-one-or-two-element-tag t)) @end lisp -if the new element consists of two tags, but it is allowed to use the -start tag without it's end tag (@samp{p} is such an element). +if the new element consists of two tags, but it is permissible to use the +start tag without its end tag (@samp{p} is such an element). @end enumerate Now you are ready and able to insert the new tags with @@ -1207,11 +1202,11 @@ M-x hm--html-add-foo-to-region @end example -But if you want to add the new commands also to the popup menu, -then you've to take a look at @file{hm--html-menu.el}, where all the +If you want to add the new commands also to the popup menu, +then you have to take a look at @file{hm--html-menu.el}, where all the menus are defined. Look at @code{hm--html-menu-noregion-expert} and -@code{hm--html-menu-region-expert}. The first one is used, if no region is -active and the second, if a region is active (both are only used, +@code{hm--html-menu-region-expert}. The first one is used if no region is +active, and the second if a region is active (both are only available if the "expert menus" are used; this is an option in the pulldown menu). You should now add an entry like @lisp @@ -1226,12 +1221,12 @@ whole variable to a new value or by using the function @code{add-menu-button}. I recommend the last method. -If you'd like to have also a key sequence for inserting the new tag, -then you've to take a look at @file{hm--html-keys.el}. There are +If you'd like to have a key sequence for inserting the new tag as well, +take a look at @file{hm--html-keys.el}. There are different key tables defined for region and no region cases and for different sorts of elements, like anchors, frame elements (doesn't mean the Netscape element frame) and so on. These "groups" are the same as -the sub menu groups. +the submenu groups. @node Use With psgml-html, Internal Drag And Drop, Add New Elements, Top @@ -1242,11 +1237,11 @@ The package provides a minor mode called @code{hm--html-minor-mode}, which could be used to join the features of this package with another -HTML package. Currently this is only tested with the psgml html mode in -the XEmacs. Please let me know, if it works or not with other packages -or in the Emacs 19. +HTML package. Currently this is only tested with the psgml-html mode in +XEmacs. Please let me know if it works or not with other packages +or in Emacs 19. -If you'd like to use the minor mode in the psgml html mode, you've to +If you'd like to use the minor mode in psgml-html mode, put the following line in your @file{.emacs}: @lisp @@ -1254,10 +1249,10 @@ @end lisp Note: This should work only in XEmacs versions greater than 19.14 and not -in 20.0. It doesn't work in other versions, because the hook variable -@code{html-mode-hook} exists not in that versions. Therefore in that -versions you've to called the minor mode either by hand or change the -lisp file of the psgml html mode. +in 20.0. It doesn't work in other versions because the hook variable +@code{html-mode-hook} doesn't exist in those versions. Therefore in those +versions you must either call the minor mode by hand or change the +lisp file of the psgml-html mode. @node Internal Drag And Drop, Template Minor Mode, Use With psgml-html, Top @@ -1269,13 +1264,13 @@ @vindex hm--html-idd-actions -The file @file{internal-drag-and-drop.el}, which is shipped with the +The file @file{internal-drag-and-drop.el}, which is shipped with @file{hm--html-menus}, provides a general package for internal drag and -drop in the emacs. General means, that it can be used also without the +drop in emacs. "General" means that it can be used apart from @code{hm--html-mode} in any other mode. You can start such an action by clicking with the mouse in the source -buffer and then in the destination buffer. The action could depend on +buffer and then in the destination buffer. The action may depend on the points where you've clicked with the mouse, on the state of the region, the point, the mark and any other properties of the source and the destination buffers. The actions are defined by the variable @@ -1293,12 +1288,12 @@ @cindex customization @cindex configuration -The internal drag and drop functions could be used in all -modes. Therefore it's general customization isn't done in -@file{hm--html-configuration.el}. It's variables are defined in the file +The internal drag and drop functions may be used in all +modes. Therefore their general customization isn't done in +@file{hm--html-configuration.el}. Its variables are defined in the file @file{internal-drag-and-drop.el} instead. You can set them in your -@file{.emacs} or in one of the other emacs init files (eg: -@file{default.el}). The following subsections describes the main +@file{.emacs} or in one of the other emacs init files (e.g. +@file{default.el}). The following subsections describe the main customization variables. @@ -1314,9 +1309,9 @@ @cindex drag and drop actions @vindex idd-actions -The drag and drop actions are commands, which are called after an -internal drag and drop. They depends from the source and the destination -of the drag and drop. Drag and drop actions must be defined by the +The drag and drop actions are commands which are called after an +internal drag and drop. They depend on the source and the destination +of the drag and drop. Drag and drop actions are defined by the variable: @itemize @bullet @@ -1356,9 +1351,9 @@ @end table @end lisp -The @var{<specification-type>} - functions must have two arguments, the +The @var{<specification-type>} - functions must have two arguments. The first one is the source or destination and the second is the -@var{<value>}. It must return @code{nil}, if the test wasn't successful +@var{<value>}. It must return @code{nil}, if the test wasn't successful, and a number (in general 1), which specifies the weight of the test function. The weights of all single tests are added to a summary weight and assigned to the action. The action with the highest weight is called @@ -1378,17 +1373,17 @@ matches. @code{idd-actions} is a buffer local variable, which should be at least mode depended. So if the @var{<destination-specification-1>} is set to @code{nil} it says, that the destination buffer must only have a -specific mode. But however, it's also possible to define a general +specific mode. However, it's also possible to define a general @code{idd-actions} list, where the destination mode is specified by @code{idd-if-major-mode-p}. -@var{<action>} is a function, which has two arguments, the first +@var{<action>} is a function which has two arguments. The first specifies the source and the second the destination. Look at the function definition of @code{idd-action-copy-region} and @code{idd-action-copy-replace-region}. They are examples for such actions. -The following is an example for the @code{hm--html-mode}: +The following is an example for @code{hm--html-mode}: @lisp (defvar idd-actions @@ -1421,7 +1416,7 @@ @findex idd-mouse-drag-and-drop @findex idd-help-mouse-drag-and-drop -There are the following three variables, which determines the mouse +The following three variables determine the mouse bindings and the mouse behaviour for the internal drag and drop package: @itemize @bullet @@ -1432,14 +1427,14 @@ package @file{internal-drag-and-drop} to these keys in the @b{global keymap}. The drag and drop action @b{must be bound global}, because the drag and drop action must be started by a click in the source -buffer. Therefore no action will be performed, if the mouse keys are not +buffer. Therefore no action will be performed if the mouse keys are not bound to @code{idd-mouse-drag-and-drop} in the destination buffer. Set it to @code{nil}, if you don't want to bind this function during loading. If the command is already bound in the global keymap during loading, -then this key sequence will not be bind. +then this key sequence will not be bound. By default the mouse binding is @key{meta} @key{control} @key{button1}. @@ -1447,29 +1442,29 @@ @code{idd-global-help-mouse-keys}: The mouse keys for the command @code{idd-help-mouse-drag-and-drop}. The command @code{idd-help-mouse-drag-and-drop} is bound during the loading of the -package @file{internal-drag-and-drop} to this keys in the @b{global +package @file{internal-drag-and-drop} to these keys in the @b{global keymap}. -Set it to @code{nil}, if you don't want to bind this function during +Set it to @code{nil} if you don't want to bind this function during loading. If the command is already bound in the global keymap during loading, -then this key sequence will not be bind. +then this key sequence will not be bound. By default the mouse binding is @key{meta} @key{control} @key{button3}. @item @code{idd-drag-and-drop-mouse-binding-type}: The type of the drag and -drop mouse binding. The value maybe @code{click} or -@code{press-button-during-move}. A value of @code{click} means, that -you've to click over the source, leave the button and click it again -over the destination. A value of @code{press-button-during-move} means, -that you've to press the button down over the source and hold it until +drop mouse binding. The value may be @code{click} or +@code{press-button-during-move}. A value of @code{click} means that +you have to click over the source, release the button and click it again +over the destination. A value of @code{press-button-during-move} means +that you have to press the button down over the source and hold it until the mouse pointer is over the destination. The @emph{disadvantage} of the @code{press-button-during-move} type -compared with the @code{click} type is, that you can't select a destination -region and therefore a drag and drop action depending on a selected +compared with the @code{click} type is that you can't select a destination +region, and therefore a drag and drop action depending on a selected region can't be started with that type of mouse binding. @end itemize @@ -1478,9 +1473,9 @@ @section The Drag And Drop Commands @cindex drag and drop commands -There are 2 groups of commands. The first one contains commands, which -performs the drag and drop action and the second displayed a help -message about a possible drag and drop action. +There are 2 groups of commands. The first contains commands which +perform the drag and drop action and the second displays help +messages about a possible drag and drop action. @menu @@ -1500,7 +1495,7 @@ @findex idd-help-start-action @vindex idd-drag-and-drop-mouse-binding-type -There are the following five different commands, which performs internal +The following five commands perform internal drag and drop actions: @itemize @bullet @@ -1510,17 +1505,17 @@ @code{idd-mouse-drag-and-drop-press-button-during-move} depending on the value of @code{idd-drag-and-drop-mouse-binding-type}. However you've set this, you start a drag and drop action with this command by pressing -down it's mouse button over the source. This command is bind by default +down its mouse button over the source. This command is bound by default to a global mouse key sequence. @xref{The Mouse Bindings}. @item @code{idd-start-mouse-drag-and-drop}: Starts a drag and drop command. This command could be used to start a drag and drop command without a -button event. Therefore this should not be bind direct to a mouse +button event. Therefore this should not be bound directly to a mouse button. This command can be used to start a drag and drop action with a -click on a menu item or tool bar icon. After that you've to press down a +click on a menu item or tool bar icon. After that you have to press a mouse button over the source. The rest depends on the value of -@code{idd-drag-and-drop-mouse-binding-type}, like with the command +@code{idd-drag-and-drop-mouse-binding-type}, as with the command @code{idd-mouse-drag-and-drop}. @item @@ -1533,9 +1528,9 @@ @item @code{idd-mouse-drag-and-drop-press-button-during-move}: Performs a drag and drop action in a more traditional way than -@code{idd-mouse-drag-and-drop-click}. At first you must press the button -down over the source and then move with the pressed button to the -destination, where you must leave the button up. This must be bind to a +@code{idd-mouse-drag-and-drop-click}. First you press the button +over the source and then move with the depressed button to the +destination, where you release the button. This must be bound to a mouse button. The @code{SOURCE-EVENT} must be a @code{button-press-event}. @@ -1545,19 +1540,19 @@ You should bind the command @code{idd-mouse-drag-and-drop} instead of this one, because it's then possible to switch between both drag and -drop behaviour by changing only one variable. +drop behaviours by changing only one variable. @item @code{idd-mouse-drag-and-drop-click}: Performs a drag and drop action in a more useful way than -@code{idd-mouse-drag-and-drop-press-button-during-move}. At first you -must click on the source and after that on the destination. This must -be bind to a mouse button. The @code{SOURCE-EVENT} must be a +@code{idd-mouse-drag-and-drop-press-button-during-move}. First you +click on the source and then on the destination. This must +be bound to a mouse button. The @code{SOURCE-EVENT} must be a @code{button-press-event}. You should bind the command @code{idd-mouse-drag-and-drop} instead of this one, because it's then possible to switch between both drag and -drop behaviour by changing only one variable. +drop behaviours by changing only one variable. @end itemize @@ -1570,24 +1565,24 @@ @findex idd-start-help-mouse-drag-and-drop It's possible to display a buffer with a help message describing the -action before actually performing it. To perform the action, you've then -to click on a special extent in the help buffer. To get the help buffer, -you've to do the same things, as you've to do to perform the action -direct. Only the mouse key differs. There are two commands for this: +action being considered before actually performing it. To perform the +action, you then click on a special extent in the help buffer. To get +the help buffer, you do the same things as you do to perform the action +itself. Only the mouse key differs. There are two commands for this: @itemize @bullet @item @code{idd-help-mouse-drag-and-drop}: Displays help about the drag and -drop action. It works similar as @code{idd-mouse-drag-and-drop} +drop action. It works similarly to @code{idd-mouse-drag-and-drop} (@pxref{Performing The Drag And Drop Action}). -By default this command is global bound to @key{meta} @key{control} -@key{button3}. This could be changed with the variable +By default this command is globally bound to @key{meta} @key{control} +@key{button3}. This may be changed with the variable @code{idd-global-help-mouse-keys} (@pxref{The Mouse Bindings}). @item @code{idd-start-help-mouse-drag-and-drop}: Starts displaying help about -the drag and drop action. It works similar as +the drag and drop action. It works similarly to @code{idd-start-mouse-drag-and-drop} (@pxref{Performing The Drag And Drop Action}) and can be used to start the help by clicking on a menu item or a tool bar icon. @@ -1603,7 +1598,7 @@ of the package @emph{hm---html-menus}. It provides functions to use templates for the @code{hm--html-mode} and also for other modes. It needs nothing from the rest of the package and therefore it can be used -independently of the @code{hm--html-mode}. +independently of @code{hm--html-mode}. @menu @@ -1621,10 +1616,10 @@ @findex tmpl-expand-templates-in-buffer @findex tmpl-expand-templates-in-region -Templates are special pieces of text, which can be expanded by the -emacs. Expansion means, that the template is replaced by something else, -which is determined by evaluating lisp forms or emacs commands. The -expansion can be done automaticly after the insert of templates +Templates are special pieces of text, which can be expanded by +emacs. Expansion means that the template is replaced by something else, +determined by evaluating lisp forms or emacs commands. The +expansion can be done automatically after the insertion of templates with the command @code{tmpl-insert-template-file} in a buffer or by hand with the commands @code{tmpl-expand-templates-in-buffer} or @code{tmpl-expand-templates-in-region}. @@ -1653,7 +1648,7 @@ C-SPC}. You can also use any other character or string of characters by changing the variable @code{tmpl-sign}. -At the moment, there are 3 different mayor types of templates: +At the moment, there are 3 major types of templates: @enumerate @item @@ -1665,7 +1660,7 @@ ^@@LISP^@@ (insert-file "~/.emacs") ^@@END LISP^@@ @end lisp -It inserts the contents of the file @file{~/.emacs} in the current +inserts the contents of the file @file{~/.emacs} in the current buffer during the expansion. @item @@ -1677,7 +1672,7 @@ ^@@COMMAND^@@ insert-file ^@@END COMMAND^@@ @end lisp -It runs the interactive command @code{insert-file} during the expansion. +runs the interactive command @code{insert-file} during the expansion. @item @emph{Template comments} Nothing will be evaluated during the expansion @@ -1691,7 +1686,7 @@ syntax as a lisp or C++ comment. @end enumerate -The default is, that a template will be deleted after its expansion, but +By default, a template will be deleted after its expansion, but without the linefeed. Look at the following examples: Before the expansion: @@ -1709,13 +1704,13 @@ Line after the template -Templates can start in every column and only the template will be deleted +Templates can start in any column, and only the template will be deleted after its expansion. -There is also the possibility to put an attribute list in a template. The -attributes of the list are controlling the deletion of the template. It -may be, that this will be extended in the future with other attributes. +It is also possible to put an attribute list in a template. The +attributes of the list control the deletion of the template. It +may be that this will be extended in the future with other attributes. The attribute list must be specified as an alist (assoc list) in the start tag of a template and after its type. Each element of the alist consists of the name of the attribute following its value. @@ -1724,9 +1719,9 @@ @enumerate @item @emph{don't delete attribute} (@code{DONT_DELETE}): If the value -is t, then the template will not be deleted after its expansion or else -if the value is nil then the template will be deleted. The default is -nil. For example: +is t, then the template will not be deleted after its expansion. If the +value is nil then the template will be deleted. The default is nil. For +example: Before the expansion: @@ -1746,10 +1741,9 @@ It was assumed, that the file @file{~/.cshrc} was empty ! -@item -@emph{delete line attribute} (@code{DELETE-LINE}): If the value is t, -then the linefeed before or after the template will be deleted or else -if the value is nil then no linefeed will be deleted. The default is +@item @emph{delete line attribute} (@code{DELETE-LINE}): If the value is +t, then the linefeed before or after the template will be deleted. If +the value is nil then no linefeed will be deleted. The default is nil. For example: Before the expansion: @@ -1770,7 +1764,7 @@ It was assumed, that the file @file{~/.cshrc} was empty ! @end enumerate -The attributes can be combined. For example: +These attributes can be combined. For example: @example ^@@COMMAND ((DELETE-LINE t) (DONT-DELETE nil))^@@ @@ -1778,10 +1772,10 @@ ^@@END COMMAND^@@ @end example -The last examples shows also, that whitespaces (blanks, tabs, linefeeds) -are allowed at the most positions in a template. +The last examples show also that whitespace (blanks, tabs, linefeeds) +is allowed at most positions in a template. -Look at the file @file{tmpl-minor-mode.el}, for a description of the +Look at the file @file{tmpl-minor-mode.el} for a description of the commands to expand templates. @@ -1796,11 +1790,11 @@ @vindex tmpl-sign @vindex tmpl-minor-mode-map -Templates could be used for all editing modes and not only for the -@code{hm--html-mode}. Therefore it's general customization isn't done in -@file{hm--html-configuration.el}. It's variables are defined in the file +Templates may be used for all editing modes, not only for +@code{hm--html-mode}. Therefore their general customization isn't done in +@file{hm--html-configuration.el}. Template variables are defined in the file @file{tmpl-minor-mode.el} instead. You can set them in your -@file{.emacs} or in one of the other emacs init files (eg: +@file{.emacs} or in one of the other emacs init files (e.g. @file{default.el}). The following are the main variables for customization. @@ -1815,27 +1809,27 @@ @code{tmpl-insert-template-file-from-fixed-dirs} and at @code{tmpl-insert-template-file}. The command @code{tmpl-insert-template-file} uses only the car of the list (if it is -a list).") +a list.) @item -@code{tmpl-filter-regexp}: It determines an regular expression used for -filtering out non template files in template directories. It is used in +@code{tmpl-filter-regexp}: This defines a regular expression used for +filtering out non-template files in template directories. It is used in the command @code{tmpl-insert-template-file-from-fixed-dirs} to allow -only the selecting of files, which are matching the regexp. If it is +only the selection of files which match the regexp. If it is nil, then the Filter @code{".*\\.tmpl$"} is used. Set it to @code{\".*\"} if you want to disable the filter function or use the command @code{tmpl-insert-template-file}. @item @code{tmpl-automatic-expand}: If you insert a template file with @code{tmpl-insert-template-file-from-fixed-dirs} or with -@code{tmpl-insert-template-file}, this variable is used. In this case -the templates in the buffer will be automaticly expanded, if the -variable is set to t, which is the default. +@code{tmpl-insert-template-file}, this variable is used. The templates +in the buffer will be automatically expanded if the variable is set to +t, which is the default. @item -@code{tmpl-sign}: It determines the sign which marks the beginning and +@code{tmpl-sign}: Thisdetermines the sign which marks the beginning and the end of template expressions. By default it is set to the null -character (displayed in the emacs as ^@@). You can also set this to a -string. Be careful, if you change it, so that the templates will not be -mixed up with other non template text! Note: The expansion function +character (displayed in emacs as ^@@). You can also set this to a +string. Be careful if you change it, so that the templates will not be +mixed up with other non-template text! Note: The expansion function looks at the whole template, so that it is very unlikely that the function will make a mistake. @item @@ -1873,22 +1867,23 @@ @item @code{tmpl-insert-template-file}: This command can be used to insert a template file in the current buffer. It will expand the templates in the -buffer, if @code{tmpl-automatic-expand} is set to @code{t}. You can set +buffer if @code{tmpl-automatic-expand} is set to @code{t}. You can set a default directory for this command by setting the variable -@code{tmpl-template-dir-list}, @xref{Template Customization}. +@code{tmpl-template-dir-list}. @xref{Template Customization}. @item -@code{tmpl-insert-template-file-from-fixed-dirs}: The difference to the -simpler command @code{tmpl-insert-template-file} is, that this command -will build a list for filename completion from a list of predefined -directories (look at @code{tmpl-template-dir-list}). The filename -completion list will also be filtered with the regular expression -defined by @code{tmpl-filer-regexp}. @xref{Template Customization}. You -can set the directory list and/or the filter different in each mode, -where you use templates, so that you will get only template files in the -completion list, which could be used for the current mode. +@code{tmpl-insert-template-file-from-fixed-dirs}: The difference from +the simpler command @code{tmpl-insert-template-file} is that this +command will build a list for filename completion from a list of +predefined directories (look at @code{tmpl-template-dir-list}). The +filename completion list will also be filtered with the regular +expression defined by @code{tmpl-filer-regexp}. @xref{Template +Customization}. You can set the directory list and/or the filter +differently in each mode where you use templates, so that you will get +in the completion list only template files which could be used for the +current mode. If you want to insert a template file with this command, which is not in -one of the directories from @code{tmpl-template-dir-list}, then you've +one of the directories from @code{tmpl-template-dir-list}, then you have to enter the string @emph{"Change the directory"} instead of a template file. This string is also in the completion list. @end itemize @@ -1908,23 +1903,23 @@ @findex tmpl-expand-templates-in-region @findex tmpl-expand-templates-in-buffer -You can expand templates by hand or automaticly after their -insert. @xref{Insert Of Template Files}, for automatic -expansion. The expansion by hand can be done with one of the +You can expand templates by hand or automatically after their +insertion. @xref{Insert Of Template Files}, for automatic +expansion. Expansion by hand can be done with one of the following two functions: @itemize @bullet @item @code{tmpl-expand-templates-in-region}: Expands the templates in the -region. The region is determined by it's optional arguments @code{BEGIN} +region. The region is established by the optional arguments @code{BEGIN} and @code{END}. If the arguments are @code{nil}, or if the function is called -interactive, then the current region will be used. +interactively, then the current region will be used. @item @code{tmpl-expand-templates-in-buffer}: Expands all templates in the current buffer. @end itemize -Both commands are bind to keys in the @code{tmpl-minor-mode}. @xref{The +Both commands are bound to keys in the @code{tmpl-minor-mode}. @xref{The Template Minor Mode}. @@ -1939,24 +1934,24 @@ It is possible to escape template signs in a buffer or in a region. Templates with escaped template signs are not expanded, but they are un-escaped by the expansion functions. Therefore it is possible to -prevent single templates from the expansion by escaping them. Note: -You can't escape template twice. The commands, which can be used for +exclude single templates from the expansion by escaping them. Note: +You can't escape a template twice. The commands which can be used for this are: @itemize @bullet @item -@code{tmpl-escape-tmpl-sign-in-region}: Escapes all @code{tmpl-sign}'s +@code{tmpl-escape-tmpl-sign-in-region}: Escapes all @code{tmpl-sign}s (@pxref{Template Customization}) with a @code{tmpl-sign} in a -region. The region is determined by it's optional arguments @code{BEGIN} +region. The region is established by the optional arguments @code{BEGIN} and @code{END}. If the arguments are @code{nil}, or if the function is -called interactive, then the current region will be used. +called interactively, then the current region will be used. @item @code{tmpl-escape-tmpl-sign-in-buffer}: Same as @code{tmpl-escape-tmpl-sign-in-region}, but escapes all templates in the whole buffer. @end itemize -Both commands are bind to keys in the @code{tmpl-minor-mode}. @xref{The +Both commands are bound to keys in @code{tmpl-minor-mode}. @xref{The Template Minor Mode}. @@ -1971,13 +1966,13 @@ The template minor mode can be toggled with the command @code{tmpl-minor-mode}. The purpose of this mode is only to provide key bindings for some of the commands of the package -@file{tmpl-minor-mode}. So if you don't want to use the key bindings, you +@file{tmpl-minor-mode}. If you don't want to use the key bindings, you don't need this minor mode. Look at the key table @code{tmpl-minor-mode-map} (@pxref{Template Customization}) for the definition of the keys. -It may be, that I'll provide also a pulldown or popup menu for the minor +It may be that I'll also provide a pulldown or popup menu for the minor mode in a future release. @@ -1988,7 +1983,7 @@ @findex hm--html-submit-bug-report There's no software out there without bugs. This package contains -software, therefore it has bus. I (Heiko Münkel +software, therefore it has bugs. I (Heiko Münkel <muenkel@@tnt.uni-hannover.de>) have inserted most of the bugs in this package by myself, but I've forgotten where. So please help me out of this disaster and send bug reports, if you've found one of these little @@ -2002,15 +1997,15 @@ There's also an entry in the pulldown menu for this. -In some cases a backtrace would also be fine. +In some cases a backtrace would also be appropriate. -If you can't send the report with this function, than you should at -least insert the package version and your @code{Emacs}/@code{XEmacs} +If you can't send the report with this function, at +least include the package version and your @code{Emacs}/@code{XEmacs} version. -In the best of all worlds you include also a patch to fix the bug. +In the best of all worlds you would also include a patch to fix the bug. -@emph{Note}: It's not true, that I've inserted the bugs as a marketing trick, +@emph{Note}: It's not true that I've inserted the bugs as a marketing trick, so that you must buy the next version to get some of them fixed. This is false, because this software is free.