no slide title - oneildownloads.oneil.com/emssupport/ems2/guides/wordauthguide.pdfauthoring guide...

Authoring Guide

for Creating

Electronic Maintenance System Version 2(EMS-2)

Interactive Electronic Technical Manuals (IETMs)

Using Microsoft SGML Author for WordPrepared for TACOM

by

March 2005

495 Byers RoadMiamisburg, OH 45342-3662

EMS-2 Administration Guide

March 2005

i

1 ABOUT THIS GUIDE ............................................................................................................... 1

1.1 IETM AUTHORING SYSTEM OVERVIEW ...................................................................... 1

1.1.1 Word Document Files ................................................................................................ 1

1.1.2 Document Conventions and Toolbars ....................................................................... 2

1.1.3 Graphic Files.............................................................................................................. 6

1.1.4 Multimedia Files ......................................................................................................... 6

1.1.5 SGML (IW) Author Files............................................................................................. 6

1.1.6 Feedback Files........................................................................................................... 7

1.1.7 SGML (IR) Files ......................................................................................................... 7

1.1.8 IR SGML File Renaming............................................................................................ 7

1.1.8.1 EMS-2 Naming Restrictions ............................................................................... 7

1.1.8.2 EMS-2 Intermediate and Compiled Viewers ...................................................... 8

1.1.8.3 EMS-2 HyperTarget Rules ................................................................................. 8

2 WORKING WITH TEMPLATES............................................................................................... 9

2.1 AUTHORING A FRONT DOCUMENT ............................................................................. 9

2.1.1 Creating an Introduction ............................................................................................ 9

2.1.2 Creating a Preface ................................................................................................... 11

2.1.3 Creating a Foreword ................................................................................................ 12

2.1.4 Creating a How To Use Document .......................................................................... 13

2.1.5 Entering Safety and Caution Summary Information ................................................ 14

2.2 AUTHORING A BODY DOCUMENT ............................................................................. 17

2.2.1 Creating a Chapter................................................................................................... 18

2.2.2 Creating a Section ................................................................................................... 19

2.2.3 Creating Paragraphs................................................................................................ 20

2.3 AUTHORING A MAINTENANCE DOCUMENT ............................................................. 21

2.4 AUTHORING A TROUBLESHOOTING (OR PMCS) DOCUMENT............................... 26

2.4.1 Creating the Troubleshooting Test .......................................................................... 30

2.4.1.1 Entering a Test Procedure ID ........................................................................... 30

2.4.1.2 Entering a Test Question.................................................................................. 31

2.4.1.3 Entering Preconditions and Setup Steps.......................................................... 31

2.4.1.4 Creating Logic Branches .................................................................................. 31

2.4.1.4.1 Creating a Visual Logic Branch .................................................................... 31

2.4.1.4.1.1 Creating a Button Logic Branch ............................................................. 33

2.4.1.4.2 Automatically Collecting Data for Evaluation................................................ 35


March 2005

ii

2.4.1.4.2.1 Automatically Collecting Data Using the DODACTEST Function.......... 35

2.4.1.4.2.2 Collecting Data Using the Connect Function ......................................... 38

2.4.1.4.2.3 Collecting Data Using Special Test Function......................................... 41

2.4.1.5 Knowledge Base............................................................................................... 42

2.4.1.5.1 Creating a Knowledge Base in Binary Troubleshooting ............................... 43

2.4.1.5.2 Referencing the Knowledge Base in Binary Troubleshooting ...................... 44

2.4.1.6 Creating a Knowledge Base in Dynamic Troubleshooting ............................... 46

2.4.1.7 Referencing the Knowledge Base in Dynamic Troubleshooting ...................... 47

2.4.1.8 Creating a Reason............................................................................................ 48

2.4.1.9 Creating a Locator Graphic .............................................................................. 49

2.4.1.10 Entering Follow-On Information........................................................................ 49

2.5 AUTHORING A REAR DOCUMENT.............................................................................. 50

2.5.1 Creating an Appendix .............................................................................................. 50

2.5.2 Creating a Glossary ................................................................................................. 51

2.5.2.1 Editing Glossary Items...................................................................................... 53

2.5.2.2 Deleting Glossary Items ................................................................................... 54

2.5.2.3 Adding Glossary Items ..................................................................................... 54

2.5.3 Creating a Foldout Document.................................................................................. 54

2.5.3.1 Creating a Foldout Figure................................................................................. 54

2.5.3.2 Creating a Foldout Table .................................................................................. 55

3 WORKING WITH COMMON TOOLS .................................................................................... 59

3.1 CREATING A TABLE..................................................................................................... 59

3.2 INSERTING GRAPHICS AND FIGURES....................................................................... 60

3.2.1 Inserting graphics..................................................................................................... 60

3.2.2 Inserting Figures ...................................................................................................... 61

3.2.2.1 Inserting Figures In Cover Documents............................................................. 61

3.2.2.2 Inserting Figures In Foldout Documents .......................................................... 62

3.3 CREATING LINKS.......................................................................................................... 64

3.3.1 Creating HyperProc Links........................................................................................ 64

3.3.2 Creating HyperText Links ........................................................................................ 65

3.3.3 Creating Hyper Application Links............................................................................. 66

3.3.4 Creating Hot Spots Within a Graphic....................................................................... 67

3.4 CREATING A KEYWORD LIST ..................................................................................... 69

3.5 ALERTS.......................................................................................................................... 69

3.5.1 Entering Warnings and Cautions ............................................................................. 69

3.5.1.1 Creating a New Warning, Caution or Note ....................................................... 69


March 2005

iii

3.5.1.2 Referencing a Warning or Caution ................................................................... 71

3.5.2 Creating Notes in Documents.................................................................................. 71

3.5.3 Referencing Notes From Other Documents ............................................................ 73

3.6 INSERTING COMMENTS............................................................................................... 74

3.7 INSERTING MULTIMEDIA OBJECTS........................................................................... 74

3.8 CREATING LISTS .......................................................................................................... 76

3.8.1 Creating Random Lists ............................................................................................ 76

3.8.2 Creating Sequential Lists ......................................................................................... 77

3.9 SAVING AND CONVERTING AUTHORED DOCUMENTS........................................... 78

3.9.1 Converting Authored Documents............................................................................. 79

3.9.2 Successful Conversion ............................................................................................ 79

3.9.3 Unsuccessful Conversion ........................................................................................ 79

3.10 REFORMATTING AUTHORED DOCUMENTS.......................................................... 80

3.10.1 Reformatting individual or a group of documents .................................................... 80

3.10.2 Reformatting An Entire IETM................................................................................... 82


March 2005

iv

Figure 1 EMS-2 Development Process.......................................................................................................... 2

Figure 2 Direct Format Warning ................................................................................................................... 3

Figure 3 Style Area Displayed in Document .................................................................................................. 3

Figure 4 SGML and EMS-2 Toolbars ............................................................................................................ 4

Figure 5 Opening a Front Document ............................................................................................................. 9

Figure 6 Introduction Styles ........................................................................................................................ 10

Figure 7 Introduction in a Front Document ................................................................................................. 10

Figure 8 Preface Styles ................................................................................................................................ 11

Figure 9 Preface in a Front Document......................................................................................................... 12

Figure 10 Foreword Styles .......................................................................................................................... 12

Figure 11 How To Use Next Legal Style Dialog Box................................................................................. 13

Figure 12 How To Use Information in a Front Document .......................................................................... 14

Figure 13 Safety Summary Styles ............................................................................................................... 15

Figure 14 Warning Dialog Box ................................................................................................................... 15

Figure 15 Warning ID Dialog Box .............................................................................................................. 15

Figure 16 Inserting Graphic in a Safety Summary ...................................................................................... 16

Figure 17 Summary of Warnings in a Document ........................................................................................ 17

Figure 18 Opening a Body Document ......................................................................................................... 18

Figure 19 Chapter Styles ............................................................................................................................. 19

Figure 20 Chapter in a Body Document ...................................................................................................... 19

Figure 21 Section Styles .............................................................................................................................. 20

Figure 22 Section in a Body Document....................................................................................................... 20

Figure 23 PARA0 Styles ............................................................................................................................. 21

Figure 24 PARA0 Information in a Body Document .................................................................................. 21

Figure 25 Opening a Maintenance Document ............................................................................................. 22

Figure 26 Initial Maintenance Styles........................................................................................................... 23

Figure 27 Subsequent Maintenance Styles .................................................................................................. 23

Figure 28 ID & Applicability Dialog Box................................................................................................... 24

Figure 29 Step Dialog Box .......................................................................................................................... 25

Figure 30 Step Use-On-Code Dialog Box ................................................................................................... 25

Figure 31 Step ID in Maintenance Document ............................................................................................. 25

Figure 32 Maintenance Styles in Document................................................................................................ 26

Figure 33 Opening a Troubleshooting Document ....................................................................................... 28

Figure 34 Document Type Dialog Box ........................................................................................................ 28


March 2005

v

Figure 35 Data Base Builder Dialog Box .................................................................................................... 28

Figure 36 Next Legal Style Dialog Box ...................................................................................................... 29

Figure 37 Usability Dialog Box................................................................................................................... 30

Figure 38 Test Procedure Dialog Box ......................................................................................................... 30

Figure 39 Changing Test Procedure and Use-On Information .................................................................... 31

Figure 40 Visual Logic Dialog Box............................................................................................................. 32

Figure 41 Button Selected in the Next Legal Style Dialog Box .................................................................. 34

Figure 42 Button Dialog Box ...................................................................................................................... 34

Figure 43 DODACEST in Next Legal Style Dialog Box ............................................................................ 36

Figure 44 DoDACTest Dialog Box ............................................................................................................. 36

Figure 45 Type Evaluation Dialog Box....................................................................................................... 37

Figure 46 Evaluate Logic Dialog Box ......................................................................................................... 38

Figure 47 Connect Function Selected.......................................................................................................... 39

Figure 48 Connect Dialog Box.................................................................................................................... 39

Figure 49 Read Selection Dialog Box ......................................................................................................... 40

Figure 50 Type Evaluation Box................................................................................................................... 41

Figure 51 Special Test Function Selected ................................................................................................... 42

Figure 52 Special Tests Dialog Box ............................................................................................................ 42

Figure 53 Knowledge Model in Next Legal Style Dialog Box ................................................................... 43

Figure 54 Knowledge Model Dialog Box ................................................................................................... 43

Figure 55 Definition Dialog Box................................................................................................................. 44

Figure 56 Fault Reference List Dialog Box................................................................................................. 45

Figure 57 Reference Dialog Box with Known and Possible Information ................................................... 45

Figure 58 Fault Definition Dialog Box......................................................................................................... 46

Figure 59 Visual Logic Dialog Box ............................................................................................................. 47

Figure 60 Button Logic Dialog Box ............................................................................................................. 48

Figure 61 Reason in Next Legal Style Dialog Box ..................................................................................... 48

Figure 62 Template in the New Document Dialog Box .............................................................................. 50

Figure 63 Appendix Next Legal Style Dialog Box...................................................................................... 51

Figure 64 Glossary Options Dialog Box ..................................................................................................... 51

Figure 65 Title in Glossary Dialog Box ...................................................................................................... 52

Figure 66 Glossary Dialog Box ................................................................................................................... 52

Figure 67 Glossary in Rear Document ........................................................................................................ 53

Figure 68 Edited Item in Glossary Dialog Box ........................................................................................... 53

Figure 69 Foldout Options Dialog Box ....................................................................................................... 54

Figure 70 Figure Title Dialog Box .............................................................................................................. 55


March 2005

vi

Figure 71 Foldout Options Dialog Box ....................................................................................................... 55

Figure 72 Table-ID Dialog Box................................................................................................................... 56

Figure 73 Table Title Dialog Box................................................................................................................. 56

Figure 74 Insert Table Dialog Box ............................................................................................................... 56

Figure 75 Foldout Table .............................................................................................................................. 57

Figure 76 Table Title Dialog Box................................................................................................................ 59

Figure 77 Insert Table Dialog Box .............................................................................................................. 59

Figure 78 Insert Picture Dialog Box............................................................................................................ 60

Figure 79 Use-on Not-Use-on Dialog Box.................................................................................................. 61

Figure 80 Inset Picture Dialog Box ............................................................................................................. 62



Figure 83 HyperProc Dialog Box................................................................................................................ 64

Figure 84 HyperText Dialog Box................................................................................................................ 65

Figure 85 HyperApp Dialog Box ................................................................................................................ 66

Figure 86 Open Dialog box ......................................................................................................................... 67

Figure 87 Destination Editor Dialog Box.................................................................................................... 68

Figure 88 Warning Dialog Box ................................................................................................................... 70

