Hello fellow phpdocers.
In response to the conversation we had last week (you remember: the one
where Goba shot down my XUL docs idea, and I conceded? (-; ), I've been
working on packaging a pre-built Livedocs distribution. Ilia's recent
changes have also been a catalyst for me to actually do something about
this.
The project is currently in what I'd consider "early alpha" state, but
the few people I've had test it say that it works fine. Please don't
distribute the URL outside of this list.. yet.
So, basically what it is, is a pre-configured phpdoc + a pre-built
livedocs, with the paths mangled (to work at any location in the
filesystem), and all of the unnecessary files stripped out of the phpdoc
tree (leaving only the DocBook XML). It's likely that there are more
files that can be stripped, so I'm open to suggestions. It also marks
the function pages with an identifier: "language/control-structures.xml
$Revision: 1.119 $ | Sean's Pre-Built Livedocs 20050621 | generated:
2005-06-21 15:16:57 GMT"
Tarred and bzipped, we're to be slightly under 7 megs. Not too bad.
Short term goals:
- Get this working well on all tested platforms
- Create a new theme for this that's lighter than the php.net theme,
but DOES include a search box (only way to search, currently, is to hack
on the URL (using the default theme))
- Port my script to docweb, once we're reasonably happy with stability
(and save my bandwidth/CPU).
Long term goals:
- Distribute via php.net
- Use translations (livedocs dependent)
- Distribute as a PEAR package (PEAR's new channels seem like the
perfect candidate, as does the upcoming PHP_Archive package).
- "Make your own docs" where users can [un-]check the modules they
[don't] want, reducing the size of the tarball, and creating a custom
doc package. We could also have "common configurations" like "MySQL
developer" (remove all other database docs), as a base, before
[un-]checking modules.
And now, the URL:
http://www.phpdoc.info/livedocs/built/
It's built nightly. I know today's (20050621) works well.
Feedback, please.
S
