Documenting Plugins

We should develop a standard way of documenting plugins, with a WikiFormatted? template.

Might I suggest the following as a starting point:

Yehuda's Proposal (Cribbed from Christian Bach's Excellent Examples)

== Plugin Title ==
=== Plugin Description ===
==== By Plugin Author ====
==== Syntax ====
{{{ Syntax in question }}}
==== Return Value ====
{{{ Return Value in question }}}
==== Tested In ====
 * IE 5.x, 6.0, 7.0 Beta 2
 * ~~IE 5.x Mac~~
 * Firefox > 1.0
 * Opera 8.54, ~~Opera 9 Beta~~
 * ~~Safari 2.03~~
==== Download ====
attachment:"file-name.zip"
==== Example ====
{{{ Example }}}
==== Demo ====
If applicable and possible. May be a link to an alternative location.
==== Notes ====
Notes
==== Link ====
Link to Homepage

---

How it looks

---

Plugin Title

Plugin Description

By Plugin Author

Syntax

Syntax in question

Return Value

Return Value in question

Tested In

• IE 5.x, 6.0, 7.0 Beta 2
• IE 5.x Mac
• Firefox > 1.0
• Opera 8.54, Opera 9 Beta
• Safari 2.03

Download

attachment:"file-name.zip"

Example

Example

Demo

If applicable and possible. May be a link to an alternative location.

Notes

Notes

Link

Link to Homepage

---

Note

For the "Tested In" Section, we should develop an updated master list of platforms that we should ideally test in, and keep the plugins updated with those tests. It would be nice if we could automate the process. That's the concept behind by strikethrough above. All plugins would have the same master list, with tested platforms un-struck-through. I have some JS/HTML-based ideas for automating the process (involving checkboxes and a central list of platforms we could keep in one place and call with JS syntax when necessary).