Re: [PHP-DOC] Re: [PHP-DOC-CHM] Getting PEAR documentation into the PHP Extended CHM Manual.

2005-06-10 Thread Sean Coates

Who has no webserver on his machine nowadays? Especially if he is
interested in PHP? Livedocs offers a lot more possibilities also in an
offline (ie without internet connection, with local webserver) setting,
if used appropriately.


That's a fair argumet. I agree. (-:

S


Re: [PHP-DOC] Re: [PHP-DOC-CHM] Getting PEAR documentation into the PHP Extended CHM Manual.

2005-06-10 Thread Gabor Hojtsy
>> Please enhance and fix what is already in here, and do not start a new
>> project! :) Livedocs, livedocs!
> 
> I appreciate the sentiment, but livedocs = online, XUL manual = offline.
> 
> Anyway.. no time for either, ATM (-:

Who has no webserver on his machine nowadays? Especially if he is
interested in PHP? Livedocs offers a lot more possibilities also in an
offline (ie without internet connection, with local webserver) setting,
if used appropriately.

Goba


Re: [PHP-DOC] Re: [PHP-DOC-CHM] Getting PEAR documentation into the PHP Extended CHM Manual.

2005-06-10 Thread Sean Coates

Gabor Hojtsy wrote:

Please enhance and fix what is already in here, and do not start a new
project! :) Livedocs, livedocs!


I appreciate the sentiment, but livedocs = online, XUL manual = offline.

Anyway.. no time for either, ATM (-:

S


Re: [PHP-DOC] Re: [PHP-DOC-CHM] Getting PEAR documentation into the PHP Extended CHM Manual.

2005-06-10 Thread Gabor Hojtsy
>> Maybe
>> it is worth taking a serious look at using a PHP +GTK app? Not the best
>> idea, maybe.
> 
> On my incomplete PHP-related TODO
> (http://wiki.phpdoc.info/SeanCoates/PHPToDo), is:  XUL based PHP Manual
> (CHM Alternative)
> 
> Unfortunately, I hardly have time to sleep, presently, so if someone
> else wants to run with the idea, I'd be more than happy to chip in (when
> I can).. I haven't done much with it yet.

Please enhance and fix what is already in here, and do not start a new
project! :) Livedocs, livedocs!

Goba


Re: [PHP-DOC] Re: [PHP-DOC-CHM] Getting PEAR documentation into the PHP Extended CHM Manual.

2005-06-09 Thread Sean Coates

Richard A. Quadling wrote:

Maybe
it is worth taking a serious look at using a PHP +GTK app? Not the best
idea, maybe.


On my incomplete PHP-related TODO 
(http://wiki.phpdoc.info/SeanCoates/PHPToDo), is:  XUL based PHP Manual 
(CHM Alternative)


Unfortunately, I hardly have time to sleep, presently, so if someone 
else wants to run with the idea, I'd be more than happy to chip in (when 
I can).. I haven't done much with it yet.


S


RE: [PHP-DOC] Re: [PHP-DOC-CHM] Getting PEAR documentation into the PHP Extended CHM Manual.

2005-06-09 Thread Richard A. Quadling
Anatoly,

But having all the documentation linkable in a single CHM, not
necessarily by default, would be of benefit to non-newbies though.

I accept that the indexing issues within MS's CHM is pretty poor. Maybe
it is worth taking a serious look at using a PHP +GTK app? Not the best
idea, maybe.

I think though, when the livedocs system goes live, it should include
ALL PHP documentation (PHP, PEAR, PECL, Zend) and allow the option to
have it ALL searched. Rather than have all these different manuals.

 

