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

Home » Public Forums » archive » Help for non-RSI libraries under IDL 4.0
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
Help for non-RSI libraries under IDL 4.0 [message #4367] Fri, 26 May 1995 00:00 Go to next message
Eric Deutsch is currently offline  Eric Deutsch
Messages: 11
Registered: May 1995
Junior Member
I've installed version 4.0 of IDL, and the new help system is fairly helpful,
although just as ugly as the MS Windows help browser.

However, there seems to be one terrible thing lacking: it appears to me that
the new help system provides no support for linking other help files from
user-created or downloaded libraries to the new help system. i.e., whereas
in IDL 3.6 and before, help files for the JHUAPL library, etc. where
browsable from the '?' facility, this appears to be no longer possible.

Can someone point out how this can be done? I must be wrong in thinking
that it is no longer possible to browse .HELP files...

thanks,
Eric


------------------------------------------------------------ ----------------
Eric Deutsch email: deutsch@astro.washington.edu
Department of Astronomy FM-20 Voice: (206) 616-2788
University of Washington FAX: (206) 685-0403
Seattle, WA 98195 Physics/Astronomy Bldg., Room B356F
WWW: http://www.astro.washington.edu/deutsch
Re: Help for non-RSI libraries under IDL 4.0 [message #4420 is a reply to message #4367] Wed, 31 May 1995 00:00 Go to previous message
sterner is currently offline  sterner
Messages: 106
Registered: February 1991
Senior Member
sterner@strdev.jhuapl.edu (Ray Sterner) writes:

> I agree that HTML should be used for help. Something like netscape
> should be able to do pretty much everything that the new IDL 4.0
> help does. The 4.0 help cannot be copied from the help window and
> pasted into IDL (or anywhere else). HTML does not have this problem.

To clarify the statement about not being able to copy help text,
that is not quite right. You can copy the text, it takes an extra
step: Use the Copy option from the Edit menu. A new widow appears
with plain text which can be copied.

I have learned some of the reasons for not using HTML for IDL 4.0
help. The same text is used for both online help and the published
manuals. The current help system took a considerable time to develope
and when started HTML browsers were not as widely available or as
good as now. Plus they still do not have good support for easy
cross referencing and indexing. Perhaps if HTML support software
becomes more widespread the balance will change.

Ray Sterner sterner@tesla.jhuapl.edu
The Johns Hopkins University North latitude 39.16 degrees.
Applied Physics Laboratory West longitude 76.90 degrees.
Laurel, MD 20723-6099
WWW Home page: ftp://fermi.jhuapl.edu/www/s1r/people/res/res.html
Re: Help for non-RSI libraries under IDL 4.0 [message #4427 is a reply to message #4367] Wed, 31 May 1995 00:00 Go to previous message
sterner is currently offline  sterner
Messages: 106
Registered: February 1991
Senior Member
thompson@achilles.nascom.nasa.gov (William Thompson) writes:

. . .
> The modern standard for hypertext is HyperText Markup Language (HTML) as used
> in the World Wide Web. RSI should consider moving to this standard as this
> will be what their customers will be most familiar with.
. . .

I agree that HTML should be used for help. Something like netscape
should be able to do pretty much everything that the new IDL 4.0
help does. The 4.0 help cannot be copied from the help window and
pasted into IDL (or anywhere else). HTML does not have this problem.

If HTML were used for help adding your own help would be as easy as
making your own top level HTML page and including a link to the IDL
HTML help page. A system variable could then be set to point to your
own help page.

Ray Sterner sterner@tesla.jhuapl.edu
The Johns Hopkins University North latitude 39.16 degrees.
Applied Physics Laboratory West longitude 76.90 degrees.
Laurel, MD 20723-6099
WWW Home page: ftp://fermi.jhuapl.edu/www/s1r/people/res/res.html
Re: Help for non-RSI libraries under IDL 4.0 [message #4451 is a reply to message #4367] Sun, 28 May 1995 00:00 Go to previous message
thompson is currently offline  thompson
Messages: 584
Registered: August 1991
Senior Member
twf@pfc.mit.edu (twf@pfc.mit.edu) writes:


> In article <3q36dl$iid@nntp5.u.washington.edu>,
> Eric Deutsch <deutsch@astro.washington.edu> writes:

>> I've installed version 4.0 of IDL, and the new help system is fairly helpful,
>> although just as ugly as the MS Windows help browser.
>>
>> However, there seems to be one terrible thing lacking: it appears to me that
>> the new help system provides no support for linking other help files from
>> user-created or downloaded libraries to the new help system. i.e., whereas
>> in IDL 3.6 and before, help files for the JHUAPL library, etc. where
>> browsable from the '?' facility, this appears to be no longer possible.
>>
>> Can someone point out how this can be done? I must be wrong in thinking
>> that it is no longer possible to browse .HELP files...

> The word from RSI is that the help files can only be created by using a
> third party proprietary product. They have begun to get complaints about this
> problem. The short term workaround is to use the same procedures that were
> invoked by the ? before to access user libraries:

> IDL> man_proc,'*'

> I hope this is not the final answer. One of IDL's nicest features was the
> ability to extend its functionality in a way that made the extensions seem
> like they were part of the IDL package. Providing one help facility for
> RSI's functions and procedures and a separate lower class help facility for
> add on's is not very appealing. Perhaps the license for the help compiler is
> reasonable enough to make all of this a mute point. I don't know the answer
> to that.

The modern standard for hypertext is HyperText Markup Language (HTML) as used
in the World Wide Web. RSI should consider moving to this standard as this
will be what their customers will be most familiar with.

We've long since given up on using help files for getting help on procedures.
Instead, we use the routine XDOC which is able to retrieve the documentation
header from any routine in IDL's path. When used with X-windows, it can also
display the entire source code, and has some other nifty features. A
particular advantage is that you don't need to create separate help files,
which may end up being out of date with the current software. One place you
can find the XDOC and associated routines is in

http://sohowww.nascom.nasa.gov/softops/cds/util/help/

Bill Thompson
  Switch to threaded view of this topic Create a new topic Submit Reply
Previous Topic: non-interactive IDL from scripts
Next Topic: idl hyperhelp on DEC ultrix system

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

Current Time: Wed Oct 08 18:57:03 PDT 2025

Total time taken to generate the page: 0.00759 seconds