cvs: phpdoc /en/appendices about.xml

From: Date: Sat, 24 Nov 2001 17:24:07 +0000
Subject: cvs: phpdoc /en/appendices about.xml
Groups: php.doc 
Request: Send a blank email to phpdoc+get-969339217@lists.php.net to get a copy of this message
jan Sat Nov 24 12:24:07 2001 EDT Modified files: /phpdoc/en/appendices about.xml Log: clearification, grammar, spelling and information improvement added note about using grep and the windows search system for offline searching. Index: phpdoc/en/appendices/about.xml diff -u phpdoc/en/appendices/about.xml:1.1 phpdoc/en/appendices/about.xml:1.2 --- phpdoc/en/appendices/about.xml:1.1 Sat Nov 24 11:44:22 2001 +++ phpdoc/en/appendices/about.xml Sat Nov 24 12:24:06 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <appendix id="moreabout"> <title>More about this Manual</title> @@ -33,7 +33,7 @@ from many different formats we provide. What you choose depends on your operating system, and your personal reading style. If you are interested, how we can generate - these many formats, read on the technical part of this + these various formats, read on the technical part of this appendix named <link linkend="moreabout.generate">How we generate the formats</link>. </para> @@ -46,15 +46,17 @@ or text version is not ideal for day to day work, although full text search is easy in such files. Note, that the compressed file with several HTML - files contain more than 2000 files. Using - that you face the lack of offline search, but - you gain the fast access to information anytime. + files contain more than 2000 files. You can serach in + these files using your OS search capabilities such as the + global search dialog on Windows or grep on unix like + systems. Since it is not very comfortable using these tools, + avail yourself of the online search as often as needed. </para> <para> PDF is also a popular cross platform format. This is the best for printing, although we do not - recommend printing out the manual in a whole, as - it can take so much reqources. As the manual + recommend printing out the manual on the whole, as + it can take so much resources. As the manual changes from day to day, think twice before you print out the whole manual. Viewing PDF, you have the full text search ability. Note, that @@ -77,13 +79,15 @@ At last, but not least, we have a Windows HTML Help version of the PHP Manual. It is actually a spiced up HTML package. The biggest - advantage of HTML Help (also known as CHM) - is that the viewer provides full text search, - search in search results, full index, and - bookmarking. This format also kindly integrates - with many popular PHP IDEs on Windows. + advantage of the Compiled HTML (also known as + <acronym>CHM</acronym>) version is that the viewer + provides full text search, search in search results, + full index, and bookmarking. This format also kindly + integrates with many popular PHP IDEs on Windows. The biggest disadvantage is that it is only - available on Windows operating systems. + available on Windows operating systems. You also + need the MS Internet Explorer 4.0 or newer to access the + CHM version, if you are on an older Windows system </para> </sect1> @@ -121,15 +125,15 @@ <ulink url="&url.php.books;">&url.php.books;</ulink>. We do not recommend you to buy a reprint of the PHP Manual, because these are commonly quite outdated. - Consider, that the PHP manual is changing from day + Consider that the PHP manual is changing from day to day. </para> <para> - If you think someone already faced the exact problem, + If you think someone already faced the exact problem and you are stuggling, you can ask your questions on one of our popular mailing lists. There are plenty of them grouped by subject. You may receive an answer - for your question in minutes in the busyest hours. + for your question in minutes in the busiest hours. You can subscribe to one mailing list at <ulink url="&url.php.support;">&url.php.support;</ulink>. You can also find IRC channels linked on this @@ -146,17 +150,19 @@ <title>How to help improve the documentation</title> <para> Of course you can help to improve our documentation. - There are basically to ways of doing this. + There are basically two ways of doing this. </para> <para> - If you find any errors in this manual, in any language, + If you find any errors within 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". This way we can follow every bug and track the things done to eliminate them from the documentation. You can also submit format problems (eg. PHP Manual PDF displayed - incorrectly). + incorrectly). Please don't abuse the bug system by submitting + requests for help, use the mailing lists or community sites + mentioned above, instead. </para> <para> By adding annotations to pages, you can provide more

« previous php.doc (#969339217) next »