Auto-generated Plugin Documentation

[Timothy M. Shead]

Folks:

Although we've had auto-generated plugin documentation for awhile, it's
only gotten updated on an ad-hoc basis.  I've been spending some time
lately getting it fully up-and-running, so here's what to expect:

* Every plugin (even application plugins) has an article in the wiki
that matches the plugin's name.  So the documentation for
SelectEdgeRings is located at:

http://www.k-3d.org/wiki/SelectEdgeRings.

* These are the pages that are opened by the "Help" button located in
the Node Properties Panel.

* Every plugin category has an article in the wiki named "<Category>
Plugins".  So the documentation for plugins in the Annotation category
is located at:

http://www.k-3d.org/wiki/Annotation_Plugins

* There are also articles for all plugins, experimental plugins, stable
plugins, and deprecated plugins:

http://www.k-3d.org/wiki/All_Plugins
http://www.k-3d.org/wiki/Experimental_Plugins
http://www.k-3d.org/wiki/Stable_Plugins
http://www.k-3d.org/wiki/Deprecated_Plugins

* Each plugin article consists of the main article source, plus
auto-generated reference content for the plugin.  At the top of the main
article, you will see

<plugin>{{PAGENAME}}</plugin>

... which expands to the reference content.

* The reference content is automatically updated each night by a script
that instantiates each plugin and enumerates over its properties,
categories, etc.  You can't edit this content directly.

* The main page is generated once the first time its plugin is included
in the nightly build.  Because it is never overwritten, you can (and
should) edit it to provide additional content.  As you browse through
the existing plugin pages you'll see that some already include
human-generated content, many don't.

* The plugin articles should be the *first* place authors go to document
their plugins.

If you don't see your plugin in the wiki, it's because the nightly build
hasn't happened, or your module isn't enabled on the nightly build
machine.  Ping me if you're being left out.

Cheers,
Tim


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
K3d-development mailing list
K3d-development@...
https://lists.sourceforge.net/lists/listinfo/k3d-development