IETMs. Rick Jelliffe Academia Sinica Computing Center. IETM Copyright (C) 1999 Rick Jelliffe. 1 of 67

Transcription

1 IETMs Rick Jelliffe Academia Sinica Computing Center 1 of 67

2 Interactive Electronic Training Manuals A package of information... required for the diagnosis and maintenance of a weapons system,... optimally arranged and formatted for interactive screen presentation to the enduser. US DOD Definition 2 of 67

3 (1) Package of Information SGML Documents: Group resources in any format: graphics, video, animation, text Allow direct specification of text Allows any data structures and relationships between data Allows any kind of addressing to name and locate resources and fragments 3 of 67

4 (2) For Diagnosis and Maintenance Procedures: step-by-step, warnings Troubleshooting: symptoms, history Parts Information: graphics, lists Descriptions: theory of operation 4 of 67

5 (3) Optimally Arranged and Formatted Targeted (Technicians get all the information when they need it) Focused (Technicians only gets the information they need) Complete (updated, no lossage) Suitable for PEDDs (Personal Electronic Display Devices) 5 of 67

6 6 of 67

7 An Example IETM Windows, Menus, Popups Text Panes Graphics Panes Navigation Button 7 of 67

8 The Key Idea is Dialog: IETM gives some choices User makes a response Each frame of information has Pre-conditions and Post-conditions 8 of 67

9 Overview of Seminar US Military Specifications The 5 Classes of IETMS Overview of Overview of ISO ISMID Overview of of 67

10 US Specifications (1) MIL-M Manuals, Interactive Electronic Technical: General Content, Style, Format and User-Interaction Requirements What does an IETM do? What does an IETM look like? How should an IETM behave? 10 of 67

11 US Specifications (2) MIL-M Data Base, Revisable: Interactive Electronic Technical Manuals, for the Support of Source Data Element Structures Contol Mechanisms Database forms? 11 of 67

12 US Specifications (3) Navy MID-2 Metafile for Interactive Documents ISO ISMID Information technology -- Interchange Standard for Modifiable Interactive Documents Delivery format A rigid data format which contains or references all content from an IETM data base developed in accordance with MIL-M or other specified 12 of 67

13 definitions, structured to contain all the sequencing information necessary to specify the behaviour of information when presented. This will result in an unambiguous, complete, precise and consistent presentation of the IETM information accross dissimilar authoring tools and Presentation Systems. Allows IETMs to be constructed from non documents: XML, HTML, PDF, etc. 13 of 67

14 US Specifications (4) MIL-MRP-28001C Appendix B FOSI Formatted Output Specification Instance Stylesheet Not widely implemented, therefore not platform independent! Not required Not easy to implement or use 14 of 67

15 My Recommendations Don t require FOSI Use ISO DSSSL or W3C XSL Don t require MIL-M DTD Allow XML, PDF pages, etc Do require MID Perhaps revise for better fit with XML Do require MIL-M Look & Feel Good (English) rules for IETM 15 of 67

16 The 5 Classes of IETMS 1970s Paperless Ship Initiative Originally scanned images 1986 ISO SGML (1998 W3C XML) 1992 DOD IETM Specs 1992 ISO HyTime (revised 1997) 1995 ISO DSSSL (1999 W3C XSL) 1995 Navy MID (1999 ISO ISMID) 16 of 67

17 Overlap But the 5 classes are not well-defined!!! 17 of 67

18 Class 1: Electronically Indexed Pages Page-turner Scanned images or PDF For library and reference material Example: Acrobat Reader in full-page mode; or UNIX man pages 18 of 67

19 Class 2: Electronically Scrolling Documents Scrolling text Handmade Hypertext Launch external process Example: Acrobat Reader with scrolling, searching, index 19 of 67

20 Class 3: Linearly Structured IETMS SGML or XML or HTML MIL-M Look and Feel if possible Pages fit screen Systematic cross-references Example: HTML Browser with frames, addressing disabled, hotspots, buttons 20 of 67

21 Class 4: Hierarchically Structured IETMS MIL-M User prompts (fill-in forms) Data management Links and data authored-in Example: SplitVision, database, multiple views 21 of 67

22 Class 5: Integrated Data Base Data Base: Randomly accessible but logically connected IETM data elements (source documents) Expert System(rules, knowledge) Example: HyMid simultaneous access to many different sources (dynamic data) script access to expert system 22 of 67

23 Real Browsers...do not fit neatly into one class of 67

24 Difficulty and Price (For large runs) Current Breakpoint: Class US $1~$5 page US $40~ $100/ page 24 of 67

25 An Overview of Gives requirements for General Content, Style, Format, and User Interaction 25 of 67

