Doc fixes - US vs. British spelling

Doc fixes - US vs. British spelling

[Kiddle, Oliver]

Following is a small patch to the documentation. Mostly it is changing
'initialise' to 'initialize'. If British spelling is generally prefered
then I can create a patch to do the change the other way. I just think
that we should be consistent. I did a grep for 'ise' and the only other
words this found were 'bitwise', 'otherwise' and 'recognise'. I haven't
got a US dictionary so can't confirm it but I'd guess that only the
latter would be spelt with a z in America. There are also some other
British spellings like behaviour and favour in there. 

Note that there are a couple of fixes in here which have nothing
to do with British vs. American spelling.

Oliver Kiddle

diff -u -r old/compsys.yo Zsh/compsys.yo
--- old/compsys.yo	Mon Jun 14 17:14:28 1999
+++ Zsh/compsys.yo	Wed Jun 16 23:06:44 1999
@@ -41,13 +41,13 @@
 tt($fpath) variable so that the functions can be autoloaded.
 
 startmenu()
-menu(Initialisation)
+menu(Initialization)
 menu(Control Functions)
 menu(Completion Functions)
 endmenu()
 
-texinode(Initialisation)(Control Functions)()(Completion System)
-sect(Initialisation)
+texinode(Initialization)(Control Functions)()(Completion System)
+sect(Initialization)
 
 The script tt(compinstall) can be run by a user to set up the completion
 system for use.  It will usually insert code into tt(.zshrc), although if
@@ -65,7 +65,7 @@
 completion functions are stored.  It will ask you various questions about
 how you would like completion set up.  It is in two parts; the basic part
 locates the completion files and decides where to put your personal
-dumpfile, used to speed up initialisation after the first time.  After
+dumpfile, used to speed up initialization after the first time.  After
 that, you will be asked if you wish to go on to the advanced set-up; if you
 answer tt(n), you can rerun tt(compinstall) later without having to
 re-enter any of the basic settings.
@@ -79,7 +79,7 @@
 the current session when run directly by the user; if you have run
 tt(compinstall) it will be called automatically from your tt(.zshrc).
 
-To initialise the system, the script tt(compinit) should be sourced with
+To initialize the system, the script tt(compinit) should be sourced with
 `tt(source )var(<path>)tt(/compinit)' or
 `tt(. )var(<path>)tt(/compinit)'. This will define a few utility functions,
 arrange for all the necessary shell functions to be autoloaded, and will
@@ -238,10 +238,10 @@
 )
 enditem()
 
-texinode(Control Functions)(Completion
Functions)(Initialisation)(Completion System)
+texinode(Control Functions)(Completion
Functions)(Initialization)(Completion System)
 sect(Control Functions)
 
-The initialisation script tt(compinit) re-binds all the keys which perform
+The initialization script tt(compinit) re-binds all the keys which perform
 completion to newly created widgets that all call the supplied widget
 function tt(_main_complete). This function acts as a wrapper calling
 the so-called `completer' functions that generate matches. If
@@ -382,7 +382,7 @@
 errors are accepted.  Hence with a value of `tt(0n)', no correcting
 completion will be attempted unless a numeric argument is given.
 
