This page is a listing of the entire contents of this library for IDL. This listing is the long version. Viewing the much more compact listing may be handier.
NAME:
ADD_TEMPLATE
PURPOSE:
Add a near standard IDL template to a given IDL routine file.
CATEGORY:
CALLING SEQUENCE:
add_template, file
INPUTS:
file = input IDL routine file name. in
KEYWORD PARAMETERS:
Keywords:
/INIT forces getmodhist to use new .idl_id file.
OUTPUTS:
COMMON BLOCKS:
NOTES:
Note: Existing front end, up to the pro or function
statement, are replaced by the new template.
Original file is copied to tmp.tmp as a backup.
If routine does not contain built-in help text then it
is not modified.
Trouble-shooting:
If template not filled in check that the routine
has a help keyword and tests for keyword_set(hlp).
Function or pro statement must come after any old style
template.
MODIFICATION HISTORY:
R. Sterner, about Sep 1989 at Sac Peak. The exact date was
probably lost by this routine itself.
R. Sterner, 13 Dec, 1993 --- dropped spawn to copy files.
R. Sterner, 11 Mar, 1993 --- handled no help text case.
Copyright (C) 1989, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.
(See /host/bluemoon/usr2/idllib/jhuapls1r/doc/add_template.pro)
NAME:
BRK_HELP
PURPOSE:
Return requested data from a help text array.
CATEGORY:
CALLING SEQUENCE:
brk_help, cmd, helptxt, out
INPUTS:
cmd = one of: name, purp, call, in, out, key, note. in
helptxt = text array from extract_help. in
KEYWORD PARAMETERS:
OUTPUTS:
out = text array. out
COMMON BLOCKS:
NOTES:
MODIFICATION HISTORY:
R. Sterner, 19 Sep, 1989.
Copyright (C) 1989, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.
(See /host/bluemoon/usr2/idllib/jhuapls1r/doc/brk_help.pro)
NAME:
CHECK_TEMP
PURPOSE:
Determine if given file has an IDL template.
CATEGORY:
CALLING SEQUENCE:
check_temp, file
INPUTS:
file = input IDL routine file name. in
KEYWORD PARAMETERS:
OUTPUTS:
COMMON BLOCKS:
NOTES:
Notes: lists message on screen.
MODIFICATION HISTORY:
R. Sterner, 18 July, 1990
Copyright (C) 1990, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.
(See /host/bluemoon/usr2/idllib/jhuapls1r/doc/check_temp.pro)
NAME:
EXTRACTHLP
PURPOSE:
Extract help text from an IDL routine, full text or one liner.
CATEGORY:
CALLING SEQUENCE:
extracthlp, infile, [out]
INPUTS:
infile = file to extract from. in
out = output file or text array. in
If file then appended to.
KEYWORD PARAMETERS:
Keywords:
/LISTFILE to list file name on terminal screen.
/LINER extracts only first line in liner format.
/ARRAY return a text array with help text.
ERROR=err error flag. 0: OK, 1: no help text found.
OUTPUTS:
COMMON BLOCKS:
NOTES:
Notes: if outfile is not given then the
help text is sent to the terminal screen.
Extracthlp searches for the first occurrence
of keyword_set(hlp) or keyword_set(help),
assuming it is for /HELP.
MODIFICATION HISTORY:
R. Sterner, 11 Sep, 1989.
R. Sterner, 26 Feb, 1991 --- Renamed from extract_help.pro
R. Sterner, 9 Mar, 1993 --- Looked for keyword hlp or help.
R. Sterner, 11 Mar, 1993 --- Added error flag to indicate NO HELP.
R. Sterner, 1994 May 31 --- Modified /LINER to show routine type.
Copyright (C) 1989, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.
(See /host/bluemoon/usr2/idllib/jhuapls1r/doc/extracthlp.pro)
NAME:
GETCOMMON
PURPOSE:
Get list of commons from an IDL routine.
CATEGORY:
CALLING SEQUENCE:
getcommon, file, list
INPUTS:
file = name of IDL procedure file. in
KEYWORD PARAMETERS:
OUTPUTS:
list = text array listing commons. out
COMMON BLOCKS:
NOTES:
MODIFICATION HISTORY:
R. Sterner, 19 Sep, 1989.
Copyright (C) 1989, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.
(See /host/bluemoon/usr2/idllib/jhuapls1r/doc/getcommon.pro)
NAME:
GETMODHIST
PURPOSE:
Get list of modification history from an IDL routine.
CATEGORY:
CALLING SEQUENCE:
getmodhist, file, list, year
INPUTS:
file = name of IDL routine file to process. in
KEYWORD PARAMETERS:
Keywords:
/INIT forces new ident to be used.
OUTPUTS:
hist = text array with history records. out
year = returned copyright year. out
COMMON BLOCKS:
getmodhist_com
NOTES:
Notes: needs the home directory file .idl_id
which gives the author's ID. The format is:
last_name
first initial
first_name
initials
Comment lines start with ; in column 1 and are ignored.
An example file:
;------ .idl_id = User ID used by getmodhist
sterner
r
ray
res
This allows you to just put your name (or initials) and
date at the front of a new routine and let add_template
fill in the standard template.
MODIFICATION HISTORY:
R. Sterner, 19 Sep, 1989.
R. Sterner, 21 Mar, 1991 --- added copyright year.
R. Sterner, 14 Jan, 1993 --- moved ID info to .idl_id in HOME.
R. Sterner, 1995 Dec 15 --- Now drops all text found before
; MODIFICATION HISTORY:
Copyright (C) 1989, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.
(See /host/bluemoon/usr2/idllib/jhuapls1r/doc/getmodhist.pro)
NAME:
LIBR
PURPOSE:
Maintains multiple IDL libraries.
CATEGORY:
CALLING SEQUENCE:
libr
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
COMMON BLOCKS:
get_lpath_com
libr_com
libr_com
libr_com
libr_com
libr_com
libr_com
libr_com
NOTES:
Notes: the functions are:
Add/Update a routine to a library.
Move a routine from one library to another.
Delete a routine from a library.
Examine routines in a library.
Search for references to a routine in a library.
Check that all library routines are in alph.one & cat.one.
Need to set up the file .idl_libs in your home directory:
do .run libr
get_lpath,/help
for .idl_libs file format.
MODIFICATION HISTORY:
R. Sterner, 11 Jan, 1993
R. Sterner, 19 May, 1993 --- Added ADD backups.
R. Sterner, 23 Jun, 1993 --- Dropped the need for .idl_editor
in your HOME directory. Uses Env. Var. EDITOR instead.
Copyright (C) 1993, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.
(See /host/bluemoon/usr2/idllib/jhuapls1r/doc/libr.pro)
********************************************************** ;================================================ ; add_cat = add an entry to the cat.one file ; Files read from main lib, written to both ; main and mirror libs. ;================================================ pro update_cat ;------- Read in cat.one file -----------
(See /host/bluemoon/usr2/idllib/jhuapls1r/doc/update_cat.pro)