Zsh Mailing List Archive
Messages sorted by: Reverse Date, Date, Thread, Author

Re: zsh.texi commentary (actually, HTML pages commentary)



On Fri, 21 Jun 1996, Bart Schaefer wrote:

> On Jun 20,  3:03pm, Mark Borges wrote:
> } Subject: Re: zsh-2.6-beta21 released
> }
> } I've applied this patch and re-generated the html files via
> } texi2html-1.50. The URL is still
> } 
> } 	http://www.mal.com/zsh/Doc/test/
> } 
> } where zsh.texi.gz is version 2.03.
> 
> I think maybe it should be clearer in the documents that 2.03 is the
> version number of the document and not the version of zsh to which it
> refers.  `Edition 2.0.3' on the TOC page is confusing.

OK. 'Edition 2.0.3' -> 'Document Edition 2.0.3'.
 
> For the rest of these comments, I don't know which need to change the
> man pages, the FAQ, zsh.texi, and/or all of them; but they're all from
> reading the HTML at the above URL.
> 
> I've scattered semi-related thoughts and commentary throughout, usually
> prefixed with "Aside:".
> 
> 
> Intro section:
> 
> <pf@xxxxxxxxxx> hasn't been a usable address for Paul since almost two
> years ago.  He's now <pf@xxxxxxxxxxxx>.

OK. This is updated.

> Spell checking still hasn't happened ... "defauly"?

That particular mistake was corrected in 2.0.1, is not in 2.0.2 (in the
beta21 dist), so I've no idea why that should still be there if Mark has
updated his HTML from 2.0.3. Mark ?
 
> Shell Grammar section:
 
> Spell checking again ... "anexternal" --> "an external".

Again, Mark needs to update/fix HTML ???? 
 
> Further, the whole section could benefit from some vertical white space
> between defined terms.  Looks like it's there in the source but gets
> squashed out when displayed.  I suppose its a texi2html problem (some
> strategic <br> need to be output).

Yes, the info and printed tex are formatted correctly, so I guess the
problem is with texi2html.
 
> The paragraph on Comments still refers to HISTCHARS; it's now histchars.

Fixed.

> texi2html is still having problems with pairs of single quotes (''),
> rendering that as a double quote (").

Having just d/l'd texi2html, the solution to this one would seem to be to
run it with the '-expandinfo' option.
 
> Expansion section:

> I'd love it if there were more hrefs, e.g. from every reference to an
> option name to the description of that option, or from a builtin's name
> to its description.  E.g., in the sentence:
>     The PUSHD_MINUS option exchanges the effects of ~+ and ~-
>     where they are followed by a number.
> It'd be great to be able to click on PUSHD_MINUS.

I'll give this some thought when I get home this evening.
 
Clive.
-- 
C Messer. Epos Systems. UK.  |
<clive@xxxxxxxxxxxxxxxx>     |   "I pressed her thigh and death smiled."
<clive@xxxxxxxxxxxxxxxxxx>   |    Jim Morrison.                       
--- zsh.texi-2.0.3	Thu Jun 20 00:30:35 1996
+++ zsh.texi	Fri Jun 21 13:26:20 1996
@@ -10,13 +10,13 @@
 @afourpaper
 @end iftex
 
-@set EDITION 2.0.3
+@set EDITION 2.0.4
 @set VERSION 2.6.21
-@set UPDATED 20 June 1996
+@set UPDATED 21 June 1996
 
 @ifinfo
 @noindent
-Edition @value{EDITION}, last updated @value{UPDATED},
+Document Edition @value{EDITION}, last updated @value{UPDATED},
 of @cite{The Z Shell Guide}, for zsh, Version @value{VERSION}.
 
 This is a texinfo version of the man page for the Z Shell, originally by 
@@ -27,13 +27,13 @@
 
 @titlepage
 @title The Z Shell
-@subtitle Edition @value{EDITION} 
+@subtitle Document Edition @value{EDITION} 
 @subtitle @value{UPDATED}
 @author Originally by Paul Falstad
 @page
 @vskip 0pt plus 1filll
 @noindent
-Edition @value{EDITION}, last updated @value{UPDATED},
+Document Edition @value{EDITION}, last updated @value{UPDATED},
 of @cite{The Z Shell Guide}, for zsh, Version @value{VERSION}.
 
 This is a texinfo version of the man page for the Z Shell, originally by 
@@ -169,7 +169,7 @@
 @cindex author
 
 @noindent
-Zsh was originally written by Paul Falstad, @code{pf@@z-code.com}.
+Zsh was originally written by Paul Falstad, @code{pf@@software.com}.
 Programmable completion was implemented by Sven Wischnowsky,
 @code{oberon@@cs.tu-berlin.de} and Peter Stephenson,
 @code{P.Stephenson@@swansea.ac.uk}.  Richard Coleman,
@@ -670,8 +670,8 @@
 In non-interactive shells, or in interactive shells with the
 @code{INTERACTIVE_COMMENTS} option set, a word beginning with the third
 @pindex INTERACTIVE_COMMENTS, use of
-character of the @code{HISTCHARS} parameter (@code{#} by default) causes
-@vindex HISTCHARS, use of
+character of the @code{histchars} parameter (@code{#} by default) causes
+@vindex histchars, use of
 that word and all the following characters up to a newline to be
 ignored.
 
@@ -707,10 +707,10 @@
 preceding it with a @code{\}.  @code{\} followed by a newline is
 ignored.  All characters enclosed between a pair of single quotes
 @ifinfo
-(@code{@'@'}) are quoted, except the first character of @code{HISTCHARS}
+(@code{@'@'}) are quoted, except the first character of @code{histchars}
 @end ifinfo
 @iftex
-(@code{''}) are quoted, except the first character of @code{HISTCHARS}
+(@code{''}) are quoted, except the first character of @code{histchars}
 @end iftex
 (@code{!} by default).  A single quote cannot appear within single
 quotes.  Inside double quotes (@code{""}), parameter and command
@@ -6881,3 +6881,6 @@
 eg. "-f" to @samp, rather than @code.
 v2.0.2. June 13th 1996. Several fixes to Programmable Completion. 
 v2.0.3. June 20th 1996. Updated to include changes from 2.6.20 to 2.6.21.
+v2.0.4. June 21st 1996. Changed occurances of HISTCHARS to histchars.
+Changed mail address for Paul Falstad to pf@xxxxxxxxxxxxx
+'Edition' -> 'Document Edition' to save confusion with zsh version.


Messages sorted by: Reverse Date, Date, Thread, Author