.!+
.! Help Module Name:
.!	GloTeX
.!
.! Author:
.!	RL Aurbach	CR&DS MIS Group		26-Aug-1986
.!
.! Description:
.!	Help module for the GloTeX utility.
.!
.! Special Notes:
.!	none
.!
.! Modification History:
.!
.! Ident     Initials	    Date	Description
.! -------------------------------------------------------------------------
.! 1-001	RLA	26-Aug-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#GloTeX

GloTeX is a utility which is used in conjunction with LaTeX to automate the
generation of glossaries in LaTeX documents.  It enables you to maintain 
definitions of terms in Glossary Definition Files, where they may be reused
as needed. A User's Guide to GloTeX is available as the file 
CRL__DOCUMENTATION:GLOTEX.QMS.

The format of the GloTeX command is
.s.nf
	GLOTEX  file [/STYLE=value] [/GLOSSARY=(file-list)]
.f
.indent -1;2#Parameters

The "file" parameter is the name of the input file.  This file is used to
specify which terms should be included in the glossary.  The default file
specification "SYS$DISK:[].GLO" is used.
.indent -1;2#Qualifiers
.indent -1;/STYLE

The /STYLE qualifier is used to specify how the glossary should be formatted.
Specify the value "ARTICLE" if using the LaTeX article document style.  Specify
the value "REPORT" if using the LaTeX report or book document styles.  Specify
the value "SPECIAL" (or omit the qualifier -- it's optional) if using a CR_&DS
document style (pamphlet, manual, or memo).
.indent -1;/GLOSSARY

The /GLOSSARY qualifier is used to specify one or more Glossary Definition Files
to be searched for the definitions which you wish to include in the glossary.
The files are searched in the order specified.  For each file specified in the
list of files, the default file specification is "SYS$DISK:[].GDF".  Although
this qualifier is optional, no glossary will be built unless one or more
Glossary Definition Files is specified.
.indent -1;2#Preparing the Source File

To prepare the LaTeX source file you must
.list ,'*'
.le;Include a "\makeglossary" command in the document preamble.
.le;Include a "\glossary" command (format: \glossary{label}) for each term you
wish to include in the glossary.  The "label" is an identifier which specifies
the definition to be included.
.le;Include the command "\input{myfile.gls}" in the document at the point at
which the glossary should appear.  Here, "myfile" is the name of your source
file.
.els

LaTeX will generate the file "myfile.glo" when the "\makeglossary" command is
present (again, "myfile" is the name of your source file).  GloTeX will generate
the file "myfile.gls" from it.
.indent -1;2#Preparing the Glossary Definition File

The Glossary Definition File is a text file containing one or more glossary 
entries.  The format of a glossary entry is
.s.nf
	@entry{label, item} definition
	definition (continued)...
.s.f
The "label" is the identifier for the glossary entry.  It is matched against 
the label specified in the "\glossary" command to determine if the entry should
be included in the glossary.

The "entry" is the word or phrase being defined.  If identical to the label, it
need not be defined.

The "definition" is the text which defines the term.  It may optionally start on
the same line as "@entry", but that is not required.  The text of the definition
is interpreted as LaTeX source text and is formatted appropriately.