-If the value contains `tt(n)' or `tt(N)' and a exclamation mark
+If the value contains `tt(n)' or `tt(N)' and an exclamation mark
 (`tt(!)'), tt(_approximate) will var(not) try to generate corrected
 completions when given a numeric argument, so in this case the number given
 should be greater than zero.  For example, `tt(2n!)' specifies that
@@ -652,7 +652,7 @@
 from being tried simply by setting this parameter to any value.
 )
 item(tt(_multi_parts))(
-This functions gets two arguments: a separator character and an
+This function gets two arguments: a separator character and an
 array.  As usual, the array may be either the
 name of an array parameter or a literal array in the form
 `tt(LPAR()foo bar)tt(RPAR())' (i.e. a list of words separated by white 
diff -u -r old/func.yo Zsh/func.yo
--- old/func.yo	Mon Jun 14 17:14:29 1999
+++ Zsh/func.yo	Wed Jun 16 23:07:08 1999
@@ -41,7 +41,7 @@
 If the tt(KSH_AUTOLOAD) option is set, or the file contains only a simple
 definition of the function, the file's contents will be
 executed.  It would normally define the function in question, but may
-also perform initialisation.
+also perform initialization.
 It is executed in the context of the function
 execution, and may therefore define local parameters.
 
@@ -48,9 +48,9 @@
 Otherwise, the function is defined such that its body is the
 complete contents of the file.  This form allows the file to be
 used directly as an executable shell script.
-Initialisation code can be executed, but only as part of the first
+Initialization code can be executed, but only as part of the first
 function execution, so the function would have to redefine itself to
-avoid reinitialising on the next execution.
+avoid reinitializing on the next execution.
 
 If this processing of the file results in the function being
 fully defined, the function itself is then executed.
diff -u -r old/mod_zle.yo Zsh/mod_zle.yo
--- old/mod_zle.yo	Mon Jun 14 17:14:29 1999
+++ Zsh/mod_zle.yo	Wed Jun 16 22:54:22 1999
@@ -67,7 +67,7 @@
 item(tt(-N) var(new-keymap) [ var(old-keymap) ])(
 Create a new keymap, named var(new-keymap).  If a keymap already has that
 name, it is deleted.  If an var(old-keymap) name is given, the new keymap
-is initialised to be a duplicate of it, otherwise the new keymap will
+is initialized to be a duplicate of it, otherwise the new keymap will
 be empty.
 )
 enditem()
diff -u -r old/params.yo Zsh/params.yo
--- old/params.yo	Mon Jun 14 17:14:29 1999
+++ Zsh/params.yo	Wed Jun 16 22:55:52 1999
@@ -26,7 +26,7 @@
 parameter is special.
 Special parameters cannot have their type changed, and they stay special
even
 if unset.  `<Z>' indicates that the parameter does not exist when the shell
-initialises in tt(sh) or tt(ksh) emulation mode.
+initializes in tt(sh) or tt(ksh) emulation mode.
 startmenu()
 menu(Array Parameters)
 menu(Positional Parameters)
@@ -316,7 +316,7 @@
 )
 vindex(OLDPWD)
 item(tt(OLDPWD))(
-The previous working directory.  This is set when the shell initialises
+The previous working directory.  This is set when the shell initializes
 and whenever the directory changes.
 )
 vindex(OPTARG)
@@ -339,7 +339,7 @@
 )
 vindex(PWD)
 item(tt(PWD))(
-The present working directory.  This is set when the shell initialises
+The present working directory.  This is set when the shell initializes
 and whenever the directory changes.
 )
 vindex(RANDOM)
@@ -592,7 +592,7 @@
 An array (colon-separated list)
 of directories that tt(zmodload)
 searches for dynamically loadable modules.
-This is initialised to a standard pathname,
+This is initialized to a standard pathname,
 usually `tt(/usr/local/lib/zsh/$ZSH_VERSION)'.
 (The `tt(/usr/local/lib)' part varies from installation to installation.)
 For security reasons, any value set in the environment when the shell
diff -u -r old/zftpsys.yo Zsh/zftpsys.yo
--- old/zftpsys.yo	Mon Jun 14 17:14:29 1999
+++ Zsh/zftpsys.yo	Wed Jun 16 22:55:32 1999
@@ -47,7 +47,7 @@
 otherwise, you will need to find them and copy them.  The directory should
 appear as one of the elements of the tt($fpath) array (this should already
 be the case if they were installed), and at least the function tt(zfinit)
-should be autoloaded; it will autoload the rest.  Finally, to initialise
+should be autoloaded; it will autoload the rest.  Finally, to initialize
 the use of the system you need to call the tt(zfinit) function.  The
 following code in your tt(.zshrc) will arrange for this; assume the
 functions are stored in the directory tt(~/myfns):
@@ -59,7 +59,7 @@
 Note that tt(zfinit) assumes you are using the tt(zmodload) method to
 load the tt(zftp) command.  If it is already built into the shell, change
 tt(zfinit) to tt(zfinit -n).  It is helpful (though not essential) if the
-call to tt(zfinit) appears after any code to initialise the new completion
+call to tt(zfinit) appears after any code to initialize the new completion
 system, else unnecessary tt(compctl) commands will be given.
 
 texinode(Zftp Functions)(Miscellaneous Features)(Installation)(Zftp
Function System)
@@ -324,7 +324,7 @@
 
 startitem()
 item(tt(zfinit [ -n ]))(
-As described above, this is used to initialise the zftp function system.
+As described above, this is used to initialize the zftp function system.
 The tt(-n) option should be used if the zftp command is already built into
 the shell.
 )

Re: Doc fixes - US vs. British spelling

[Geoff Wing]

