Just a quick note to point out [url=http://beeblex.com/lists/index.php/php.doc/969372058]this post[/url].
Gabor is stepping down as the PHP Manual's main editor.
As I [url=http://beeblex.com/lists/index.php/php.doc/969372059]said in the thread[/url]: so long Goba, you will be missed.
S
I've finally found a few minutes to upgrade my s9y install, so I no longer have an excuse to avoid posting here.
I'm currently at php|works (like Marco, Wez, Derick, Ilia, Marcus, Rasmus, George, Chris, Lukas, Davey, and many others whom I'm probably forgetting).
It's been wonderful, so far. Interesting talks, great company, and an excellent venue.
As always, the best part is sharing mind-time with the guys I normally only see on IRC and in mails. Marco has been exceptionally hospitable.
In the same vein (mind-time sharing), I managed to get some work done on Livedocs, yesterday, and I bugged Ilia enough to commit my patches. In short: the search bar is now in the default theme, and the leftbar TOC now has the "current" breakout on the top of the list (suggested by both Wez and Lukas).
S
Just a quick note to say that I finished up the first round of [url=http://php.net/apc]APC Documentation[/url] over the weekend.
(and Rasmus linked to my livedocs on the Internals list)
There've been more changes since that was built, but at least the basic docs are there, now.
Enjoy.
((update: seems I suck at making links in HTML; fixed))
S
A couple weeks ago, I [url=http://news.php.net/php.doc/969368780]posted the following[/url] (well, almost) to the PHP Doc list (don't worry, it's not a rant, this time). I haven't got much feedback from the list (we're busy guys!), and it's been a while, so I think it's about time I get some general feedback.
Short version: pre-built livedocs available for consumption by the enlightened (but not quite ready for newbies).
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.
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, it's around 4.5 megs. Not 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:
[url=http://www.phpdoc.info/livedocs/built/]http://www.phpdoc.info/livedocs/built/[/url]
It's built nightly.
Feedback, please.
S
Today, I put together a new (small) tool, at the [url=http://news.php.net/php.doc/969368576]request[/url] of Jared Williams, on the doc list. It occurred to me that some of my other doc tools are virtually unknown.
Here's a brief description of three.
One of peoples' beefs about PHPDoc and Docbook is the tool chain required to build it. This tool is so simple, I wouldn't even call it a "tool" outside of this post: basically, it's a pre-configured docbook tree of the PHP manual. Why would anyone want this? Well, the requester needed it for a command-line tool he's building, but was having diffulties (guessing here) getting the tool chain working. It was a simple job, so I scripted and cronned it up. Note: you still need the tool chain to, e.g. build the HTML manual.
If you need a pre-configured doc tree (with appropriate functions.xml files, etc.), for some reason, see: [url]http://www.phpdoc.info/docs_prepared/[/url]. This will evolve over time: purging old builds, a "latest" build script, etc. It's tarred up, nightly.
(keep reading, the other two are cooler (-: )
I've mentioned this one a couple times, to a few people (and briefly, on the doc list). I'll eventually port it to docweb. The PHP Manual has User Contributed Notes on (almost) every page. These are a headache to maintain. Most of them are garbage. If you have a CVS account, you can help. All you need to do is log in and get the magic cookie (the tool will ask you for this if you haven't yet logged in). I find my notes manager at [url]http://www.phpdoc.info/notes/manage.php[/url] helps ease the usually-thankless task of purging notes (the tool itself only proxies notes).
IMO, this is the coolest of the tools. You may have noticed the RSS feed in the right-bar of my blog, of the "latest PHP commits". I construct this feed myself. See: [url]http://www.phpdoc.info/commits/[/url] for HTMLized versions of the commit mails (I track most, but not all PHP commits). If you're interested in the RSS feed(s), try: [url]http://www.phpdoc.info/commits/rss[/url] (or: [url]http://www.phpdoc.info/commits/rss/pear[/url], [url]http://www.phpdoc.info/commits/rss/doc[/url])
Hope those are useful to more people than just me.
If you have questions, or find bugs, be sure to let me know.
S
