PHPDoc ExtJS converter template

As some of you may have noticed, Zym has very nice Extjs based API docs generated by PHPDocumentor. Luckily our code is open, so others can have the same beautiful ExtJS PHPDoc theme. We created it to our specifications and needs mainly so there will still be some bugs.

Check out our API docs for a demo

Install: Simply place it into the Converter/Html/frames/ directory and use "HTML:frames/Extjs:default" as the output template

License: GPL v3

Grab the latest version from our downloads

Download Zym's PHPDoc ExtJS template
Comments (28)add comment

David said:

To start phpdoc parsing I have to change "HTML:frames/Extjs:default" with "HTML:frames:Extjs:default".

Great work!
Thanks,
david
 
report abuse
vote down
vote up
October 15, 2008 | url
Votes: -1

David said:

HTML:frames:Extjs:default" it is wrong. I tried
But... sone one know why apper this error?
ERROR: Converter HTMLframesExtjsConverter specified by --output command-line option is not a class

ERROR: No Converters have been specified by --output command-line option

ERROR: No Converters have been specified by --output command-line option
 
report abuse
vote down
vote up
October 15, 2008 | url
Votes: +0

Geoffrey Tran said:

Hi David,

It should be HTML:frames/Extjs:default as specified. It is the same as what we use in our build scripts.

http://code.google.com/p/zym/source/browse/trunk/documentation/api/build/build.properties

Perhaps the theme was placed in the wrong directory? (On my mac, there was two installations of phpDoc for some odd reason)
 
report abuse
vote down
vote up
October 15, 2008
Votes: +2

david said:

Thanks for your help, now it work.

I did:

1) /usr/share/php5/PEAR/data/PhpDocumentor/phpDocumentor/Converters/HTML/frames/
2) /usr/share/php5/PEAR/PhpDocumentor/phpDocumentor/Converters/HTML/frames

There are two directories phpDocumentor, in the first one there is /data/ en plus. But the file have to split into these two directories, in this way:

Put Extjs as explained in INSTALL.txt into 1)
Mkdir Extjs into 2)
Move HTMLframesExtjsConverter.inc file from 1) to 2) Extjs dir

bye, david
 
report abuse
vote down
vote up
October 16, 2008 | url
Votes: +5

Son Nguyen said:

Very nice, it works as expected and it's very usability. Thanks for your contribution
 
report abuse
vote down
vote up
December 28, 2008 | url
Votes: -2

Wilfried Loche said:

Thx a lot david, I had exactly the same pb as you had smilies/cheesy.gif
 
report abuse
vote down
vote up
January 26, 2009 | url
Votes: +0

Russian Red said:

WTF!! smilies/angry.gif
 
report abuse
vote down
vote up
February 13, 2009
Votes: -5

Wol Darf said:

I tried everything but cant make it to work...

Tried to use HTML:frames/Extjs:default, HTML:frames:Extjs/default, HTML:frames:Extjs:default

Tried:
PhpDocumentorphpDocumentorConvertersHTML rames emplatesExtjs emplatesdefault emplates
PhpDocumentorphpDocumentorConvertersHTML rames emplatesExtjsdefault emplates
PhpDocumentorphpDocumentorConvertersHTML rames emplatesExtjs emplates

But none worked, or it give me:
Converter HTMLframesExtjsConverter specified by --output command-line option is not a class

Or

directory: '' not found
 
report abuse
vote down
vote up
August 26, 2009
Votes: +0

Wol Darf said:

My mistake, i was putting it inside template.
 
report abuse
vote down
vote up
August 26, 2009
Votes: +0

Geoffrey Tran said:

Hi Wol,

Great to hear that you got it working, I'll try to clear up the installation procedure when I have time.

Eventually I want to clean up the template and package it up as a pear package, but as of now I am a bit busy.

Geoff
 
report abuse
vote down
vote up
September 01, 2009 | url
Votes: +0

Sebastian said:

Hello
I have one of the above mentioned problems too.

ERROR: Converter HTMLframesExtjsConverter specified by --output command-line option is not a class
ERROR: No Converters have been specified by --output command-line option
ERROR: No Converters have been specified by --output command-line option

I'm running phpdoc using the web-gui instead of the commandline. I think it's unzipped in the correct folder ([document_root]/phpdoc/phpDocumentor/Converters/HTML/frames/Extjs)

I'm usind HTML:frames/Extjs:default to specify the output format.

moving the HTMLframesExtjsConverter.inc as mentioned above didn't help. Is it a problem that my apache is running on windows?

I'm grateful for any suggestion ...
greetz
 
report abuse
vote down
vote up
October 05, 2009 | url
Votes: +0

rowy said:

awesome looking template guys. well done...

i've gotten as far as using the HTMLframesExtjsConverter.inc.php fix, and the generation works (excusing my lack of docBlocks and some 'Undefined variable: childrenPkgClasses' errors)

but! the JS fails to start - i get the loading icon, and a JS error 'attr is null' line 105 of ext-all.js
 
report abuse
vote down
vote up
October 29, 2009 | url
Votes: +0

rowy said:

UPDATE:
ok - so it all works now - seems the renderer didnt like my total lack of packages / subpackages. works a charm now... so, so much better than anything else php doc offers template-wise!

It would be fantastic if your template also included some of the other functionalities:
- a @todo listing
- a class inheritance tree
- an index of elements/methods
- highlighted source code

