api in chm format

thread: 5 messages  |  last: about 3 years ago  |  started: wednesday, march 26, 2008, 2:55 am pdt


#1  |  activeserver (India)
Wednesday, March 26, 2008, 2:55 AM PDT

Hi all,
I find it a bit troublesome to keep referring to the online API at api.qcodo.com, due to my ISP.

A.
It should be a do-able task to make a CHM for Qcodo API and I'm willing to chip in. (and if it's that easy, i'll get it ready in a week or so, if all goes well :) )

B.
In the worst case, it can be a website image in zip/tgz format.
For that, I can use a website downloader once and then make the zip file available for download at some public download server or here at QCodo.

I just need pointers as to how to grab a full download.
The problem is that api.qcodo.com is Javascript-based and so, a downloader will not be able to grab links.
Maybe that is the way it was designed to throttle bad bots, but if I download once and distribute the zip, that should not be a problem :)

C.
Alternatively, if there's a way of generating the API docs out of the source itself, that is best.

Any help is greatly appreciated.
TIA!

#2  |  activeserver (India)
Wednesday, April 9, 2008, 3:19 AM PDT

Could we offer the “view source code” link in a frame alongside?
Using a frame is probably not so bad in this case because the examples ship with the qcodo download and it's for us developers.

It's irritating to keep two windows open and tiled and read the rendered html on one side and the formatted source view on the other chiefly because this has to be done for every page....

Of course I can style the CSS for myself, but will it help anyone else as well...?

comments/criticisms welcome :-)
tia

#3  |  activeserver (India)
Thursday, June 19, 2008, 1:45 PM PDT

Better late than never :-)

QCodo api docs in htmlhelp/.chm form

http://www.mediafire.com/?glezuxx4lyd

----------------------------------------
DISCLAIMER: Alpha version. Poor CSS. Not organized. Please customize.
----------------------------------------

To do a better job yourself, get phpdocumentor from sourceforge.net and run it on the qcodo source that you download from here.

1. if on WAMP (wampserver) like me, put C:\wamp\bin\php\php5.x.y, the path to the php.exe file in your windows path

2. open a command window - cmd.exe ->

3. run this in the folder(C:\wamp\www\PhpDocumentor) having the phpdoc.bat file:

“C:\wamp\www\PhpDocumentor\phpdoc.bat” -t “C:\wamp\www\PhpDocumentor\docbuilder\qcodo332” -o HTML:frames:default -d “C:\wamp\www\qcodo332\wwwroot”

The term
HTML:frames:default
can be replaced by any one of these:

HTML:frames:earthli
HTML:frames:l0l33t
HTML:frames:phpdoc.de
HTML:frames:phphtmllib
HTML:frames:phpedit
HTML:frames:DOM/default
HTML:frames:DOM/earthli
HTML:frames:DOM/l0l33t
HTML:frames:DOM/phpdoc.de
HTML:frames:DOM/phphtmllib
HTML:Smarty:default
HTML:Smarty:HandS
HTML:Smarty:PHP
PDF:default:default
CHM:default:default
XML:DocBook/peardoc2:default

Alternatively you can read the phpdocumentor INSTALL and README to figure out what's going on :-)

hope that helps!

PS: if time permits, a better version will follow soon. IF...

#4  |  activeserver (India)
Monday, June 23, 2008, 1:51 PM PDT

oops! the chm above does not work! :-(

So, try this instead: http://www.mediafire.com/?m9yzd2f2zqo
This one's for qcodo-0.3.43b
(checked it this time, seems fine...)

If you can figure out the difference between 0.3.32 and 0.3.43b,
you can surely generate the docs yourself.

A zip in plain frames-html format, Javadoc-like layout.

HTH

#5  |  activeserver (India)
Friday, July 18, 2008, 12:00 AM PDT

Hi all,
I'll be working over the weekend with moving the comments that Mike's put in the source code to “DocBlock” format.

To ensure that I do not repeat work done by Mike Ho or Mike Hostetler, I have a few questions about “what” and how good” -

==============
Q1: Is this necessary? Or is there another documentor tool which nicely generates HTML documentation from the present set of comments itself?

Q2: Since QCodo and ZCodo are now officially declared mutually beneficial, all good things from Q,Z can be moved to Z,Q. So should the source code commenting, right?
==============

AFAIK, Z has its own distinct identity because of the Drupal integration and Mike Hostetler's cross-framework integration stuff.
OTOH, Q is awesome to begin with. And now that Mike's been talking of GITting it, we can expect a lot more people to join and contribute.

So IMO, documentation can flow both ways if useful.

Now to the next relevant thing - Mike Hostetler's doc-wiki - is it nearing completion? if so then a web-grab of the site is a good enough starting point - and we can edit the wiki.
But we still need a downloadable zip or CHM(windows) manual. Many people like it.

All ears to any suggestion. No leanings either way ;-)



Copyright © 2005 - 2012, Quasidea Development, LLC
This open-source framework for PHP is released under the terms of The MIT License.