[wp-docs] Re: [wp-hackers] Codex function page proposal

[Jennifer Hodgdon]

You might want to post this to the Doc list too (so I've cc'd that list).

I personally like your new style better than the current style. It 
annoys me all the time to have to scroll to the bottom to find the 
argument list, the way some of the current pages have been organized.

But if you are planning on using this for the functions known as 
"Template Tags", you will need to get some feedback from less 
technically-oriented viewers than the typical person on the Hackers 
list. I think the way those pages are organized (with examples first and 
the args way at the bottom) was chosen to avoid intimidating themers who 
are just trying to do a little more with their themes but might not be 
PHP or programming experts.

So what I am trying to say is I think your style idea is great for a 
programmer. :)   But we need to make sure to accomodate other audiences 
for "template tag" functions.

Regards,
    Jennifer

Gaarai wrote:
> I've spent the past couple of days working on a new style for the 
> function pages on the Codex. I did a lot of research on different 
> documentation sites. Eventually, I found that the PHP Function Reference 
> <http://us2.php.net/manual/en/funcref.php>, has what I consider the most 
> straightforward, intuitive function documentation style.
> 
> In order to see how the PHP style would work on the Codex, I created a 
> new function reference rough draft to try it out. My results can be 
> found here <http://codex.wordpress.org/User:Chrisbliss18/wp_cache_add> 
> (http://codex.wordpress.org/User:Chrisbliss18/wp_cache_add).
> 
> For those that don't know why I'm doing this, I'm trying to get a 
> standard format that can be used for all functions in order to make 
> using the Codex more consistent and creating/editing pages quicker and 
> easier.
> 
> With that in mind, I'd like to get feedback on what everyone thinks 
> about this format.
> 
> What do you like and dislike about it?
> Would this format make using the Codex easier or more difficult?
> Would this format make adding/editing the Codex easier or more difficult?
>