Figure 89 Warning ID Dialog Box .............................................................................................................. 70


Figure 91 Warning SDOC & ELEM Dialog Box........................................................................................ 71

Figure 92 Note Dialog Box ......................................................................................................................... 72

Figure 93 ID & Text Dialog Box................................................................................................................. 72


Figure 95 Note Dialog Box ......................................................................................................................... 74

Figure 96 SDOC & ELEM Dialog Box....................................................................................................... 74

Figure 97 Multimedia Not Legal Dialog Box.............................................................................................. 75

Figure 98 Multimedia Object Dialog Box ................................................................................................... 75

Figure 99 Browse Dialog Box ..................................................................................................................... 76

Figure 100 Random List Selected in Next Legal Style Dialog Box ............................................................ 77

Figure 101 Random List Dialog Box........................................................................................................... 77

Figure 102 Sequential List Dialog Box ....................................................................................................... 78

Figure 103 Conversion Confirmation Message ........................................................................................... 79

Figure 104 Conversion Error Displayed in .fbk File ................................................................................... 80

Figure 105 EMS-2 Reformatter File Selection Window ............................................................................. 81

Figure 106 Reformatter Confirmation Window .......................................................................................... 82


March 2005

vii

Figure 107 EMS-2 Reformatter File Selection Window ............................................................................. 83

Figure 108 Reformatter Confirmation Window .......................................................................................... 84


March 2005

1

1 ABOUT THIS GUIDE

This Authoring Guide provides detailed information for using the Electronic Maintenance System, Version

2 (EMS-2) Authoring and Presentation System. Section 1 of this guide provides an overview of the EMS-2

system and descriptions of the files and toolbars used to build the components of an Interactive Electronic

Maintenance Manual (IETM). Sections 2 and 3 include specific instructions for creating IETM

components through the use of EMS-2 templates and common formatting tools. Sections 4 and 5 provide

instructions for saving, converting, and reformatting the IETM components and activating the interactive

manual.

1.1 IETM AUTHORING SYSTEM OVERVIEW

The EMS-2 authoring system allows an authoring team to develop separate components of an IETM that

can be converted, reformatted, and viewed interactively in the viewing application. The EMS-2 system

utilizes an easy-to-use editor based on two Microsoft

applications: Microsoft Word 97 for Windows and

Microsoft SGML Author for Word. This document is written for Microsoft Word for Windows and

Microsoft SGML Author for Word version 1.1. SGML stands for Standard Generalized Markup Language,

a set of codes used to indicate type, purpose, or structure of text in documents. When an IETM document

is saved in Word, EMS-2 copies the file and generates a SGML (.sgm) and a feedback (.fbk) file. The

feedback file contains any formatting errors that occurred during the conversion. An error-free SGML file

can be formatted and then displayed in the viewing application.

NOTE: The EMS-2 system must be properly installed and a directory structure created prior to

authoring IETM documents. Installation and directory instructions are provided in the Administration

Guide.

1.1.1 Word Document Files

The EMS-2 authoring system utilizes customized templates and macros made available in Microsoft Word.

The five templates are used to build the following IETM components:

Front Document

Body Document

Maintenance Document

Troubleshooting Document

Rear Document

Each document (such as a troubleshooting or maintenance procedure) is authored as a separate Microsoft

Word document with a unique name that reflects its contents, followed by a .doc file extension. The types

of files that can be entered or inserted into Microsoft Word files for EMS-2 include the following:

ASCII text

Word processor documents

Optical Character Recognition (OCR) scanned pages

Graphic files (scanned or otherwise imported to the directory)

Multimedia (animation, audio, and video) files


March 2005

2

Figure 1 shows the flow of the EMS-2 Development process. The IETM authoring activities are shown at

the top of Figure 1.

Figure 1 EMS-2 Development Process

1.1.2 Document Conventions and Toolbars

The character styles that display in the converted EMS-2 IETM are applied in two ways: automatically, by

the authoring system, and manually, by the author using the SGML and EMS-2 toolbars.

The EMS-2 paragraph styles (Chapter Title, Sequence List, Test Procedure, etc.) are assigned

predetermined character styles (bold, italic, point size, etc.) by the authoring system. This automatic

formatting provides consistency among the individual documents that make up the IETM; and it prevents

conversion errors due to character styles that are incompatible with the SGML converter.

An author is limited to the character style changes allowable in EMS-2. The character options available to

an author are those available on the SGML and EMS-2 toolbars. They are the boldface, italic, underline,

hypertext, and hyperprocedure attributes. These formats are primarily available wherever the paragraph

style is used. Characters formatted using the MS Word menus will not be saved in SGML and should not

be used. Use of the menus to apply character formats results in the warning message shown in Figure 2.


March 2005

3

Figure 2 Direct Format Warning

As styles are applied in a document, they are displayed in the Style Area at the left edge of the document as

shown in Figure 3.

Figure 3 Style Area Displayed in Document

Figure 4 displays the EMS-2 and SGML toolbars.


March 2005

4

Figure 4 SGML and EMS-2 Toolbars

The EMS-2 toolbar is located at the bottom of the window. The EMS-2 toolbar is template-dependent.

Tables 1.1.2-1 through 1.1.2-4 identify the selections available on those toolbars in the IETM templates.

Table 1.1.2-1 Front Document EMS-2 Toolbar Selections

Button Description

Opens Cover document.

Opens Safety Summary document.

Opens Foreword document.

Opens Preface document.

Opens How To Use document.

Opens Introduction document.

Opens Menu document/Menu dialog box.

Opens the HyperText dialog box.

Opens the HyperProc dialog box.

Opens the HyperApp dialog box.


March 2005

5

Button Description

Opens KeyWord dialog box.

Applies the applicable style to a selected graphic.

Applies the applicable multimedia format.

Table 1.1.2-2 Body Document EMS-2 Toolbar Selections

Button Description

Opens Chapter document.

Applies PARA0 Title style.

Opens Section document.







Table 1.1.2-3 Maintenance and Troubleshooting Document EMS-2 Toolbar Selections

Button Description







Table 1.1.2-4 Rear Document EMS-2 Toolbar Selections

Button Description


March 2005

6

Opens an Appendix document.

Opens a Glossary document.

Creates a Foldout figure.



Opens HyperApp dialog box.

Opens the KeyWord dialog box.



1.1.3 Graphic Files

Each Technical Manual (TM) illustration may be scanned from legacy material or generated by the IETM

authoring staff and saved as a digital graphic file, with the associated file extension (e.g., a graphic file

containing a bitmap graphic from page 3-27 might be named 0327.bmp). The author inserts the graphic

files into documents using the Graphic style from the Next Legal Style dialog box. The graphic format is

applied to the inserted graphic using the graphic extension button on the EMS-2 toolbar. The available

graphic formats are BMP, CGM, TIFF, JPEG, and WMF. To use the CGM graphic format, Henderson

Graphics must be installed in the authoring workstation. It is recommended that graphics be cropped to

620 x 480 pixels or smaller in order to properly display in the viewer. Pallet size up to 24-bit color can be

supported. Please note that WMF graphic format source files are vector graphics, containing a high level of

detail, but considerably more memory intensive.

1.1.4 Multimedia Files

EMS-2 supports two types of multimedia files: audio, and video.

An audio file is a digital representation of an audio waveform. Each audio sequence must be in a separate

audio file. Audio files may be created by the IETM authoring staff from audiotape using commercially

available and public domain audio tools. The audio format supported by EMS-2, and thus the only possible

extension name, is WAV. This format is supported by Microsoft WindowsTM

. A soundcard must be

installed in the deployed computer to hear the audio file. This is a major consideration when planning a

project.

A video file is a digital representation of a video sequence. Each video sequence must be in a separate AVI

video file format, which is supported by Microsoft WindowsTM

. Video files may be created by the IETM

authoring staff from videotape using commercially available tools.

1.1.5 SGML (IW) Author Files

Completed IETM files are saved in SGML format. This creates an SGML IW (intermediate word) file

copy. This file is created by the SGML Author for Word application. The newly created SGML IW file

has the same name as the Word document, but ends in .sgm. It resides on the same directory as the .doc

file.

Every time documents are saved as SGML, the application also saves the document file and the IW tagged

files are regenerated. The creation of SGML IW files allows large manuals to be divided into independent


March 2005

7

SGML sub-documents (SUBDOCs). These independent SUBDOCs are displayed by EMS-2 as a complete

document.

1.1.6 Feedback Files

When the author saves a document as SGML, a second copy of the document is created. The newly created

file has the same name as the procedure created in Microsoft WordTM

, but it contains the .fbk (feedback)

file extension. Feedback files reside in the same directory as the .doc file. The feedback file contains error

reports and warnings pertaining to the document's structure. Every time the document is saved as SGML, a

new .fbk file is generated. Once the, .fbk file is closed, it is eliminated from the system.

1.1.7 SGML (IR) Files

Another document translation is performed by the Reformatter/Indexer. The SGML files produced by the

reformatter have names ending in IR for Intermediate RunTime. When the files are reformatted, the

translated files are written to another SGML directory, which is used by the Interpretive Viewer. These

SGML files are created by the reformatter and reside on a directory called SGML, located at the same

subdirectory level as that containing the .doc file. For example, if the .doc file is in directory

…\Maintain\05, the reformatted file will be written to …\Maintain\SGML. Relative to the document file

directory, the reformatter always writes to ..\SGML, where ‘..’ is the DOS / Windows notation for Parent

Directory. IR SGML files are the only files used by the Viewer system.

1.1.8 IR SGML File Renaming

SGML identifiers must begin with an alphanumeric character. SGML names and identifiers in the core

concrete syntax can only consist of the characters ‘a’..’z’, ‘A’..’Z’, ‘0’..’9’, ‘.’ and ‘-‘.

The file name characters are chosen from ‘a’..’z’, ‘A’..’Z’, ‘0’..’9’, and ‘_’ (the last character is an

ASCII underscore character). HyTime Files

Linking between documents is done by Hypermedia/Time-based Structuring Language (HyTime), an

extension of SGML.

All the individual SUBDOCs with names ending in ‘IW’ (for Intermediate Word) are linked together by the

HyTime Linker/Compiler to form the composite document and displayed by EMS-2 as a complete

document. The linker resolves the HyTime references between the SUBDOCS and reports any missing

links. The compiler generates an Indexed Sequential Access Method (ISAM) database which is deployed

to the field. When revisions are made to the individual SUBDOCS, they are re-linked and a new ISAM file

is generated.

1.1.8.1 EMS-2 Naming Restrictions

EMS-2 uses HyperText and HyperProc dialog boxes to identify the destination document of a link (SDOC)

and a location (ELEM) within the document. When the destination document is created, each hyperlink

target is assigned an identification (ID) style, using the ID button on the EMS-2 toolbar. For example, if

the target document is M05-07, and the ID within the document is S09, the SDOC is M05-07, and the

ELEM is S09.

NOTE: EMS-2 element names (ELEM) and identifiers (ID) must not contain a period.

When an SDOC is identified without an ELEM value, the target is the beginning of the target document.

This convention ensures that all EMS-2 document identifiers are unique.


March 2005

8

When specifying an ID within the current document, Local is the preferred SDOC, although the document

name (M05-07) is allowed. The names used for SDOC and ELEM may contain a dash (-) and either upper

or lower case letters. The ELEM may contain up to 32 characters.

1.1.8.2 EMS-2 Intermediate and Compiled Viewers

The organization of the generated documents is governed by several SGML tagged files, which the

administrator uses to control menu generation and manual section linking. Authors edit files in Microsoft

Word, then verify the appearance by first running the file in the intermediate viewer. This can result in

several passes through authoring process. When the file appears acceptable in the intermediate viewer, it

can then be viewed in the compiled viewer. Although the appearance of the Microsoft Word documents

and their run time or Viewer appearance will differ, they are very similar. Under EMS-2, authors are only

responsible for the content and correctness of their documents. The viewer is responsible for document

layout and appearance. Compiled documents are viewed from the Indexed Sequential Access Method

(ISAM) database, where all HyTime references are resolved.

1.1.8.3 EMS-2 HyperTarget Rules

HyTime references are IDREFS. An IDREF is a reference to an SGML ELEMENT identifier attribute.

HyperTargets are valid SGML elements with defined ID attributes. If an element is used as a HyperTarget,

you must assign an ID attribute to the target element. ID attributes must be unique within the same

SUBDOC and they must be valid SGML identifiers. Identifiers, which are automatically generated by the

Reformatter for referring to entities and HyTime locators, are guaranteed to be unique within the IETM. It

is possible to select either HyperProc (HyperProcedure) or HyperText for linking to related information.

Using HyperProc will set-up a link to another document and when selected will take the viewer into that

