nato joint computer-aided acquisition and logistic support (jcals) system 01

8/3/2019 Nato Joint Computer-Aided Acquisition and Logistic Support (Jcals) System 01

1/38

U.S. Army Communications-ElectronicsCommand (CECOM) Acquisition Center

Washington Operations OfficeAlexandria, VA

U.S. ArmyProgram Manager, JCALS

Fort Monmouth, NJ

LESSON PLAN

CDRL SEQUENCE NO. N002

Prepared for:

Prepared by:

Computer Sciences CorporationSupply Chain Solutions

Federal Sector - Defense Group304 West State Highway 38

Moorestown, NJ 08057

44033604.3E

JOINT COMPUTER-AIDED ACQUISITIONAND LOGISTIC SUPPORT (JCALS) SYSTEM

FOR THE

Produced Under Contract Number:DAHC94-89-C-0008

Distribution authorized to Department of Defense (DoD) and DoD Contractors only. Reason: To protect technical or operational data or Information.Other requests for this document shall be referred to Project Manager, Joint Computer-aided Acquisition and Logistic Support (JCALS) System,ATTN: SFAE-PS-CAL-L, Fort Monmouth, New Jersey 07703-5626.

Destruction Notice: Destroy by any method that will prevent disclosure of contents or reconstruction of document.

27 August 1999

TM - 01 SGML Basic Concepts, Tagging, and Editing

TM FUNCTIONAL USER COURSE - VOLUME 1

TM01001 - Introduction to SGMLTM01002 - How to Create and Modify a Simple SGML Document


2/38


3/38

U.S. Army Communications-ElectronicsCommand (CECOM) Acquisition Center

Washington Operations OfficeAlexandria, VA

U.S. ArmyProgram Manager, JCALS

Fort Monmouth, NJ

LESSON PLAN

CDRL SEQUENCE NO. N002

Prepared for:

Prepared by:

Computer Sciences CorporationSupply Chain Solutions

Federal Sector - Defense Group304 West State Highway 38

Moorestown, NJ 08057

44033604.3E

JOINT COMPUTER-AIDED ACQUISITIONAND LOGISTIC SUPPORT (JCALS) SYSTEM

FOR THE

Produced Under Contract Number:DAHC94-89-C-0008

Distribution authorized to Department of Defense (DoD) and DoD Contractors only. Reason: To protect technical or operational data or Information.Other requests for this document shall be referred to Project Manager, Joint Computer-aided Acquisition and Logistic Support (JCALS) System,ATTN: SFAE-PS-CAL-L, Fort Monmouth, New Jersey 07703-5626.

Destruction Notice: Destroy by any method that will prevent disclosure of contents or reconstruction of document.

27 August 1999

TM - 01 SGML Basic Concepts, Tagging, and Editing

TM FUNCTIONAL USER COURSE - VOLUME 1

TM01001 - Introduction to SGMLTM01002 - How to Create and Modify a Simple SGML Document


4/38


5/38

44033604.3E

27 August 1999

iii

RECORD OF CHANGES

Change No. Date Title of Brief Description Entered by


6/38

44033604.3E

27 August 1999

iv

PREFACE

This document has been updated to incorporate Software Package (SWP) 2 Maintenance Drop (MD) 2

functionality.


7/38

44033604.3E

27 August 1999

v

DEFINITIONS

The following definitions and terms are used in this document.

Attribute Tag markup that further defines elements.

DTD Document Type Definition (DTD). A file that defines the components of a

document and the rules for using the markup; including placement, usage,

content, and structure.

Element Structural component of a DTD.

Entity A character, text, data, graphical, or file selection of information in a document

that is clearly defined as a character, text paragraph or list, graphical table or

figure, or a labeled file.

FOSI Formatting Output Specification Instance (FOSI). A file that assigns values tothe style characteristics for a DTD, defining the format and style of the printed

document.

ID Identification "string". The ID is usually a unique string of characters (made up

of letters and numbers) that accompanies some piece of data through the system

and serves as a data identifier. The ID can be located, extracted, sorted, and

otherwise processed to suit system data identification requirements such as

association with a postcomposition page number for placement in a Table of

Contents, cross-references, list of changed pages, etc.

Markup The components that make up a document. Starting at the highest, or document

level, components of a document represent subdivisions of content down to the

smallest distinguishable and reusable unit.

Meta Key The key on standard keyboards.

PC Client PC Client software that enables Joint Computer-aided Logistic Support (JCALS)

functions, including the ArborTextADEPT* EditorStandard Generalized

Markup Language (SGML) software, to be accessed by a Personal Computer

(PC).

SGML Standard Generalized Markup Language. An internationally accepted standard

created for the needs of industries that manage extremely large amounts ofinformation in the form of text.

SGML Editor The ArborTextADEPT* Editorused to process SGML documents in the Joint

Computer-aided Acquisition and Logistic Support (JCALS) System.

SWP Software Package. A version of the JCALS infrastructure software which

provides a defined set of functions.


8/38

44033604.3E

27 August 1999

vi

TM Acronym for Technical Manual, which is also referred to as a Technical Order

(TO) by the Air Force.

Validate The process of parsing a document to assure completeness. Mechanical

validation uses the "parser" program that checks accuracy according to SGMLrules. Objective validation can also be performed by an analyst who verifies

application of the rules for thoroughness, context, and construct-content models.

Workfolder An electronic accordion file folder that houses folders and composites.


9/38

44033604.3E

27 August 1999

vii

TABLE OF CONTENTS

RECORD OF CHANGES ................................................................................................... iii

PREFACE ............................................................................................................................ iv

DEFINITIONS..................................................................................................................... vTABLE OF CONTENTS .................................................................................................... vii

LESSON 1 - INTRODUCTION TO SGML ....................................................................... 1

1.1 ADMINISTRATION INFORMATION........................................................ 1

1.1.1 Course Data.................................................................................................. 1

1.1.2 Time Breakdown (in Hours).......................................................................... 1

1.1.3 References .................................................................................................... 1

1.1.4 Learning Objective(s).................................................................................... 1

1.1.5 Equipment Required for Instruction............................................................... 2

1.1.6 Instructional Aids.......................................................................................... 2

