kennyt Wed Jan 14 19:17:22 2004 EDT
Modified files: /phpdoc/en/appendices about.xml Log: Cleaned some expressions (no-trans) and corrected that the manual is built 'periodically.' Index: phpdoc/en/appendices/about.xml diff -u phpdoc/en/appendices/about.xml:1.29 phpdoc/en/appendices/about.xml:1.30 --- phpdoc/en/appendices/about.xml:1.29 Sun Jan 11 15:12:40 2004 +++ phpdoc/en/appendices/about.xml Wed Jan 14 19:17:22 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.29 $ --> +<!-- $Revision: 1.30 $ --> <!-- TODO: add manual conventions section (eg. how to read @@ -125,9 +125,9 @@ <sect1 id="about.prototypes"> <title>How to read a function definition (prototype)</title> <para> - Each function is documented for quick reference, knowing how + Each function is documented for quick reference. Knowing how to read and understand the manual will make using PHP - much easier. Rather than relying on examples or cut/paste, you want + much easier. Rather than relying on examples or cut/paste, you will want to know how to read function definitions (prototypes). Let's begin: </para> <note> @@ -142,8 +142,8 @@ </note> <para> Function definitions tell us what - type of value is <link linkend="functions.returning-values">returned</link>, - let's use the definition for <function>strlen</function> as our first example: + type of value is <link linkend="functions.returning-values">returned</link>. + Let's use the definition for <function>strlen</function> as our first example: </para> <para> <screen> @@ -229,16 +229,16 @@ <para> What does this mean? in_array() returns a <link linkend="language.types.boolean">boolean</link> value, &true; on - success (the <parameter>needle</parameter> was found in the - <parameter>haystack</parameter>) or &false; on failure (the + success (if the <parameter>needle</parameter> was found in the + <parameter>haystack</parameter>) or &false; on failure (if the <parameter>needle</parameter> was not found in the <parameter>haystack</parameter>). The first parameter is named - <parameter>needle</parameter> and it can be many different + <parameter>needle</parameter> and it can be of many different <link linkend="language.types">types</link>, so we call it "<emphasis>mixed</emphasis>". This mixed <parameter>needle</parameter> - (what we're looking for) can either be a scalar value (string, integer, + (what we're looking for) can be either a scalar value (string, integer, or <link linkend="language.types.float">float</link>), or an - <link linkend="language.types.array">array</link>. + <link linkend="language.types.array">array</link>. <parameter>haystack</parameter> (the array we're searching in) is the second parameter. The third <emphasis>optional</emphasis> parameter is named <parameter>strict</parameter>. All optional parameters are seen @@ -263,7 +263,7 @@ the CVS version handling system. If you are not a developer of PHP itself, and you are not keen on using the very latest development version of PHP, features marked with the "available in CVS" wording - are not accessible to you. Though these features will probably be + are not accessible to you. These features, though, will probably be available in the next stable version of PHP. If you would like to download the CVS version, see the <ulink url="&url.php.anoncvs;">anonymous CVS access page</ulink>. @@ -271,9 +271,9 @@ <para> You may also encounter documentation for a PHP version which is not released (something like PHP 5.0.0 as the latest stable version - is 4.3.0). Most of the time, this is not an error in the documentation. + is 4.3.x). Most of the time, this is not an error in the documentation. Explanation is often added for features not available in the current - PHP release, but will be available in a known future PHP version. + PHP release, but which will be available in a known future PHP version. </para> </sect1> @@ -318,8 +318,8 @@ </note> <para> By contributing notes, you can provide additional examples, caveats, and - clarifications for other readers. But do not submit bug reports using the - annotation system please. You can read more about annotations in the <link + clarifications for other readers. But please do not submit bug reports using the + annotation system. You can read more about annotations in the <link linkend="about.notes">'About user notes'</link> section of this appendix. </para> @@ -349,8 +349,8 @@ The tools used for formatting <acronym>HTML</acronym> and <acronym>TeX</acronym> versions are <ulink url="&url.jade;">Jade</ulink>, written by <ulink - url="&url.jclark;">James Clark</ulink> and <ulink - url="&url.dbstyle;">The Modular DocBook Stylesheets</ulink> + url="&url.jclark;">James Clark</ulink>; and <ulink + url="&url.dbstyle;">The Modular DocBook Stylesheets</ulink>, written by <ulink url="&url.nwalsh;">Norman Walsh</ulink>. We use <ulink url="&url.winhelp;">Microsoft HTML Help Workshop</ulink> to generate the Windows HTML Help format @@ -360,10 +360,10 @@ <para> You can download the manual in various languages and formats, including plain text, plain <acronym>HTML</acronym>, - <acronym>PDF</acronym>, PalmPilot DOC, PalmPilot iSilo and + <acronym>PDF</acronym>, PalmPilot DOC, PalmPilot iSilo, and Windows HTML Help, from <ulink url="&url.php.docs;">&url.php.docs;</ulink>. - The manuals are updated automatically as the text is updated. + The manuals are updated periodically as the text is updated. </para> <para> You can find more information about downloading the @@ -376,12 +376,12 @@ <sect1 id="about.translations"> <title>Translations</title> <para> - The PHP manual is not only available in various formats, - it is also available in various languages. The text of the + The PHP manual is available not only in various formats, but + also in various languages. The text of the manual is first written in English, then teams of people across - the world take care of translating it to their native language. + the world take care of translating it to their native languages. If a translation for a specified function or chapter has not yet - been made, the build system of the manual falls back to the + been made, the manual's build system falls back to the English version of it. </para> <para> @@ -402,7 +402,7 @@ message that you are interested in translating the manual to a language and someone will get back to you, helping you start a new language translation or reach the already active documentation team for your language. - </para> + </para> </note> <para> At the moment the manual is available, partly or not, in the following languages: