isisdoc Documentation

isisdoc - Create formatted documentation of programs and procedures
This program processes one or more PDF files to produce a formatted
documentation file that can be printed to produce a user's manual for
a set of application programs and TAE procedures.  If multiple PDF
files are being processed, then a file containing a one-line summary
of all the programs can optionally be produced.  There is also the
option of creating HTML documents.

PROGRAMMER:  Tracie Sucharski, USGS, Flagstaff

Name of a single PDF file to
be processed
  (default extension is .pdf)

" "

Name of file that contains list
of PDFs to be processed
  (default extension is .lis)

--

Output in an html format
(YES, NO)

NO

Name of output file to write
 (If HTML=NO, default extension
        is .doc
  If HTML=YES, default extension
        is .html)

--

Name of output summary file
  (default extension is .sum)

--

Name of output quick reference
file
  (default extension is .ref)

--

ADDITIONAL NOTES:

Parm	Description
FROMPDF	Specifies the name of a single PDF file to be processed. If the file extension is omitted, then ".pdf" will be assumed. If no disk directory is specified, then the PDF file will be located in the default directory. NOTE: If FROMPDF is specified, then PDFLIST should be left blank.
PDFLIST	Name of a disk file that contains a list of PDF files to be processed. If the file extension is omitted, then ".lis" will be assumed. Each of the listed PDF files will be processed and the resulting documentation put into the single output documentation file being created. (See the description of the DOCFILE parameter.) The PDFLIST file is an ordinary text file in which each line lists a single PDF to be processed. This list can be created by a text editor or by the "ls" command. For example, the following will create a list of all the ISIS PDF files in the appropriate format: ls -1 $ISISEXE/*.pdf > isis.lis If PDFLIST is specified, then the program will type out the name of each listed PDF as it is processed. NOTE: If PDFLIST is specified, then FROMPDF should be left blank.
HTML	Output the file in an html format. This will simply be the same format as the output usually produced with html element at the beginning and end of the file to indicate the text is preformatted.
DOCFILE	Name of the output documentation file to produce. If no extension is specified, then the extension will be ".doc". If this parameter is left at NULL, then the default output file name will be the name of the input pdf with an extension of ".doc". If a value is entered for this parameter and a list of PDF files is being processed, then the output for all pdfs processed will be written to the given file with a formfeed in between each pdf documentation.
SUMFILE	Name of the output summary file to produce. If no extension is specified, then the extension will be ".sum". If a list of input PDF files is specified with the PDFLIST parameter, then the SUMFILE will contain the one-line summary list, which consists of the .TITLE lines for all the programs. If the value of SUMFILE is NULL(--), then no summary file will be produced.
REFFILE	Name of the Quick Reference output file. This file lists the program name and description followed by a list of all parameters. Required parameter will be preceded by "$" and parameters which require a list will be listed as PARAMETER=list. If a file name is not entered in REFFILE this list will not be produced.