[wp-hackers] Codex function page proposal

Kim Parsell kparsell-wp at kpdesign.net
Tue Dec 30 12:47:42 GMT 2008

Chris, Dave, Alex -

Charles Clarkson has already written a parser in Perl that automates the 
creation of Codex documentation based on the inline documentation 
already in WordPress 2.7 (see 
Why not work with him to improve the documentation, rather than 
duplicating his effort?

I would also recommend moving this discussion over to the wp-docs list 
(http://lists.automattic.com/mailman/listinfo/wp-docs) as it's the more 
appropriate place for it, and ensures that anyone already involved in 
the documentation process sees your thoughts/ideas on the subject.

Just my 3 cents worth.



Gaarai wrote:
> I'm very interested Dave. I like the idea mentioned before where we 
> can test this out on a separate site, so that we can ensure that the 
> method works. When we come up with a model that works, we can then do 
> a proposal to the Docs team.
> I have a very full day today, but I can begin work on stuff tomorrow 
> evening.
> Chris Jean
> http://gaarai.com/
> http://wp-roadmap.com/
> ---------------------------------------------
> dave jaggy wrote:
>> Thank you Alex.
>> So, it is possible to create fully automated documentation site, 
>> which will populate itself from phpdoc, Codex and user-made comments. 
>> Does anyone here want to participate in a project like that? Gaarai, 
>> Brian?
>> I think we gotta choose php.net structure: function categories on 
>> top, function listing from current directory on left sidebar, the in 
>> the content part - function's phpdoc reference, source code block, 
>> codex wiki underneath it and user comments at the bottom. All content 
>> block should be collapsable. That's it I think.
>> Please feel free to express your opinions and suggestions, even if 
>> you do not want or have no time to participate in the project.
>> Dave
>> ----------------------------------------------
>> On Mon, Dec 29, 2008 at 11:46 PM, Alex Hempton-Smith
>> <hempsworth at googlemail.com> wrote:
>>> Well the Codex runs off MediaWiki, which has an API:
>>> http://www.mediawiki.org/wiki/API
>>> -- Alex

More information about the wp-hackers mailing list