Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

general/misc/

mk_html_help2.pro


NAME: MK_HTML_HELP2 PURPOSE: Creates a html document from a list of IDL procedures. 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. This version is enhanced over the routine supplied by IDL, It will also cross reference, print the purpose, and add links to the source code. 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. If not provided, searches down directory tree from current directory for files. Outfile: The name of the output file which will be generated without HTML extension. If no inputs are given: All directories in the current directory tree are used with the exception of: directories named: 'obsolete' or 'SCCS.' (UNIX only) KEYWORDS: TITLE: If present, a string which supplies the name that should appear as the Document Title for the help. FILENAME: Alternative method of specifying Outfile (see above) 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). CROSSLINK:If this keyword is set MK_HTML_HELP will create a cross reference between library files. CLTURBO: If this keyword is set to a single character string, then the cross reference procedure will only cross reference lines that contain the character given in CLTURBO. This greatly increases the speed of the routine. By default the double quote (") is used PRINT_PURPOSE: If this keyword is set then the first line after PURPOSE: is printed in the output file. MASTLIST: If set, create master list only. Do not create subdirectory file listings. 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. September, 1995, D. Larson. SSL Berkeley. Added crosslink, print_purpose clturbo. October 4, 1995, D. Larson. SSL Berkeley. Added link to source file. October 3, 1996, F. Marcoline. SSL Berkeley. Added Alphabet Jumpline. October 10, 1996, D. Larson. Added Listing by Directory. October 1, 2007, J. McTiernan, allow to work with more than 28 directories, dropped obsolete /stream keywords from openw calls. FILE: mk_html_help2.pro VERSION 1.26 LAST MODIFICATION: 99/04/22

Routines

Routines from mk_html_help2.pro

result = setup_sources(base)
alt_mhh_strict, txtlines
alt_mhh_grab_hdr, name, dict, infile_indx, libfile_indx, txt_file, verbose, strict, print_purpose=print_purpose, allfiles=allfiles
alt_mhh_dum_file, outfile, title, verbose
alt_mhh_gen_file, dict, txt_file, infiles, libfiles, outfile, verbose, title, strict, crosslink=crosslink, clturbo=clturbo, no_dirlist=no_dirlist, mastlist=mastlist, listname=listname, nolist=nolist
mk_html_help2, sources, outfile, VERBOSE=VERBOSE, TITLE=TITLE, STRICT=STRICT, crosslink=crosslink, clturbo=clturbo, print_purpose=print_purpose, FILENAME=FILENAME, allfiles=allfiles, no_dirlist=no_dirlist, mastlist=mastlist, listname=listname

Routine details

top source setup_sources

result = setup_sources(base)

Parameters

base

top source alt_mhh_strict

alt_mhh_strict, txtlines

Parameters

txtlines

top source alt_mhh_grab_hdr

alt_mhh_grab_hdr, name, dict, infile_indx, libfile_indx, txt_file, verbose, strict, print_purpose=print_purpose, allfiles=allfiles

Parameters

name
dict
infile_indx
libfile_indx
txt_file
verbose
strict

Keywords

print_purpose
allfiles

top source alt_mhh_dum_file

alt_mhh_dum_file, outfile, title, verbose

Parameters

outfile
title
verbose

top source alt_mhh_gen_file

alt_mhh_gen_file, dict, txt_file, infiles, libfiles, outfile, verbose, title, strict, crosslink=crosslink, clturbo=clturbo, no_dirlist=no_dirlist, mastlist=mastlist, listname=listname, nolist=nolist

Parameters

dict
txt_file
infiles
libfiles
outfile
verbose
title
strict

Keywords

clturbo
no_dirlist
mastlist
listname
nolist

top source mk_html_help2

mk_html_help2, sources, outfile, VERBOSE=VERBOSE, TITLE=TITLE, STRICT=STRICT, crosslink=crosslink, clturbo=clturbo, print_purpose=print_purpose, FILENAME=FILENAME, allfiles=allfiles, no_dirlist=no_dirlist, mastlist=mastlist, listname=listname

Parameters

sources
outfile

Keywords

VERBOSE
TITLE
STRICT
clturbo
print_purpose
FILENAME
allfiles
no_dirlist
mastlist
listname

File attributes

Modification date: Thu Feb 13 16:43:47 2014
Lines: 549