Bioperl: POD tips

Steve A. Chervitz sac@genome.stanford.edu
Mon, 10 Nov 1997 15:37:45 -0800 (PST)


Chris,

> First things first, excellent job on organizing the RFI response.  As I said

Thanks. I've been informed that our response is now available on the OMG 
server as doc# corbamed/97-11-16.

Regarding the POD stuff:

> > I like your new organization of the POD for PreSeq.pm: 
> > 
> >http://www.ayf.org/~c_raffi/bioperl/PreSeq.pm.html 
> > 
> > The table of contents listing at the top of the file should be standard 
> > for all Perl modules.
> 
> Yep.
> 
> It's a new and improved version of 'pod2html' the previous version was a
> nightmare when it came to producing cleanly formatted HTML...this version is
> much better and builds the index by default.  BTW- I am using Perl version
> 5.004_01 under Digital Unix.
> 
> You should just be able to upgrade your version of perl..I had to do a bit of
> editing to the .PM files to get things to work but it was fairly painless.

Unfortunately, I'm a bit dependent on my overworked sys-admin for this. 
I did, however, come up with a script to generate the index (based on 
the output from pod2html from the 5.003 distribution). 
I enhanced the method listing to include data from each 
method's POD. (This of course depends on the way methods are 
documented.) Also, the NAME data is put at the top. Check a demo at:

http://genome-www.stanford.edu/~sac/perlOOP/bioperl/lib/Obj/Object.pm.html


SteveC

===== Bioperl Project General Mailing List Message Footer =======
Project URL: http://www.techfak.uni-bielefeld.de/bcd/Perl/Bio/
For info about how to (un)subscribe, where messages are archived, etc:
http://www.techfak.uni-bielefeld.de/bcd/Perl/Bio/vsns-bcd-perl.html