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:
CHARLIST
PURPOSE:
This procedure can be used to add a directory to the IDL path.
CALLING SEQEUNCE:
Example> addpath,'/auto/orca/root/home/name/prodirectory'
or > addpath,'/auto/orca/root/home/name/prodirectory',/last
Use the /last keyword to add your directory at the end not the front.
This program does not check to make sure that the directory exists!
(See /host/bluemoon/usr2/idllib/deutsch/local/addpath.pro)
NAME: CNVT2SEMIC PURPOSE: This procedure converts any file to one that begins with a ';+', has as ';' at the begnning over every line and ends with ';-' so that is becomes usable in the help facility. CALLING SEQEUNCE: cnvt2semic,infile,outfile
(See /host/bluemoon/usr2/idllib/deutsch/local/cnvt2semic.pro)
NAME: IDLUSE PURPOSE: This program sifts through the lmgrd log and extracts some useful info. The info is now less useful since newer versions of lmgrd provide even less info in the log. CALLING SEQEUNCE: .run idluse
(See /host/bluemoon/usr2/idllib/deutsch/local/idluse.pro)
NAME: MAKENODENAMES PURPOSE: This program prints outs a fancy name for use a hostname monitor label. It is intended to be edited by hand, rather than have parameters so it can be infinitely customizable. CALLING SEQEUNCE: .run makenodenames
(See /host/bluemoon/usr2/idllib/deutsch/local/makenodenames.pro)
print,datestr
(See /host/bluemoon/usr2/idllib/deutsch/local/mkmsgslist.pro)
print,datestr
(See /host/bluemoon/usr2/idllib/deutsch/local/mksysmlist.pro)
NAME:
MK_HTML_HELP
PURPOSE:
Given a list of IDL procedure files (.PRO), VMS text library
files (.TLB), or directories that contain such files, this procedure
generates a file in the HTML format that contains the documentation
for those routines that contain a DOC_LIBRARY style documentation
template. The output file is compatible with World Wide Web browsers.
CATEGORY:
Help, documentation.
CALLING SEQUENCE:
MK_HTML_HELP, Sources, Outfile
INPUTS:
Sources: A string or string array containing the name(s) of the
.pro or .tlb files (or the names of directories containing
such files) for which help is desired. If a source file is
a VMS text library, it must include the .TLB file extension.
If a source file is an IDL procedure, it must include the .PRO
file extension. All other source files are assumed to be
directories.
Outfile: The name of the output file which will be generated.
KEYWORDS:
TITLE: If present, a string which supplies the name that
should appear as the Document Title for the help.
VERBOSE: Normally, MK_HTML_HELP does its work silently.
Setting this keyword to a non-zero value causes the procedure
to issue informational messages that indicate what it
is currently doing. !QUIET must be 0 for these messages
to appear.
STRICT: If this keyword is set to a non-zero value, MK_HTML_HELP will
adhere strictly to the HTML format by scanning the
the document headers for characters that are reserved in
HTML (<,>,&,"). These are then converted to the appropriate
HTML syntax in the output file. By default, this keyword
is set to zero (to allow for faster processing).
COMMON BLOCKS:
None.
SIDE EFFECTS:
A help file with the name given by the Outfile argument is
created.
RESTRICTIONS:
The following rules must be followed in formatting the .pro
files that are to be searched.
(a) The first line of the documentation block contains
only the characters ";+", starting in column 1.
(b) There must be a line which contains the string "NAME:",
which is immediately followed by a line containing the
name of the procedure or function being described in
that documentation block. If this NAME field is not
present, the name of the source file will be used.
(c) The last line of the documentation block contains
only the characters ";-", starting in column 1.
(d) Every other line in the documentation block contains
a ";" in column 1.
Note that a single .pro file can contain multiple procedures and/or
functions, each with their own documentation blocks. If it is desired
to have "invisible" routines in a file, i.e. routines which are only
for internal use and should not appear in the help file, simply leave
out the ";+" and ";-" lines in the documentation block for those
routines.
No reformatting of the documentation is done.
MODIFICATION HISTORY:
July 5, 1995, DD, RSI. Original version.
July 13, 1995, Mark Rivers, University of Chicago. Added support for
multiple source directories and multiple documentation
headers per .pro file.
July 17, 1995, DD, RSI. Added code to alphabetize the subjects;
At the end of each description block in the HTML file,
added a reference to the source .pro file.
July 18, 1995, DD, RSI. Added STRICT keyword to handle angle brackets.
July 19, 1995, DD, RSI. Updated STRICT to handle & and ".
Changed calling sequence to accept .pro filenames, .tlb
text librarie names, and/or directory names.
Added code to set default subject to name of file if NAME
field is not present in the doc header.
(See /host/bluemoon/usr2/idllib/deutsch/local/mk_html_help.pro)
NAME: MK_LOCAL_HELP PURPOSE: This program generates the large local help files (using RSI's mk_html_help) for all installed software and also generates the master index.html for the IDL page. CALLING SEQEUNCE: mk_local_help NOTES: This program should be run on bluemoon (where all the IDL libraries reside).
(See /host/bluemoon/usr2/idllib/deutsch/local/mk_local_help.pro)
NAME: MK_LOCAL_HELP2 PURPOSE: This program converts the large HTML help files generated by mk_local_help (using RSI's mk_html_help) to "one liner" help files where each procedure gets only a few lines of description instead of the whole header. CALLING SEQEUNCE: mk_local_help2 NOTES: This program should be run on bluemoon (where all the IDL libraries reside).
(See /host/bluemoon/usr2/idllib/deutsch/local/mk_local_help2.pro)
NAME: MK_LOCAL_HELP3 PURPOSE: This program modifies the headers of large HTML help files generated by mk_local_help (using RSI's mk_html_help) to have a nicer header. CALLING SEQEUNCE: mk_local_help3 NOTES: This program should be run on bluemoon (where all the IDL libraries reside). See /host/bluemoon/usr2/idllib/deutsch/local/=Making_html_help.notes
(See /host/bluemoon/usr2/idllib/deutsch/local/mk_local_help3.pro)
NAME: NETPLOT PURPOSE: This program plots up some data from the output of a network throughput checking script. CALLING SEQEUNCE: netplot,netfile
(See /host/bluemoon/usr2/idllib/deutsch/local/netplot.pro)
NAME: PRINTERSTATS PURPOSE: This program assembles some stats from print accounting log files. CALLING SEQEUNCE: printerstats,whichqueues
(See /host/bluemoon/usr2/idllib/deutsch/local/printerstats.pro)
NAME: STRINGAD PURPOSE: Converts a string of sexigesimal coordinates into decimal degrees. CALLING SEQUENCE: STRINGAD, COORDS, RA, DEC INPUT: COORDS A string of coordinates (e.g. '17 00 45.2 25 4 32.4') It should have six numbers delimited by spaces or colons OUTPUT: RA Right Ascension, decimal degrees, scalar DEC Declination, decimal degrees, scalar PROCEDURES CALLED: Getopt Ten HISTORY: 09-AUG-90 Version 1 written by Kerry McQuade 20-AUG-90 Put code to account for '-0' back in after it was removed by someone. E. Deutsch 17-JUL-95 Added support for coordinates separated by colons, e.g. 17:00:45.2 25:4:32.4, which IRAF uses. E. Deutsch
(See /host/bluemoon/usr2/idllib/deutsch/local/stringad.pro)
NAME: TEK PURPOSE: Simple procedure to switch to TEKtronics mode. CALLING SEQEUNCE: tek INPUT: NONE OUTPUT: NONE HISTORY: 21-OCT-1992 Written by E. Deutsch
(See /host/bluemoon/usr2/idllib/deutsch/local/tek.pro)
NAME: TETHYSLOG PURPOSE: This program manages the accounting for the printer tethys. CALLING SEQEUNCE: .run tethyslog
(See /host/bluemoon/usr2/idllib/deutsch/local/tethyslog.pro)