.!+
.! Help Module Name:
.!	IdxTeX
.!
.! Author:
.!	R L Aurbach	CR&DS MIS Group		14-Jun-1986
.!
.! Description:
.!	Help file for the IdxTeX automatic index generator for LaTeX
.!
.! Special Notes:
.!	none
.!
.! Modification History:
.!
.! Ident     Initials	    Date	Description
.! -------------------------------------------------------------------------
.! 1-001	RLA	14-Jun-1986	Original Code
.!-
.no flags uppercase
.no flags lowercase
.flags capitalize
.page size 9999
.!
.! Insure only Key definition lines are against margin
.!
.left margin 1
.right margin 71
.set paragraph 0,1,2
.autoparagraph
.noautosubtitle
.no headers
.style headers 7, 0, 0
.indent -1;1#IdxTeX

IdxTeX is a program which automates the generation of an Index in a LaTeX
document.  Normally, an Index is generated in LaTeX by using the \makeindex
command in the document preamble, with appropriate \index commands within the
document to create the needed entries.  LaTeX generates a file with an .IDX
file type which includes the necessary information.  The user is left with 
the job of manually formatting the result.

Using IdxTeX, the .IDX file is transformed into an .IND file which contains
all of the necessary commands to generate a properly-formatted index.  It is,
then, merely necessary to \input this file in your source document to generate
the Index.

The IdxTeX program is documented in a User's Guide -- IDXTEX.QMS -- which may
be found in the CRL__DOCUMENTATION directory.

To use the program, issue the command
.s.nf
	$ IDXTEX  file  [/TOC = { ARTICLE | REPORT }]
.f

.indent -1;2#Parameters

.lm +8;.indent -8;file####Specify the name of the file to be processed.  LaTeX
generates a file with the same filename as your document, but with the .IDX
filetype.  This is the source file used by IdxTeX.  IdxTeX generates an output
file with the same filename as the input file, but with the .IND filetype.

You need only specify the name of the file.  By default, IdxTeX will look for
a file with a specified (i.e., required) filename, but with the .IDX filetype
in your current default directory.
.lm -8

.indent -1;2#Qualifiers
.indent -1;/TOC

The normal LaTeX document styles (article, report, and book) do not 
automatically generate Table of Contents entries for the Index.  If you wish
the Index to appear in the Table of Contents, you must use the /TOC qualifier.

The /TOC qualifier must be specified with either the value ARTICLE or REPORT.
That is, you must use either
.s.nf
	$ IDXTEX file /TOC:ARTICLE
.s
		-or-
.s
	$ IDXTEX file /TOC:REPORT
.s.f
for the command to work.  Use the ARTICLE value with the article document
style.  Use REPORT with either the report or book document styles.

.note
If you are using the CR_&DS document styles (pamphlet, manual, or memo), DO NOT
use the /TOC qualifier.  These document styles automatically generate Table of
Contents entries for the Index.  Using /TOC will cause the Table of Contents
to list the Index twice.
.end note
.indent -1;2#Making Index Entries

IdxTeX supports three levels of indexing.  To make an entry for the term "Test",
enter \index{Test}.  To make a subindex entry for "Release" under "Test", enter
\index{Test_>Release}.  to make a subsubindex entry for "New" under "Release",
enter \index{Test_>Release_>New}.  Note that the syntax was chosen to be similar
to the syntax of RUNOFF to facilitate the conversion of documents.

To cause the page number reference in the entry to appear in boldface, include
the _^ character as the first character in the index entry (i.e., 
\index{_^Test_>Release_>New}.  Similarly, use the _~ character to cause the
page number reference to appear in italics, and the __ character to cause
the page number reference to appear underlined.

For further information, please refer to the IdxTeX User's Guide.