| Re: HELP adding entries to MAN_PROC [message #793] |
Thu, 04 February 1993 13:51 |
knight
Messages: 37
Registered: January 1992
|
Member |
|
|
In article <1kqqq6INN4h3@maz4.sma.ch>, oet@sma.ch (Thomas Oettli) writes:
|> In article <107906@netnews.upenn.edu> mark@ginger.biophys.upenn.edu (Mark Elliott) writes:
|> >
|> > DOES ANYONE KNOW HOW TO ADD ENTRIES TO IDL'S ON LINE HELP PROGRAM, MAN_PROC?
...(omitted text)...
|> >
|> Try mk_library_help:
|>
|> EXAMPLE:
|>
|> IDL> mk_library_help, !DIR+'/lib/userlib',!DIR+'/help/test.help'
|>
|> IDL> ?
|>
|> You will now have description of all procedures in the subdir userlib
|> on the button 'test'.
|>
I use this method also, and it helps the novice as well as the expert, who
wants to review a routine's action or parameter list. In addition, I build
into each routine a /help keyword to print its header. For example,
myroutine,/help
produces the header via the doc_library routine. The only things needed in the
code are:
pro myroutine,help=help,...
...
if keyword_set(help) then begin & doc_library,'myroutine' & return & endif
...
Fred
--
=Fred Knight (knight@ll.mit.edu) (617) 981-2027
C-483\\MIT Lincoln Laboratory\\244 Wood Street\\Lexington, MA 02173
|
|
|
|
| Re: HELP adding entries to MAN_PROC [message #794 is a reply to message #793] |
Thu, 04 February 1993 02:23  |
oet
Messages: 28
Registered: February 1993
|
Junior Member |
|
|
In article <107906@netnews.upenn.edu> mark@ginger.biophys.upenn.edu (Mark Elliott) writes:
>
>
>
> DOES ANYONE KNOW HOW TO ADD ENTRIES TO IDL'S ON LINE HELP PROGRAM, MAN_PROC?
>
>
> We have a created a directory $IDL/ourlib containing IDL programs used
> by our group. I would like to add the DOC_LIBRARY descriptions of these files to
> MAN_PROC. I have determined that MAN_PROC calls MP_WIDGETS, which scans the
> $IDL/help directory for "*.help" files. Each ".help" file generates a category
> of help topics in the widget. The format of these files is clear, but not trivial
> to generate.
> Is there a program in the IDL distribution which scans a directory and
> constructs a ".help" file? This appears to be all I would need to add descriptions
> of our "home-made" programs to the HELP widget.
>
> Any response greatly appreciated.
>
Try mk_library_help:
EXAMPLE:
IDL> mk_library_help, !DIR+'/lib/userlib',!DIR+'/help/test.help'
IDL> ?
You will now have description of all procedures in the subdir userlib
on the button 'test'.
--
|Thomas Oettli Internet: Thomas.Oettli@sma.ch |
|Swiss Meteorological Institute CServe: 100015.3543@compuserve.com |
|Kraehbuehlstr. 58 X.400 (PP) : |
|8044 Zuerich S=oet/O=sma/PRMD=SWITCH/ADMD=ARCOM/C=CH/ |
| FAX: +41 1 256 92 78, Phone: +41 1 256 93 16 |
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
