[wp-hackers] Plugin Readmes

Denis de Bernardy denis at semiologic.com
Thu Jul 21 10:51:37 GMT 2005

OK, well, how about this then?

Step 1, either of:

- rss2xml (simple xslt)
- atom2xml (simple xslt)
- wiki2xml (parser needed)
- readme2xml (parser needed)

And then: xml2plugindoc (simple xslt)

There is an obvious argument for the plain text readme file (human
readability), but introducing an intermediary xml step may very well make it
a lot more appropriate to pull content from other sources. The xml format
would need to be determined -- though I can't see why RSS would not fit


> -----Original Message-----
> From: wp-hackers-bounces at lists.automattic.com 
> [mailto:wp-hackers-bounces at lists.automattic.com] On Behalf Of Firas D.
> Sent: Thursday, July 21, 2005 12:34 PM
> To: wp-hackers at lists.automattic.com
> Subject: Re: [wp-hackers] Plugin Readmes
> Denis de Bernardy wrote:
> >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.
> >
> Someone wants to put their plugin docs in the trac wiki. 
> Someone wants 
> to put it in a fancy WP page with a continuous RSS feed. Someone else 
> may want to put it in mediawiki. I've put my plugin pages in 
> straight html.
> There are a gazillion ways to expose information about a 
> plugin, all of 
> which may be perused when you click through to the actual page you're 
> directed to for further info about the plugin. I just want to make it 
> easy for you to put your stuff in a directory without you 
> having to get 
> an account with the website and log in to describe it and notify of 
> updates (which is how wp-plugins.net currently works)--the plan is to 
> sync with descriptive files in your webspace/repository/etc, and with 
> some consistency across items. I could just ask for an xml 
> file, but the 
> markdowned text file idea Matt came up with a while ago just 
> seems more 
> sound.
> _______________________________________________
> 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