document and all it’s contents. The viewer “back” feature can be used to return to the document of origin.

Using HyperText will bring selected information (information assigned an ID attribute) to the document

you are linking from, contained in a dialog box that can be dismissed by clicking on provided “Cancel”

button. Once the dialog box is dismissed, the viewer remains in the document of origin.


March 2005

9

2 WORKING WITH TEMPLATES

All IETM text files are created using the five customized document templates. These templates are titled

Front, Body, Maintenance, Troubleshooting, and Rear.

2.1 Authoring a Front Document

The information included in the front of an IETM is entered using the Front template. The Front template

allows the generation of the Cover, Foreword, Safety Summary (Warnings and Cautions), Preface,

Introduction, How To Use, and Menu components. Because the IETM Cover and Menu are usually created

by the System Administrator, instructions for creating those components are provided in the Administration

Guide.

The Common Tools section (3.0) explains how to insert tables, graphics, hypertext and hyperprocedures

(HyperProc), hyperapplications (HyperApp), keywords, warnings, cautions, notes, comments, multimedia

objects, and lists.

Perform the following steps to create a Front document:

• Start the Microsoft Word application.

• Select New from the File menu. The New document dialog box displays, as shown in Figure

5.

• Verify that the Create New Document button is selected.

• Double-click the document icon labeled "Front.dot” to open the Front Document.

Figure 5 Opening a Front Document

2.1.1 Creating an Introduction

Perform the following steps to create an Introduction Document using a Front Template:


March 2005

10

• Click the Show/Hide (¶) Paragraph button on the SGML toolbar.

• Click the Intro button on the EMS-2 toolbar.

• Enter the Introduction title at the PARA0 Title line within the document.

• Click the Next Legal Style button. The Next Legal Style dialog box displays, as shown in

Figure 6.

Figure 6 Introduction Styles

• Select the next style that best matches the TM requirements.

• Click Create.

• Use the Next Legal Style button to enter the remaining introduction information. An example

of an Introduction document is shown in Figure 7.

Figure 7 Introduction in a Front Document

• Save the Introduction document.

• Click the Save As SGML button on the SGML toolbar. This saves and closes the .doc file,

and creates .fbk and .sgm files. (See Section 4, Saving Documents).


March 2005

11

2.1.2 Creating a Preface

Perform the following steps to create a Preface Document using a Front Template:

• Click the Show/Hide (¶) paragraph button on the SGML toolbar.

• Click the Preface button on the EMS-2 toolbar.

• Enter the preface title at the PARA0 Title line.


Figure 8.

Figure 8 Preface Styles


• Click Create.

• Use the Next Legal Style button to enter the remaining Preface information. A sample

Preface is shown in Figure 9.


March 2005

12

Figure 9 Preface in a Front Document

• Save the Preface document.



2.1.3 Creating a Foreword

Perform the following steps to create a Foreword Document using a Front Template:

• Click the Hide/Show (¶) paragraph button on the SGML toolbar.

• Click the Frwrd button on the EMS-2 toolbar.

• Enter the Foreword title at the PARA0 Title line in the document.


Figure 10.

Figure 10 Foreword Styles


March 2005

13


• Click Create.

• Use the Next Legal Style button to enter the remaining Foreword information.

• Save the Foreword document.



2.1.4 Creating a How To Use Document

Perform the following steps to enter How To Use Document using a Front Template:

• Click the Hide/Show (¶) paragraph button on the SGML toolbar.

• Click the HowToUse button on the EMS-2 toolbar.

• Enter a How To Use title at the title line.


Figure 11.

Figure 11 How To Use Next Legal Style Dialog Box


• Click Create.

• Use the Next Legal Style button to enter the remaining How To Use information. A sample

How To Use document is shown in Figure 12.


March 2005

14

Figure 12 How To Use Information in a Front Document

• Save the How To Use document.


and creates .fbk and .sgm files. (See Section 4, Saving Documents)

2.1.5 Entering Safety and Caution Summary Information

NOTE: Safety and Caution summary documents are not the same but are created in the same way; The

Safety summary should include all the Warnings used throughout the IETM; The Caution summary shall

include all the Cautions used throughout the IETM.

Warnings and cautions can be displayed either by entering them in the document where the information

will be used, or by creating a summary document and referencing the specific warning or caution. Each

warning and caution in the summary document is assigned a unique ID, then referenced from the document

requiring the information.

Safety and Caution summaries are created in the same manner. Perform the following steps to enter a

warning or caution in a Summary Document using a Front Template:

• Click SafSum on the EMS-2 toolbar.

• The Next Legal Style Dialog Box displays, as shown in Figure 13.


March 2005

15

Figure 13 Safety Summary Styles

• Select and enter PARA0 Title in the document, if applicable.

• Click the Next Legal Style button and select Warning or Caution from the dialog box. The

Warning/Caution dialog box displays, as shown in Figure 14. This dialog allows you to create

a new Warning/Caution, or to use an existing Warning/Caution. The dialog box defaults to

Create New Warning.

Figure 14 Warning Dialog Box

• Accept the default and click OK. The Warning or Caution ID dialog box displays, as shown

in Figure 15.

Figure 15 Warning ID Dialog Box

• Enter a short, unique name that identifies the Warning or Caution in the text box labeled

"Enter a unique ID." The name may be up to 32 characters long and must not contain any

spaces. Capitalization and dashes (-) are acceptable entries.


March 2005

16

NOTE: The Warning or Caution ID must be unique for the entire IETM, not just the local document.

• Click OK. The Insert Picture dialog box displays, as shown in Figure 16.

Figure 16 Inserting Graphic in a Safety Summary

NOTE: Each time you enter a graphic, the system may default to an erroneous file path. Verify that the

file path originates from the system drive, not Network Neighborhood, and make the correction.

• Select the appropriate graphic from the following path (do not double-click the graphic, see

note):

X:\EMS2\VEHICLE NAME\GRAPHICS\WARNINGS\FILENAME

X is the letter that corresponds to your system drive.

VEHICLE NAME is the name of the vehicle.

FILE NAME is the name of the graphic.

• View the graphic in the dialog box to verify that the appropriate graphic is selected.

• Verify that "Link To File" is checked.

• Verify that "Save with Document" is not checked.

• Click OK.

• Click the appropriate format for the graphic on the EMS-2 toolbar: BMP, CGM, CCITT4,

JPEG, or WMF.

• If you wish to insert additional graphics, answer Yes to the message, “Additional Icon?”, then

repeat steps 8 through 13.

• Deselect the inserted graphic.


March 2005

17

• Enter the text of the Warning or Caution in the document at the WarnTPara line or the

CautionTPara line. A sequence or random list may also be entered within the Warning or

Caution at this point.

• Click the Next Legal Style button and select to enter the remaining Warnings or Cautions.

Figure 17 shows Warnings and their associated graphics in a document.

Figure 17 Summary of Warnings in a Document

• Save the Safety/Caution Summary document. Click the Save As SGML button on the SGML

toolbar. This saves and closes the .doc file, and creates .fbk and .sgm files. (See Section 4,

Saving Documents).

NOTE: The filenames of Safety and Caution summary documents must match the file names defined for

these documents in the configuration file.

2.2 Authoring a Body Document

A Body Document can include General Information, Purpose of Equipment, Differences Between Models,

Principles of Operation, Preventive Maintenance Checks and Services (PMCS), and various other data.

EMS-2 Authoring Guide Doc. No. EMS2-SW-GU-2-8

April 15, 2001

18

This material is often located in "Chapter 1" or "Chapter 2" of the TM. PMCS information may also be

entered using the troubleshooting template section (2.4).


(HyperProc), keywords, warnings, cautions, notes, comments, multimedia objects, and lists.

Perform the following steps to create a Body Document using a Body Template:


• Select New from the File menu. The New document dialog box displays, as shown in Figure

18.

• Verify that the General tab is selected.


• Double-click on the icon labeled "Body.dot" to open the Body Document.

Figure 18 Opening a Body Document

2.2.1 Creating a Chapter

Perform the following steps to create a Chapter Document using a Body Template:


• Click the Chapter button on the EMS-2 toolbar.

• Enter the chapter title at the Chapter Title line within the document. Do not include the

paragraph number or any model numbers.

• Click the Next Legal Style button on the SGML toolbar. The Next Legal Style dialog box

displays, as shown in Figure 19.


April 15, 2001

19

Figure 19 Chapter Styles


• Click Create.

• Use the Next Legal Style button to enter the remaining Chapter information. An example of a

Chapter document is shown in Figure 20.

Figure 20 Chapter in a Body Document

• Close and save the Chapter document (see Section 4, Saving Documents).

2.2.2 Creating a Section

Perform the following steps to create a Section Document using a Body Template:


• Click the Section button on the EMS-2 toolbar.


April 15, 2001

20

• Enter the section title at the Section Title line in the document. Do not include the paragraph

number or any model numbers.



Figure 21 Section Styles

• Select the next style that best matches the TM requirements; then click Create.

• Use the Next Legal Style button to enter the remaining Section information. An example of a

Section is shown in Figure 22.

Figure 22 Section in a Body Document

• Close and save the Section document (see Section 4, Saving Documents).

2.2.3 Creating Paragraphs

Perform the following steps to create a Paragraph Document using a Body Template:


• Click the PARA0 button on the EMS-2 toolbar.


April 15, 2001

21

• Enter the paragraph title at the paragraph style PARA0 Title within the document. Do not

include the paragraph number or any model numbers.



Figure 23 PARA0 Styles

• Select the style that best matches the TM requirements; then click Create.

• Use the Next Legal Style button to enter the remaining paragraphs. An example of Body

Document paragraphs is shown in Figure 24.

Figure 24 PARA0 Information in a Body Document

2.3 Authoring a Maintenance Document

Maintenance procedures describe how to remove, repair, and install vehicle or equipment parts. In the

IETM, maintenance procedures can be accessed directly from the cover screen, a troubleshooting

procedure, or another maintenance procedure. Perform the following steps to create a Maintenance

Document using a Maintenance Template.


April 15, 2001

22


(hyperproc), keywords, warnings, cautions, notes, comments, multimedia objects, lists, and Hot Spots.


• Select New from the File menu.

• Verify that the EMS2 tab is selected.


• Double-click the icon labeled "Maintain.dot" to open the file. The highlighted maintenance

file is displayed in Figure 25.

Figure 25 Opening a Maintenance Document


• Enter the maintenance procedure title. Do not include the paragraph number or any model

numbers.




April 15, 2001

23

Figure 26 Initial Maintenance Styles

NOTE: In Maintenance and Troubleshooting documents, items displayed in the Next Legal Style dialog

box should be entered in the order shown. The application enforces style structure by displaying styles that

must be entered before displaying subsequent styles. Enter "None" if no data exists in the TM for

mandatory styles.

• Select Condition from the Next Legal Style dialog box and click Create. Enter the condition.

• Click the Next Legal Style button. Subsequent styles display as shown in Figure 27.

Figure 27 Subsequent Maintenance Styles

• Enter Tool, Material, Personnel, Reference Material, Equipment, Follow-on, and Paragraphs

from the TM as applicable.

• Click the Next Legal Style button. Select "Step1 Title" in the Next Legal Style dialog box,

and click Create. The "ID & Applicability" dialog box displays, as shown in Figure 28.


April 15, 2001

24

Figure 28 ID & Applicability Dialog Box

• Complete the fields as follows:

ID: This field is automatically filled with the current Step1 Title identifier. The entry

automatically increments with each new Step Title within a procedure. This field can be

edited, but must be unique within the document.

Title: Enter the name of the task, e.g., Remove or Install. Do not include the outline number/letter

or model numbers with this entry.

Use-On/Not-Use-On: Select the button that applies to the items listed in the box titled "Enter the

code(s) for the desired vehicle(s)."

Enter the code(s) for the desired vehicle(s): This field contains a list of applicable vehicle

names or UOC codes. Leave a single space between entries, e.g., M977 M978 M979.

• Click OK to accept the entries.

• Enter the step title in the document.

• Click the Next Legal Style button. Select Step1 and click Create.

NOTE: If only one step is to be entered, select "Step1 UnNumbered" from the Next Legal Style dialog

box. The single step will not be numbered.

• Continue to select Step1 steps using the Next Legal Style button to enter remaining steps, as

applicable.

• Click the Next Legal Style button. Select Step2 and click Create. Enter Step2 steps (or

subordinate Step3 steps), as applicable. Some steps may not be required for all vehicle or

equipment models. Perform the following steps to mark vehicle applicability for individual

steps:

• Position the cursor at the beginning of the step. Click the ID button on the SGML toolbar.

The Step dialog box displays, as shown in Figure 29.