26 87268: General Content Common Content: front matter, table of contents, IETM number, IETM date Technical Functions: to ensure that the technical information...is complete, comprehesible and appropriate. Wish-list for ideal IETM Required for Class 4 & 5 26 of 67

27 Nodes of Data The IETMDB shall be constructed of composite nodes. These nodes shall comprise the basic information units within the IETM IETM 1 IETM 2 IETM 3 <p> <p> <h1> <p> <p> <p> <img> <p> <table> Text, Table, 27 of 67

28 Graphic, Dialog 1-1 Element Link, Multiway Relationship Link Links to avoid repeated text HyTime locations Pre-condition/Post-condition elements 28 of 67

29 Contents in All IETMS Help on Technical Content (Reference Material) Full Publication Information Applicability: which equipment?, which configuration?, which kind of maintenance? Introduction, List of Contents How to use Help 29 of 67

30 IETM Utility Functions: errors, faults, replacements, orders Dictionary: acronyms and unusual terms Warnings, Cautions and Notes Safety Notes and Health Icons Naming, numbering and English guides Audio, graphics, GUI functions 30 of 67

31 Warnings and Cautions Precede the text to which they apply. Specific nature of the hazard Steps to overcome the hazard Location of the source of the hazard What happens if you ignore the warning or caution 31 of 67

32 Procedures Divided into task, subtask, and step The step Open the door does not need technical information: so make this an optional step. But the step Defuse the bomb needs technical information: make it a required step 32 of 67

33 Procedure Support Test equipment required Tools required Parts and consumable items Support equiment Personel Preparation checklist Safety information 33 of 67

34 Steps Actions statement Indication statement Usual form: Point of test Expected result Where to go next Troubleshooting linked to repair manual 34 of 67

35 Troubleshooting Symptoms Procedures Graphics, locator graphics and schematics Parts and test equipment information Equipment failure history Theory of operation 35 of 67

36 Fault Trees and Expert Systems Fixed fault detection tree Dynamically-generated fault isolation information Simple Procedure Step Step Procedures Procedure Step Step Procedure Step Step Step 36 of 67

37 Procedure Complex Step Step Procedures condition Task Step Step Procedure Step Step Procedure Step Step Step 37 of 67

38 Graphics Minimum displayable size? Interactive? Simplified schematics first, but access to full Locator Graphics for showing a part Procedure-sensitive Callouts Hotspot functional graphics 38 of 67

39 87268: User Interface Interact with Dialog Boxes and Panes! 39 of 67

40 But... Now newer kinds of interaction: Tree views for indexes Hyperbolic trees Interactive animation 3D GUIs Collapsible views Very conservative, portable approach 40 of 67

41 An Overview of MID US Navy: Metafile for Interactive Documents ISO: International Standard Modifiable Interactive Documents (ISMID) & do not give enough information for identical look-and-feel on different IETM browsers Distribution format: more like PDF or JavaScript for IETMs! 41 of 67

42 Overview MID divides information into: containers,...organized into pools or chains,...specify panes and controls,...contain paras, tables, lists, graphics,...selected by scripting elements; and transitions and links, showing relationships 42 of 67

43 An Overview of MIL-D Database, Revisable: Interactive Electronic Technical Manuals An SGML DTD (Document Type Definition) with two layers: Generic Layer (appendix A & C) Content-Specific Layer (appendix B & D) You build content-specific elements using templates provided in the generic layer. (In OO programming: a class relationship) 43 of 67

44 Generic Layer Procedure Templates: Nodes, NodeSeq, NodeAlts, IfNode, LoopNode Primitive Data Elements: text; tables; graphics; audio, video and process; links Dialog Elements: fillin, menu, selection Context Filtering Elements: Preconditions, assertions and postconditions 44 of 67

45 Node Template Basic model for a procdure, task, or step Node link to external element Precondition Dialogs yes no primitives subnodes post conditions Next Continue 45 of 67

46 NodeSeq Sequence of Nodes (A Set) NodeSeq Node Node Node Pre- no Next Pre- no Next Pre- no Next condition yes condition yes condition yes link to external element primitives subnodes Continue link to external element primitives subnodes Continue link to external element primitives subnodes Continue Dialogs post conditions Dialogs post conditions Dialogs post conditions 46 of 67

47 NodeAlts Alterative Nodes (A Bag) NodeAlts Node Node Node Pre- no Next Pre- no Next Pre- no Next condition yes condition yes condition yes link to external element primitives subnodes Continue link to external element primitives subnodes Continue link to external element primitives subnodes Continue Dialogs post conditions Dialogs post conditions Dialogs post conditions 47 of 67

