[wp-hackers] Plugin Readmes

Denis de Bernardy denis at semiologic.com
Thu Jul 21 10:20:22 GMT 2005


Eww... Sorry about that. For those who are wondering, I meant: Why not catch
the plugin's official page via RSS? :)

D.

> -----Original Message-----
> From: wp-hackers-bounces at lists.automattic.com 
> [mailto:wp-hackers-bounces at lists.automattic.com] On Behalf Of 
> Denis de Bernardy
> Sent: Thursday, July 21, 2005 12:14 PM
> To: wp-hackers at lists.automattic.com
> Subject: RE: [wp-hackers] Plugin Readmes
> 
> 
> Just curious... Why not catch the page where the plugin's 
> official page via RSS?
> 
> That way, it is structured properly, can be formatted 
> otherwise, the documentation is synchonized, and there is 
> even a direct link to the comments.
> 
> D.
> 
> > -----Original Message-----
> > From: wp-hackers-bounces at lists.automattic.com
> > [mailto:wp-hackers-bounces at lists.automattic.com] On Behalf Of 
> > Jonathan Leighton
> > Sent: Thursday, July 21, 2005 1:10 PM
> > To: wp-hackers at lists.automattic.com
> > Subject: Re: [wp-hackers] Plugin Readmes
> > 
> > 
> > Matthew Mullenweg wrote:
> > 
> > > Firas D. wrote:
> > >
> > >> The expectation is (a) there's a file in /trunk/ called 
> readme.txt,
> > >> (b) It's formatted like
> > >> 
> > <http://dev.wp-plugins.org/file/staticize-reloaded/trunk/readme.txt>
> > >
> > >
> > > Before anyone implements something, it would be a good time
> > to discuss
> > > improvements and intentions of that format. Right now
> > Contributors is
> > > expected to be forum usernames, for example.
> > 
> > Personally I don't like the readme.txt idea at all. Whenever
> > I change the wiki page for my plugin, I have to alter the 
> > readme.txt, and vice versa. It's annoying and bound to cause 
> > problems with them going out of sync. I'd much prefer that 
> > details about the plugin could just be pulled from the 
> > comment stuff at the top and people used a wiki page for 
> > docs. This has two advantages:
> > 
> > a) EVERY plugin has this comment -- it needs to in order to work
> > b) Wiki pages are FAR more formattable than a text file.
> > 
> > Jon
> > 
> > --
> > Jonathan Leighton aka. Turnip
> > http://turnipspatch.com/ | http://digital-proof.org/
> > 
> > _______________________________________________
> > wp-hackers mailing list
> > wp-hackers at lists.automattic.com
> > http://lists.automattic.com/mailman/listinfo/wp-hackers
> > 
> 
> _______________________________________________
> wp-hackers mailing list
> wp-hackers at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-hackers
> 



More information about the wp-hackers mailing list