April 15, 2001

25

Figure 29 Step Dialog Box

• Click either the "Use-On" or "Not-Use-On" button. The corresponding dialog box displays,

as shown in Figure 30.

Figure 30 Step Use-On-Code Dialog Box

• Enter the UOC code(s) in the text box.

• Click OK. The code(s) are displayed in the document at the beginning of the step, as shown

in Figure 31.

• Specific steps may be the target of a hyper procedure from another part of the IETM, e.g., a

troubleshooting procedure may branch to a maintenance step. To function as a target, the step

must be assigned a unique identifier. Perform the following steps to assign a unique identifier

to a maintenance step.

• Position the cursor at the beginning of the step. Click the ID button.

• Enter a step ID in the text box. A recommended format is the step title followed by a letter,

e.g., S02A.

The step ID is displayed in the document, as shown in Figure 31.

Figure 31 Step ID in Maintenance Document

• Repeat the preceding steps until all steps have been entered.


April 15, 2001

26

A sample Maintenance document is shown in Figure 32.

Figure 32 Maintenance Styles in Document

• Close and save the Maintenance document (see Section 4, Saving Documents).

NOTE: Maintenance documents from paper-based TM’s should be saved with the "M" prefix (e.g,. M01,

M02) and can match its corresponding paper section numbering.

2.4 Authoring a Troubleshooting (or PMCS) Document

Troubleshooting procedures describe how to find the causes of vehicle malfunctions through a series of

questions and logic choices. Troubleshooting documents can be authored to follow a binary or dynamic

logic. Binary logic uses a series of tests with a pass or fail option to isolate the cause of the malfunction.

Dynamic troubleshooting procedures are authored using a series of multiple option tests to isolate the cause

of the malfunction. Troubleshooting documents may be accessed directly from the cover menu or from

other troubleshooting procedures. The troubleshooting Template will also accommodate a PMCS

document.


(HyperProc), keywords, warnings, cautions, notes, comments, multimedia objects, and lists.


April 15, 2001

27

Troubleshooting procedures must follow a certain naming convention. Troubleshooting procedures are

named starting with an alphabetical character that corresponds to the folder in which it is stored.

X:\Ems2\VehicleName\Text\Troubleshooting Folder\Filename

VehicleName: Name of vehicle procedure is being written (e.g. HMMWV,

PLS, MVTR, etc.)

Troubleshooting Folder: Name of the folder where the troubleshooting procedure is

being stored (e.g. A, B, CTRPL, MM, WTEC).

NOTE: Troubleshooting documents cannot have a single M starting the file name. This is reserved for

Maintenance documents. M troubleshooting tracks must begin with MM.

FileName: File names beginning with the letter of the folder where the

document is stored. (e.g. A02, B04, N14)

NOTE: Diagnostic code procedures, procedures that are a target of launching procedures, have restricted

naming conventions. They are usually an acronym of the ECM/ECU manufacturer followed by the

corresponding code number

CTRPL Caterpillar Engines

EATON Eaton CTIS

EABS Eaton ABS

WTEC World Transmission

DTDSC Detroit Diesel

WABCO WABCO Brakes

(e.g. CTRPL24 is the procedure name for the diagnostic code 24 on a Caterpillar engine.)

Perform the following steps to create a Troubleshooting or PMCS Document using a Troubleshooting

Template:



• Verify that the EMS2 tab is selected. Verify that the Create New Document button is

selected.

• Double-click the icon labeled "Trouble.dot" to open the file. The highlighted Troubleshooting

file is displayed in Figure 33.


April 15, 2001

28

Figure 33 Opening a Troubleshooting Document

• From the Document Type dialog box Figure 34, select “Troubleshooting (Binary),

Troubleshooting (Dynamic), or “PMCS”.

Figure 34 Document Type Dialog Box

• The Data Base Builder dialog box displays as shown in Figure 35.

Figure 35 Data Base Builder Dialog Box


April 15, 2001

29

• Select the vehicle being authored.

• Click on the OK button.

• Enter the procedure title. Do not include the paragraph number or any model numbers.



Figure 36 Next Legal Style Dialog Box

NOTE: In Troubleshooting documents, items displayed in the Next Legal Style dialog box could be

entered in the order shown. The application displays styles that must be entered before displaying

subsequent styles.

• Select and create the Input Pre-Condition using the Next Legal Style button.

When the subsequent styles−Tool, Material, Personnel, Reference Material, and Equipment−are selected,

the Usability dialog box displays, as shown in Figure 37. This dialog box allows you to specify vehicles or

equipment to which these styles apply.

• Select and create Tool, Material, Personnel, Reference Material, and Equipment paragraphs.

Enter "None" for each style that is not applicable.

• If a style is needed for some but not all vehicles, select Use-On or Not-Use-On and enter

applicable vehicle or equipment codes in the text box. Use a space between codes. Click OK.

The codes display in the document. Click OK if the item applies to all vehicles.


April 15, 2001

30

Figure 37 Usability Dialog Box

NOTE: In Dynamic Troubleshooting documents, Knowledge is defined before creating the

Troubleshooting Test. Refer to Knowledge Base section of this manual.

2.4.1 Creating the Troubleshooting Test

The troubleshooting test consists of a test procedure ID (section 2.4.1.1), an optional test question (section

2.4.1.2), preconditions and setup steps (section 2.4.1.3), logic branches (section 2.4.1.4), knowledge base

(section 2.4.1.5), and the reason for the test (section 2.4.1.6). Additionally, the troubleshooting test may

also include a locator graphic (section 2.4.1.9) and follow-on information (section 2.4.1.10).

2.4.1.1 Entering a Test Procedure ID

Select Test Procedure from the Next Legal Style dialog box. The Test Procedure dialog box displays, as

shown in Figure 38.

Figure 38 Test Procedure Dialog Box

The EMS-2 Authoring System automatically numbers each test procedure, beginning with TP01, and

assigns it the ID character style. This allows the procedure to be the target of a HyperProc statement (see

Section 3.3.1 Creating HyperProc Links). The test number and ID references are not visible in the rendered

IETM.


April 15, 2001

31

• Click the Use-On or Not-Use-On button to specify vehicles or equipment for which the test

procedure is, or is not, applicable. The Applicability dialog box displays with the Use-On

button selected. If no text is entered in the Group Box, the Use-On selection is not in effect,

and the procedure will apply to all vehicles.

• Enter the vehicle codes in the text box that corresponds to the Use-On or Not-Use-On

selection. Use a space between codes.


NOTE: Predefined test procedure numbers can be changed by positioning the cursor after the test

procedure number and clicking the ID button on the SGML toolbar. The resulting Test Procedure ID dialog

box allows you to enter new Test Procedure number and Use-On information, as shown in Figure 39. The

test procedure ID must be unique within the document.

Figure 39 Changing Test Procedure and Use-On Information

2.4.1.2 Entering a Test Question

Select Question from the Next Legal Style dialog box and click Create.

Enter a question, e.g., "Is the fuel filter dirty?" Subsequent preconditions and setup steps lead to answering

the question.

2.4.1.3 Entering Preconditions and Setup Steps

If a precondition exists for the test, select Test Proc Pre-Condition from the Next Legal Style button and

click Create to enter the condition, e.g., "Hood raised and secure."

Click the Next Legal Style button, select Step1, click Create, and enter setup information.

Continue to select Step1 from the Next Legal Style dialog box to enter each subsequent step.

2.4.1.4 Creating Logic Branches

The IETM contains logical paths through diagnostic and troubleshooting procedures. Each of these

procedures follows a symptom down to its cause by asking questions of the user, who utilizes visual

observation, external measurements, or data captured by the data bus on the vehicle. The answers to these

questions require choosing logic branches that eventually isolate the problem. Logic branches may consist

of one or more paths. The most common branches consist of one Go and one NoGo path. Typically, the

NoGo path identifies the fault and takes the user to the repair step or maintenance procedure, while the Go

path continues the troubleshooting procedure. The following sections provide instructions for creating three

types of logic branches: Visual, Button, and Automatic.

2.4.1.4.1 Creating a Visual Logic Branch


April 15, 2001

32

A Visual Logic Branch uses visual observation in its diagnostic and troubleshooting procedures. Perform

these steps to create a visual logic branch.

• Click the Next Legal Style button, select Step2, and click Create.

• Enter an “If” statement that describes a failed condition, and a brief name for the button the

IETM user will click if that condition exists. This name describes anticipated conditions (e.g.,

Engine Stalls).

• Click the Next Legal Style button, select Visual, and click Create.

The Visual Logic dialog box displays, as shown in Figure 40

Figure 40. This dialog box creates two 3-D buttons that can be selected by the IETM user to branch to

another part of the IETM.

Figure 40 Visual Logic Dialog Box

• Select Left Button or Right Button then complete the following fields.

Label: Enter a brief description of anticipated conditions (e.g., Engine Stalls or Engine Runs), to

display as a label on the rectangular button. This label must match the button name entered in

the Step2 style. Because the buttons display horizontally, it is best to keep the label brief to

prevent button icon distortion. Default Labels (Fail and Pass) may be used.

SDOC: Enter the name of an IETM file accessed by a procedure within this document; or enter

"Local" to access data within the current document.

ELEM: Enter the ID of a specific area within the document to be accessed. The accessed area

must be tagged with a unique designation and given the ID character style, e.g., "S01" for step


April 15, 2001

33

ID "S01." If this field remains blank, the IETM will default to the beginning of the accessed

file or to the next test procedure of the current document when the SDOC is "Local."

IW Text: Enter Intermediate Window (IW) text that briefly describes the goal of the link, e.g.,

"Replace worn alternator belt." This field is important in the NoGo path to prevent confusion

at decision points.

Doc Type: Select from the drop-down menu one of the following types of templates: Maintain,

Front, Body, Trouble, and Rear. The selection is the template type in which the referenced

item was authored.

Elem Type: Select from the drop-down menu of the following styles in which the referenced

item was authored.:

Step

Para

Root Select Root when accessing the beginning of the document or when the ELEM

field was left empty.

Menu This is valid when the document type is "Front."

Test-Proc Select Test-Proc when the data being accessed is part of a test procedure

paragraph style.

Return: Checking this box makes available new SDOC and ELEM fields, allowing you to link

back (return) to this or any other document. If the box is left blank, the IETM will

remain in the target file and after closing will not return to the original file.

SDOC: The field contains the name of the return document. Enter "Local" to return to

the current track.

ELEM: Enter the target step or test procedure in the return document.

NOTE: The troubleshooting logic assumes that a fault isolation will follow a NoGo path and will point to

a maintenance procedure.


2.4.1.4.1.1 Creating a Button Logic Branch

The Button Logic Branch provides logic branching to one or more paths. For example, an inspection of

alternator and fan belts could present three conditions: "Loose or frayed alternator belts," "Loose or frayed

fan belts," or "All belts OK." Or a single "Continue" button can branch to a single path. Buttons are usually

presented as radio buttons in the document.

Perform the following steps to create a Button Logic Branch.

• Create a test procedure as described in Section 2.4.1.

• Click the Next Legal Style button.

• Select "Button," as shown in Figure 41. Click Create.


April 15, 2001

34

Figure 41 Button Selected in the Next Legal Style Dialog Box

The Button dialog box displays, as shown in Figure 42.

Figure 42 Button Dialog Box

• Complete the following fields.

Button Orientation: Select the Radio button to display button descriptions next to buttons. Radio

buttons allow longer, more descriptive labels than Three-D buttons. Select Three-D for one or

two selection choices.

Button Label: This field contains a brief description of anticipated conditions (e.g., Loose or

Frayed Alternator Belt).


April 15, 2001

35

SDOC: Enter the name of an IETM file accessed by a procedure within this IETM; or enter

"Local" to access data within the current document.

ELEM: Enter the ID (target) of a specific area within the document to be accessed. The accessed

area must be tagged with a unique designation and given the ID character style, that is, enter

"S01" for step ID "S01." If this field remains blank, the IETM will default to the beginning of

the accessed file or to the next test procedure of the current document when SDOC is "Local."

IW Text: Enter Intermediate Window (IW) text that briefly describes the goal of the link, e.g.,

"Replace worn alternator belt." This field is important in the Fail path to prevent confusion at

decision points, and will display when transitioning to another document type, e.g.,

Maintenance.

Doc Type: Select from the drop-down menu of the following types of templates: Maintain, Front,

Body, Trouble, and Rear. The selection is the template type in which the referenced item was

authored.

Elem Type: Select from the drop-down menu of the following styles in which the referenced

item was authored:

Step Applies with the document type is ”Maintain."

Para

Root Select Root when accessing the beginning of the document or when the ELEM

field was left empty.

Menu Applies when the document type is "Front."