1.1.7 Testing Requirements.................................................................................... 2

1.1.8 List of Supporting Papers.............................................................................. 2

1.1.9 Supporting Papers......................................................................................... 2

1.1.10 Trainee Instructional Materials...................................................................... 2

1.1.11 Multiple Instructor Requirements .................................................................. 2

1.1.12 Instructional Guidance .................................................................................. 3

1.1.13 Classroom Requirements............................................................................... 3

1.1.14 Safety Precautions Related to the Course....................................................... 3

1.2 INTRODUCTION........................................................................................ 3

1.2.1 Overview ...................................................................................................... 3

1.2.2 Motivation .................................................................................................... 3

1.2.3 Gain Attention............................................................................................... 3

1.2.4 Safety Precautions Related to the Lesson....................................................... 41.2.5 Review of Related Lesson Topic.................................................................... 4

1.3 BODY.......................................................................................................... 4

1.3.1 Presentation .................................................................................................. 4

1.3.2 Outline of Instruction .................................................................................... 4

1.3.3 Learning Activities........................................................................................ 6

1.3.4 Application ................................................................................................... 6

1.3.5 Evaluation..................................................................................................... 6

1.3.6 Intermediate Summaries ................................................................................ 6

1.3.7 Statement of Enabling Learning Objective(s) ................................................. 7

1.3.8 Helps............................................................................................................ 8

1.3.9 Questions...................................................................................................... 8

1.3.10 Answers to Questions.................................................................................... 9

1.3.11 Practical Exercise(s)...................................................................................... 9

1.4 CONCLUSION ............................................................................................ 9

1.4.1 Review/Summary.......................................................................................... 9

1.4.2 Assignments.................................................................................................. 10

1.4.3 Transition Information .................................................................................. 10

1.4.4 Test/Evaluation of Objective(s) ..................................................................... 10

1.4.5 Critique of Course......................................................................................... 10


10/38

44033604.3E

27 August 1999

viii

TABLE OF CONTENTS (Continued)

LESSON 2 - HOW TO CREATE AND MODIFY A SIMPLE SGML DOCUMENT..... 11

2.1 ADMINISTRATION INFORMATION ....................................................... 112.1.1 Course Data................................................................................................. 11

2.1.2 Time Breakdown (in Hours) ......................................................................... 11

2.1.3 References.................................................................................................... 11

2.1.4 Learning Objective(s) ................................................................................... 11

2.1.5 Equipment Required for Instruction .............................................................. 12

2.1.6 Instructional Aids ......................................................................................... 12

2.1.7 Testing Requirements ................................................................................... 12

2.1.8 List of Supporting Papers............................................................................. 12

2.1.9 Supporting Papers........................................................................................ 12

2.1.10 Trainee Instructional Materials ..................................................................... 13

2.1.11 Multiple Instructor Requirements.................................................................. 13

2.1.12 Instructional Guidance.................................................................................. 132.1.13 Classroom Requirements .............................................................................. 13

2.1.14 Safety Precautions Related to the Course...................................................... 13

2.2 INTRODUCTION ....................................................................................... 13

2.2.1 Overview...................................................................................................... 13

2.2.2 Motivation ................................................................................................... 14

2.2.3 Gain Attention.............................................................................................. 14

2.2.4 Safety Precautions Related to the Lesson ...................................................... 14

2.2.5 Review of Related Lesson Topic................................................................... 14

2.3 BODY ......................................................................................................... 14

2.3.1 Presentation.................................................................................................. 14

2.3.2 Outline of Instruction.................................................................................... 142.3.3 Learning Activities ....................................................................................... 16

2.3.4 Application .................................................................................................. 16

2.3.5 Evaluation.................................................................................................... 16

2.3.6 Intermediate Summaries ............................................................................... 16

2.3.7 Statement of Enabling Learning Objective(s)................................................. 17

2.3.8 Helps ........................................................................................................... 19

2.3.9 Questions ..................................................................................................... 19

2.3.10 Answers to Questions ................................................................................... 19

2.3.11 Practical Exercise(s)..................................................................................... 20

2.4 CONCLUSION............................................................................................ 20

2.4.1 Review/Summary......................................................................................... 21

2.4.2 Assignments................................................................................................. 212.4.3 Transition Information.................................................................................. 21

2.4.4 Test/Evaluation of Objective(s)..................................................................... 21

2.4.4.1 Evaluation Preparation ................................................................................. 21

2.4.4.2 Answers and Evaluation of Examination....................................................... 22

2.4.4.3 Examination/Evaluation................................................................................ 23

2.4.5 Critique of Course........................................................................................ 28


11/38

44033604.3E

27 August 1999

1

LESSON 1 - INTRODUCTION TO SGML

1.1 ADMINISTRATION

Provide administrative information addressing class hours, break times, messages, telephone, restrooms, and office refreshments, etc.

1.1.1 Course Data

Course Title: TM Functional User Course

Module: SGML Basic Concepts, Tagging, and Editing (TM-01)

Lesson Plan Number: TM01001

Date of Preparation: 27 August 1999

Topic: Introduction to SGML

1.1.2 Time Breakdown (in Hours)

Administrative: 0.00

Conference: 0.5

Practical/Hands-on Application: 0.5

Performance Evaluation: 0.0

Total: 1.0

1.1.3 References

1. JCALS Publishing Manual

2. ArborTextADEPTSeries: User Guide

3. On-line Electronic Book Technology (EBT) End User Manual (EUM)

1.1.4 Learning Objective(s)

Listed below are the Terminal Learning Objectives (TLOs) that pertain to this lesson. Each of these

objectives will be performed under the same conditions: Given the standard Joint Computer-aided

Acquisition and Logistic Support (JCALS) workstation, the Standard Generalized Markup Language

(SGML) Basic Concepts, Tagging, and Editing Trainee Guide, the JCALS Publishing Manual, and no

supervision.

TM01001-01

Task: Identify SGML concepts.

Standard: 1. Identify the advantages of using SGML.

2. Identify the definitions of a document type definition (DTD), a

formatting output specification instance (FOSI), elements, tags,

attributes, and entities.


12/38

44033604.3E

27 August 1999

2

TM01001-02

Task: Create a new SGML document template.

Standard: 1. Create a workfolder.

2. Create an SGML template.

TM01001-03

Task: Identify the components of the SGML Edit window.

Standard: Identify and define the following: tags and tag sets, menu options, and

command line.

1.1.5 Equipment Required for Instruction

Standard JCALS System suite of equipment

1.1.6 Instructional Aids

1. Whiteboard with colored marker and eraser

2. Easel with butcher paper and colored markers

3. Overhead projector

4. Instructional media transparencies as indicated in the Outline of Instruction

5. Computer projection system (optional)

1.1.7 Testing Requirements

The material in this lesson will be evaluated at the conclusion of the module.

1.1.8 List of Supporting Papers

None

1.1.9 Supporting Papers

None

1.1.10 Trainee Instructional Materials

Refer to Section 1, Introduction; Section 2, An Introduction to DTDs and FOSIs; and Section 3,

Creating New Documents, Change Documents, and Revisions in the JCALS Publishing Manual.

1.1.11 Multiple Instructor Requirements

One Principal Instructor for each class and one Assistant Instructor for every 10 students


13/38

44033604.3E

27 August 1999

3

1.1.12 Instructional Guidance

The instructor is to verify that the trainees have successfully completed the JCALS System General

User Course.

1.1.13 Classroom Requirements

Normal classroom facilities with a standard JCALS System suite of equipment

1.1.14 Safety Precautions Related to the Course

1. All electrical equipment should be properly plugged into a grounded surge protector.

2. No equipment should be unplugged or turned off by a student or user unless he or she is

instructed by an authorized individual.

3. Liquids should not be placed near a keyboard or mouse.

1.2 INTRODUCTION

This lesson provides the Technical Manual (TM) Functional User with a working knowledge of the

basic concepts and structure of the SGML document authoring tool and identifies the materials being

presented.

1.2.1 Overview

Documents have a lifecycle which is supported by SGML tools. SGML is an international standard

language that allows for the creation of rules which identify the structure of the document rather than

its format or appearance. Structure is determined by a DTD and is defined as tags used to identify the

elements of each document type. A FOSI assigns values to the style characteristics for a particular

DTD. For information concerning the background of the Quest Publishing Application, refer to theJCALS Publishing Manual.

1.2.2 Motivation

The TM Functional User will understand the use of DTDs, FOSIs, and the SGML Editor in the

JCALS System.

1.2.3 Gain Attention

Write the instructors' names on the whiteboard. As class begins, introduce yourselves as the

Instructors (if this has not occurred). If the students have not had the opportunity to introduce

themselves, the instructors should have them do so, and state what they do and how long they have

been in the job. This activity will provide an opportunity for both the instructors and the students to

meet one another and to begin to know something about each other, thus providing a foundation for

further interaction.

Explain how SGML supports the TM Functional User in creating and editing technical documentation,

specifically TMs.


14/38

44033604.3E

27 August 1999

4

1.2.4 Safety Precautions Related to the Lesson



instructed by an authorized individual.3. Liquids should not be placed near a keyboard or mouse.

1.2.5 Review of Related Lesson Topic

None

1.3 BODY

The order of the lesson material is outlined with appropriate teaching points, questions, answers, helps,

and practical exercises which are used to reinforce the material being taught as part of the

lesson.

1.3.1 Presentation

The instructor is to use a combination of a conference, practical/hands-on application, and practical

exercises to present the lesson.

1.3.2 Outline of Instruction

1. Prior to class, write instructors names, course, module, date and time information on the

whiteboard and check PCs for appropriate login information. Display Administrative

Information transparency. Welcome the students and provide administrative information.

2. Display the TM-01 SGML Basic Concepts, Tagging, and Editing transparency. Introduce the

lesson and what is to be covered. Provide a Trainee Guide to each student. Point out the Job Steps and the Lesson Outline

in the Trainee Guide so notes may be taken.

Provide a JCALS Publishing Manual for student reference. Point out that furtherinformation is contained in the JCALS Publishing Manual.

Ask questions during the instruction, listed in 1.3.9, Questions.3. Display the Purpose transparency. Discuss the purpose of the SGML Basic Concepts,

Tagging, and Editing module.

4. Display the Module Overview transparency. Discuss the content of the module.

5. Display the Lesson 1, Introduction to SGML transparency.

6. Display the Lesson 1, Learning Objectives transparencies. Review the TLOs.

7. Describe the advantages of SGML. Explain that with SGML hardware and software dependency is eliminated. Explain that with SGML all documents have a similar structure. Explain that with SGML documents are easy to read. Explain that with SGML automatic numbering of chapters, sections, and paragraphs is

allowed.

Explain that with SGML the data base application can access the data in documents. Explain that with SGML documents can be reviewed on-line.


15/38

44033604.3E

27 August 1999

5

Explain that with SGML information can be transferred to other locations and displayterminal.

Explain that with SGML documents are modular, interchangeable, and flexible. Explain that with SGML additional advantages of SGML are identified in the JCALS

Publishing Manual.8. Display the SGML Definitions transparencies. Describe the relationship of SGML structure.

Explain that DTD:- Specifies what elements are allowed

- Identifies if the elements are optional or required

- Specifies the rules of the document through elements, attributes, and entities.

Explain that FOSI:- Assigns values to the style characteristic for a DTD

- Defines the format and style of the document.

Explain that Elements:- Are the major structural components of a DTD

- Are defined by the DTD and FOSI.

Explain that tags identify each element. Explain that Attributes:

- Are markups of an element tag that further define aspects of the element

- Elements can have many attributes or no attributes.

Explain that Entities:- Characters, text, data, or graphics which make up the content of a document

- Are placed between tags.

Explain that additional definitions of SGML structure and relationships are identified inthe JCALS Publishing Manual.

9. Provide an Intermediate Summary. Describe the advantages of using SGML. Describe the

relationship between a DTD, a FOSI, elements, tags, attributes, and entities.

10. Instruct students to create a new SGML document template. Instruct students to open PC Client. From the JCALS Session Manager, click on the

JCALS Desktop icon; the [Main:dt] window opens. Double-click on the Filing Service;

the Filing Service window opens.

Instruct students to create a workfolder. From the Filing Service, click on File; a drop-down menu displays. Click on New > Workfolder; a New Workfolder window appears.

Name the new workfolder Your first name_SGML_TEST.

Instruct students to create an SGML template. Highlight the new workfolder. Click onFile > Open; the Workfolder window appears. Click on File > New > Object; a Create

New Object window opens. Highlight New SGML Document. Click on OK; a New

SGML Document window appears. Enter the appropriate information for documents

Description (for Workfolder), and for Class, Family, Group, and Version as follows:- Class: JCALS Standards

- Family: Quest 1

- Group: Legacy

- Version: 4

11. Highlight the appropriate Template Available for Selected DTD. Click on the OK button;

the Workfolder window populates with the new SGML template data. Click on File > Save to

save the new SGML template. Click on File > Exit to close the SGML Editor. Highlight the


16/38

44033604.3E

27 August 1999

6

new SGML template. Click on File > Open > To Edit; theADEPT* Editor[new

doc:revision] window opens with the new SGML template.

Note: Do not use spaces, commas, dashes, etc. in documents Description (for Workfolder) field. Use

underscore character as a separator (e.g., File_Name_Doc). The name of the document is howit will appear in the Workfolder, and is not the title of the document.

12. Explain tags and tag pairs -- beginning, end, and empty.

13. Instruct students to open the Edit window. Discuss the Edit window components.

Title Bar - Displays software product and name of the document in Edit window. Scroll Bar - Allows for movement up and down through the document. Status Bar - Displays processing and format status. Menu Bar - Contains File, Edit, View, Options, Tools, Misc, and Help. Instruct the

students to access the menu bar.

Note: Detailed instruction on selected menu items is provided in subsequent lessons.

14. Explain what information displays on the command line.15. Display Lesson 1 Review/Summary transparencies. Summarize the lesson.

1.3.3 Learning Activities

Throughout the course, the students are required to complete a variety of practical hands-on exercises

that relate to the lessons objective.

1.3.4 Application

SGML structure needs to be understood in order to use the SGML document Editor to create and edit

TMs for publication.

1.3.5 Evaluation

The students will be evaluated on their ability to perform the following:

1. Describe the advantages of using SGML.

2. Describe the relationship of SGML structure.

3. Describe the window components.

4. Create a new SGML document template using the SGML document Editor.

1.3.6 Intermediate Summaries

There should be one intermediate summary in this lesson. Following learning objective, describeSGML concepts:

1. Describe the advantages of using SGML.

2. Describe the relationship between a DTD, a FOSI, elements, tags, attributes, and

entities.


17/38

44033604.3E

27 August 1999

7

1.3.7 Statement of Enabling Learning Objective(s)

Listed below are the Enabling Learning Objectives (ELOs) that pertain to this lesson. Each of these

objectives should be performed under the same conditions: Given the standard JCALS workstation, the

SGML Basic Concepts, Tagging, and Editing Trainee Guide, the JCALS Publishing Manual, and nosupervision.

TM01001-01 is supported by the following ELOs:

Task: List the advantages of SGML for users of the JCALS System.

Standard: Identify the following advantages of SGML:

1. Hardware and software dependency is eliminated.

2. All documents have a similar structure.

3. Documents are easy to read.

4. Automatic numbering of chapters, sections, and paragraphs.

5. The data base application can access the data in documents.

6. Documents can be reviewed on-line.7. Information can be transferred to other locations and display

terminals.

8. Documents are modular, interchangeable, and flexible.

Task: List basic SGML structure terms.

Standard: Identify the definitions of the following:

1. DTD

2. FOSI

3. Elements

4. Tags

5. Entities

6. Attributes


Task: Create a workfolder.

Standard: Perform the following:

1. From the Server Desktop double-click on Filing Service; the

Filing Service window opens.

2. Click on File; a drop-down menu displays.

3. Click on New > Workfolder; a New Workfolder window

appears.

4. Name the new workfolder.

Task: Create an SGML template.


1. Highlight the new workfolder. Click on File > Open; the

Workfolder window appears.

2. Click on File > New > Object; a Create New Object window

opens. Highlight New SGML Document and click on the OK

button; a New SGML Document window appears.


18/38

44033604.3E

27 August 1999

8

3. Enter the appropriate information for documents Description

(for Workfolder), and select applicable Class, Family, Group,

and Version. Highlight the appropriate Template Available for

Selected DTD and click on the OK button; the Workfolder

window populates with the new SGML template data. Click onFile > Save to save the new SGML template. Click on File >

Exit to close the SGML Editor.

4. Highlight the new SGML template. Click on File > Open, To

Edit; theADEPT* Editor[new doc:revision] window opens with

the new SGML template.


Task: Identify tags and tag pairs.

Standard: Identify the following:

1. Beginning tags

2. End Tags3. Empty tag pairs

Task: Identify Menu options.

Standard: Identify the following Edit window components:

1. Title Bar - Displays software product and name of the document

in Edit window.

2. Scroll Bar - Allows for movement up and down through the

document.

3. Status Bar - Displays processing and format status.

4. Menu Bar - Contains File, Edit, View, Options, Tools, Misc, and

Help. Access the Menu bar and view the Edit window

components.

Task: Identify the Command line function.

Standard: Identify the information found in the Command line.

1.3.8 Helps

None

1.3.9 Questions

This section contains suggested questions that may be asked, as time permits, during instruction and/orthe Review/Summary of the lesson. The questions may also be presented during the Practical

Exercises.

1. What do the terms SGML, FOSI, and DTD mean?

2. What are the components of the SGML document Editor window?


19/38

44033604.3E

27 August 1999

9

1.3.10 Answers to Questions

1. SGML means Standard Generalized Markup Language. FOSI means Formatting Output

Specification Instance. DTD means Document Type Definition.

2. The Edit window, Scroll Bar, Status Bar, and the Menu bar.

1.3.11 Practical Exercise(s)

Practical Exercises provided in JCALS classes or JCALS training materials (i.e., Lesson Plans

and Trainee Guides) are designed for use in a training environment only. These exercises

SHOULD NOT be used on a production JCALS System. Running certain exercises on a

