goba Mon May 24 13:42:55 2004 EDT
Modified files:
/phpdoc/en/appendices about.xml
Log:
some rewording, updating for PHP 5, removin the HTML role where inappropriate
http://cvs.php.net/diff.php/phpdoc/en/appendices/about.xml?r1=1.33&r2=1.34&ty=u
Index: phpdoc/en/appendices/about.xml
diff -u phpdoc/en/appendices/about.xml:1.33 phpdoc/en/appendices/about.xml:1.34
--- phpdoc/en/appendices/about.xml:1.33 Sun May 23 17:46:55 2004
+++ phpdoc/en/appendices/about.xml Mon May 24 13:42:55 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.33 $ -->
+<!-- $Revision: 1.34 $ -->
<appendix id="about">
<title>About the manual</title>
@@ -119,8 +119,8 @@
<sect1 id="about.prototypes">
<title>How to read a function definition (prototype)</title>
<para>
- Each function is documented for quick reference. Knowing how
- to read and understand the manual will make using PHP
+ Each function in the manual is documented for quick reference. Knowing how
+ to read and understand the text will make learning PHP
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>
@@ -143,7 +143,7 @@
<screen>
strlen
-(PHP 3, PHP 4 >= 4.0.0)
+(PHP 3, PHP 4, PHP 5)
strlen -- Get string length
Description
@@ -173,10 +173,10 @@
</row>
<row>
<entry>
- (PHP 3, PHP 4 >= 4.0.0)
+ (PHP 3, PHP 4, PHP 5)
</entry>
<entry>
- strlen() has been around in both all of PHP 3 and PHP 4
+ strlen() has been around in all versions of PHP 3, PHP 4 and PHP 5
</entry>
</row>
<row>
@@ -185,7 +185,7 @@
</entry>
<entry>
Type of value this function returns, which is an
- <type>integer</type> (i.e. The length of a string is measured in
+ <type>integer</type> (i.e. the length of a string is measured in
numbers).
</entry>
</row>
@@ -194,8 +194,8 @@
( string str )
</entry>
<entry>
- The first (and in this case the only) parameter/argument for the
- function strlen() is named <parameter>str</parameter>, and it's a
+ The first (and in this case the only) parameter/argument for this
+ function is named <parameter>str</parameter>, and it's a
<type>string</type>.
</entry>
</row>
@@ -207,7 +207,7 @@
We could rewrite the above function definition in a generic way:
</para>
<para>
- <screen role="html">
+ <screen>
returned type function name ( parameter type parameter name )
</screen>
</para>
@@ -216,7 +216,7 @@
Its prototype is as follows:
</para>
<para>
- <screen role="html">
+ <screen>
bool in_array ( mixed needle, array haystack [, bool strict])
</screen>
</para>
@@ -241,13 +241,26 @@
boolean &false;. See the manual page on each function for details on
how they work.
</para>
+ <para>
+ There are also functions with more complex PHP version information. Take
+ <function>html_entity_decode</function> as an example:
+ </para>
+ <para>
+ <screen>
+ (PHP 4 >= 4.3.0, PHP 5)
+ </screen>
+ </para>
+ <para>
+ This means that this function was not available in PHP 3, and is only
+ available in a released version since PHP 4.3.0.
+ </para>
</sect1>
<sect1 id="about.phpversions">
<title>PHP versions documented in this manual</title>
<para>
- This documentation contains information about PHP 4, with some added
- migration and compatibility notes regarding PHP 3. Behaviour,
+ This documentation contains information about bot PHP 4 and PHP 5, with
+ some added migration and compatibility notes regarding PHP 3. Behaviour,
parameter, return value and other changes between different PHP
versions are documented in notes and inline text in the manual.
</para>
@@ -264,7 +277,7 @@
</para>
<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
+ not released (something like PHP 5.0.0 while the latest stable version
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 which will be available in a known future PHP version.
@@ -275,9 +288,9 @@
<title>How to find more information about PHP</title>
<para>
This manual does not attempt to provide instruction about general
- programming practices. If you are a first-time, or even just a beginning,
+ programming practices. If you are a first-time - or even just a beginning -
programmer, you may find it difficult to learn how to program in PHP using
- just this manual. You may want to seek out a text more oriented towards
+ this manual only. You may want to seek out a text more oriented towards
beginners. You can find a list of PHP-related books at <ulink
url="&url.php.books;">&url.php.books;</ulink>.
</para>
@@ -286,9 +299,9 @@
programming with PHP. If you find yourself stuck on a problem for which you
can't find your own solution, you may be able to get help from someone on
these lists. You can find a list of the mailing lists at <ulink
- url="&url.php.support;">&url.php.support;</ulink>, as well as links to the
- mailing list archives and other online support resources. Furthermore, at
- <ulink url="&url.php.links;">&url.php.links;</ulink> there is a list of
+ url="&url.php.support;">the PHP.net support page</ulink>, as well as links to
+ the mailing list archives and other online support resources. Furthermore, at
+ <ulink url="&url.php.links;">the PHP.net links page</ulink> there is a list of
websites devoted to PHP articles, forums, and code galleries.
</para>
</sect1>
@@ -302,7 +315,7 @@
If you find errors in this manual, in any language, please report them
using the bug system at <ulink url="&url.php.bugs;">&url.php.bugs;</ulink>.
Classify the bug as "Documentation Problem". You can also submit problems
- related to specific manual formats here.
+ related to specific manual formats there.
</para>
<note>
<para>
@@ -353,11 +366,12 @@
</para>
<para>
You can download the manual in various languages and
- formats, including plain text, plain <acronym>HTML</acronym>,
+ formats, including plain <acronym>HTML</acronym>,
<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 periodically as the text is updated.
+ Note that due to technical reasons, some formats may
+ be unavailable.
</para>
<para>
You can find more information about downloading the
