Pre-Built Livedocs

PeeaycHPee

Tuesday, July 19. 2005

Pre-Built Livedocs

A couple weeks ago, I posted the following (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:
http://www.phpdoc.info/livedocs/built/
It's built nightly.

Feedback, please.

S
Posted by Sean Coates in PHP Doc at 14:10 | Comment (1) | Trackbacks (0)

Trackbacks
Trackback specific URI for this entry

No Trackbacks

Comments
Display comments as (Linear | Threaded)

3months and no comment?
Great package. I struggled with many configuration problems under Windows to get the regular phpdocs built. Before I succeeded, I found livedocs which looked more appealing. I had problems setting that up too. The pre-built livedocs has given me a valuable boost in knowing how it all ends up. For new comers, they don't need to worry about so much configuration.

I have not yet done a comparison of the code between a cvs livedocs and the prebuilt set. I will be looking into it and seeing what other improvements to make.
#1 odbc3 on 2005-10-16 05:45 (Reply)

Add Comment

BBCode format allowed

To prevent automated Bots from commentspamming, please enter the string you see in the image below in the appropriate input box. Your comment will only be submitted if the strings match. Please ensure that your browser supports and accepts cookies, or your comment cannot be verified correctly.
CAPTCHA

You can use [geshi lang=lang_name [,ln={y|n}]][/lang] tags to embed source code snippets
 
 

Pay the bills...

Calendar

Back July '08
Mon Tue Wed Thu Fri Sat Sun
  1 2 3 4 5 6
7 8 9 10 11 12 13
14 15 16 17 18 19 20
21 22 23 24 25 26 27
28 29 30 31      

Quicksearch

Archives

July 2008
June 2008
May 2008
Recent...
Older...

Syndicate This Blog

My PERSONAL Blog

Note:
The contents of this blog are my own, PERSONAL opinion and do not represent the thoughts or opinions of the people I work with or for. If you have a beef with something I said, take it up with ME. Thanks (-:
Geo Visitors Map