production JCALS System could serve to delete data, obligate funds, or halt the system.

This section contains practical exercises that may be used for student practice during and after

presentation of the lesson. Depending on the complexity of the lesson, practical exercises may contain

questions to reinforce teaching points in the lesson and/or exercises designed to require analysis and

decision-making by the student in situations similar to those which may occur in the operationalenvironment.

Exercise 1

1. Open an existing SGML document in the workfolder.

2. Scroll through a document in the Edit window.

Exercise 2

Create a new SGML document template using the following information:

Class: JCALS StandardsFamily: Quest 1

Group: Legacy

Version: 4

1.4 CONCLUSION

The TM Functional User should review the TLOs and ELOs which support this lesson.

1.4.1 Review/Summary

In this lesson, the TM Functional User has been introduced to SGML basic concepts, tagging, and

editing. The TM Functional user is able to:

1. Describe the advantages of SGML.

2. Describe the relationships of SGML structure.

3. Create a new SGML document template using the SGML document Editor.

4. Describe the window components of the SGML document Editor.


20/38

44033604.3E

27 August 1999

10

1.4.2 Assignments

None

1.4.3 Transition Information

None

1.4.4 Test/Evaluation of Objective(s)

The examination of the objectives of this lesson will be conducted at the conclusion of the module.

1.4.5 Critique of Course

A critique of this course will be obtained at the conclusion of the TM Functional User course using the

Incident Reporting and Tracking System (IRTS).


21/38

44033604.3E

27 August 1999

11

LESSON 2 - HOW TO CREATE AND MODIFY A SIMPLE SGML DOCUMENT

2.1 ADMINISTRATION

None

2.1.1 Course Data

Course Title: TM Functional User Course

Module: SGML Basic Concepts, Tagging, and Editing (TM-01)

Lesson Plan Number: TM01002

Date of Preparation: 27 August 1999

Topic: How to Create and Modify a Simple SGML Document

2.1.2 Time Breakdown (in Hours)

Administrative: 0.0

Practical/Hands-on Application: 2.0

Written Examination: 0.25

Performance Evaluation: 0.75

Total: 3.0

2.1.3 References

1. JCALS Publishing Manual

2. ArborTextADEPT* EditorSeries: User Guide

3. EUM

2.1.4 Learning Objectives

Listed below are the TLOs that pertain to this lesson. Each of these objectives will be performed under

the same conditions: Given the standard JCALS workstation, the SGML Basic Concepts, Tagging,

and Editing Trainee Guide, the JCALS Publishing Manual, and no supervision.

TM01002-01

Task: Create a valid simple SGML document.


1. Open the SGML Edit window.

2. Open the SGML template created in Lesson 1.

TM01002-02

Task: Modify basic content displays in the Edit window.

Standard: Perform the following Magnification options in the View menu:

1. Tag Display

2. Tag Size

3. Font Size


22/38

44033604.3E

27 August 1999

12

TM01002-03

Task: Edit a document using basic SGML editing tools.

Standard: Use basic SGML editing tools to edit the document by performing the

following:1. Construct a file for a simple SGML document.

2. Enter text.

3. Save changes.

4. Insert and delete basic markup tags and text.

5. Cut or copy and paste text and tags.

6. Find markup information in the document

7. Undo mistakes.

8. Check the completeness of a document using the SGML Editor.

9. Print an Editor View of the document.

TM01002-04

Task: Check editorial accuracy using basic SGML editing tools.


1. Check spelling.

2. Check punctuation.

3. Look up words in the dictionary.

2.1.5 Equipment Required for Instruction

Standard JCALS System suite of equipment

2.1.6 Instructional Aids

1. Whiteboard with colored marker and eraser

2. Easel with butcher paper and colored markers

3. Overhead projector

4. Instructional media transparencies as indicated in the Outline of Instruction

5. Computer projection system (optional)

2.1.7 Testing Requirements

The material in this lesson will be evaluated at the conclusion of the module.

2.1.8 List of Supporting Papers

None

2.1.9 Supporting Papers

None


23/38

44033604.3E

27 August 1999

13

2.1.10 Trainee Instructional Materials

Refer to Section 3, Creating New Documents, Change Documents, and Revisions, in the JCALS

Publishing Manual.

2.1.11 Multiple Instructor Requirements

One Principal Instructor for each class and one Assistant Instructor for every 10 students in a class

2.1.12 Instructional Guidance

The instructor needs to verify that the trainees have successfully completed the JCALS System General

User Course.

2.1.13 Classroom Requirements

Other than the normal classroom facilities with a standard JCALS System suite of equipment, there areno special training area or range requirements.

2.1.14 Safety Precautions Related to the Course



instructed to do so by an authorized individual.


2.2 INTRODUCTION

This lesson provides the TM Functional User with the knowledge and skills to construct an SGMLdocument using the SGML authoring tool; and to use basic SGML editing tools to cut or copy and

paste text, search for text strings and markup tags, check spelling and punctuation, and look up words

in a dictionary.

2.2.1 Overview

The SGML Editor is used to create text and edit a tagged simple SGML document using a predefined

DTD. SGML basic editing tools are used to cut or copy text into a paste buffer. Text can be cut or

copied and pasted, text strings and markup tags can be searched for, spelling and punctuation can be

checked, and words can be looked up in a dictionary.

The Edit window display of the document can be customized using options in the View menu. Markup

tags can be displayed fully, partially or not at all. Tag size can be enlarged by 50 percent for easier

viewing. Font size can be increased or decreased in 25-percent increments.

Tags and attributes can be inserted, modified and deleted. Cut or copied text can be pasted anywhere

in a document where it does not violate context rules. The SGML Editor is also used to check the

completeness of a document to ensure it complies with the DTD.


24/38

44033604.3E

27 August 1999

14

2.2.2 Motivation

The SGML Editor allows the users to produce documents with an established structure that meets

Government requirements. The SGML basic editing tools provide the users the ability to easily verify

the editorial accuracy of a document.

The General User will be able to customize the SGML Editor display to their personal viewing

preferences.

2.2.3 Gain Attention

Explain how the SGML document Editor enables the TM Functional User to create an SGML

document and modify SGML content displays, and how the SGML document Editor supports the TM

