s1000d and ietpdownloadcentre.sdl.com/sdl_s1000d_webinar_4-ietp.pdf · 2012-11-28 · s1000d...
TRANSCRIPT
S1000D Webinar Series, Session 4SDL Structured Content Technologies
S1000D and Interactive Electronic Technical Publications
2
Our Presenters Today
Rhonda WainwrightS1000D and IETM SpecialistSDL Structured Content Technologies
Ed HougardyProgrammer Analyst, AWS Training and Support SystemsThe Boeing Company
3
Objectives
Provide an introduction to Interactive Electronic Technical Publications (IETPs)Explain and demonstrate how delivering S1000D content in an IETP provides advanced functionality:Applicability/effectivity filtering at runtimeProcess data modules for interactive fault isolationMultimedia for just-in-time training Intelligent graphics (hot spots, wire highlighting, more)
Share insights and expertise from an IETP developer
4
Introduction to Interactive Electronic Technical Publications (IETPs) What is an IETP? IETP classes, types, and the S1000D Functionality Matrix
Why use IETP with S1000D? Demonstration: Applicability Demonstration: Locator Graphic Demonstration: Process DM Demonstration: Simulations and Animations
Industry Expert Presentation: Ed Hougardy, Boeing IETP, Start at the Beginning
Agenda
5
What is an IETP?
An Interactive Electronic Technical Publication is: An electronic information resource
Can be delivered online or via CD-ROM/DVD
Indexed to provide searching capabilities
Hyper linked to provide easy navigation
Non-linear in nature; the user jumps from one location to another through interaction with the content
Interactive; user actions drive navigation to the right information at the right time
6
Background
Known as “IETMs” or “Interactive Electronic Technical Manuals” pre-S1000D, IETPs originated as Electronic Technical Manuals (ETMs) in the late 80s/early 90s Not Interactive; Pre-PDF! Usually based on ASCII “print file” Basic searching capabilities; saved paper
and shipping costs (and that’s about all)
With the introduction of SGML into aviation/defense tech docs, things changed! Effectivity/applicability filtering System-driven navigation and hyperlinks Intelligent graphics
7
“Classes” and “Types”
To differentiate between “page turner” ETMs and true “interactive” electronic technical manuals, “Classes” were created: Class 1: Page turner documents, may have
indexing and hyperlinking Class 2: Electronically scrolling documents with indexing and
hyperlinking Class 3: SGML or XML-tagged documents with
dialog-driven interaction, user selectable cross-references, indexing & hyperlinking
Class 4: Hierarchically structured SGML or XML documents, dialog driven interaction, user selectable cross references, indexing, & hyperlinking data management by a DBMS
Class 5: Integrated database, identical to Class 4 but integrated at the data level with other application information
8
“Classes” and “Types”
To differentiate between “page turner” ETMs and true “interactive” electronic technical manuals, “Classes” were created: Class 1: Page turner documents, may have
indexing and hyperlinking Class 2: Electronically scrolling documents with indexing and
hyperlinking Class 3: SGML or XML-tagged documents with
dialog-driven interaction, user selectable cross-references, indexing & hyperlinking
Class 4: Hierarchically structured SGML or XML documents, dialog driven interaction, user selectable cross references, indexing, & hyperlinking data management by a DBMS
Class 5: Integrated database, identical to Class 4 but integrated at the data level with other application information
TYPE II
Later, “Type” classifications were defined to differentiate between the two major kinds of IETMs:
TYPE I
11
Polling Question #1
What has been your experience with the S1000D Functionality Matrix? I’ve never heard of it before today. I’ve looked at it before but never used it. I’ve used it successfully; it’s a good tool I’ve used it and don’t recommend it
12
Choosing an IETP
Major considerations Standard technologies: XML, XSL,
XSLT, XSL-FO, Java, JavaScript, HTML, XHTML
Performance: PDOM, AJAX Open architecture Scalable
Program considerations Web-enabled / support for CD/DVD API for integration Graphic viewer support Runtime applicability filtering Everything on the S1000D Functionality
Matrix that your program needs
13
Publishing IETPs
IETP configuration development Your data must be rendered into the
appropriate format for display on screen An IETP “skin” needs to be developed Any special dialogs need to be created IETP print styles need to be developed Most IETPs require some sort of
configuration file(s)
Another publishing output When integrated with an S1000D
Common Source Data Base (CSDB) , IETP publishing can become as simple as “pushing the print button”
PDF can be generated as a secondary output from the same XML source
14
Introduction to Interactive Electronic Technical Publications (IETPs) What is an IETP? IETP classes, types, and the S1000D Functionality Matrix
Why use IETP with S1000D? Demonstration: Applicability Demonstration: Locator Graphic Demonstration: Process DM Demonstration: Simulations and Animations
Industry Expert Presentation: Ed Hougardy, Boeing IETP, Start at the Beginning
Agenda
16
Polling Question #2
What is your prior experience with IETMs or IETPs? None. I have never worked with IETMs in any capacity I have used IETMs as an information consumer (end-user) I have prepared data for publishing to IETM I have developed IETMs
17
Introduction to Interactive Electronic Technical Publications (IETPs) What is an IETP? IETP classes, types, and the S1000D Functionality Matrix
Why use IETP with S1000D? Demonstration: Applicability Demonstration: Locator Graphic Demonstration: Process DM Demonstration: Simulations and Animations
Industry Expert Presentation: Ed Hougardy, Boeing IETP, Start at the Beginning
Agenda
IETP: Start at the Beginning
Ed HougardyProgrammer Analyst, AWS Training and Support SystemsThe Boeing Company
19
Start at the Beginning – Business Rules are a mustAuthoring guidelines Element / Attribute usageWhat data module types are used?
IETP Creation Process
20
Do you have everything you need?DMRL (Data Module Requirements List)
• A spreadsheet might be more useful
What about graphics?• There might be more than meets the eye
IETP Creation Process
21
Think outside the box (or IETP) Will the data modules be printed?
• What about multimedia
Graphics and Foldouts?• What size is the screen
Look and Feel• Be open to change
IETP Creation Process
22
Do you know its right? Internal Quality Check Is the data valid? Does it parse?
• Applicability might be an issue
Does it hold up against the business rules?• Are you doing what you said you would do
Does it pass tagging “gotchas”• A internalRef element might reference the wrong
internalRefTargeType
IETP Creation Process
23
The Publication Module ~ The Key to Navigation Master module include smaller publication modules
• Flexibility create the navigation hierarchy (TOC)– By Standard Numbering System– By traditional “publication” order.
• Flexibility to update modules within the hierarchy
IETP Creation Process
24
Be ready for change; it’s coming Have a test suite of data modules
• Known results and behavior• Use all elements• Use fewer elements
Requirements can change; can you?
IETP Creation Process
25
Playing with fire Change the schema
• Remove elements• Require attributes and elements
Maintenance Issues• Staying in sync with the specification
IETP Creation Process
26
The very beginningVendor Selection
• Does it meet your specification requirements (Functionality Matrix)?• Flexibility to update styles and look & feel• Support Team• “No Special Tagging” required
IETP Creation Process
28
For Additional Information
For S1000D specification training or for more information…Visit us on the web: www.sdl.com/xmlEmail: Rhonda Wainwright: [email protected]
Join us for our next S1000D webinar…S1000D and MultimediaTuesday, September 21, 2010To register: http://www.sdlxysoft.com/en/news-and-events/events/2010-09-21-S1000D-Multimedia.asp