comp.lang.idl-pvwave archive: archive » Re: HELP adding entries to MAN

Home » Public Forums » archive » Re: HELP adding entries to MAN_PROC

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

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

Report message to a moderator

[Message index]

		Re: HELP adding entries to MAN_PROC By: knight on Thu, 04 February 1993 13:51
		Re: HELP adding entries to MAN_PROC By: oet on Thu, 04 February 1993 02:23

Previous Topic:	wirtefits
Next Topic:	Setting PLOT colors on TRUE_COLOR display??

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Wed Oct 08 17:00:07 PDT 2025

Total time taken to generate the page: 0.00551 seconds