Test-Proc Select Test-Proc when the data being accessed is part of a test procedure

paragraph style.

Return: Checking this box makes available new SDOC and ELEM fields, allowing you to link

back (return) to this or any other document. If the box is left blank, the IETM will remain

in the target file and after closing will not return to the original file.

SDOC: The field contains the name of the return document. Enter "Local" to return to

the current track.

ELEM: Enter the target step or test procedure in the return document.

• Click Next Button to define the next button. Continue until all buttons are created.


2.4.1.4.2 Automatically Collecting Data for Evaluation

Three functions are available in the Troubleshooting template that allows an Electronic Test Set to

automatically collect vehicle data for evaluation. They are DODACTEST, Connect, and Special Test. All

are selected through the Next Legal Style dialog box.

2.4.1.4.2.1 Automatically Collecting Data Using the DODACTEST Function

The DODACTEST function allows the Electronic Test Set to monitor a particular location on the vehicle.

This is done by either using probes or the vehicle's embedded sensors, via the DCA cable.

Perform the following steps to electronically collect vehicle data:

• Create a test procedure, as described in Section 2.4.1.



April 15, 2001

36

• Select DODACTEST, as shown in Figure 43. Click Create.

Figure 43 DODACEST in Next Legal Style Dialog Box

The DoDACTest dialog box displays, as shown in Figure 44.

Figure 44 DoDACTest Dialog Box

• Complete the following fields.

Test: Select the test number to be performed from the drop-down menu (e.g., test 67 for battery

voltage measurement). These DAC tests are standardized throughout the Army vehicles.

Repeat: Select SINGLE if the measurement is to be instantaneous. Select LOOP if a gauge or

meter needs to appear in the IETM for observation. Select LOOPIGTO (LOOP IGnore Time

Out) if the stimulus will occur after the test starts to prevent an automatic timeout. Select

LOOPIGALL (LOOP IGnore ALL) to ignore all errors.

NOTE: The following tests should not be looped: 12-15, 66, and 72-79.


April 15, 2001

37

Input: Select DCA if the vehicle's embedded sensors are to be sampled. Select TK for current or

pressure probe measurements. Select J4 if probes are to be used for DVM voltage or

resistance measurements.

NOTE: Values are displayed for applicable tests. These selections are grayed out when not applicable for a

specified test. The values are as follows:

Control Functions 01-04: Select to force the test to loop and display the appropriate meters.

Control Function 02 (Display Minimum Value): Select to display the minimum value of the

resulting data.

Control Function 03 (Display Maximum Value): Select to display the maximum value of the

resulting data.

Control Function 04 (Display Peak-to-Peak Value): Select to display the difference between

the highest and lowest values.

Control Function 06 Dual (DoDACTest): Select to run two tests simultaneously.

NOTE: Tests 73, 74, and 75 use data generated by test 72, which is run automatically when any of these

tests is run. Test 76 is also run automatically when Test 77, 78, or 79 is run.

• Click OK. If the Dual DoDACTest was selected, the DoDACTest dialog box displays for the

second test number selection. When selections are complete, the "Type Evaluation" dialog

box displays, as shown in Figure 45.

Figure 45 Type Evaluation Dialog Box

• Select the type of evaluation to be made:

Visual: If the IETM user must evaluate the reading of a displayed meter, click on Visual.

Automatic: If the reading is to be evaluated automatically, click on Automatic. The Evaluate

Logic dialog box displays, as shown in Figure 46.


April 15, 2001

38

Edit: If more procedural Step1 or Step2 styles need to be entered as text after a test has been

called, but before evaluation if performed, click on Edit and edit the document.

Figure 46 Evaluate Logic Dialog Box

• For automatic evaluating, complete the following fields.

Evaluate ID: The Evaluate ID is automatically generated for this field. The ID is made up of a

prefix and a numeric identifier.

Test Number: The Test Number is automatically generated for this field. If "Dual

DoDACTEST" was selected in the Type Evaluation dialog box, the test choices are included

in this field.

Condition: Select evaluation criteria for measurement parameters: LT (Less Than), GT (Greater

Than), BETWEEN, PASS, CLOSE, OPEN, FAIL, ON, or OFF. Selecting LT, GT, and

BETWEEN enables the Value fields.

Value: For the conditions LT, GT, and BETWEEN, enter low and high numeric values. LT takes

a value in the Low field. GT takes a value in the High field. BETWEEN takes values in the

Low and High fields to establish a range.

The remaining fields in the Evaluate Logic dialog box are dedicated to Go or NoGo destinations and are

filled as shown in Section 2.4.1.4.1 Creating a Visual Logic Branch.


2.4.1.4.2.2 Collecting Data Using the Connect Function

The Connect function allows the Electronic Test Set to collect data using J1708, Counter, and Digital

Multimeter.


April 15, 2001

39

Perform the following steps to collect data through the Connect function using an Electronic Test Set:


• Click the Next Legal Style button. Select Connect from the Next Legal Style dialog box, as

shown in Figure 47. Click Create.

Figure 47 Connect Function Selected

The Connect dialog box displays, as shown in Figure 48.

Figure 48 Connect Dialog Box

The Instrument group box in the Connect dialog box displays J1708-Write as the default selection.

• Select the Instrument option and select either J5 or DCA from the Input group box, Click OK.

NOTE: The Instrument selection will define the title of the following dialog box. For this example, the

Read dialog box is displayed.

The Read dialog box displays, as shown in Figure 49.


April 15, 2001

40

Figure 49 Read Selection Dialog Box

The following four Read syntax choices are available:

J1708 DIAG CYLCUT Performs a cylinder cutout test in the automatic

mode and returns a list of cylinder, pulse, width, and

engine RPM as results.

J1708 DIAG HISTORICAL Displays historical codes present on the J1708 bus,

historical codes are active codes that have "gone

away".

J1708 DIAG ACTIVE Displays active codes present on the J1708 bus.

J1708 VALUE Displays the value of the parameter selected from

the DDEC Code drop down menu.

NOTE: All connect function tests are authored similarly, in this example, DIAG CYLCUT is used as an

example.

• Click on DIAG CYLCUT.

• Select the number of cylinders to be tested from the pulldown menu.

• Click the RPM=1000 box, if the engine speed needs to be set to 1000 RPM.

• Click OK to accept the data. The Type Evaluation dialog box displays, as shown in Figure

50.


April 15, 2001

41

Figure 50 Type Evaluation Box

• Select the type of evaluation to be made:

Visual: If the IETM user must evaluate the reading of a displayed meter, click on Visual.

Automatic: If the reading is to be evaluated automatically, click on Automatic.

Edit: If more procedural Step1 or Step2 styles need to be entered as text after a test has been

called, but before evaluation is performed, click on Edit and edit the document.

NOTE: Enter the required information in the Evaluate dialog box as described in section 2.4.1.4.2.1.

Enter the required information in the Visual dialog box as described in section 2.4.1.4.1.


2.4.1.4.2.3 Collecting Data Using Special Test Function

The Special Test function provides for clearing and reading both active and historical codes, directing the

vehicle to perform an onboard computer-controlled function, and interrogating the onboard computer for

the status of various vehicle functions.

Perform the following steps to use the Special Test function:


• Click the Next Legal Style button. Select Special Test from the Next Legal Style dialog box,

as shown in Figure 51. Click Create.


April 15, 2001

42

Figure 51 Special Test Function Selected

NOTE: The Data Base Builder dialog box will display if you are editing a previously authored document

or if the document was imported from a different IETM.

The Special Tests dialog box displays, as shown in Figure 52.

Figure 52 Special Tests Dialog Box

• Select the required Special Test.

The Type Evaluation dialog box displays.

To complete the Special Test, refer to section 2.4.1.4 and follow the instructions.

2.4.1.5 Knowledge Base

The goal of troubleshooting procedures is to find the cause of a problem through the process of elimination.

It is necessary to create a list of components that could cause the vehicle’s faulty condition. For binary

troubleshooting, the list includes reference ID, Known and Possible entries. For dynamic troubleshooting,

the list includes reference ID, and three condition status statements for each component (Known Text, Bad

Text, and Possible Text).


April 15, 2001

43

The following sections contain instructions for creating and referencing a knowledge base in binary and

dynamic troubleshooting documents.

2.4.1.5.1 Creating a Knowledge Base in Binary Troubleshooting

It is recommended that the knowledge base be done up-front in the first TP. Perform the following steps to

create a knowledge base, after creating the appropriate logic:

Click the Next Legal Style button, and select "KnowledgeModel" as shown in Figure 53. Click Create.

Figure 53 Knowledge Model in Next Legal Style Dialog Box

Select Definition in Knowledge Model dialog box, as shown in Figure 54.

Figure 54 Knowledge Model Dialog Box

The Definition dialog box displays, as shown in

Figure 55.


April 15, 2001

44

Figure 55 Definition Dialog Box

Enter known information and possible fault values in the fields, and click the Next button. The fault ID

number increments up with each new definition. Continue to enter values until all information has been

entered.

Click OK to enter the information into the document.

The definitions can now be referenced, after logic buttons are created, in subsequent test procedures, within

the current document.

NOTE: In the rendered IETM, the value of Known Info in the first procedure defaults to None.

2.4.1.5.2 Referencing the Knowledge Base in Binary Troubleshooting

A previously defined knowledge base can be referenced from subsequent test procedures within the same

document. Perform the following steps to reference an existing knowledge base after creating the

appropriate logic.

• Select KnowledgeModel from the Next Legal Style dialog box and click Create.

• Select Reference from the Knowledge Model dialog box shown in Figure 56.


April 15, 2001

45

Figure 56 Fault Reference List Dialog Box

The Reference dialog box displays, as shown in Figure 57.

Figure 57 Reference Dialog Box with Known and Possible Information

• Select known information and possible problems from the previously defined lists in the

Reference Dialog Box, and click the Add button.

• Click OK to enter the information into the document.


April 15, 2001

46

2.4.1.6 Creating a Knowledge Base in Dynamic Troubleshooting

• Select KnowledgeModel from the Next Legal Style dialog box and click Create.

The Fault Definition dialog box appears as shown in Figure 58.

Figure 58 Fault Definition Dialog Box

• Complete the fields as follows:

ID: Enter the name or a representing value for the component that is subject to testing (i.e. Wheels,

Battery, Alternator).

Weights: Enter the numeric value that represents the probability of this component causing this

failure/symptom.

Fault Code: Enter the numeric value for the fault code that represents this component.

Test: Enter the Test Procedure ID that attempts to isolate this component as the cause for this

failure/symptom.

Dependencies: If setup or tests must be conducted before attempting to isolate this component, enter the

Test Procedure ID were the setup/test are conducted. If more than one Test Procedure must be performed,

enter the Test Procedure ID for the first one that must be done.

Known Text: Enter the known or OK status statement (i.e. Wheels OK, Battery OK).

Bad Text: Enter the bad status statement (i.e. Wheels bad, Battery bad).

Possible Text: Enter the component’s possible status statement (i.e. Wheels may be bad, Battery may be

bad).

• Select Next to define more components or select OK when done.


April 15, 2001

47

2.4.1.7 Referencing the Knowledge Base in Dynamic Troubleshooting

In Dynamic troubleshooting, Knowledge Base references are done on a per-link basis. Every logic path

(VisualGo, VisualNoGo, Button, EvalGo, etc) that has Knowledge Base implications, must reference the

Knowledge Base to change the status of the component under test.

If a component is found to be faulty/bad as a result of a test then the fail path button must change the

component’s status from possible to Active. If the component is found to be good then the pass path button

must change the component’s status to Inactive.

To reference the Knowledge Base from the Visual Logic Dialog box Figure 59. Select the Right or Left

button (logic path), select the component then click on the Active or Inactive button.

If additional faults are uncovered after performing a test, faults can be added to the Knowledge Base by

clicking on the Add Fault button. Fill the fields in the Fault Definition dialog box to add the new

Knowledge Base component(s).

Select OK when done.

Figure 59 Visual Logic Dialog Box

To reference the Knowledge Base from the Button Logic Dialog box Figure 60. Select the component then

click on the Active or Inactive button.

Select Next Button to define more buttons and reference the Knowledge Model or select OK when done.


April 15, 2001

48

Figure 60 Button Logic Dialog Box

2.4.1.8 Creating a Reason

The Reason field explains the reason for a troubleshooting step. Perform the following steps to enter a

reason:

• Using the Next Legal Style button select "Reason" from the dialog box, as shown in Figure

61. Click Create.

Figure 61 Reason in Next Legal Style Dialog Box

• Enter the reason in the document.


April 15, 2001

49

2.4.1.9 Creating a Locator Graphic

