philip Wed Apr 18 14:50:18 2007 UTC
Modified files: /phpdoc/howto README docbook.xml generating.xml preface.xml scripts.xml tools.xml working.xml Log: Spelling
http://cvs.php.net/viewvc.cgi/phpdoc/howto/README?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/howto/README diff -u phpdoc/howto/README:1.6 phpdoc/howto/README:1.7 --- phpdoc/howto/README:1.6 Sun Sep 11 19:37:41 2005 +++ phpdoc/howto/README Wed Apr 18 14:50:17 2007 @@ -1,7 +1,7 @@ ABOUT THE PHPDOC HOWTO This directory contains a working DRAFT of a PHP Documenation HOWTO. -It's being written in a very simliar format to the PHP Documentation, +It's being written in a very similar format to the PHP Documentation, so anyone should be able to jump right in. As a matter of fact, we use a modified copy of the main PHPDOC html.dsl stylesheet for this document's HTML formatting (see phpdoc/howto.dsl), so it can't be http://cvs.php.net/viewvc.cgi/phpdoc/howto/docbook.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/howto/docbook.xml diff -u phpdoc/howto/docbook.xml:1.7 phpdoc/howto/docbook.xml:1.8 --- phpdoc/howto/docbook.xml:1.7 Sat Apr 12 12:48:26 2003 +++ phpdoc/howto/docbook.xml Wed Apr 18 14:50:17 2007 @@ -23,7 +23,7 @@ Simply this means, that writing a DocBook file is no more, than writing a text file, using some simple "tags" where they are needed. An opening tag is a < bracket followed - by the tag's name, optinally some arguments, and a > + by the tag's name, optionally some arguments, and a > bracket (eg. <para> for paragraphs). A closing tag is a < bracket followed by a / sign, the tag name and a closing > bracket (eg. </para> for paragraphs). http://cvs.php.net/viewvc.cgi/phpdoc/howto/generating.xml?r1=1.21&r2=1.22&diff_format=u Index: phpdoc/howto/generating.xml diff -u phpdoc/howto/generating.xml:1.21 phpdoc/howto/generating.xml:1.22 --- phpdoc/howto/generating.xml:1.21 Fri Feb 10 16:51:26 2006 +++ phpdoc/howto/generating.xml Wed Apr 18 14:50:17 2007 @@ -11,7 +11,7 @@ </para> <para> - The <filename>Makefile</filename> controls serveral aspects + The <filename>Makefile</filename> controls several aspects of how the documentation is validated and created. To generate a <filename>Makefile</filename> from a fresh checkout, <command>cd</command> to the <filename>phpdoc</filename> http://cvs.php.net/viewvc.cgi/phpdoc/howto/preface.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/howto/preface.xml diff -u phpdoc/howto/preface.xml:1.5 phpdoc/howto/preface.xml:1.6 --- phpdoc/howto/preface.xml:1.5 Sun Apr 3 10:53:20 2005 +++ phpdoc/howto/preface.xml Wed Apr 18 14:50:17 2007 @@ -68,7 +68,7 @@ <para> This document is based on many files, previously hosted - in the phpdoc module at cvs.php.net, containg information + in the phpdoc module at cvs.php.net, containing information about several distinct subjects, ranging from generating the HTML files from XML sources to starting a new translation. This is a central place for all these things. We tried to http://cvs.php.net/viewvc.cgi/phpdoc/howto/scripts.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/howto/scripts.xml diff -u phpdoc/howto/scripts.xml:1.4 phpdoc/howto/scripts.xml:1.5 --- phpdoc/howto/scripts.xml:1.4 Sun Sep 11 19:37:41 2005 +++ phpdoc/howto/scripts.xml Wed Apr 18 14:50:17 2007 @@ -5,7 +5,7 @@ <para> The PHP manual is very big and the PHP sources change every day. To help the - documentation writers's work, we have developed a couple of scripts during + documentation writers work, we have developed a couple of scripts during the last years. Below you will find a list of the scripts, as well a short explanation and usage tips for each one. </para> @@ -31,8 +31,8 @@ <title>check-references.php</title> <para> This script tries to parse the PHP sources and compares the facts about - function parameters (their count, types, optionality and the need of - passing them as reference) with the documentation. Only easy parsable + function parameters (their count, types, optionally and the need of + passing them as reference) with the documentation. Only easily parsable functions from Zend, extensions, PECL and SAPI sources are checked. </para> <para> @@ -138,7 +138,7 @@ </note> <para> The script should warn you for missing tags or even bogus values, although - it won't report any XML errors. So, you have the responsability to run + it won't report any XML errors. So, you have the responsibility to run <command>make test</command> before running this script. Failing to do so, may lead to unexpected results. </para> http://cvs.php.net/viewvc.cgi/phpdoc/howto/tools.xml?r1=1.29&r2=1.30&diff_format=u Index: phpdoc/howto/tools.xml diff -u phpdoc/howto/tools.xml:1.29 phpdoc/howto/tools.xml:1.30 --- phpdoc/howto/tools.xml:1.29 Thu Dec 8 21:50:38 2005 +++ phpdoc/howto/tools.xml Wed Apr 18 14:50:17 2007 @@ -22,7 +22,7 @@ so to work with those projects, you need an editor, which supports these encodings. The English documentation mostly uses ISO-Latin-1 (ISO-8859-1), but some files are UTF-8 - encoded, so you are better equiped with an UTF-8 supporting + encoded, so you are better equipped with an UTF-8 supporting editor. Some more useful tools: <itemizedlist> <listitem><simpara>Visual CVS client</simpara></listitem> @@ -61,7 +61,7 @@ <title>Tools on Linux</title> <para> - Although many tools are preinstalled on the majority of + Although many tools are pre-installed on the majority of Linux systems, we collected some useful information about how they can be obtained and installed, if your system misses them. http://cvs.php.net/viewvc.cgi/phpdoc/howto/working.xml?r1=1.62&r2=1.63&diff_format=u Index: phpdoc/howto/working.xml diff -u phpdoc/howto/working.xml:1.62 phpdoc/howto/working.xml:1.63 --- phpdoc/howto/working.xml:1.62 Tue Sep 5 18:28:38 2006 +++ phpdoc/howto/working.xml Wed Apr 18 14:50:18 2007 @@ -494,7 +494,7 @@ <title>A function skeleton (<filename>func-name.xml</filename>)</title> <programlisting role="xml"> <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.62 $ --> +<!-- $Revision: 1.63 $ --> <refentry id="function.func-name"> <refnamediv> <refname>func_name</refname> @@ -673,7 +673,7 @@ <title>A <filename>reference.xml</filename> skeleton</title> <programlisting role="xml"> <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.62 $ --> +<!-- $Revision: 1.63 $ --> <!-- Purpose: xx --> <!-- Membership: xx --> <!-- State: xx --> @@ -743,7 +743,7 @@ <title>A <filename>configure.xml</filename> skeleton</title> <programlisting role="xml"> <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.62 $ --> +<!-- $Revision: 1.63 $ --> <section id="extname.installation"> &reftitle.install; <para> @@ -784,7 +784,7 @@ <title>A <filename>constants.xml</filename> skeleton</title> <programlisting role="xml"> <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.62 $ --> +<!-- $Revision: 1.63 $ --> <section id="extname.constants"> &reftitle.constants; &extension.constants; @@ -834,7 +834,7 @@ <title>A <filename>ini.xml</filename> skeleton</title> <programlisting role="xml"> <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.62 $ --> +<!-- $Revision: 1.63 $ --> <section id="extname.configuration"> &reftitle.runtime; &extension.runtime; @@ -1114,7 +1114,7 @@ not yet in those old files, these errors are inevitable. Either update your translation, or remove the offending files, thus allowing the - English originals to take precendence. + English originals to take precedence. </simpara> </listitem> </itemizedlist> @@ -1223,7 +1223,7 @@ <para> There is another way of tracking versions instead of - using the method descibed above. You can decide yourself, + using the method described above. You can decide yourself, 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 @@ -1274,7 +1274,7 @@ Here <literal>xx</literal> is the imaginary language code. After running this script you'll get a <filename>revcheck.html</filename> in the same directory. - You can find revision comparisions and links to diffs + You can find revision comparisons and links to diffs for all the files in this language. You can also add a further restriction parameter, the maintainer name, so the script will only list the files corresponding to @@ -1345,7 +1345,7 @@ as a <filename>Translators</filename> file. What is new in this file, is that you can add users without a CVS account, and can assign ready documents or work-in-progress files to them. The - biggest advantage of using this addon is that all this information + biggest advantage of using this add-on is that all this information is used to generate dynamic tables of translators and files in the <filename>revcheck.html</filename> file. All translators are linked to from the individual files they are assigned @@ -1378,7 +1378,7 @@ </para> <para> - Another addon to this system is just to give credit to all people + Another add-on to this system is just to give credit to all people 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 @@ -1955,7 +1955,7 @@ <simpara> If the note submitter's email address is obviously bogus, don't 'reject' the note, just 'delete' it. Rejecting the note just gives the mail server - more work trying to send an email to a non-existant address, which doesn't + more work trying to send an email to a non-existent address, which doesn't help anything. </simpara> </listitem>