> 
> Oooh, that could be good and that could be bad.  PDL is pretty popular
> and I wouldn't want to step on their features.  Then again, PDL si
> pretty popular and can act as a springboard.
> 
> More info?  What do they use their =for tags err... for?
> 

They use it for their online help system. Since perldl (as opposed to
PDL) is a perl shell they have to provide a help system.

? topic

   Returns help information on topic. The help information is extracted
   from the full pod document using the =for tags. Each pdl command
   uses the following layout:

   =head2 command()

   =for ref

   Description of command

   =for example

     $x = command( $pdl)

   =for usage

     Usage information


Currently one of the problems is that it is based on an old version of
Pod::Parser (at the time it was originally implemented Pod::Parser was
lacking some features).


> This is a possibility for perl's internal docs, but its kind of a pain
> fr external stuff.  Perhaps we can distribute perl's internal docs
> with the '=for example' built in (since if you install the docs you
> should also install the new POD utilities) and provide a converter for
> module/code authors who need to worry about compatibility.

I suppose a standalone pod translator would do the job.

-- 
Tim Jenness
JCMT software engineer/Support scientist
http://www.jach.hawaii.edu/~timj


Reply via email to