Page 1 of 1

Tutorials for phpDocumentor docBook

Posted: Tue Oct 10, 2006 4:28 pm
by Ollie Saunders
Anybody written tutorials in phpDocumentor with docBook?
Know any good resources/tutorials/applications for doing it?

Posted: Tue Oct 10, 2006 5:25 pm
by sweatje
http://blog.casey-sweat.us/?p=25 is a little broader in scope than just the docbook stuff, but I think I remember touching on it a bit. You might also want to look at the files in SimpleTest as an example, I worked out a couple of things to generate the docs at http://simpletest.org/ (the lower right frame)

Posted: Tue Oct 10, 2006 5:37 pm
by Ollie Saunders
Ahh superb, thanks Jason.
Btw your presentation was very nice, I particularly liked the live coding. Didn't really teach me anything though I has have both your book and Kent Beck's TDD by Example.

Posted: Tue Oct 10, 2006 6:00 pm
by Ollie Saunders
Err yeah. All 48 slides told me things I already knew :(
And I can't seem to find your .proc .pkg .cls documentation files for simpletest. That's what I would really like to look at.

Posted: Tue Oct 10, 2006 6:10 pm
by sweatje
Yeah, we have to create them on the fly by transforming the XML sources so we can have one source for the text docs, lastcraft site and the docbook for the phpdoc sources. I have to head out right now, but when I get back I will get you the transformed versions and post them as a zip file here.

Thanks for the comments on the presentation, have not heard much feedback. Hard to go too much in depth in 30 minutes. I would like to do a longer tutorial sometime where you explore the API of a system using mocks.

Posted: Tue Oct 10, 2006 6:25 pm
by Ollie Saunders
Yeah, we have to create them on the fly by transforming the XML sources so we can have one source for the text docs, lastcraft site and the docbook for the phpdoc sources.
Isn't that the whole point of docBook, that you can do that?
I have to head out right now, but when I get back I will get you the transformed versions and post them as a zip file here.
Sweet; thanks.
Thanks for the comments on the presentation, have not heard much feedback.
Yeah I thought it was pretty courageous to start coding in a room full of programmers within sniping range. I suppose I would have liked to have seen a more advanced tutorial, the basics are really easy in my opinion, it's just a question of disciplining yourself to write the tests first. It's the more advanced areas of unit testing i'm interested in now like mocks, testing larger bodies of code, web testing or strategies for tackling legacy code.

Posted: Wed Oct 11, 2006 3:34 am
by Yossarian
sweatje wrote:Hard to go too much in depth in 30 minutes. I would like to do a longer tutorial sometime where you explore the API of a system using mocks.
Would like to hear that. Was reading up on mocks on the train ride in.

Posted: Wed Oct 11, 2006 5:49 am
by sweatje
Here is one of the transformed doc sets. Not the most recent but should help. I believe there was some non-docbook stuff introduced (little Smarty macros) which would mess up the XSLT transformations to the other formats, hence the reason for pure XML sources.

Hmm. I don't see a file upload option. Try simpletest_phpdoc.tgz

Posted: Wed Oct 11, 2006 6:12 am
by Ollie Saunders
Thanks Jason.
Will be studying this in depth today. I'm writing as much of the docs for my library as possible before coding and I decided phpDocumentor was the way to go.
phpDocumentor comes built into Zend Development Environment so creating them is really easy.