folks-
i have completed the first phase of introducing a new documentation
facility for plugins.
it is backward compatible, so you don't need to do anything to your
plugins immediately.
but, we should convert them slowly but surely so they have consistent
and thorough documentation. (this will be required for "certification")
the main features are:
- the documentation for the plugin lives in the plugin's .pm file
- there are a standard set of documentation fields that are expected
(eg, description, tables depended on, notes)
- there is a new command line argument processor that replaces
easyCsp. it supports:
- easy way to add new argument types (eg, date, tablename, etc)
- list arguments
- constraint functions
- standardized documentation of the argument
To see what this all looks like:
- do a cvs update -d from $PROJECT_HOME/GUS
- (if you're not at cbil, do a ga +meta and a ga +update
GUS::Common::Plugin::SubmitRow)
- try ga GUS::Common::Plugin::SubmitRow --help to see the docs
displayed in text
- see http://www.gusdb.org/documentation/plugins/ which is where the
plugin docs are shown in html
- check out the plugin itself:
$PROJECT_HOME/GUS/Common/plugin/perl/SubmitRow.pm
- see http://www.gusdb.org/documentation.html for the overall
documentation (available from http://www.gusdb.org)
- see http://www.gusdb.org/documentation/GUS-PluginMgr-Plugin.html
for the Plugin API
steve
|
