Flourish PHP Unframework
This is an archived copy of the forum for reference purposes

Offline documentation

posted by al 10 years ago

It will be awesome, if we'll have offline documentation :)

Adam Patterson created a PDF of at least some of the documentation a while back and posted it at http://www.studiolounge.net/files/FlourishPHPDocumentation. I believe it is somewhat out-of-date, but it could be a start.

I am hoping at some point to take some time and see if I can find a nice way to generate a PDF of the documentation as part of my standard post-commit SVN hook. It would probably need to be some sort of HTML to PDF conversion since the documentation exists in formats (PHPDoc and wiki) that currently really only generate HTML well.

I'm sure someone will point out that PHPDoc can generate PDFs, however there is quite a bit of customization that I've done for the HTML generation I have that I don't think would be feasible with PDFs and the amount of time I have to work on it.

posted by wbond 10 years ago

I've created a single HTML file for offline viewing of the documentation. It is accessible from the Documentation page and will be automatically updated every time new code is checked in, or whenever a class documentation page is edited.

posted by wbond 9 years ago