[wp-hackers] Plugin readme #section links

Dan Phiffer dan at phiffer.org
Sat Jun 26 16:05:30 UTC 2010

On Jun 25, 2010, at 11:18 PM, Michael D Adams wrote:

> On Fri, Jun 25, 2010 at 1:32 PM, Dan Phiffer <dan at phiffer.org> wrote:
>> I have a rather big readme file for my JSON API plugin (http://wordpress.org/extend/plugins/json-api/other_notes/) and I'm concerned that it's getting a bit unwieldy in its current form. As far as I know there's not a way to create hash links (#foo) in plugin readme files. Markdown doesn't seem to provide a way to made id attributes (see: http://daringfireball.net/projects/markdown/syntax.text which resorts to <h2 id="section">...</h2>) and I'm not sure what a reasonable syntax might look like. But I thought I'd float the general idea here and see if anyone else might find this useful.
> For your case, it looks like you only need to link to headings within
> what the Plugins Directory displays as "Other Notes" (the URL you
> linked: http://wordpress.org/extend/plugins/json-api/other_notes/ ).
> Is that true or do you want to be able to link to arbitrary places
> (not just headings)?

Yeah, that's all I need it for. But I could see it being useful for the FAQ section, for those who have one.

> What if the plugins directory automatically generated id attributes
> for the header elements (like MediaWiki does)?

That sounds like a perfect solution. I like that existing readmes would be covered -- no need to update.

> See the <#API Reference> section below for a complete method listing.

I think the Markdown link syntax is sufficient, but this would be fine with me too.


> _______________________________________________
> 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