mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
we are not providing text versions anymore, plus adding more info on linux chm viewers, the extended CHM, and URL shortcuts
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@159482 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
parent
553592bd19
commit
033a8ab373
1 changed files with 23 additions and 31 deletions
|
@ -1,14 +1,6 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.32 $ -->
|
||||
<!-- $Revision: 1.33 $ -->
|
||||
|
||||
<!--
|
||||
TODO: add manual conventions section (eg. how to read
|
||||
function usage parts, what is fixed width, what is
|
||||
bold, what is linked
|
||||
|
||||
add some tips about combining the versions (online-
|
||||
offline), and using "http://anymirror.php.net/funcname"
|
||||
-->
|
||||
<appendix id="about">
|
||||
<title>About the manual</title>
|
||||
|
||||
|
@ -26,17 +18,18 @@
|
|||
</para>
|
||||
</note>
|
||||
<para>
|
||||
You can read the manual online at <ulink url="&url.php;">&url.php;</ulink>
|
||||
You can read the manual online at the <ulink url="&url.php;">PHP.net website</ulink>
|
||||
and on the numerous mirror sites. For best performance, you should choose
|
||||
the mirror site closest to you. You can view the manual in either its plain
|
||||
(print-friendly) HTML format or an HTML format that integrates the manual
|
||||
into the look and feel of the PHP website itself.
|
||||
</para>
|
||||
<para>
|
||||
An advantage of the online manual over most of the offline formats is the
|
||||
Two notable advantages of the online manual over most of the offline formats is the
|
||||
integration of <link linkend="about.notes">user-contributed
|
||||
notes</link>. An obvious disadvantage is that you have to be online to view
|
||||
the manual in the online formats.
|
||||
notes</link> and the <ulink url="&url.php.urlhowto;">URL shortcuts</ulink> which you
|
||||
can use to get to the desired manual parts quickly. An obvious disadvantage is
|
||||
that you have to be online to view this edition of the manual.
|
||||
</para>
|
||||
<para>
|
||||
There are several offline formats of the manual, and the most appropriate
|
||||
|
@ -46,17 +39,17 @@
|
|||
formats'</link> section of this appendix.
|
||||
</para>
|
||||
<para>
|
||||
The most cross-platform formats of the manual are the HTML and plain-text
|
||||
versions. The HTML format is provided both as a single HTML file and as
|
||||
a package of individual files for each section (which results in a
|
||||
collection of several thousand files). The HTML and plaintext formats are
|
||||
provided as tar files compressed using the bzip2 archiver.
|
||||
The most cross-platform format of the manual is the HTML version. This
|
||||
is provided both as a single HTML file and as a package of individual files
|
||||
for each section (which results in a collection of several thousand files).
|
||||
We provide these versions compressed, you will need some sort of uncompression
|
||||
utility to get the files contained in the archives.
|
||||
</para>
|
||||
<para>
|
||||
Another popular cross-platform format, and the format most suited to
|
||||
printing, is PDF (also known as Adobe Acrobat). But before you rush to
|
||||
download this format and hit the Print button, be warned that the manual is
|
||||
nearly 2000 pages long, and constantly being revised.
|
||||
more than 2000 pages long, and constantly being revised.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
|
@ -79,19 +72,18 @@
|
|||
<productname>Windows HTML Help</productname> application. This
|
||||
version provides full-text search, a full index, and bookmarking. Many
|
||||
popular Windows PHP development environments also integrate with this
|
||||
version of the documentation to provide easy access.
|
||||
version of the documentation to provide easy access. CHM viewers for
|
||||
Linux desktops are also available. Check out
|
||||
<ulink url="&url.xchm;">xCHM</ulink> or
|
||||
<ulink url="&url.gnochm;">GnoCHM</ulink>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
There is also an <ulink url="&url.php.echm;">extended CHM version</ulink>
|
||||
available, which is updated less frequently, but provides much more
|
||||
features. It will only work on <productname>Microsoft Windows</productname>
|
||||
though, because of the technologies used to build up the help pages.
|
||||
</para>
|
||||
<!--
|
||||
mmmm, this project seems to be dead. Any news?
|
||||
<note>
|
||||
<para>
|
||||
A Visual Basic for Linux project is in the planning stage, which will
|
||||
include the development of a CHM Creator and Viewer for Linux. See their
|
||||
<ulink url="&url.vb4linux;">SourceForge.net page</ulink> if you are
|
||||
interested in the progress.
|
||||
</para>
|
||||
</note>
|
||||
-->
|
||||
</sect1>
|
||||
|
||||
<sect1 id="about.notes">
|
||||
|
|
Loading…
Reference in a new issue