Kiddle, Oliver <KiddleO@logica.com> typed:
:Following is a small patch to the documentation. Mostly it is changing
:'initialise' to 'initialize'.

Ughh.  Now you need to create the locale dependent versions :-)
-- 
Geoff Wing : <gcw@pobox.com>     Work URL: http://www.primenet.com.au/
Rxvt Stuff : <gcw@rxvt.org>      Ego URL : http://pobox.com/~gcw/
Zsh Stuff  : <gcw@zsh.org>       Phone   : (Australia) 0413 431 874

Re: Doc fixes - US vs. British spelling

[Peter Stephenson]

Anthony.Iano-Fletcher@nih.gov wrote:
> > If British spelling is generally prefered
> 
> I certainly prefer it. So much computer documentation is written in
> American that Im used to it but it would be nice to have some in
> British english.

Wize guy, eh?

If you want a decision, then we'd better stick with `-ize' (apart from
-wise, of course).  Many of the changes were necesssary because I spelled
it the other way (I can't rememember how Sven does).  The authorities agree
that -ize has a perfectly good pedigree on both sides of the Atlantic,
although other oceans may be a different matter.

On the other hand, I'm not sure I can bring myself to face `honor' and
`color'.  Luckily, they don't occour, err, occur; we'd better keep it that
way to avoid an incident.

(Gibt's Freiwilligen fuer eine deutsche Fassung???  Auch Plattdeutsch?)

-- 
Peter Stephenson <pws@ibmth.df.unipi.it>       Tel: +39 050 844536
WWW:  http://www.ifh.de/~pws/
Dipartimento di Fisica, Via Buonarroti 2, 56127 Pisa, Italy

Re: Doc fixes - US vs. British spelling

[Anthony.Iano-Fletcher]

Hi 

Firstly, I'd like to join with Helmut when he says....

> MANY MANY thanks to all who help improving ZSH

Secondly,

> If British spelling is generally prefered

I certainly prefer it. So much computer documentation is written in
American that Im used to it but it would be nice to have some in
British english.

> words this found were 'bitwise', 'otherwise' and 'recognise'. I haven't
> got a US dictionary so can't confirm it but I'd guess that only the
> latter would be spelt with a z in America. There are also some other
> British spellings like behaviour and favour in there. 

yes, Americans spell recognise with a z. Bitwise and otherwise I think
are correct on either side of the Atlantic.

			Anthony

-- 
Anthony R Iano-Fletcher        Anthony.Iano-Fletcher@nih.gov
                               http://cbel.cit.nih.gov/~arif
                               CBEL, CIT, NIH, Bethesda, MD, USA.
                               Phone: (+1) 301 402 1741.

Re: Doc fixes - US vs. British spelling

[Anthony.Iano-Fletcher]

Hi

> > I certainly prefer it. So much computer documentation is written in
> > American that Im used to it but it would be nice to have some in
> > British english.
> 
> Wize guy, eh?

Not wise, just hopeful. :-)

> If you want a decision, then we'd better stick with `-ize' (apart from
> -wise, of course).  Many of the changes were necesssary because I spelled
> it the other way (I can't rememember how Sven does).  The authorities agree
> that -ize has a perfectly good pedigree on both sides of the Atlantic,
> although other oceans may be a different matter.

C'est la vie.

Basically if someone wants to write the manual (for which Im am very
grateful) then they can use any dialect they want. 

> On the other hand, I'm not sure I can bring myself to face `honor' and
> `color'.  Luckily, they don't occour, err, occur; we'd better keep it that
> way to avoid an incident.

Didnt I see mention of colour support in zsh?

> (Gibt's Freiwilligen fuer eine deutsche Fassung???  Auch Plattdeutsch?)

Ah.... German, French, Italian, Russion, etc versions would be nice.

How does the Babelfish site
	http://babelfish.altavista.digital.com/cgi-bin/translate?
do on the zsh manual?

	Oh well, back to work....

			Anthony 

-- 
Anthony R Iano-Fletcher        Anthony.Iano-Fletcher@nih.gov
                               http://cbel.cit.nih.gov/~arif
                               CBEL, CIT, NIH, Bethesda, MD, USA.
                               Phone: (+1) 301 402 1741.
These opinions are my own and no-one elses.

Re: Doc fixes - US vs. British spelling

[Bart Schaefer]

On Jun 17,  9:45am, Kiddle, Oliver wrote:
} Subject: Doc fixes - US vs. British spelling
}
} Following is a small patch to the documentation. Mostly it is changing
} 'initialise' to 'initialize'. If British spelling is generally prefered
} then I can create a patch to do the change the other way. I just think
} that we should be consistent.

This came up once before, soon after Zoltan had become coordinator IIRC.
The zsh-workers archive seems to be down right now; my local copy only
finds discussion of whether Clive should clean up the original zsh.texi.

I think the conclusion was that people from both sides of the pond are
going to be adding new snippets of doc, so inconsistent spellings are
bound to slip in again at some point, and therefore why bother ...

The only problem is that you have to remember to use i[sz]e in searches.

On Jun 17,  2:33pm, Peter Stephenson wrote:
} Subject: Re: Doc fixes - US vs. British spelling
}
} On the other hand, I'm not sure I can bring myself to face `honor' and
} `color'.  Luckily, they don't occour, err, occur; we'd better keep it that
} way to avoid an incident.

There's an instance of "honoured" in the 3.0.6 documentation.

On Jun 17,  9:25am, Anthony.Iano-Fletcher@nih.gov wrote:
} Subject: Re: Doc fixes - US vs. British spelling
}
} Didnt I see mention of colour support in zsh?

Yes, and Greg's patch handles both ZLS_COLORS and ZLS_COLOURS as special
parameters, so we'd end up with both spelling in the doc even if PWS will
have to keep looking away on that page.

} How does the Babelfish site
} 	http://babelfish.altavista.digital.com/cgi-bin/translate?
} do on the zsh manual?

Oh, my ... apart from the fact that it would probably take a week to
process it, I'll bet the results would be truly hilarious.  (That aside,
the problem would be that you can't stop it from translating the names
of the builtin commands and other keywords.)

Recognize this?

1. * Verschachtelter Ersatz *
     wenn mehrfache verschachtelte ${...}-Formulare anwesend sind, wird
     Ersatz vom Innere außerhalb durchgeführt. an jed Stufe, d Ersatz
     berücksichtigen ob d aktuell Wert sein ein scalar oder ein Reihe,
     ob d vollständig Ersatz sein in doppelt Anführungsstrich, und was
     Markierungsfahne sein angeben zu d aktuell Stufe von Ersatz, gerade
     als ob d verschachteln Ersatz sein d äußerst. Die Markierungsfahnen
     werden nicht bis zum Umgeben des Ersatzes fortgepflanzt; der
     verschachtelte Ersatz bringt entweder einen Scalar oder eine Reihe
     zurück, wie durch die Markierungsfahnen festgestellt, vielleicht
     eingestellt auf die Veranschlagung. Alle folgenden Jobsteps finden
     statt, wo anwendbar auf allen Stufen des Ersatzes. Beachten Sie,
     daß, es sei denn Markierungsfahne des `(P)' anwesend ist, die
     Markierungsfahnen und alle mögliche Tiefzeichen direkt auf den
     Wert des verschachtelten Ersatzes zutreffen; z.B., die Expansion
     ${${foo}} benimmt sich genau dasselbe wie ${foo}.

