MK_HTML_HELP procedure, given a list of IDL procedure filenames (
files), VMS text library filenames (
files), or the names of directories containing such files, generates a file in
HyperText Markup Language) format that contains documentation for those routines that contain standard IDL documentation headers. The resulting file can then be viewed with a "
World Wide Web" browser such as
MK_HTML_HELP procedure makes single HTML file that starts with a list of the routines documented in the file. The names of routines in that list are hypertext links to the documentation for those routines. The documentation for each routine is simply the text of the documentation header copied from the corresponding
file--no reformatting is performed.
The documentation headers of the
files in question must have the following format:
;+, starting in column 1.
;-, starting in column 1.
;in column 1.
subdirectory of the
subdirectory of the IDL distribution contains a template for creating your own documentation headers.
This routine is supplied for users to make
online documentation from their own IDL programs. Although it could be used to create an HTML documentation file from the
subdirectory of the IDL distribution, we do not recommend doing so. The documentation headers on the files in the
directory are used for historical purposes--most do not contain the most current or accurate documentation for those routines. The most current documentation for IDL's built-in and library routines is found in IDL's online help system (enter
at the IDL prompt).
This routine is written in the IDL language. Its source code can be found in the file
subdirectory of the IDL distribution.
A string array containing the names of IDL procedure files (
files), VMS text libraries (
files), or directories containing such files. The
array may contain both individual file and directory names. Each IDL procedure file must have the file extension
, and each VMS text library must include the file extension
. Elements of the
array that do not have either of these extensions are assumed to be directories.
Set this keyword to force MK_HTML_HELP to adhere strictly to the HTML format by scanning the documentation blocks for HTML reserved characters and replacing them in the output file with the appropriate HTML syntax. HTML reserved characters include
. By default, this keyword is set to zero to allow for faster processing of the input files.