(i might event have a read of the GPL smilies/smiley.gif
 
report abuse
vote down
vote up
October 30, 2009 | url
Votes: +0

rowy said:

having had a quick look at the highlighted source code stuff - all of it seems to be there, but the style path in the sourcecode view is wrong:

is currently styles/phpdoc.css
should be ../styles/phpdoc.css

a quick fix for this for anyone reading is this:
1) render your documents
2) go to your document root directory
3) cp -R styles/ __filesource/
4) hey presto!
 
report abuse
vote down
vote up
October 30, 2009 | url
Votes: +0

Merwin said:

Hi,

I just installed this templates and it rox. The problem is that when I go to the generated doc, there is the 'Loading' icon in the middle, and nothing happened.

I can click and expend right menu, new tabs open, but there always have the loading icon. Help me please ;-)
 
report abuse
vote down
vote up
November 04, 2009
Votes: +0

tayfun said:

Hi Everyone,

I have used David's third comment to set up the template. I can generate documents using HTML:frames/Extjs:default and as for the "Loading" problem, I'm not sure why but if you serve the file via a webserver it works.

I hope this helps,

Tayfun
 
report abuse
vote down
vote up
November 13, 2009 | url
Votes: +0

Seven said:

Hi Everyone!

I managed to get it work by dropping the "Extjs" in Converters/HTML/frames/. However, when I open up index.html I get the loading icon in the middle and nothing else happens. Firebug shows a "attr is null" error.

Is it possible that the JS caught a bug because of documentation errors? I have several "Class Not Found" errors as I am using CakePhp and I do not want to redocument the core cake classes.
 
report abuse
vote down
vote up
November 24, 2009
Votes: +2

Lloyd Watkin said:

Struggled with the .ini fix myself, as a summary (to get it to work for me at least), move the HTMLframesExtjsConverter.inc file to the following path:

/usr/share/pear/PhpDocumentor/phpDocumentor/Converters/HTML/frames/Extjs
[lloyd@local Extjs]# ls
HTMLframesExtjsConverter.inc

In the same format as the HTMLSmartyConverter.inc and HTMLframesConverter.inc files (you'll work out the format!).
 
report abuse
vote down
vote up
December 10, 2009 | url
Votes: +0

webamoeba said:

Having the same problem as Seven. I just get a loading icon... The files are definiygtley there, so it must be some sort of JS problem.
 
report abuse
vote down
vote up
January 06, 2010
Votes: +0

webamoeba said:

Ahhh! Just spotted the solution - it must be run from a webserver (now why didn;t I think of that!). See http://code.google.com/p/zym/i...er Summary for more info.
 
report abuse
vote down
vote up
January 06, 2010
Votes: +0

andrezero said:

guys! congrats!

this is a fantastic application! it finally stepped up the quality of php documentation past the of level of comfort... it's more than enjoyable, it's even fun to use.

there's just one feature I fell missing, updating the url fragment to whatever tab/detail is open so we can link directly to a resource in the docs

 
report abuse
vote down
vote up
January 13, 2010 | url
Votes: +1

Denis St-Michel said:

Thanks for this wonderful converter!

One question though, it doesn't seems to use the right encoding or character set, because it does not render french or spanish character correctly, but on other converters it does.

any help?

Thanks,

Dennis
 
report abuse
vote down
vote up
February 19, 2010
Votes: +0

Christian Schultze said:

Thanks for this great Template.

Is there a way to link directly to generated pages, so that eg jump directly into one class of one existing subpackage?
 
report abuse
vote down
vote up
April 28, 2010
Votes: +0

Keith Loy said:

I was getting the "is not a class" error as well.

My fix: "mv ./HTMLframesExtjsConverter.inc /usr/share/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/Extjs"

I am using Ubuntu 10.04
 
report abuse
vote down
vote up
July 25, 2010 | url
Votes: +0

benny said:

I'm using ubuntu 10.04
the direcotries are

for the HTMLframesExtjsConverter.inc
/usr/share/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/Extjs

for the normal Extjs dir use this dir
/usr/share/php/data/PhpDocumentor/phpDocumentor/Converters/HTML/frames
 
report abuse
vote down
vote up
August 08, 2010
Votes: +0

Quick said:

The parsing and creation of the pages works well, and as long as I follow the links on the left hand side they open properly in the right part of the page.

But if I click an internal link in one of the documentation pages i.e. a class under the direct decendents it will open in a new browser tab, and not in a new tab within the documentation page.

Any ideas?
 
report abuse
vote down
vote up
August 08, 2010
Votes: +0

Jumper said:

Found a template based on this one, works better imo. Uses ajax and has a better menu.

You can find it here:
http://evolve.crazytje.be
 
report abuse
vote down
vote up
August 30, 2010
Votes: +0

PaNtHaLooN said:

ExtJS is definitely a nice template to start with. Enabling file sources I found that source links don't add new tabs within the template. Otherwise really nice job.

Evolve... as in Evolution? I found it lacks usability, style and the developer actually trades divs/spans for tables in parts (In my opinion that's a clear sign of regression).
 
report abuse
vote down
vote up
August 30, 2010
Votes: +0

Write comment
quote
bold
italicize
underline
strike
url
image
quote
quote
smile
wink
laugh
grin
angry
sad
shocked
cool
tongue
kiss
cry
smaller | bigger

busy