-- 
Bart Schaefer                                 Brass Lantern Enterprises
http://www.well.com/user/barts              http://www.brasslantern.com

Re: Doc fixes - US vs. British spelling

[Sven Wischnowsky]

Peter Stephenson wrote:

> Anthony.Iano-Fletcher@nih.gov wrote:
> > > If British spelling is generally prefered
> > 
> > I certainly prefer it. So much computer documentation is written in
> > American that Im used to it but it would be nice to have some in
> > British english.
> 
> Wize guy, eh?
> 
> If you want a decision, then we'd better stick with `-ize' (apart from
> -wise, of course).  Many of the changes were necesssary because I spelled
> it the other way (I can't rememember how Sven does).  The authorities agree
> that -ize has a perfectly good pedigree on both sides of the Atlantic,
> although other oceans may be a different matter.

I prefer the -ise forms...

> On the other hand, I'm not sure I can bring myself to face `honor' and
> `color'.  Luckily, they don't occour, err, occur; we'd better keep it that
> way to avoid an incident.

There is this suggestion for supporting colo(u|)red completion lists...

> (Gibt's Freiwilligen fuer eine deutsche Fassung???  Auch Plattdeutsch?)

I can't see myself translating our 100++ pages manual to German
without getting money for it (and I can understand Platt, but can
hardly write it ;-).

Aber eine Sammlung von Handbuechern in verschiedenen Sprachen -- das
hat was.

Bye
 Sven


--
Sven Wischnowsky                         wischnow@informatik.hu-berlin.de