goba Sun May 23 17:46:55 2004 EDT
Modified files:
/phpdoc/entities global.ent
/phpdoc/en/appendices about.xml
Log:
we are not providing text versions anymore, plus adding more info on linux chm
viewers, the extended CHM, and URL shortcuts
http://cvs.php.net/diff.php/phpdoc/entities/global.ent?r1=1.182&r2=1.183&ty=u
Index: phpdoc/entities/global.ent
diff -u phpdoc/entities/global.ent:1.182 phpdoc/entities/global.ent:1.183
--- phpdoc/entities/global.ent:1.182 Sun May 23 16:51:39 2004
+++ phpdoc/entities/global.ent Sun May 23 17:46:55 2004
@@ -1,6 +1,6 @@
<!-- -*- SGML -*-
- $Id: global.ent,v 1.182 2004/05/23 20:51:39 goba Exp $
+ $Id: global.ent,v 1.183 2004/05/23 21:46:55 goba Exp $
Contains global "macros" for all the XML documents.
@@ -97,6 +97,7 @@
<!ENTITY url.gettext "http://www.gnu.org/software/gettext/gettext.html";>
<!ENTITY url.gettext.docs "http://www.gnu.org/software/gettext/manual/gettext.html";>
<!ENTITY url.gmp "http://www.swox.com/gmp/";>
+<!ENTITY url.gnochm "http://gnochm.sourceforge.net/";>
<!ENTITY url.gnu.configure "http://www.airs.com/ian/configure/";>
<!ENTITY url.gnu.man.date-input
"http://www.gnu.org/software/tar/manual/html_chapter/tar_7.html";>
<!ENTITY url.halcyon "http://www.halcyonsoft.com/";>
@@ -224,6 +225,7 @@
<!ENTITY url.php.docs "http://www.php.net/docs.php";>
<!ENTITY url.php.dochowto "http://cvs.php.net/co.php/phpdoc/howto/howto.html.tar.gz";>
<!ENTITY url.php.downloads "http://www.php.net/downloads.php";>
+<!ENTITY url.php.echm "http://www.php.net/docs-echm.php";>
<!ENTITY url.php.gtk "http://gtk.php.net/";>
<!ENTITY url.php.hosts "http://www.php.net/links.php#hosts";>
<!ENTITY url.php.license "http://www.php.net/license/";>
@@ -243,6 +245,7 @@
<!ENTITY url.php.snapshots 'http://snaps.php.net/'>
<!ENTITY url.php.talks 'http://talks.php.net/'>
<!ENTITY url.php.support "http://www.php.net/support.php";>
+<!ENTITY url.php.urlhowto "http://www.php.net/urlhowto.php";>
<!ENTITY url.phpeditorlist "http://phpeditors.linuxbackup.co.uk/";>
<!ENTITY url.phplib "http://phplib.sourceforge.net/";>
<!ENTITY url.powerarchiver "http://www.powerarchiver.com/";>
@@ -304,6 +307,7 @@
<!ENTITY url.winrar "http://www.rarlab.com/";>
<!ENTITY url.winzip "http://www.winzip.com/";>
<!ENTITY url.wddx "http://www.openwddx.org/";>
+<!ENTITY url.xchm "http://xchm.sourceforge.net/";>
<!ENTITY url.xdebug "http://www.xdebug.org/";>
<!ENTITY url.xdiff "http://www.xmailserver.org/xdiff-lib.html";>
<!ENTITY url.xitami "http://www.xitami.com/";>
http://cvs.php.net/diff.php/phpdoc/en/appendices/about.xml?r1=1.32&r2=1.33&ty=u
Index: phpdoc/en/appendices/about.xml
diff -u phpdoc/en/appendices/about.xml:1.32 phpdoc/en/appendices/about.xml:1.33
--- phpdoc/en/appendices/about.xml:1.32 Wed May 19 10:11:51 2004
+++ phpdoc/en/appendices/about.xml Sun May 23 17:46:55 2004
@@ -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">