Functional User in creating and editing technical documentation, specifically TMs.

Explain how the use of SGML basic editing tools enables the TM Functional User to manipulate text,

find markup information, check spelling and punctuation, look up words in the dictionary, checkcompleteness, and print an Editor View of a an SGML document when editing SGML technical

documentation, specifically TMs.

2.2.4 Safety Precautions Related to the Lesson



instructed to do so by an authorized individual.


2.2.5 Review of Related Lesson Topic

None

2.3 BODY

The order of the lesson material is outlined with appropriate teaching points, questions, answers, helps,

and practical exercises that are used to reinforce the material being taught as part of the lesson.

2.3.1 Presentation

The instructor will use a combination of conference, practical/hands-on application, and practical

exercises to present the lesson.

2.3.2 Outline of Instruction

1. Display Lesson 2, How to Create and Modify a Simple SGML Document transparency.

2. Display Lesson 2, Learning Objectives transparencies. Introduce the lesson and what is to be

covered.

3. Discuss the document life cycle consisting of Generate/Create, Edit, Compose, Review,

Change, and Revise.


25/38

44033604.3E

27 August 1999

15

4. Instruct students to open the Filing Service from the JCALS Desktop and double-click on their

Workfolders created during Lesson 1. Instruct students to open their Workfolders and select

their SGML template created in Lesson 1.

5. Display Example SGML Tagged Document Format transparency.

6. Instruct students to modify the tag display of SGML document in the Edit window from FullTags to Partial Tags to No Tags, and restore the View to Full Tags. Point out that this is an

aid in proofreading.

7. Instruct students to modify the tag size of the SGML document from Normal to Large to Very

Large and restore to Normal.

8. Instruct students to modify the font size of the SGML document by increasing font

magnification by 25% from normal and by decreasing by -25% from normal. Point out that

increasing tag size does not affect font magnification; however, font magnification affects tag

size.

9. Conduct an Intermediate Summary. Describe modifying basic content displays using

magnification options for tags, tag size, and font size.

10. Instruct students to perform Exercise 1.

11. Instruct students to create a basic SGML document consisting of front matter and twoparagraphs of text.

12. Instruct students to enter text between tag sets for authnot, pubdate, chapter title, and the first

para.

13. Instruct students to find markup information in a document.

14. Conduct an Intermediate Summary. Describe entering text between tag sets in front matter and

paragraphs and how to find markup information.


16. Instruct students to cut, copy, and paste text and tags.

17. Instruct students to insert and delete markup tags for subsequent paragraph.

Note: Instruct students to intentionally introduce spelling errors in the text of the paragraph, and toplace two periods at the end of one sentence.

18. Conduct an Intermediate Summary. Describe inserting and deleting markup tags.


20. Instruct students to correct mistakes.

Check for spelling mistakes. Note that this will also check for double punctuation. Find and substitute a word. Look up a word in the dictionary. Check for completeness of the document. Print an Editor View of the document.

21. Conduct an Intermediate Summary. Describe checking for spelling and punctuation mistakes,finding and substituting words, looking up a word in the dictionary, checking for completeness,

saving the document, and printing an Editor View of the document.


23. Display Lesson 2, Review/Summary transparencies. Summarize what was covered in the

lesson.

24. Display the Written Examination Instructions transparency. Conduct the Written

Examination.


26/38

44033604.3E

27 August 1999

16

25. Display the Performance Evaluation Instructions transparency. Conduct the Performance

Evaluation.

26. Display Where to Get Additional Information transparency.

2.3.3 Learning Activities

Throughout the course, the students are required to complete a variety of practical hands-on exercises

that relate to the lessons objective.

2.3.4 Application

Use of basic SGML editing tools provides the TM Functional user with the means to rapidly perform

basic text editing in technical documentation.

2.3.5 Evaluation

The students will be evaluated on their ability to perform the following functions:

1. Open the SGML document Editor.

2. Identify basic Edit window components.

3. Identify the terms SGML, DTD, and FOSI.

4. Modify tag displays.

5. Change tag size.

6. Increase and decrease font magnification.

7. Create a simple SGML document.

8. Cut, copy, and paste text.

9. Enter text and save changes.

10. Insert markups.

11. Delete text and markups.12. Undo mistakes.

13. Find/Substitute.

14. Check spelling.

15. Look up a word.

16. Check completeness.

17. Print Editor View of document.

2.3.6 Intermediate Summaries

There should be four intermediate summaries in this lesson.

1. Following learning objective, Modify Basic Content Displays:

Modify tag displays. Change tag size. Increase and decrease font magnification.


27/38

44033604.3E

27 August 1999

17

2. Following learning objective, Undo Mistakes:

Create a simple SGML document. Enter text and save changes. Insert markup.

3. Following learning objective, Edit a Document Using Basic SGML Editing Tools:

Cut, copy, and paste text. Delete text and markup. Undo mistakes.

4. Following learning objective, Check Accuracy of a Document Using Basic SGML Editing

Tools:

Check spelling. Find/Substitute. Look up a word.

Check Completeness. Print Editor View of document.

2.3.7 Statement of Enabling Learning Objective(s)

Listed below are the ELOs which pertain to this lesson. Each of the ELOs that support these

objectives should be performed under the same conditions: Given the standard JCALS workstation, the

SGML Basic Concepts, Tagging, and Editing Trainee Guide, JCALS Publishing Manual, and no

supervision.


Task: Open the SGML document Editor.Standard: Perform the following:

1. From the JCALS Desktop, double-click on the Filing Service; the

Filing Service window opens.

2. Double-click on an existing workfolder in the Filing Service.

3. Click on File on the menu bar; a drop-down menu displays.

4. Click on New > Object. Select New SGML Document; the

New SGML Document window opens.

5. Enter information for documents Description (for Workfolder)

and select applicable Class, Family, Group, and Version.

6. Highlight the Templates Available line and click on the OK

button.


Task: Modify tag display.

Standard: From the View menu, change the tag display to Full Tags, Partial

Tags, and No Tags.

Task: Change tag size.


28/38

44033604.3E

27 August 1999

18

Standard: From the View menu, change the tag size to Normal, Large, and Very

Large