48 48 of 67 IfNode Conditional tests Dialogs Node Continue Next Precondition no yes primitives link to external element post conditions subnodes Dialogs Node Continue Next Precondition no yes primitives link to external element post conditions subnodes Dialogs Node Continue Next Precondition no yes primitives link to external element post conditions subnodes NodeSeq Dialogs Node Continue Next Precondition no yes primitives link to external element post conditions subnodes Dialogs Node Continue Next Precondition no yes primitives link to external element post conditions subnodes Dialogs Node Continue Next Precondition no yes primitives link to external element post conditions subnodes NodeSeq expression true false

49 LoopNode Repeating a procedure until it is finished evaluate assertion evaluate assertion expression true NodeSeq Node Node Node false Precondition link to external element Precondition link to external element no yes primitives subnodes Next Continue no yes primitives subnodes Next Continue Precondition link to external element no yes primitives subnodes Next Continue Dialogs post conditions Dialogs post conditions Dialogs post conditions 49 of 67

50 Primitive: Text <!ELEMENT text - - (precond*, link*, (#PCDATA, text-alt, text)*)> Text may have pre-conditions Text may have links to other data Text may have alternative parts: textalt <!ELEMENT text-alt - - ( text )*> 50 of 67

51 Primitive: Table <!ELEMENT table - - (precond*, link*,rowhddef*, (colhddef*, entry+)+ )> <!ELEMENT rowhddef - - (%text;)> <!ELEMENT colhddef - - (%text;)> <!ELEMENT entry - - (%text; %graphic; )> A table has row and column headers Entries are assigned to row and column by attributes not containers! 51 of 67

52 Links Uses ISO HyTime: ilink=independent link: location could not be an anchor <!ELEMENT link - - ( #PCDATA )> <!ATTLIST link id ID #REQUIRED HyTime NMTOKEN #FIXED ilink endtypes CDATA #FIXED desc parts text table graphic audio video process linkends IDREFS #REQUIRED desc IDREFS #IMPLIED parts IDREFS #IMPLIED... > 52 of 67

53 Primitives: Graphic, Audio, Video Graphics have no surprises Audio and video have pointer to a locating element <!ATTLIST audio external-ptr IDREF #REQUIRED> 53 of 67

54 Primitive: Process You can link to a process, perform some action or fetch some data <!ELEMENT process - - (precond*, link*, parameter*)> <!ATTLIST process external-ptr IDREF #REQUIRED> <!ELEMENT parameter - - (expression)> 54 of 67

55 Context-filtering <!ELEMENT precond - - ( expression )> <!ELEMENT postcond - - ( assertion )> <!ELEMENT assertion - - ( property, expression )> <!ELEMENT property - - ( #PCDATA )> <!ELEMENT expression - - ((expression, %bop;, expression) (%unary-op;, expression) property %value; )> 55 of 67

56 Dialogs Dialogs allow user interaction <!ELEMENT dialog - - (precond*, link*, %text;, (dialog fillin menu selection )*> 56 of 67

57 Content-Specific Layer Appendix B of Uses the templates and generic layer given in Appendix A Creates structures suitable for IETMS for technicians on weapons systems 57 of 67

58 4 Kinds of Technical Information procedural descriptive parts faults 58 of 67

59 Breakdown of Structure: <!ELEMENT techinfo - - ( version+, system+ )> Version allows revision tracking A system might be F-18 <!ELEMENT system - - ( precond*, link*, system*, descinfo*, task*, partinfo*, fault*) > 59 of 67

60 descinfo Descriptive sequences traditional text can be most of usual IETM (75%?) paragraph structure can be complicated descinfo uses the NODE template 60 of 67

61 task task uses the NODE template <!ELEMENT task - - ( precond*, link*, input*, step-seq, follow-on*, postcond* )> 61 of 67

62 task: step-seq uses the NODE-SEQ template <!ELEMENT step-seq - - ( step step-seq if-step loop-step )+> <!ELEMENT step - - ( precond*, link*, alert*, (text table graphic audio video process)*, step-seq?, post-cond* )> 62 of 67

63 step-seq: alert very important and useful <!ELEMENT alert - - ( precond*, link*, text+, graphic* )> <!ATTLIST alert type ( Warning Caution Note ) #IMPLIED > 63 of 67

64 partinfo A maintainer s view of the parts Connections Locations uses NODE template to give instructions on how to attach or connect parts 64 of 67

65 fault troubleshooting go through steps to identfy the problem uses the NODE template <!ELEMENT fault - - (precond*, link*, (rect fltstate )+ system* )> 65 of 67

66 fltstate faultstate is possible faults <!ELEMENT fltstate - - ( precond*, link*, fault+)> 66 of 67

67 rect rect gives possible ways to fix the fault <!ELEMENT rect - - (precond*, link*, task*, fault*, system, test* )> test gives check-out tests And so on of 67