[Opengrads-devel] UDXT documentation

[Arlindo da S. <da...@al...>]

All,
  I spent sometime this weekend updating the documentation of the UDXTs. The
revised man pages are here

       http://opengrads.org/doc/

  These have been derived from source code using pod2html, and uses a new
pod.css I introduced to match the OpenGrADS general layout. For the first
time I have documentation for the environment variable extension (env) and
gsudf, a device for writing GrADS UDFs as script functions (these used to be
entirely separate, now the line is blurred).

   B.-J.: I have add a very rough skeleton for the libbjt documentation,
based on what I could derive from your example script. There is still a lot
of gaps that I need your help with. The documentation is stored within the
sources. To get to it, checkout

% gacvs co -P Grads   (notice capital "G")
% cd extensions/libbjt

and edit file libbjt.c. To see the formatted documentation on the screen
type

% perldoc libbjt.c

which should give you a man page kind of output. Type

% make html

to create libbjt.html, the same as this page:

    http://opengrads.org/doc/udxt/libbjt/


(You may need to install packages named something like perl-doc or
perl-pod.) If you don't know POD do not worry about getting the perfect
format, I can fix that later. Just type in the arguments and general
description for the function in the "FUNCTIONS PROVIDED" section. I already
entered the examples I got from you for some of the functions. You have a
great collection of very useful functions; with a bit of documentation
others may be able to take advantage of all your hard work. Thanks.


 My plan is to work with Mike to make some adjustments to fish, some touch
ups in shape, complete the documentation and then release a new version of
the UDXTs, including the grib2 capability for v1.9.


 Any comment greatly appreciated.


 Cheers!


  Arlindo.







-- 
Arlindo da Silva
da...@al...