[jQuery] Documenting the API
Hey guys,
In the interest of improving readability on the wiki, as well as ease of writing wiki documentation, I have been working with John to create some useful wiki macros, as well as templates for documenting the API.
Those macros include:
<ul><li>Sidebar macro that automatically generates parent, children, and related links</li><li>A macro to automatically generate parameter lists</li><li>A macro to generate simple 2-column tables
</li><li>A macro to automatically generate $(expression) with a link to the appropriate expression page (primarily because I, as well as others on this list, had trouble initially finding the jQuery expression documentation -- using the [[Expression]] macro will ensure that $(expression) will link to the appropriate documentation).
</li></ul>Additionally, we've hammered out a basic template for documenting the API that will ensure uniformity.
Finally, we've developed a simple hierarchy for the wiki that is provided visually to the user via the sidebar macro. Look at the Base module (or go to the Overview page) for an example. To make sure your pages comply, use CamelCase for new pages.
You can get all the details at:
<a href="http://proj.jquery.com/docs/WikiPages">http://proj.jquery.com/docs/WikiPages</a> and <a href="http://proj.jquery.com/docs/WikiPages/DocumentingAPI">http://proj.jquery.com/docs/WikiPages/DocumentingAPI
</a>.
Please visit those two (rather simple) pages before doing documentation work. You'll find it'll save you a lot of time, as well as make your documentation perfectly uniform with the rest of the existing documentation.
One final note:
I've done a bunch of work updating the existing documentation to the new template format. I've also added <span style="font-weight: bold;">some</span>, but not all, of the new functions John posted here when he released
1.0a. Go crazy!
--
Yehuda Katz
Web Developer
(ph) 718.877.1325
(fax) 718.686.4288
_______________________________________________
jQuery mailing list
discuss@jquery.com
http://jquery.com/discuss/