-Original Message-
From: anatoly techtonik [mailto:[EMAIL PROTECTED] 
Sent: 08 June 2005 18:42
To: Gabor Hojtsy
Cc: Richard A. Quadling; [EMAIL PROTECTED]; phpdoc@lists.php.net
Subject: Re: [PHP-DOC] Re: [PHP-DOC-CHM] Getting PEAR documentation into
the PHP Extended CHM Manual.

||*()*|| Hi, Gabor.

>> Are there any plans to provide a means for people downloading the XML

>> sources via CVS to be able to build a COMPLETE PHP Manual?
>>
>> By complete, I mean, PHP, PEAR, ZendAPI, etc, the whole lot. All 
>> documentation associated with PHP.
>>
>> I understand that most users would only want the PHP part, though, I 
>> think the PEAR documentation should be included also.
>>
>> Currently, I can ...
>>
>> ./configure --with-chm=yes --with-source=./../php-src 
>> --with-pecl-source=./../pecl --with-pear-source=./../pear>> 
>> ../conf.log
>>
>> The PEAR source doesn't seem to produce any output.
>>
>> The PECL documentation produces a single section with 4 subsections 
>> (HTML parser extension, EXIF tag access library, MDB data file access

>> library and UUID extension). The level of documentation here is
brief.

GH> CHM building uses interesting tricks, but it is still a good 
GH> question, whether we can make it possible to build a complete 
GH> PEAR+PHP manual. Could someone from the peardoc front comment on
this?

PEAR manual already renders in CHM and it takes about 2.4Mb additional
load. ZendAPI is not included in xCHM, but present in standart CHM
version. I guess it is possible to link these CHM's together, but I
doubt somebody will benefit from this if Index and Search capabilities
merge. PEAR index can greatly confuse users who learn PHP. Search
results make it even worse producing informational garbage gathered from
all three files rather than displaying only relevant info. I don't know
a way to limit search scope and it seems to me, that having three
separate manuals is the best solution.


t
-- 


RE: [PHP-DOC] Re: [PHP-DOC-CHM] Getting PEAR documentation into the PHP Extended CHM Manual.

2005-06-09 Thread Gabor Hojtsy

But having all the documentation linkable in a single CHM, not
necessarily by default, would be of benefit to non-newbies though.

I accept that the indexing issues within MS's CHM is pretty poor. Maybe
it is worth taking a serious look at using a PHP +GTK app? Not the best
idea, maybe.

I think though, when the livedocs system goes live, it should include
ALL PHP documentation (PHP, PEAR, PECL, Zend) and allow the option to
have it ALL searched. Rather than have all these different manuals.


The livedocs display engine is supposed to take on this role, but 
apparantely, we need quite some hands for testing, daily using, tweaking, 
bugfixing and improving on that engine. I bet you will find noone on earth 
to create a PHP-GTK based help browser for the PHP docs, especially given 
that CHM viewers are available for all major platforms. Livedocs however 
would be much more optimal for DocBook based documentation, so it has 
quite some advantages over CHM (the possibility of dynamic, on demand TOC 
creation for example, with only those extensions you really use).


Goba


Re: [PHP-DOC] Re: [PHP-DOC-CHM] Getting PEAR documentation into the PHP Extended CHM Manual.

2005-06-09 Thread Gabor Hojtsy

PEAR manual already renders in CHM and it takes about 2.4Mb
additional load. ZendAPI is not included in xCHM, but present in
standart CHM version. I guess it is possible to link these CHM's
together, but I doubt somebody will benefit from this if Index and
Search capabilities merge. PEAR index can greatly confuse users who
learn PHP. Search results make it even worse producing informational
garbage gathered from all three files rather than displaying only
relevant info. I don't know a way to limit search scope and it seems
to me, that having three separate manuals is the best solution.


There is a feature in the CHM creation process to specify zones 
(collections) for browsing and searching, but this was eventually not 
implemented too nicely by Microsoft, and completely left undocumented.


  http://fox.wikis.com/wc.dll?Wiki~HtmlHelpCollections~VFP

Goba


Re: [PHP-DOC] Re: [PHP-DOC-CHM] Getting PEAR documentation into the PHP Extended CHM Manual.

2005-06-09 Thread anatoly techtonik
||*()*|| Hi, Gabor.

>> Are there any plans to provide a means for people downloading the XML
>> sources via CVS to be able to build a COMPLETE PHP Manual?
>>
>> By complete, I mean, PHP, PEAR, ZendAPI, etc, the whole lot. All
>> documentation associated with PHP.
>>
>> I understand that most users would only want the PHP part, though, I
>> think the PEAR documentation should be included also.
>>
>> Currently, I can ...
>>
>> ./configure --with-chm=yes --with-source=./../php-src
>> --with-pecl-source=./../pecl --with-pear-source=./../pear>> ../conf.log
>>
>> The PEAR source doesn't seem to produce any output.
>>
>> The PECL documentation produces a single section with 4 subsections
>> (HTML parser extension, EXIF tag access library, MDB data file access
>> library and UUID extension). The level of documentation here is brief.

GH> CHM building uses interesting tricks, but it is still a good question, 
GH> whether we can make it possible to build a complete PEAR+PHP manual. Could 
GH> someone from the peardoc front comment on this?

PEAR manual already renders in CHM and it takes about 2.4Mb
additional load. ZendAPI is not included in xCHM, but present in
standart CHM version. I guess it is possible to link these CHM's
together, but I doubt somebody will benefit from this if Index and
Search capabilities merge. PEAR index can greatly confuse users who
learn PHP. Search results make it even worse producing informational
garbage gathered from all three files rather than displaying only
relevant info. I don't know a way to limit search scope and it seems
to me, that having three separate manuals is the best solution.


t
-- 


[PHP-DOC] Re: [PHP-DOC-CHM] Getting PEAR documentation into the PHP Extended CHM Manual.

2005-06-08 Thread Gabor Hojtsy

Are there any plans to provide a means for people downloading the XML
sources via CVS to be able to build a COMPLETE PHP Manual?

By complete, I mean, PHP, PEAR, ZendAPI, etc, the whole lot. All
documentation associated with PHP.

I understand that most users would only want the PHP part, though, I
think the PEAR documentation should be included also.

Currently, I can ...

./configure --with-chm=yes --with-source=./../php-src
--with-pecl-source=./../pecl --with-pear-source=./../pear>> ../conf.log

The PEAR source doesn't seem to produce any output.

The PECL documentation produces a single section with 4 subsections
(HTML parser extension, EXIF tag access library, MDB data file access
library and UUID extension). The level of documentation here is brief.


CHM building uses interesting tricks, but it is still a good question, 
whether we can make it possible to build a complete PEAR+PHP manual. Could 
someone from the peardoc front comment on this?


Goba