A Locator graphic helps the IETM user to locate vehicle or equipment parts referenced in a troubleshooting

step.

Perform the following steps to create a Locator graphic in a troubleshooting step:

• Select Locator from the Next Legal Style dialog box. The Insert Picture dialog box displays.

• Select a graphic and click OK to enter it in the document (see Section 3.2.1 Inserting

Graphics for instructions on entering graphics). Click the graphic and click the appropriate

graphic format button on the EMS-2 toolbar.

2.4.1.10 Entering Follow-On Information

The Follow-On style is used to enter follow-on actions applicable to a test procedure. For example, a test

procedure that requires the removal of battery cables would require a follow-on, such as " Reconnect

battery cables."

The Follow-On style accepts format changes available on the SGML and EMS-2 toolbars: boldface, italic,

underline, hypertext, and hyperprocedure attributes.

To enter a Follow-On in a Troubleshooting document, select Follow-On from the Next Legal Style dialog

box. Enter the follow-on information in the document.


April 15, 2001

50

2.5 Authoring a Rear Document

The components used in the back of an IETM are included in the "Rear" template. These include the

Appendix, Glossary, and Foldout figure.


(hyperproc), keywords, warnings, cautions, notes, comments, multimedia objects, and lists.

Perform the following steps to create a Rear Document using a Rear Template:



• Verify that the Create New Document button is selected on the EMS2 tab.

• Double-click the document labeled "Rear.dot" to open the Rear Document template. The

highlighted Rear template is displayed in Figure 62.

Figure 62 Template in the New Document Dialog Box

• Save the file (see Section 4 Saving and Converting Authored Documents).

2.5.1 Creating an Appendix

Perform the following steps to create an Appendix document using the Rear Template:

• Enable the Show/Hide paragraph button on the SGML toolbar.

• Click the Appendix Title button on the EMS-2 toolbar.

• Enter the Appendix Title at the title line. Do not include the paragraph number or any model

numbers.


April 15, 2001

51


Figure 63.

Figure 63 Appendix Next Legal Style Dialog Box

• Select the style that best matches the TM requirements.

• Click Create.

• Use the Next Legal Style button to enter the remaining appendix information.

• Close and save the document (see Section 4 Saving and Converting Authored Documents).

NOTE: Appendices must be saved with a filename in the following format: Appndx-X.

X is the letter of the appendix.

2.5.2 Creating a Glossary

Perform the following steps to create a Glossary document using a Rear Document:

• Enable the Show/Hide (¶) paragraph button on the SGML toolbar.

• Click the Glossary button on the EMS-2 toolbar. The Glossary options dialog box displays,


Figure 64 Glossary Options Dialog Box

• Select the button that best serves the TM requirements.


April 15, 2001

52

• Click OK to create a paragraph at the beginning of a glossary. Although demonstrated here,

this selection is optional.

• Enter text at the Glossary Para line in the document.

• Click the Next Legal Style button on the SGML toolbar.

• Select Glossary Title and enter the title on the Glossary Title line in the document.

• Click the Next Legal Style button, and select "Definition List" from the dialog box.

• Click Create. The "Glossary" dialog box displays.

• If a title is not required, go to Step 12.

• If a title is required, click the "Title" box and enter a title in the "Title" text box, as shown in

Figure 65.

Figure 65 Title in Glossary Dialog Box

• Click OK . The Glossary dialog box displays, as shown in Figure 66.

Figure 66 Glossary Dialog Box


April 15, 2001

53

• Enter a term and its definition in the Term and Definition fields. Subsequent dialog boxes

include a Next button. Click Next to enter subsequent terms, definitions, or titles.

• Click OK to enter the information in the glossary. Figure 67 is a sample Glossary document.

Figure 67 Glossary in Rear Document

2.5.2.1 Editing Glossary Items

Perform the following steps to edit glossary items.

• Position the cursor anywhere within the item to be edited.


• Select "DefPara Edit" from the Next Legal Style dialog box.

• Click Create . The "Glossary" dialog box displays with the Glossary item inserted, as shown

in Figure 68.

Figure 68 Edited Item in Glossary Dialog Box

• Edit the glossary item as needed.

• Click "Next" to enter additional glossary items.

• Click OK at the completion of editing.


April 15, 2001

54

2.5.2.2 Deleting Glossary Items

Perform the following steps to delete glossary items.

• Select the item, or the paragraph, to be deleted.

• Press the Delete key. The selected item(s) will be deleted.

2.5.2.3 Adding Glossary Items

Perform the following steps to add glossary items.

• Position the cursor above the entry point of the new term.


• Select "DefPara" in the dialog box.

• Click Create to display the "Glossary" dialog box.

• Enter the term and definition. Click Next to enter more items.

• Click OK to accept the additions.

2.5.3 Creating a Foldout Document

The EMS-2 Authoring system allows the IETM user to view a foldout figure or table and access

information on specific areas of the foldout using hotspots. This section provides instructions for creating

foldout figures and tables.

2.5.3.1 Creating a Foldout Figure

Perform the following steps to create a Foldout Figure using a Rear Template:

• Select the Foldout button from the EMS-2 toolbar. The Foldout Options dialog box displays,


Figure 69 Foldout Options Dialog Box

• Select Create a Foldout Figure, and click OK. The Figure Title dialog box displays, as

shown in Figure 70.


April 15, 2001

55

Figure 70 Figure Title Dialog Box

• Click the Figure Title box and enter a figure title then click OK. The figure title displays in

the document and the Insert Picture dialog box displays.

• Identify and insert a graphic (see Section 3.2 Inserting Graphics).

• Click the graphic and click on the associated graphic format on the EMS-2 toolbar.

2.5.3.2 Creating a Foldout Table

Perform the following steps to create a Foldout Table using a Rear Template:

• Select the Foldout button from the EMS-2 toolbar. The Foldout Options dialog box displays,


Figure 71 Foldout Options Dialog Box

• Select Create a Foldout Table, and click OK.

The Table-ID dialog box appears as shown in Figure 72.

NOTE: If the table will have an excessive number of entries, it may be split into two or more documents to

make it easier to author and edit. Enter the required information in the Table-ID dialog box only if you intend to

split the table into more than one document, then click on the OK button. If table will be authored in a single

document, click on the Cancel button.


April 15, 2001

56

Figure 72 Table-ID Dialog Box

• Enter the table title in the Table Title dialog box as shown in Figure 73.

Figure 73 Table Title Dialog Box

• Click OK.

The Insert Table dialog box appears as shown in Figure 74.

Figure 74 Insert Table Dialog Box

• Enter the number of columns and rows then click on the OK button.


April 15, 2001

57

The table displays, as shown in Figure 75.

Figure 75 Foldout Table


April 15, 2001

58

This page intentionally left blank


April 15, 2001

59

3 WORKING WITH COMMON TOOLS

Common Tools are considered to be tools used in the normal authoring process.

3.1 Creating a Table

The Table paragraph style is available in all EMS-2 templates. Tables should be entered only at locations

specified by the Next Legal Style dialog box. Tables entered using the Table menu could result in errors in

document compiling and reformatting.

Perform the following steps to enter a Table in a document:

• Click the "Next Legal Style" button.

• Select the table style, and click Create to display the ID Dialog Box. Table ID is mandatory.

Enter a unique table ID and click OK. The "Table Title" dialog box displays, as shown in

Figure 76.

Figure 76 Table Title Dialog Box

• Enter the name of the table as shown in the paper-based TM. Do not include the table

number, as it will be automatically entered.

• Click OK to accept the entry. The Insert Table dialog box displays, as shown in Figure 77.

Figure 77 Insert Table Dialog Box

• Enter the number of rows and columns required for the table, and click OK.

The table is created and may be edited using Microsoft Word’s editing capabilities. Items that may be

entered into table cells include graphics, alerts, hypertext links, hyperproc links, random lists and sequential

lists.

NOTE: The first two rows of a table can be identified as table headers. An ID may be assigned to the row in the

first column of the table only. Use-on, NotUse-on codes may be assigned to each individual cell or to an entire

table row. Adding (-) to the Use-on, NotUse-on code (i.e., -XXX) in the first column cell of a row will make the


April 15, 2001

60

code applicable to the entire row.

3.2 Inserting Graphics and Figures

The difference between graphics and figures is that figures are titled and numbered and graphics are not.

3.2.1 Inserting graphics

Perform the following steps to enter graphics in a document. Prepared graphics are located in the following

directory:

X:\EMS2\VEHICLE NAME\GRAPHICS\XX\GRAPHIC NAME.TYPE



XX is the TM chapter number where the text is located.

GRAPHIC NAME is the name of the graphic to be placed in the text.

TYPE is the extension of the graphic name. Example, bitmap is "BMP."

• Position the cursor one line above the insertion point of the graphic, which is at the end of the

line just before the paragraph mark


• Select "Graphic" and click Create. The "Insert Picture" dialog box is displayed, as shown in

Figure 78.

Figure 78 Insert Picture Dialog Box

• Select the appropriate graphic. The file path will default to Network Neighborhood. Insert the

proper path. Do not double-click the graphic.

NOTE: Each time you enter a graphic, the system may default to an erroneous file path. Verify that the file path


April 15, 2001

61

originates from the system drive, not Network Neighborhood, and make the correction.

• View the graphic in the dialog box to verify the appropriate graphic is selected.

• Verify "Link To File" is checked.

• Verify "Save with Document" is not checked.

• Click OK.

• Select the graphic just inserted and click the appropriate format from the EMS-2 toolbar.

Repeat the preceding steps until all the graphics have been entered.

3.2.2 Inserting Figures

3.2.2.1 Inserting Figures In Cover Documents

Perform the following steps to enter figures in Cover documents:

• Position the cursor one line above the insertion point of the figure, which is at the end of the

line just before the paragraph mark.


• Select "Figure" and click Create. The "Use On--Not Use On" dialog box is displayed, as

shown in Figure 79.

Figure 79 Use-on Not-Use-on Dialog Box

• Select Use On or Not Use On and type the applicable models or UOC codes in the space

provided.

• Click on the OK button. The "Insert Picture" dialog box is displayed, as shown in Figure 80.

• Select the appropriate figure. The file path will default to Network Neighborhood. Insert the

proper path. Do not double-click the figure.


April 15, 2001

62

Figure 80 Inset Picture Dialog Box

NOTE: Each time you enter a figure, the system may default to an erroneous file path. Verify that the file path


• View the figure in the dialog box to verify the appropriate figure is selected.



• Click OK.

• Select the figure just inserted and click the appropriate format from the EMS-2 toolbar.

Repeat the preceding steps until all the figures have been entered.

3.2.2.2 Inserting Figures In Foldout Documents

Perform the following steps to insert figures in Foldout documents:

• Position the cursor one line above the insertion point of the figure, which is at the end of the

line just before the paragraph mark.


• Select “Figure Title” and click Create. The Figure Title dialog box appears as shown in

Figure 81.


April 15, 2001

63


• If the figure requires a title, check the figure title check box and type in the figure title in the

space provided.

• Click on the OK button. The "Insert Picture" dialog box is displayed, as shown in Figure 82.


• Select the appropriate figure. The file path will default to Network Neighborhood. Insert the

proper path. Do not double-click the figure.

NOTE: Each time you enter a figure, the system may default to an erroneous file path. Verify that the file path


• View the figure in the dialog box to verify the appropriate figure is selected.



• Click OK.

• Select the figure just inserted and click the appropriate format from the EMS-2 toolbar.

• Repeat the preceding steps until all the figures have been entered.


April 15, 2001

64

3.3 Creating Links

3.3.1 Creating HyperProc Links

NOTE: HyperProc links can be created to and from body, maintain, troubleshooting, and rear documents. Front

documents only support HyperProc links to other documents. In other words you can not HyperProc to a front

document. Using HyperProc will set-up a link to another document and when selected will take the viewer into

that document and all it’s contents. The viewer “back” feature can be used to return to the document of origin.

Using HyperText will bring selected information (information assigned an ID attribute) to the document you are

linking from, contained in a dialog box that can be dismissed by clicking on provided “Cancel” button. Once the

dialog box is dismissed, the viewer remains in the document of origin.

• Select a character, word, or string of characters or word with the open document.

• Click the HyperProc button on the EMS-2 toolbar. The HyperProc dialog box displays, as

shown in Figure 83.

Figure 83 HyperProc Dialog Box

• Complete the following fields:

Document: This field identifies a different document (i.e. different level of maintenance) than the

one being referenced from. Enter the exact name of the manual or alias as defined in the

appropriate Vehicle .cfg file. The manual or alias should be comprised of letters and numbers

with the first character being a letter.

SDOC: This field contains the name of the IETM file to be accessed. To access data within the

current document, enter "Local."

