Changes between Version 6 and Version 7 of ContributingCode

Timestamp:

01/10/08 05:40:37 (5 years ago)

Author:

MartinBudden

Comment:

--

ContributingCode

@@ -39 +39 @@
 
 Each metadata item corresponds to one of the attributes of the plugin tiddler. Other attributes that can be set are "modified" (for the last modified date of the plugin, and "created" for the creation date of the plugin).
+
+== Guidelines for Plugin Documentation ==
+
+A plugin should normally contain three items of documentation:
+
+  1. A header table containing the plugin essentials: its title, author etc
+  1. A summary describing what the plugin does
+  1. A usage section, describing how to use the plugin
+
+The header table should normally contain at least the following:
+
+||Name:||The name of the plugin||
+||Description:||A one line description of the plugin||
+||Author:||The name of the author of the plugin||
+||Source:||where a user can obtain the plugin, eg: http://www.MyWebSite.com/#ExamplePlugin ||
+||CodeRepository:||the code repository of where the plugin is stored, if any||
+||Version:||The version number of the plugin, useful for when users report bugs||
+||Status:||The plugin's status, eg released, beta etc||
+||Date:||The date when the plugin was written||
+||Comments:||A place where the user can make comments about the plugin, eg at http://groups.google.co.uk/group/TiddlyWiki ||
+||License:||The license for the plugin, essential if you want to allow others to use your plugin||
+||~CoreVersion:||The version of TiddlyWiki required to run the plugin (eg 2.3)||
+
+The summary should be a short paragraph describing what the plugin does.
+
+The usage section should describe how to use the plugin, its parameters (if any) and any other things the user might need to know to use the plugin.
+
+There is an example plugin at:
+
+http://svn.tiddlywiki.org/Trunk/contributors/MartinBudden/plugins/ExamplePlugin.js
+
+that you can use for reference, or as a template for your plugins.