comp.lang.idl-pvwave archive: archive » IDLWave documentation generation

Home » Public Forums » archive » IDLWave documentation generation

Show: Today's Messages :: Show Polls :: Message Navigator
E-mail to friend

IDLWave documentation generation [message #47405]

Thu, 09 February 2006 10:29

vcarlos
Messages: 21
Registered: February 2006

Junior Member

Hi all,

I am trying to find which guidelines I should follow in order to
generate a documentation file (html) from an .pro file. Is there any
special package within IDLWave that does this to me, or I should use
the formatting suggested at IDL Reference Guide, in MAKE_HTML_HELP
function?

Thank you all

Vinicius

Report message to a moderator

Re: IDLWave documentation generation [message #47459 is a reply to message #47405]

Fri, 10 February 2006 10:55

JD Smith
Messages: 850
Registered: December 1999

Senior Member

On Fri, 10 Feb 2006 10:15:37 -0800, Gianguido Cianci wrote:

> Are you talking about a standard header/comments format? Then since idldoc
> already has a standard, why not use those conventions? This way it's
> consistent, ready made and compatible with idldoc for those who can get it
> to work.

No, I mean a standard for authors who want to write their own, separate
HTML documentation, and want that to be available using IDLWAVE's context
help, rather than the standard header format, which IDLWAVE already
supports. Does IDLDoc enforce a standard on the name/location of the
produced HTML files?

JD

Report message to a moderator

Re: IDLWave documentation generation [message #47465 is a reply to message #47405]

Fri, 10 February 2006 10:15

cgguido
Messages: 195
Registered: August 2005

Senior Member

Are you talking about a standard header/comments format? Then since
idldoc already has a standard, why not use those conventions? This way
it's consistent, ready made and compatible with idldoc for those who
can get it to work.

mmmm.... documentation....

Gianguido

Report message to a moderator

Re: IDLWave documentation generation [message #47470 is a reply to message #47405]

Fri, 10 February 2006 09:22

JD Smith
Messages: 850
Registered: December 1999

Senior Member

On Thu, 09 Feb 2006 10:29:37 -0800, vcarlos wrote:

> Hi all,
>
> I am trying to find which guidelines I should follow in order to generate
> a documentation file (html) from an .pro file. Is there any special
> package within IDLWave that does this to me, or I should use the
> formatting suggested at IDL Reference Guide, in MAKE_HTML_HELP function?

I don't have a good means of supporting HTML docs for user libraries
directly. Currently IDLWAVE uses RSI's HTML docs for RSI routines (all
~2000 of them!), and the source headers directly for non-RSI routines. If
people want to think about a consistent way to name things so that IDLWAVE
could alternatively load the HTML help instead, I'd be happy to hear it.
I'm not sure if the IDL Assistant can be used for this or not.

JD

Report message to a moderator

Re: IDLWave documentation generation [message #47489 is a reply to message #47405]

Thu, 09 February 2006 22:59

cgguido
Messages: 195
Registered: August 2005

Senior Member

Hey everyone. I have a few questions about this:

How can I get it to run with the current idl student edition (which is
based on 6.0 I believe)? I think idldoc is saved in idl 6.1 :-( I get
that nast ZLIB error mentioned here:

http://groups.google.com/group/comp.lang.idl-pvwave/browse_f rm/thread/757057e1a9cff89d/305e32e3edc995e6?q=Error+in+ZLIB+ compression+library+-+data+error.&rnum=1#305e32e3edc995e 6

Does anyone have an older version of the sav file? Are there any other
alternatives? MAKE_HTML_HELP is not the sexiest, unfortunately...

btw, I have written to the author of idldoc and will report asap.

Gianguido

Report message to a moderator

Re: IDLWave documentation generation [message #47556 is a reply to message #47459]

Thu, 16 February 2006 09:53

cgguido
Messages: 195
Registered: August 2005

Senior Member

JD Smith wrote:
> Does IDLDoc enforce a standard on the name/location of the
> produced HTML files?

I don't know. Can't run idldoc on IDL6.0.

In other news, I have been in contact with Michael Galloy, the creator
of idldoc and here's what's going on.

- he's working on a new version of idldoc, IDLdoc 2.0. It should be out
"soon".
- it will be distributed for IDL 6.0 and for IDL 6.2:
"I have a beta for IDL 6.2 out, there was a snag with the beta for IDL
6.0 since it seems I use a few features of IDL 6.2. I think I can
remove
this dependency, but it will take me a bit."
- he's also planning on releasing the source code (which I think is
great!!)

All in all great news I think. I know I am looking forward to getting
some good documentation for my code and hopefully convincing the rest
of the group to do the same.

There you have it.

Gianguido

Report message to a moderator

Re: IDLWave documentation generation [message #48149 is a reply to message #47459]

Fri, 31 March 2006 16:08

Michael Galloy
Messages: 1114
Registered: April 2006

Senior Member

JD Smith wrote:
> No, I mean a standard for authors who want to write their own, separate
> HTML documentation, and want that to be available using IDLWAVE's context
> help, rather than the standard header format, which IDLWAVE already
> supports. Does IDLDoc enforce a standard on the name/location of the
> produced HTML files?

IDLdoc will name the output files with the same basename as the .pro
file, but with an .html extension. The location of the HTML files can be
specified with the OUTPUT keyword for IDLdoc.

-Mike

Report message to a moderator

Re: IDLWave documentation generation [message #48150 is a reply to message #47489]

Fri, 31 March 2006 16:04

Michael Galloy
Messages: 1114
Registered: April 2006

Senior Member

Gianguido Cianci wrote:
> How can I get it to run with the current idl student edition (which is
> based on 6.0 I believe)? I think idldoc is saved in idl 6.1 :-( I get
> that nast ZLIB error mentioned here:
>
> http://groups.google.com/group/comp.lang.idl-pvwave/browse_f rm/thread/757057e1a9cff89d/305e32e3edc995e6?q=Error+in+ZLIB+ compression+library+-+data+error.&rnum=1#305e32e3edc995e 6

IDLdoc 2.0 on the RSI Codebank here:

http://www.rsinc.com/codebank/search.asp?FID=100

will fix this problem. It will work on IDL 6.0 and later (though it can
produce documentation for SAV files if you have IDL 6.1 or later).

-Mike

Report message to a moderator

Re: IDLWave documentation generation [message #48241 is a reply to message #47405]

Tue, 04 April 2006 16:48

Michael Galloy
Messages: 1114
Registered: April 2006

Senior Member

Tiago Stï¿½rmer Daitx wrote:
> I just want to say that IDLDoc is one of the best things that I came
> across since I got married with IDL (it's already a long love'n'hate
> relationship, so it's a marriage alright) ;-)
>
> The new IDLDoc version got even better! It supports templates,
> generates adp files (hurray!), got even prettier, and the source code
> may be released! And I didn't even try the statistics yet.
>
> It should come officially as the default documentation tool for IDL.
> Enforcing it's use would just make things better and it's a Good Thing
> (TM). It's just my 2 cents, but considering all of IDL history I don't
> really think it'll ever happen. Anyway, good tools talk for themselves.
> Let's seat, program and read our wonderful - idldoc generated, of
> course - html docs.
>
> Mike, keep up the good work!

Thanks for the kind words about IDLdoc; I'm glad it helps. I'm not sure
about releasing the source code since I'm not with RSI any more (any one
need an IDL programmer?), but I will still try to convince them it would
be a good idea.

If the lack of documentation has caused you to pause before using it
before, there is also more information in the docs folder of the new
version (IDLdoc 2.0):

http://www.rsinc.com/codebank/search.asp?FID=100

This also runs on IDL 6.0 and later.

-Mike

Report message to a moderator

Re: IDLWave documentation generation [message #48255 is a reply to message #48150]

Tue, 04 April 2006 08:20

tdaitx
Messages: 5
Registered: July 2005

Junior Member

I just want to say that IDLDoc is one of the best things that I came
across since I got married with IDL (it's already a long love'n'hate
relationship, so it's a marriage alright) ;-)

The new IDLDoc version got even better! It supports templates,
generates adp files (hurray!), got even prettier, and the source code
may be released! And I didn't even try the statistics yet.

It should come officially as the default documentation tool for IDL.
Enforcing it's use would just make things better and it's a Good Thing
(TM). It's just my 2 cents, but considering all of IDL history I don't
really think it'll ever happen. Anyway, good tools talk for themselves.
Let's seat, program and read our wonderful - idldoc generated, of
course - html docs.

Mike, keep up the good work!

Regards,
Tiago S Daitx

ps.: if anyone cares to know the other best thing is - or should I say
will be - the eclipse interface that's said to show up somewhere around
this year (at least that's what I've been told). Not that I don't like
IDLWave - it really beats the alternative - but I just can't get myself
to remember all those crazy emacs commands, so the eclipse interface
is/will be greatly welcome.

ps.: I'm not a RSI employee and Mike didn't bribe me with anything to
write this email, I swear! =)

Report message to a moderator

Previous Topic:	plot label help
Next Topic:	Shared Memory in Windows

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Sat Oct 11 00:42:04 PDT 2025

Total time taken to generate the page: 0.64081 seconds