ELEM: This field contains the "ID" tagged characters identifying the destination field in the

target file. If this field is blank, the IETM will default to the beginning of the file being

accessed.

SDOC Type: This field identifies the document template type. Select from among the existing

templates in the drop-down menu: Body, Maintain, Trouble.


April 15, 2001

65

ELEM Type: This field identifies the style of paragraph from which the data being accessed

resides. Select from among the items in the drop-down menu: Para, Root, or Step. If the

ELEM field was left empty; this field should be Root.


3.3.2 Creating HyperText Links

NOTE: Hypertext links can be created to and from all types of documents. Hypertext is also used to link

maintenance procedures to the appropriate assembly figure in the RPSTL.

• Select a character, word, or string of characters or word.

• Click the HyperText button on the EMS-2 toolbar. The HyperText dialog box displays, as

shown in Figure 84.

Figure 84 HyperText Dialog Box






SDOC: This field contains the name of the IETM file to be accessed. To access data within the

current document, enter "Local."

ELEM: This field contains the "ID" tagged characters identifying the destination field in the


accessed.

Doc Type: This field identifies the document template type. Select from among the items in the

drop-down menu: Front, Body, Maintain, Trouble, or Rear.

ELEM Type: This field identifies the style of paragraph from which the data being accessed

resides. Select from among the items in the drop-down menu: Row, Figure, Keyword, Para,

Para0, Root, Table. If the ELEM field was left empty, this field should be Root.


April 15, 2001

66

If the link is being used to link to a RPSTL figure, the fields should be completed as follows:

Complete for RPSTL:

Document: This field should remain empty.

SDOC: This field should be RPSTL.

ELEM: This field should be “FigX” where F should be cap and X is the figure number, do not

include leading zero (i.e. Fig1, Fig2, Fig99).

SDOC Type: This field should be Rear.

ELEM Type: This field should be Figure.

NOTE: If the RPSTL figure has more than one sheet, the link should target the first sheet; The RPSTL

presentation engine will allow you to flip through all sheets in the figure.


3.3.3 Creating Hyper Application Links

NOTE: Hyper Application links can be created from any document to various external applications (i.e.

PDF files, Tutorial, Point to Point, etc) as long as the application is defined in the IETM configuration file

(see Admin Guide).

• Select a character, word, or string of characters or word with the open document.

• Click the HyApp button on the EMS-2 toolbar. The HyperApp dialog box displays, as shown

in Figure 85.

Figure 85 HyperApp Dialog Box


Notation: This field identifies the external application you intend to link to. Enter the name of

the external application as it is defined in the IETM configuration file (i.e. P2P=Point to

Point).


April 15, 2001

67

File: This field contains the name of the file you intend the external application to execute/access

(i.e. EM08).

Parameters: This field is used for specific external applications which require specific command

line parameters (i.e. /s, /p).


3.3.4 Creating Hot Spots Within a Graphic

NOTE: The Hot Spot editor is a stand alone application, the executable file is found in the Bin folder

under the Ems2 directory, “\\Ems2\bin\NewHotSpot.exe”. HotSpots created with the stand alone Hot Spot

editor will be permanently attached to the graphic and will appear wherever the graphic is used.

• Launch the Hot Spot editor application; the open dialog box will display as shown in Figure

86.

Figure 86 Open Dialog box

• Following the appropriate path, select and open the graphic to which you wish to add hot

spots.

• Right click on the area within the graphic to add a Hot Spot.


April 15, 2001

68

• A box will appear in the area you clicked, resize the box by clicking on the handle and

dragging the mouse to the desired size; move the box by clicking inside the box and dragging

the mouse to the desired location.

• Once the box is ready, double click on the box and the Destination Editor dialog box displays


Figure 87 Destination Editor Dialog Box


Destination Type: Select the type of link you which to author.





Sub-Document: This field contains the name of the file you intend the link to access.

Element: This field contains the "ID" tagged characters identifying the destination field in the


accessed.

Document Type: This field identifies the document template type. Select from among the items

in the drop-down menu: Front, Body, Maintain, Trouble, or Rear.


April 15, 2001

69

Element Type: This field identifies the style of paragraph in which the data being accessed

resides. Select from among the items in the drop-down menu: Row, Figure, Keyword, Para,

Para0, Root, and Table. If the ELEM field was left empty, this field should be Root.

Notation: This field identifies the external application you intend to link to. Enter the name of

the external application as it is defined in the IETM configuration file (i.e. P2P=Point to

Point).

File Name: This field contains the name of the file you intend the external application to

execute/access (i.e. EM08).

Parameters: This field is used for specific external applications which require specific command

line parameters (i.e. /s, /p).

• Repeat these steps to add more Hot Spots to the graphic.


NOTE: Hot Spot Links may be edited by double clicking on the Hot Spot box and changing the content of

the appropriate fields in the Destination Editor dialog box.

3.4 Creating A Keyword List

When the IETM is compiled, the program automatically builds the index by searching the IETM for

keywords identified as keyword character style, and assigned an ID.

Perform the following steps to prepare keyword entries for an index:

• Highlight the entry within the document.

• Select KeyWord on the EMS-2 toolbar.

• Assign a unique ID in the ID field of the Keyword dialog box.

• Click OK.

3.5 Alerts

Alerts consist of Warnings, Cautions, and Notes.

3.5.1 Entering Warnings and Cautions

Warnings and Cautions can be entered in a Front, Body, Maintenance, Troubleshooting, and Rear

document. The Warning or Caution can be created, or a predefined warning or caution can be referenced

from another part of the IETM or Warning or Caution Summary.

3.5.1.1 Creating a New Warning, Caution or Note

Perform the following steps to create a warning or caution in a document. Warnings and cautions are

created in the same manner.

• Select Warning or Caution from the Next Legal Style dialog box. The Warning or Caution

dialog box displays, as shown in Figure 88.


April 15, 2001

70

Figure 88 Warning Dialog Box

• Select the Create New Warning/Caution button, and click OK. The Warning/Caution ID

dialog box displays, as shown in Figure 89.

Figure 89 Warning ID Dialog Box

• Enter a unique identifier for the warning or caution, and click OK. The Insert Picture dialog





April 15, 2001

71


• Select the appropriate graphic from the following path (do not double-click the graphic):

X:\EMS2\VEHICLE NAME\GRAPHIC\ FILENAME







• Click OK.

• Click on the graphic in the document to select it.

• Click the appropriate format for the graphic on the EMS-2 toolbar: BMP, CGM, TIFF, JPEG

or WMF.

• Deselect the inserted graphic.

• Enter the text of the Warning or Caution in the document at the WarnTPara line or the

CautionTPara line. A sequence or random list may also be entered within the Warning or

Caution at this point.

3.5.1.2 Referencing a Warning or Caution

• Select Warning or Caution from the Next Legal Style dialog box.

• Click the Use Warning Ref button in the Warning/Caution dialog box. The Warning SDOC &

ELEM dialog box displays, as shown in Figure 91.

Figure 91 Warning SDOC & ELEM Dialog Box

• Enter the name of the source document of the referenced warning or caution in the text box

labeled "SDOC," or enter "Local" to reference the current document.

• Enter the location of the original warning or caution in the text box labeled "ELEM." If

retrieving a warning or caution from a summary document, enter the name (ID).

• Click OK to accept the entry.

3.5.2 Creating Notes in Documents

Perform the following steps to create a Note within a document:


April 15, 2001

72

• Click the "Next Legal Style" button, and select "Note" from the dialog box.

• Click Create to display the "Note" dialog box, as shown in Figure 92.

Figure 92 Note Dialog Box

• Select the Create New Note button.

• Click OK. The Note ID dialog box displays, as shown in Figure 93.

Figure 93 ID & Text Dialog Box

• Enter a short, unique name that identifies the Note in the text box labeled "Enter a unique ID."

The name may be up to 32 characters. Upper or lower case letters and dashes (-) are

acceptable. Spaces in the name are not allowed. Click OK. The "Insert Picture" dialog box is

displayed, as shown in Figure 94.


April 15, 2001

73




• Select the appropriate graphic from the following path (do not double-click the graphic, see

note):

X:\EMS2\VEHICLE NAME\GRAPHIC\ FILENAME







• Enter the text for the Note.

• Sequential lists or random lists may also be entered with the note.

3.5.3 Referencing Notes From Other Documents

Perform the following steps to reference an existing Note from another document:

• Click the "Next Legal Style" button, and select "Note" from the dialog box.

• Click Create to display the "Note" dialog box, as shown in Figure 95.


April 15, 2001

74

Figure 95 Note Dialog Box

• Select Use Note Ref.

• Click OK. The SDOC & ELEM dialog box displays, as shown in Figure 96.

Figure 96 SDOC & ELEM Dialog Box

• Enter the name of the source document of the referenced Note in the text box labeled

"SDOC," or enter "Local" to reference the current document.

• Enter the location of the original Note in the text box labeled "ELEM." If retrieving a Note

from a summary document, enter the name (ID). Click OK.

3.6 Inserting Comments

A Comments paragraph style is available in all templates to allow authors to communicate with one another

while simultaneously working on an IETM. The Comments style is inserted using the Next Legal Style

dialog box. The Comment is saved and converted with the document, but the Reformatter removes it.

Perform the following steps to insert a Comment:

• Select COMMENT from the Next Legal Style dialog box. Click Create.

• Enter the comment in the blue highlighted text area.

3.7 Inserting Multimedia Objects

EMS-2 supports the insertion of multimedia objects into paragraph and step styles in all templates.

Multimedia objects include animation, video, and audio files.

NOTE: Multimedia objects are inserted in a document using the multimedia button on the SGML toolbar, not

the Next Legal Style button. Attempting to insert a multimedia object into a style that does not support it will

display the dialog box shown in Figure 97.


April 15, 2001

75

Figure 97 Multimedia Not Legal Dialog Box

Perform the following steps to insert a multimedia object into a document:

• Select a paragraph or step style from the Next Legal Style dialog box. Click Create.

• Enter the paragraph or step.

• Click the Multimedia button on the SGML toolbar (see Section 1.1.2 Document Conventions

and Toolbars). The Object dialog box displays, as shown in Figure 98.

Figure 98 Multimedia Object Dialog Box

• Click the Browse button. The Browse dialog box displays, as shown in Figure 99.


April 15, 2001

76

Figure 99 Browse Dialog Box

• Select a multimedia object from the directory. Be sure to access the proper EMS-2 directory.

Click OK to insert the object into the document.

• Select the inserted object and click the appropriate multimedia format button on the EMS-2

toolbar (see Section Error! Reference source not found. Document Conventions and

Toolbars).

3.8 Creating Lists

All EMS-2 templates provide two list styles: sequential lists and random lists. Sequential lists are numbered

using a user-defined numbering style and format. Random lists are not numbered, but may include

symbols, such as a bullet, and other user-defined formats.

3.8.1 Creating Random Lists

Random lists are not numbered. Random lists can begin with a symbol, such as a bullet, a character, or a

word.

Perform the following steps to enter a random list in a document. These steps are applicable to all levels of

random lists (e.g., Ran List1,Ran List2, Ran List3).

• Select the Ran List1 style from the Next Legal Style dialog box, as shown in Figure 100.


April 15, 2001

77

Figure 100 Random List Selected in Next Legal Style Dialog Box

• Click Create. The random list dialog box displays, as shown in Figure 101.

Figure 101 Random List Dialog Box

• Enter a prefix in the PreFix field. A prefix may be a symbol, character, or word. When the

PreFix field is left blank, a bullet is automatically entered.

• Enter a title in the Title field. Click OK. The prefix and title are displayed in the document.

• Enter a random list item in the document. Continue to add random list items, using the Next

Legal Style button, until all items are entered.

3.8.2 Creating Sequential Lists

The sequential list style is available to all templates. Sequential lists are automatically numbered with user-

defined number formats.

Perform the following steps to enter a sequential list in a document. These steps are applicable to all levels

of sequential lists (e.g., Seq List1, Seq List2, Seq List3).

• Select Seq List1 from the Next Legal Style dialog box. Click OK. The Sequence List dialog



April 15, 2001

78

Figure 102 Sequential List Dialog Box

• Enter an optional symbol, such as an open parenthesis, or character in the PreFix field. The

prefix does not display in the document, but will be visible in the viewer.

• Select a numeric style from the following styles:

arabic: Arabic numerals (e.g., 1, 2, 3)

romanuc: Roman numerals, uppercase (e.g., I, IV, X)

romanlc: Roman numerals, lowercase (e.g., i, iv,x)

alphauc: Alphabet, uppercase (e.g., A, B, C)

alphalc Alphabet, lowercase (e.g., a, b, c)