Task: Increase or decrease font magnification.

Standard: From theView menu, increase and decrease font magnification by25%.


Task: Construct a file for a simple SGML document.

Standard: Create a file for a new version of the SGML document by performing

the following:

1. Click on File > Save then File > Exit.

2. From the Workfolder, click on View > Refresh > All; the

document is saved as a copy in the Workfolder.

Task: Enter text and save changes.Standard: Perform the following:

1. Manually insert new text.

2. Cut and paste existing text between markup tag icon pairs.

3. Click on appropriate buttons to save changes.

Task: Insert markups and delete text and markup tags.


1. Insert and apply markups for two para0 with titles within the new

document from the Insert Markup window and the right-click fast

menu.

2. Delete a block of text and delete a set of markup tags for a para

entry using appropriate keys.

Task: Cut, copy, and paste text and tags.


1. Highlight only the text to be cut or copied, or click on the region

in the document where cut or copied information is to be pasted.

2. From the Edit menu, click on the appropriate button.

Task: Find markup information in a document.

Standard: From the Edit menu, perform the following:

1. Click on Find/Substitute, select appropriate text, and click on

Replace or Find Next button.

Task: Undo mistakes.

Standard: Click on appropriate buttons to reverse most recent change.

Task: Check completeness of a document.

Standard: From the Tools menu, click on Check > Completeness Exclude

Entities.


29/38

44033604.3E

27 August 1999

19

Task: Print an Editor View of document.

Standard: From the File menu, click on Print Editor View.


Task: Check spelling and punctuation in a document.

Standard: From the Tools menu, click on Check Spelling and select the

appropriate button for Suggestions, or to Change, Change All,

Ignore, or Add a word or term.

Task: Look up a word in the dictionary.

Standard: From the Tools menu, highlight word to be looked up and click on

Look Up Word.

2.3.8 Helps

Frequently used Edit menu options can be accessed via theEdit fast menu. Access the fast menu bypressing and holding the right mouse button with the pointer in the current Edit window; a list of edit

menu options displays. To select an option from the Edit fast menu, the user must continue to use the

right mouse button.

2.3.9 Questions

This section contains suggested questions that may be asked, as time permits, during instruction and/or

the Review/Summary of the lesson. The questions may also be presented during the Practical

Exercises.

1. Does font magnification change the size of the characters when composed?

2. How many cut or copied items can be stored in the paste buffer?3. When using the Find/Substitute feature, can you change text containing markup tags?

4. How do you look up the definition of one word?

5. Why should you use the Check Completeness option?

2.3.10 Answers to Questions

1. No. When using font magnification, the text and markup tag size are changed in the Edit

window only and do not appear changed in the composed document.

2. The paste buffer remembers only the most recent cut or copied item. The next cut or copied

item will replace any stored text in the paste buffer.

3. No. The user may search for text containing markup tags, but cannot make a change to the

string.

4. Place the caret inside or after the word. In the Tools menu, select Look Up Word. A

definition of the word displays.

5. When finished working on the document, the General User should use the Check Completeness

option to verify that the markup in the document complies with the DTD.


30/38

44033604.3E

27 August 1999

20

2.3.11 Practical Exercise(s)

Practical Exercises provided in JCALS classes or JCALS training materials (i.e., Lesson Plans

and Trainee Guides) are designed for use in a training environment only. These exercises

SHOULD NOT be used on a production JCALS System. Running certain exercises on aproduction JCALS System could serve to delete data, obligate funds, or halt the system.

This section contains practical exercises that may be used for student practice during and after

presentation of the lesson. Depending on the complexity of the lesson, practical exercises may contain

questions to reinforce teaching points in the lesson and/or exercises designed to require analysis and

decision making by the student in situations similar to those which may occur in the operational

environment.

Exercise 1

1. Change the tag size to Large then Very Large.

2. Change the tag display to No Tags then Full Tags.

3. Increase the font size by 50 percent in a document.

Exercise 2

1. Create a two-page SGML document consisting of front matter and one chapter with two

paragraphs.

2. Enter text.

Exercise 3

1. Copy and paste a section of text.

2. Insert and delete markup tags and delete text.

Exercise 4

1. Check the spelling and punctuation of a document using the Spell Check option.

2. Highlight a word in a document. Look up the word.

3. Check Completeness of the document.

4. Save and close the document.

2.4 CONCLUSION

The TM Functional User needs to review the TLOs and ELOs which support this lesson.


31/38

44033604.3E

27 August 1999

21

2.4.1 Review/Summary

In this lesson, the TM Functional User has been introduced to the use of basic SGML editing tools.

The TM Functional User is able to:

1. Modify tag display.

2. Increase and decrease font magnification.

3. Customize personal viewing preference in Edit window.

4. Create an SGML document in the workfolder.

5. Insert and delete text.

6. Insert and delete markup tags.

7. Cut or copy and paste text regions into the document.

8. Find and change text strings and search for text with markup tags.

9. Undo mistakes.

10. Check spelling and punctuation in a document.

11. Look up the definition of a word.

12. Check Completeness of a document.13. Save the document.

14. Print an Editor View of the document.

2.4.2 Assignments

None

2.4.3 Transition Information

None

2.4.4 Test/Evaluation of Objective(s)

The examination of the objectives of this lesson will be conducted at the conclusion of the module.

2.4.4.1 Evaluation Preparation

1. Safeguard all evaluation materials.

2. Ensure that a file labeled TM01_Test is located on each student's Filing Service.

3. Ensure that the System Administrator has files TM01EVAL_T and TM01EVAL_D ready to

send to the students.

4. Have each student close all windows and return to the desktop screen.

5. Hand out a copy of the SGML Basic written examination to each student.

6. Hand out a copy of the SGML Basic performance evaluation to each student.7. Go over the written examination and the performance evaluation with the students. Read the

instructions and ensure that all students understand how the examination and evaluation will be

conducted.

8. Have the students raise their hands when they have finished the written examination, and when

they are ready to demonstrate a completed task. Evaluate each task for each student and

indicate GO or NO GO on the student's evaluation paper.

9. Collect the students written examination and performance evaluation papers after all tasks are

completed or the allowed time expires.


32/38

44033604.3E

