comp.lang.idl-pvwave archive
Messages from Usenet group comp.lang.idl-pvwave, compiled by Paulo Penteado

Home » Public Forums » archive » Re: Documenting IDL routines
Show: Today's Messages :: Show Polls :: Message Navigator
E-mail to friend 
Switch to threaded view of this topic Create a new topic Submit Reply
Re: Documenting IDL routines [message #60157] Sun, 27 April 2008 18:35
Michael Galloy is currently offline  Michael Galloy
Messages: 1114
Registered: April 2006
Senior Member
Michael Galloy wrote:
> Cliff wrote:
>> Ladies and Gentlemen,
>>
>> Two related questions:
>>
>> 1. I've been looking at using ROBOdoc for automatically documenting my
>> IDL routines. It seems to do a fairly good job, although my initial
>> attempts at LaTeX don't look nearly as nice as the HTML output. Does
>> anyone have any experience in using this?
>
> Give IDLdoc a try:
>
> idldoc.idldev.com
>
> Some links that might be useful:
>
> Downloads
> http://idldoc.idldev.com/wiki/GettingStarted

Whoops, so good I listed it twice. How about:

Downloads
http://idldoc.idldev.com/wiki/Downloads

> Getting Started: (check out the 2-minute video)
> http://idldoc.idldev.com/wiki/GettingStarted
>
> Example of IDLdoc'ed library:
> http://www.michaelgalloy.com/lib/
>
> Output is HTML only right now, but I have added all the infrastructure
> to output any kind of text based documentation. All that is needed now
> is to create the LaTeX template.

Mike
--
www.michaelgalloy.com
Tech-X Corporation
Software Developer II
Re: Documenting IDL routines [message #60158 is a reply to message #60157] Sun, 27 April 2008 18:33 Go to previous message
Michael Galloy is currently offline  Michael Galloy
Messages: 1114
Registered: April 2006
Senior Member
Cliff wrote:
> Ladies and Gentlemen,
>
> Two related questions:
>
> 1. I've been looking at using ROBOdoc for automatically documenting my
> IDL routines. It seems to do a fairly good job, although my initial
> attempts at LaTeX don't look nearly as nice as the HTML output. Does
> anyone have any experience in using this?

Give IDLdoc a try:

idldoc.idldev.com

Some links that might be useful:

Downloads
http://idldoc.idldev.com/wiki/GettingStarted

Getting Started: (check out the 2-minute video)
http://idldoc.idldev.com/wiki/GettingStarted

Example of IDLdoc'ed library:
http://www.michaelgalloy.com/lib/

Output is HTML only right now, but I have added all the infrastructure
to output any kind of text based documentation. All that is needed now
is to create the LaTeX template.

> 2. I think that the official IDL online documentation is lovely (at
> least to look at). Does anyone know what they are using?

I believe they use Framemaker.

Mike
--
www.michaelgalloy.com
Tech-X Corporation
Software Developer II
  Switch to threaded view of this topic Create a new topic Submit Reply
Previous Topic: Re: Very complicated visualization problem
Next Topic: Problem with titles on a multi plot ps file

-=] Back to Top [=-
[ Syndicate this forum (XML) ] [ RSS ] [ PDF ]

Current Time: Sat Oct 11 08:08:18 PDT 2025

Total time taken to generate the page: 7.15580 seconds