• Enter an optional symbol, such as a closed parenthesis, or character in the PostFix field. The

postfix does not display in the document, but will be visible in the viewer.

• Enter a sequential list title and click OK.

• Enter a sequential list item in the document.

• Continue to add list items, using the Next Legal Style button, until all sequential list items are

entered.

3.9 Saving and Converting Authored Documents

Documents and graphics must be correctly saved to the directory structure established by the system

administrator. Maintaining directory structure ensures efficient hypertext, file, and graphic retrieval for

compilation and viewing. Save each document using the following conventions:

X:\EMS2\VEHICLE NAME\TEXT\DOCUMENT\FILENAME.DOC



DOCUMENT is the name of the template (e.g., FRONT, TROUBLE)

FILENAME is the name of the document.

NOTE: Several keywords have special meaning to the EMS-2 system and must not be used as a

FILENAME. These words are FRONT, TOC, INDEX, and KEYRPSTL.

Save each graphic using the following conventions:

X:\EMS2\VEHICLE NAME\GRAPHICS \DOCUMENT\FILENAME



DOCUMENT is the name of the template or category (e.g., REAR, WARNINGS)


April 15, 2001

79

FILENAME is the name of the graphic.

3.9.1 Converting Authored Documents

To display a document in the viewer, the file must first be saved in SGML format. The process of saving

the document file in SGML format results in the creation of the .sgm and .fbk files. (A description of these

files and their functions is provided in Section 1.1.1 Word Document Files.)

Perform the following steps to convert a document:

• Open the document in Microsoft Word.

• Click the "Save As SGML" button on the SGML toolbar.

The document is converted, leaving the .fbk and .sgm files open.

3.9.2 Successful Conversion

If there were no style-related errors in the document, a confirmation message displays, as shown in Figure

103. Click OK and close the .fbk and .sgm files.

Figure 103 Conversion Confirmation Message

3.9.3 Unsuccessful Conversion

Style-related errors found during the conversion are displayed in the .fbk file, as shown in Figure 104.


April 15, 2001

80

Figure 104 Conversion Error Displayed in .fbk File

In the example, the first error, labeled [SGML 1] pertains to the insertion of text in a style that is not

designed to contain text.

Perform the following steps to correct errors displayed in the .fbk file.

• Open the .doc file in Microsoft Word and locate the errors identified in the .fbk file.

• Make corrections and reconvert the document until all errors are resolved.

• Close the .fbk and .sgm files.

3.10 Reformatting Authored Documents

NOTE: When a document file has been converted successfully, it is ready to be reformatted. EMS-2

reformats individual documents, a group of documents, or an entire IETM.

3.10.1 Reformatting individual or a group of documents

• Start the SGML reformatter application. This program is located in the following directory:

X:\EMS2\BIN\SGMLRF32.EXE


• Verify that the document to be reformatted is closed.

• Select Reformat from the File menu and select the .sgm file, as shown in Figure 105.


April 15, 2001

81

Figure 105 EMS-2 Reformatter File Selection Window

• Click Open to begin the reformatting procedure. A confirmation window displays when the

reformatting is competed, as shown in Figure 106.


April 15, 2001

82

Figure 106 Reformatter Confirmation Window

• Select Close from the File menu.

If a different message appears, an error was encountered during the reformatting, and it may have deleted

any previously reformatted .sgm file in the SGML folder.

If the message says, "REFORMAT FAILED (see error file)," use the Windows Explorer to locate the error

file in the same folder as the original document. It will appear as "[DOCUMENT NAME].err." Any

dashes (-) in the document name appear as underscores ( _ ). Double click the error file. If the "Open

With" dialog box appears, choose either the "Notepad" or "Wordpad" program to read the file. Use any

clues in this file to identify the source of the problem.

• Open the .doc file and look carefully for an entry or style error. After repairing the problem,

save the .doc file, then do a conversion of the file, and repeat the reformatting procedure. If

no error occurs, a new .sgm file will be placed in the SGML folder.

3.10.2 Reformatting An Entire IETM

NOTE: Usually done by the system administrator.

• Start the SGML reformatter application. This program is located in the following directory:

X:\EMS2\BIN\SGMLRF32.EXE


• Verify that an Iview session of the IETM is not running.


April 15, 2001

83

• Select Reformat IETM from the File menu. A list of all IETMs is displayed as shown in

Figure 107. Selects the IETM you want to reformat.

Figure 107 EMS-2 Reformatter File Selection Window

• Click OK to begin the reformatting procedure. A confirmation window displays when the

reformatting is competed, as shown in Figure 108.


April 15, 2001

84

Figure 108 Reformatter Confirmation Window

• Select Close from the File menu.

If a different message appears, an error was encountered during the reformatting, and it may have deleted

any previously reformatted .sgm file in the SGML folder.

If the message says, "REFORMAT FAILED (see error file)," use the Windows Explorer to locate the error

file in the same folder as the original document. It will appear as "[DOCUMENT NAME].err." Any

dashes (-) in the document name appear as underscores ( _ ). Double click the error file. If the "Open

With" dialog box appears, choose either the "Notepad" or "Wordpad" program to read the file. Use any

clues in this file to identify the source of the problem.

• Open the .doc file and look carefully for an entry or style error. After repairing the problem,

save the .doc file, then do a conversion of the file, and repeat the reformatting procedure. If

no error occurs, a new .sgm file will be placed in the SGML folder.


April 15, 2001

85

Appendix A: GLOSSARY

ASCII American Standard Code for Information Interchange. Standard set of

numeric code that stands for characters and symbols used in communication

among computers.

Attribute Information descriptive of a specific element occurrence that is not regarded

as part of its content, e.g., an element’s ID attribute.

AVI Audio Video Interleave. The file format for Microsoft's Video for Windows

standard.

BMP Bitmap: File format for graphic images.

CALS Continuous Acquisition and Life-cycle Support: DoD initiative to promote

electronic document interchange.

CCITT4 Button used to apply CCITT4 style to selected text. CCITT stands for

Consultative Committee on International Telegraphy and Telephony, which

is the primary international body for fostering cooperative standards for

telecommunications equipment and systems.

CGM Computer Graphics Metafile. File format designed by several standards

organizations and formally ratified by ANSI designed to be the standard

vector graphics file format supported by a wide variety of software and

hardware products.

Compiler Software program that looks at the entire piece of source code and collects

and reorganizes the instructions. An SGML compiler processes a document

to display or print according to its predefined format. Compilers require

some time before an executable program is available.

DMM Digital Multimeter is a connected device that measures voltage, current and

resistance.

DODACTEST Troubleshooting paragraph style used to perform connect and read functions

that run ICE tests.

DODACOFFSET Troubleshooting paragraph style used to calibrate the selected ICE test.


April 15, 2001

86

CTS-ICE Contact Test Set - Internal Combustion Engine.

DTD Document Type Definitions. Specification expressed as a set of declarative

statements that accompanies a document providing the exact definitions of

the document’s mark up language.

DSSSL Document Style Semantics and Specification Language. An ISO standard

addressing the semantics of high-quality composition in a manner

independent of particular formatting systems or processes. DSSSL is

intended as a complementary standard to SGML for the specification of

semantics.

Electronic Test Set Electronic equipment that will support diagnostic tests necessary for IETM

deployment. (i.e. CTS (Contac Test Set), SPORT, etc.

ELEM Element: A text object identified descriptively or generically in SGML and

viewed as a structural component.

EMS-2 Electronic Maintenance System, Version 2: Second version of the TACOM

Interactive Electronic Technical Manual authoring and presentation system.

FBK Feedback. File extension of a second copy of a document saved as SGML.

The newly created file has the same name as the procedure created in

Microsoft Word, but it ends in .FBK (feedback). Feedback files reside in

the same directory as the .DOC file, and contain error reports and warnings.

Every time the document is saved as SGML, a new .FBK file is generated.

FLC/FLI Animation file formats supported by EMS-2.

Foldout Button used to create a foldout figure or table.

FOSI Formatting Output Specification Instances: A former SGML DTD standard

for document management in the US military, replaced by the ISO standard

DSSSL.

Hotspot Location on a graphic that is linked to another portion of the IETM, such as

the RPSTL.

HyApp Hyper Application. Button used to create a link to external an application,

such as tutorials, point to point, etc.


April 15, 2001

87

Hyperlink An element in an electronic document that links to another place in the same

document or to an entirely different document.

HyperTargets Valid SGML elements with defined ID attributes.

HyProc Hyperprocedure. Button used to create a link to procedure of the IETM,

such as a maintenance or troubleshooting procedure.

HyText Hypertext. Button used to create a hyperlink to another part of the IETM.

Hypertext links can be made to words, graphics, or sections.

HyTime Hypermedia/Time-based Structuring Language. An application of SGML

that defines a standard set of element types and syntax for hyperlink

representation in a document.

IDREF ID Reference. A reference to an SGML ELEMENT identifier attribute. The

attribute value must contain a pointer to some other element.

IETM Interactive Electronic Technical Manual: A package of information required

for the diagnosis and maintenance of a weapons system, optimally arranged

and formatted for interactive screen presentation to the end-user.

Interpreter A program that analyzes and executes each line of source code in

succession, without looking at the entire program. Interpreters can execute a

program immediately.

ISAM Indexed Sequential Access Method: A method for managing how a

computer accesses records and files stored on a hard disk.

ISO 8879:1986 ISO 8899: Information processing—Text and office systems—Standard

Generalized Markup Language (SGML): A standard approved by the

International Organization for Standardization for the definition of device-

independent, system-independent methods of representing texts in electronic

form.

IW Intermediate Word. File extension of individual subdocuments generated in

SGML format.

IW Text Troubleshooting text describing the transition between troubleshooting and

maintenance procedures.


April 15, 2001

88

J1708 Vehicle data bus used to collect diagnostic data.

JPEG Joint Photographic Experts Group. File format for digital images.

Key List Document A document containing a group of menus of linked document sections.

KeyWd Button used to assign a unique ID to a selected key word

Macro A symbol, name, or key that represents a list of commands, actions, or

keystrokes. Many programs allow you to create macros so that you can enter

a single character or word to perform a whole series of actions.

Map Files 1) A file showing the structure of a program after it has been compiled. The

map file lists every variable in the program along with its memory address.

2) Plain-text sets of lines which define the various hotspots on an image and

designate what files should be returned when the hot spots are clicked.

MdB Maintenance & Prognostic Database

MIL-M-28001 CALS document standard specifying DTDs for technical manuals in the

format required for submission to the DOD.

MIL-STD-1553 Specification for digital multiplex data bus and associated equipment

developed for standalone weapon systems or as part of larger weapons

platform.

MTask Maintenance task.

OCR Optical Character Recognition: Recognition of printed or written characters

by a computer.

OS Output Specification: Appendix B of MIL-M-28001. The OS is a DTD

developed in accordance with MIL-PRF-28001 to describe the output style

and format of documents (instances).

PMCS Preventive Maintenance Checks and Services


April 15, 2001

89

RefMat Reference Material. Documentation referenced from IETM, e.g. "TM 9-

2320-280-20-2."

RPSTL Repair Parts and Special Tools List

SAE J1708 Specification for serial communications between microcomputer systems in

heavy duty vehicle applications.

SafSum Safety Summary

SDOC A Standard Generalized Markup Language (SGML) term for a Sub-

document. A SGML sub-document is a complete, stand-alone SGML

document instance and must include a Document Type Definition (DTD).

Subdocs taken as a stand alone document, must conform to the syntax of

ISO 8879 and to the subdocument’s included DTD. When a subdoc is

parsed, any context in which it is included is ignored: i.e. the parser is

completely unaware that anything other than the subdoc exits. When

electronically jumping from one document to another (HyperText and

HyperProc), the destination document is identified by the SDOC and a

location, or element within the document (the ELEM).

SGML Standard Generalized Markup Language: Set of codes for indicating type,

purpose, or structure of text in documents.

SGML parser A software program that correctly processes an error-free (i.e. conforming)

SGML document.

Tag A command inserted in a document that specifies how the document, or a

portion of the document, should be formatted.

Template A blank form used in word processing that determines acceptable and

unacceptable document structure and style.

TM ID Technical Manual Identifier

Troubleshooting The process of making measurements and observing the operation of the

vehicle to find out if and where any problems exist.

UOC Use-On-Code. Code used to identify vehicles or equipment to which an

IETM component applies.


April 15, 2001

90

Validating SGML parser An SGML parser that determines whether or not a document conforms to

the standard and, if not, what errors exist and where.

Viewer A utility program that enables one to read an electronic document in much

the same way that one reads a paper document.

WAV The format for storing sound in files. WAV sound files end with a .wav

extension and can be played by nearly all Windows applications that support

sound.