27 August 1999

22

10. There are 7 questions on the written examination and 10 tasks in the performance

evaluation.

Each question is worth 4 points for a total of 28 points, and each task is worth a variednumber of points out of a possible 70 points.

The student must obtain a total of 70 points to receive a passing grade.11. Prepare a class roster with final grades posted and also post the grade on the top right cornerof the evaluation.

12. Retain all copies of the evaluation.

2.4.4.2 Answers and Evaluation of Examination

1. Evaluate each written examination using the following answer key:

1. d.

2. d.

3. b.

4. a.5. d.

6. a.

7. b.

2. The Instructor will evaluate performance of each task as follows:

Task 1: Open the SGML document created in Lesson TM01001 from the workfolder and

customize personal viewing preference in Edit window. (5 points)

The file should open and the viewing preference should be customized.

Task 2: Modify the tag display. (5 points)

The tag display is modified.

Task 3: Increase font magnification by 50 percent. (5 points)

The font magnification is increased.

Task 4: Insert a third paragraph of text and markup tags for the third paragraph. (10

points)

The third paragraph of text should be inserted between the paragraph markup tag

pair icons.

Task 5: Cut or copy and paste text regions into the document. (10 points)

Text regions are cut or copied and pasted into the document.

Task 6: Find and change text strings, and search for text with markup tags. (10 points)

Text strings are found and changed, and text with markup tags is found.

Task 7: Check spelling and punctuation in a document. (10 points)

All words are correctly spelled, and punctuation is correct.


33/38

44033604.3E

27 August 1999

23

Task 8: Look up the definition of a word. (10 points).

Word looked up in the dictionary is found, and the definition is copied.

Task 9: Check Completeness of the document. (5 points)

The document should be complete.

Task 10: Save the document and print an Editor View of the document. (10 points)

The document is saved and an Editor View of the document is printed.

2.4.4.3 Examination/Evaluation

Copies of the examination and evaluation to be administered follows.


34/38

44033604.3E

27 August 1999

24

EXAMINATION

TM-01 SGML BASIC CONCEPTS, TAGGING, AND EDITING

Student's Name: ________________________ Signature:______________________________

Instructor's Name: ______________________ Signature:______________________________

Date: _________________________________ Grade: ______________

INSTRUCTIONS

Do not start until your instructor tells you to begin.

You may use the JCALS System and any other available references during this evaluation.

There are 7 multiple choice questions on this evaluation from. You must answer 5 of the 7 questions

correctly for a passing grade.

You have 15 minutes to complete this evaluation.

Read all responses for each question. Circle the letter of the correct response.


35/38

44033604.3E

27 August 1999

25

EXAMINATION

Circle the correct answer.

1. Some advantages of the Standard Generalized Markup Language are:a. All documents have a similar structure

b. Hardware and software dependency is eliminated

c. Documents are modular, interchangeable and flexible

d. All of the above

2. A Document Type Definition:

a. Is a file that defines the components of a document

b. Defines rules for placement, usage, content and structure

c. Specifies the rules of the document through elements, attributes, and entities

d. All of the above

3. A Formatting Output Specification Instance:

a. Defines the major structural components of a DTD

b. Defines the format and style of the document

c. Contains characters, text, data, or graphics which make up the content of a document

d. All of the above

4. Elements:

a. Are the major structural components of a DTD

b. Are defined by the DTD and FOSI

c. Are placed between tags

d. All of the above

5. Tags:

a. Identify each element

b. Are defined by the DTD

c. Can be accessed from the Markup pulldown menu

d. All of the above

6. Attributes:

a. Are markups of an element tag that further define aspects of the element

b. Are placed outside element tags

c. Characters, text, data, or graphics which make up the content of a documentd. Are placed between tags

7. Entities:

a. Characters, text, data, or graphics which define the format of a document

b. Are placed between tags

c. Are markups of an element tag that further define aspects of the element

d. Can have many attributes or no attributes


36/38

44033604.3E

27 August 1999

26

EVALUATION

TM-01 SGML BASIC CONCEPTS, TAGGING, AND EDITINGStudent's Name: ________________________ Signature:______________________________

Instructor's Name: ______________________ Signature:______________________________

Date: _________________________________ Grade: ______________

INSTRUCTIONS

Do not start until your instructor tells you to begin.

You may use the JCALS System and any other available references during this evaluation.

There are 10 testable tasks (in bold print) on this evaluation. You must successfully complete at least

70 percent of the tasks for a passing grade.

When told to begin you must complete each task in order. As you complete a task raise your hand to

have an instructor come evaluate your task accomplishment.

The instructor will look at your JCALS monitor and determine if you have successfully completed the

task according to course standards. You will be evaluated on a GO/NO GO basis. The instructor will

initial the appropriate block on this evaluation form.

You have 45 minutes to complete this evaluation.


37/38

44033604.3E

27 August 1999

27

EVALUATION

This evaluation is based on the following scenario:

You have recently completed the SGML Basic Concepts, Tagging, and Editing module of the JCALSTM Functional User Course. Upon return to your work site, your supervisor tasks you to:

1. Create a simple SGML document with multi-paragraph text.

2. Check the spelling and punctuation and completeness of the document.

Instructors Initials

GO NO GO

Task 1 Open the Filing Service. From the workfolder, open the SGMLtemplate created in Lesson TM01-001.

Raise your hand to have this task evaluated. ________ ________

Task 2 Insert markup tags for a third paragraph and a third paragraph of

text.

Raise your hand to have this task evaluated. ________ ________

Task 3 Modify the tag display.

Raise your hand to have this task evaluated. _______ _______

Task 4 Increase font magnification by 50 percent.


Task 5 Find and change text strings, and search for text with markup tags.Raise your hand to have this task evaluated.

________ ________

Task 6 Cut or copy and paste text regions into the document.


Task 7 Check spelling and punctuation in a document.


Task 8 Look up the definition of a word.

Raise your hand to have this task evaluated._______ _______

Task 9 Check completeness of the document.


Task 10 Save the document and print an Editor View of the document.



38/38

44033604.3E

27 August 1999

2.4.5 Critique of Course

A critique of course will be obtained at the conclusion of the course using the IRTS.