goba Tue Aug 12 04:19:45 2003 EDT
Modified files:
/phpdoc/howto working.xml
Log:
Apply grammar fixing patch sent by <daveb at optusnet dot com dot au>
Index: phpdoc/howto/working.xml
diff -u phpdoc/howto/working.xml:1.36 phpdoc/howto/working.xml:1.37
--- phpdoc/howto/working.xml:1.36 Mon Jun 23 05:47:28 2003
+++ phpdoc/howto/working.xml Tue Aug 12 04:19:44 2003
@@ -409,7 +409,7 @@
Function names should be created, and documented, in lowercase
format with an underscore separating the name components. Names
without underscores are often only kept for backward
- compatibilty. Document the function named with underscores
+ compatibility. Document the function named with underscores
separating components, and mention the old one as an alias.
</simpara>
<note>
@@ -457,13 +457,13 @@
</listitem>
<listitem>
<simpara>
- Brevity is appreciated. Long winded descriptions of each and
+ Brevity is appreciated. Long-winded descriptions of each and
every function are not appropriate for the reference sections.
Using the errata comments as guidelines, it's easier to tell when
more documentation is needed, as well as the inverse, when too
much documentation in one section has increased confusion.
- <footnote><simpara>Noone complained about too much documentation
- in any section till now, so be brave to add longer explanations,
+ <footnote><simpara>No one complained about too much documentation
+ in any section until now, so be brave to add longer explanations,
and more than one example per function. :)</simpara></footnote>
</simpara>
</listitem>
@@ -655,9 +655,9 @@
<para>
There are many active translations out there of the PHP
- documentation. Some lanaguages are being maintaned by
+ documentation. Some languages are being maintained by
a group of translators (eg. the German), some are one person
- projects (eg. the Japanese). There are quite many things for
+ projects (eg. the Japanese). There are quite a few things for
translators to know, though these are simple.
</para>
@@ -665,7 +665,7 @@
<title>Starting a New Translation</title>
<para>
Starting a new language translation comes down to
- the following simple steps now.
+ the following simple steps:
<itemizedlist>
<listitem>
<simpara>
@@ -678,7 +678,7 @@
<listitem>
<simpara>
<link linkend="cvs-account">Ask for a CVS account</link>.
- Mention, that you would like to start a new translation.
+ Mention that you would like to start a new translation.
</simpara>
</listitem>
<listitem>
@@ -696,7 +696,7 @@
and <literal>phpdoc-LANGCODE</literal> (using the
<literal>phpdoc-LANGCODE-dir</literal> alias) as
described in the <link linkend="chapter-cvs">CVS chapter</link>
- of this howto.
+ of this HOWTO.
</simpara>
</listitem>
<listitem>
@@ -716,7 +716,7 @@
<link linkend="translation-revtrack">revision
tracking</link> for help about
how can you ease your work of tracking the English
- versions, and your languages versions.
+ version and your language's version.
</simpara>
</listitem>
</itemizedlist>
@@ -752,15 +752,15 @@
If you see that a manual for your language is set
up, and you would like to join the group, please
ask on the appropriate <link linkend="chapter-maillist">mailing
- list</link> about who is responsible to manage that
+ list</link> about who is responsible for managing that
translation.
</para>
<para>
If you are new to the PHP project, and you have no
CVS account, you need to <link linkend="cvs-account">request
- one account</link>, before you can join the work. Although
+ an account</link> before you can join the group. Although
there are some translations where just a few people have
- CVS accounts, and they are responsible for comitting the
+ CVS accounts, and they are responsible for committing the
other's works, this may not be ideal.
</para>
</sect1>
@@ -788,7 +788,7 @@
<simpara>
Use a system to coordinate with the translators
in your language. Currently we have two systems
- used paralelly, the Translators files and the
+ used in parallel, the Translators files and the
Revision comments. See the section about
<link linkend="translation-revtrack">revision
tracking</link> to learn more about this subject.
@@ -833,8 +833,8 @@
made to your language's files, are correct.
You may introduce illegal characters. Please
always do a <link linkend="chapter-validating">make
- test</link> before commiting. Introducing an
- error in your languages manual can stop the
+ test</link> before committing. Introducing an
+ error in your language's manual can stop the
automatic updates online until you correct the
error.
</simpara>
@@ -850,10 +850,10 @@
<ulink url="&url.buildlog.de;">&url.buildlog.de;</ulink>.
Substitute "de" with your own language code to
see the information about your manual. This file
- provides you information about the build times,
+ provides you with information about the build times,
and errors (if there were any). If the manual is
- not updated online, it is a good idea, to look
- into this file and see what was the error.
+ not updated online, it is a good idea to look
+ into this file and see what the error was.
</simpara>
<simpara>
Note, that some browsers like MSIE may
@@ -873,7 +873,7 @@
<title>Revision Tracking</title>
<para>
Working on the translations is not just translating
- an English file and commiting the results. Much of
+ an English file and committing the results. Much of
the work is needed to update the already translated
ones, to get in sync with the content of the English
files. To follow the modifications in the English
@@ -881,7 +881,7 @@
<link linkend="chapter-maillist">mailing list</link>,
or read the archives. If you never update your files,
the translations can get useless. You should also subscribe
- to your languages mailing list (if it's not English),
+ to your language's mailing list (if it's not English),
to get CVS commit messages and participate in language
specific discussions.
</para>
@@ -946,7 +946,7 @@
CVS command, or using the web interface at <ulink url="&url.php.cvs;">
&url.php.cvs;</ulink>. The web interface can generate really
visual diffs, so you can easily spot what needs to be deleted,
- added and modified where.
+ added, or modified, and where.
</para>
<para>
If you choose this method, do not forget to update the revision
@@ -969,9 +969,9 @@
<para>
There is another way of tracking versions instead of
using the method descibed above. You can decide yourself,
- as this is the better method for you or not. Some
- languages use the Revision comments and Translators files
- paralelly, some use only one of these. It is better to
+ if this is the better method for you or not. Some
+ languages use the Revision comments and <filename>Translators</filename>
+ files in parallel, some use only one of these. It is better to
decide, and not to use two systems, as things can get
very messy this way.
</para>
@@ -981,7 +981,7 @@
provide information about. Consider the <link
linkend="translation-revcheck-translators">Translators</link>
example above. Now we spread the revision and association
- informations in the files mentioned there. Let's see what
+ information in the files mentioned there. Let's see what
would be in the header of the <filename>bookinfo.xml</filename>
file in this case:
<programlisting>
@@ -989,27 +989,27 @@
</programlisting>
</para>
<para>
- You can see we loose no information here, but we can also
+ You can see we lose no information here, but we can also
add some other status information in the case it is needed
(eg. "partial" for incomplete translations). This revision
comment system is basically about storing the information in
the XML files, and not in a central place. This is extremely
- convinient now, as there are more then 4000 files in the
+ convenient now, as there are more than 4000 files in the
English tree.
</para>
<para>
- Currently all the three information is needed. Maintainer
- is intended to be a CVS user name, or some nickname without
- a space, status can be anything without a space. Note, that
- this header is not updated by CVS (in contrast with
+ Currently, all three fields (English revision, Maintainer, Status)
+ are needed. Maintainer is intended to be a CVS user name, or some
+ nickname without a space, status can be anything without a space.
+ Note, that this header is not updated by CVS (in contrast with
<literal>$Revision</literal>, which is updated automatically).
This is only updated when you edit the contents of the comment
yourself.
</para>
<para>
You may see this as a good thing, but using these comments,
- you loose the quick look on the whole list of your
- files. No, you do not loose this, but get much more! If
+ you lose the quick look on the whole list of your
+ files. No, you do not lose this, but get much more! If
you would like to build a list similar to the
<filename>Translators</filename> file given above, you
can go to the scripts directory and run:
@@ -1021,11 +1021,11 @@
<filename>revcheck.html</filename> in the same directory.
You can find revision comparisions and links to diffs
for all the files in this language. You can also
- add a furter restriction parameter, the maintainer name,
+ add a further restriction parameter, the maintainer name,
so the script will only list the files corresponding to
- the given maintaner. This HTML file gives you much more
+ the given maintainer. This HTML file gives you much more
than the <filename>Translators</filename> file. See it
- yourself for example with the Italian translation (code:
+ yourself for an example with the Italian translation (code:
it). You can also easily run this with <literal>make
revcheck</literal> in the phpdoc root directory, in
case you issued a
@@ -1096,13 +1096,13 @@
the <filename>revcheck.html</filename> file. All translators
are linked to from the individual files they are assigned
to, and there is a nice table showing the state of files for
- all the translators. Assingning ready files may be needed if
+ all the translators. Assigning ready files may be needed if
a time consuming update is in progress on that file.
</para>
<para>
- There are two CHM format related things in this XML file. The
- first is the <chmindex> part, where you can specify your
+ There are two CHM format related elements in this XML file. The
+ first is the <chmindex> element, where you can specify your
text to display on the CHM index page, with a link to the actual
versions. The editor parameter of a <person> is also used
in the grouping of translators on the CHM index page. These
@@ -1125,15 +1125,15 @@
<para>
Another addon to this system is just to give credit to all people
- worked on one file, and not just the current maintainer. To achive
+ who worked on one file, and not just the current maintainer. To achieve
this goal, we added the credit comments. One credit comment in
eg. <filename>history.xml</filename> may look like this (in case
- Joe Doe translated the file initally, but Jane followed him to
+ Joe Doe translated the file initially, but Jane followed him to
be the maintainer):
<programlisting>
<!-- CREDITS: joedoe -->
</programlisting>
- The credits comment can contain a comma separated list. These
+ The credits comment can contain a comma-separated list. These
comments only affect the display of the translators table in
<filename>revcheck.html.gz</filename>.
</para>
@@ -1160,7 +1160,7 @@
<para>
This script tries to decide whether a file is up to date or not
from the last modification date. The results are not correct if
- you modify your languages file, fixing typos, as this script thinks
+ you modify your language's file, fixing typos, as this script thinks
you modified the file to get in sync with the English one, and will
mark your file as up to date. Although this script can help some
to track files without <link linkend="translation-revcheck-comments">revision
@@ -1195,9 +1195,9 @@
LANGCODE is the same language code used in the CVS module name.
You can subscribe to / unsubscribe from these mailing lists
the same way as above explained, substituting
- <literal>phpdoc</literal> in the email adreesses with your list
+ <literal>phpdoc</literal> in the email addresses with your list
name. A sample list name is <literal>doc-zh</literal> for the
- Simplified Chineese list.
+ Simplified Chinese list.
</para>
<para>
Currently these lists (including the main phpdoc list) receive
@@ -1220,15 +1220,15 @@
</listitem>
<listitem>
<simpara>
- Other senders: the posting to list is not restricted,
+ Other senders: posting to the list is not restricted,
so people not on the list can also post messages. This
- way we got reports and suggestions by plain mails
+ way we can receive reports and suggestions by plain mail
on the list.
</simpara>
</listitem>
<listitem>
<simpara>
- The PHP bug tracking system: bug follow ups classified
+ The PHP bug tracking system: bug follow-ups classified
as "Documentation Problem" are posted to the phpdoc
list.
</simpara>
@@ -1280,9 +1280,9 @@
</para>
<para>
The commit messages coming from the CVS server, that are larger
- then 8kb, are put into attachements. You can always see the
+ then 8kb, are put into attachments. You can always see the
commit message and file list in the body, but the diff is in an
- attachement.
+ attachment.
</para>
<para>
As the Windows HTMLHelp Edition of the manual is evolving
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
