Macros Dictionary;
IGES Document Management

The LaTeX system supports the definition and instancing of Macros to help assure consistent representation of the similar information throughout a document. Some of these are part of a defined environment.

A Macro is instanced just like TeX escape commands: a back-slash is followed by the Macro name and any necessary arguments inside braces. For example, the "change bar" Macro is instanced as

\CB{RFC999}

in LaTeX source files. Where material requires a formatting construction, a LaTeX Environment is used. The material to be typeset with a defined Environment is placed between a

\begin{environmentName}[{arguments as needed}]

and a

\end{environmentName}

Below are listed both the individual Macros and the Environments as developed and defined for use in the IGES document source.

The following are included in the IGES style files. Some are not presently called from the IGES source; these are marked {not used}. Those which are not called and are not part of functional groups are listed in a separate section.

Active

\ACHEAD (1): This is a chapter head for an appendix (not the main body).
\ASHEAD (1): This is the section head for an appendix (not the main body).
\B (1): Places the argument in bold.
\BG (1): Places the argument in bold math. It is used, for example, to create a centered dot indicating multiplication.
\BSFORM (1): Adds the parameterized/unparameterized message in the 190-198 entities. The argument is the name of the entity.
\CB (1): Puts the change number in the margin (e.g., ECOxxx). If Two of these are needed, put a double back-slash between arguments (e.g., RFCxxx\\ECOxxx)
\CBS (2): Same as CB, except it is manually placed. Here, the second argument is X, Y (in centimeters). Useful alongside tables, etc.

The following 6 are used to enter notes at the bottom of the DE layout.

\DEFOOTB (0): Produces the string:
"\NOTE When the Hierarchy is set to Global Defer (01), all of the following are ignored and may be defaulted: Line Font Pattern, Line Weight, Color Number, Level, View, and Blank Status."
\DEFOOTC (0): {not used}
\DEFOOTD (0): Produces the string:
"\NOTE If PD Index 4 (Pointer to Display Geometry) is 0 or defaulted, Line Font Pattern, Line Weight, and Hierarchy are ignored."
\DEFOOTE (0): {not used}
\DEFOOTF (0): {not used}
\DEFOOTG (0): Produces the string:
"\NOTE The Level shall be ignored if this property is subordinate (see Sections~\ref{E406} and \ref{SPRPENT})."

The next two were formerly used within a Directory Entry (DE) layout; they presently appear only in the obsolete entity appendix:

\DEMACI (1): Produces the string:
"Directory Entry Entity Type Number:" Argument is entity number.
\DEMACII (2): Produces the string:
"Directory Entry Entity Type Number: Form Number:" Arguments are entity number and form number.
\detable (0): Produces the DE layout.
\ECOheader (8): Produces the first page (cover) of an ECO. (The IGES editor maintains a skeleton file which includes the arguments needed.)
\EG (0): Produces an "e.g.," in italics.
\ETC (0): Produces an "etc." in italics.
\FULL (0): Controls figure size; full page.
\HALF (0): Controls figure size; half page.
\IE (0): Produces "i.e.," in italics.
\IGNORE (0): Used only within a DE layout; produces a "< n.a. > ".
\INTG (0): Used only within a DE layout; produces a "#".
\INTGorPNTR (0): Used only within a DE layout; produces a "#,=>".
\inTWO (0): Used only in TWOITEMS environment. Produces one line.
\MACCA (3): {not used}
\MACCB (3): Used only in MACEB environment. Produces one line.
\NOTE (0): Produces the string:
"Note:" in bold face.
\ONLYBREP (0): Produces the string:
"This surface type is intended to represent the geometry underlying topology, and shall only be referenced by a Face Entity (Type 510, Form 1). The Subordinate Entity Switch shall always be set to Physically Dependent; \IE independent instances of this entity are not permitted."
\PDHEAD (0): Produces the header for the Parameter Data.
\PDLINE (4): An individual entry within the PD.
\PNTR (0): Used only within a DE layout; produces a "=>"; pointer.
\PTRDE (0): Produces the string:
"Pointer to the DE of the" with a following blank.
\RFCheader (7): Produces the cover page for an RFC; the arguments are described in the "skeleton file" for RFCs.
\RFCname (5): Constant information for an RFC or ECO: described in the "skeleton file" for RFCs..
\SHEAD (1): Defines the section heading in the specification.
\SSHEAD (1): Defines the sub-section heading in the specification.
\ZEROorPNTR (0): Used only within a DE layout; produces a "0,=>".

Environments

\begin{entity} (2): Produces the entity description. The name and the entity number are arguments.
\begin{MACEB} (0): Used to describe the definition of a pre-defined associativity. Example is in 402_1.

The following produces the Parameter Data layout; these allocate column space.

\begin{PD} - \begin{PDIV} (0)

Used to format parameter data descriptions. The different environments differ in spacing of the different columns. The following table gives the spacing in points for the various PD environments:

     Env.       Index   Name    Type 

     PD          54      54      40
     PDI         63      36      54     (not used)
     PDII       126      72      36
     PDIII       72     100      50
     PDIV        54     100      40

\begin{TWOITEMS} (0)

Produces a table with two columns. Example is in the parameter description in the parameterization discussion of 102.

The following have been developed at some point in the evolution of the IGES Style File, but are not presently called from the IGES source; these are marked {not used}. These are listed here in the event a need surfaces, and to provide a more complete record of the Style File contents.

Inactive Macros

\ASSHEAD (1): {not used}
?
\DDE (1): {not used}
?
\DEMACIII (1): {not used; it duplicates DEMACI.}
\FILLER (0): {not used}
?
\HALFWIDE (0): {not used}
?
\illus (2): {not used}
?
\illust (3): {not used}
?
\INPDI (4): {not used}
?
\nexp (1): {not used}
?
\PHEAD (1): {not used}
?
\PSURF (0): {not used}
?
\SSSHEAD (1): {not used}
?
\UPSURF (0): {not used}
?
\vcorrection (1): {not used}
?

Inactive Environments

\begin{ILLUSTRATE} (0): {not used}
?
\begin{ILLUSTRATION} (0): {not used}
?
\begin{MACEA} (0): {not used}
?

Last update: 1/17/96
For further information contact Philip Kennicott, IGES Document Editor.

Macros Dictionary; IGES Document Management