AskAnS1000DExpert Tour - Warner Robins GA - October...
Transcript of AskAnS1000DExpert Tour - Warner Robins GA - October...
Ask an S1000D Expert™ TourWarner Robins, GA
Lou IuppaVP Strategic Business Development and SDL S1000D Business Owner
Michael CookS1000D Business Analyst
Michael DavisP i i l B i C lt tPrincipal Business Consultant
Agenda: Ask An S1000D Expert™ Tour
12:00 – 12:30 – Conference Registration, Networking and Lunchand Lunch
12:30 – 13:30 – Introductions and S1000D Specification Overviewp
13:30 – 14:30 –Michael Davis, “Best Practices with Multimedia and Hot Spotting in S1000D”
14:30 – 14:45 – Break, Snack, Network14:45 – 15:30 – S1000D in Action15:30 – 16:30 – Interactive Q&A/Roundtable
Objectives of this Conference
Overview of the S1000D specificationUnderstanding the basics of the specificationUnderstanding the basics of the specificationUnderstanding the importance of a CSDB (Common
Source Data Base) and the publishing process to ) p g pS1000D
Explore Best Practices for working with Multimedia and Hot SpottingS1000D in ActionSDL LiveContent and SDL Contenta S1000D
Roundtable: Ask, Share, LearnEnsure you walk away with the answers to your
questions
Introductions
Lou Iuppa, VP Business DevelopmentVP, Business DevelopmentSDL, Structured Content Technologies
Lou Iuppa is the VP of Business Development for pp pSDL, Structured Content Technologies.
In January 2011, Lou took on the responsibility as SDL’s S1000D Business OwnerBusiness Owner.
He manages strategic business relationships with the US Navy and Northrop Grumman as well as new business within the aerospace, defense and commercial technical publication industries.
Lou has over 20 years of experience associated with publishing and content management technologies within a variety of industries from content management technologies within a variety of industries from the perspective of vendor, end user, and consultant.
Introductions
Mike Cook, S1000D Business AnalystS1000D Business AnalystSDL, Structured Content Technologies
Mike has a 30 year history within the aerospace y y pand defense community and has been working with real world S1000D project needs for the past 6 years.
Mike provided S1000D Information Architecture services for the Mike provided S1000D Information Architecture services for the Boeing 787 Dreamliner documentation system.
His experience includes roles within Boeing Flight Test, test labs, and as an Instructor of Systems Analysis, Structured Analysis, Computer Aided Software Engineering, and Project Planning and Controls.
Mike developed SDL’s S1000D Specification Education Series and Mike developed SDLs S1000D Specification Education Series and created SDL’s BREX Builder application.
Introductions
Mike Davis, Principal Business Analyst and Principal Business Analyst and S1000D SpecialistSDL, Structured Content Technologies
Mike has 20 years of experience with complex computing environments, specializing in databases and XML.
H ’ k d ith XML i it’ i ti f d XML d ithi He’s worked with XML since it’s inception focused on XML used within document production and data exchange.
Mike is a programmer, familiar with most SGML/XML data standards p g , /and has over 15 years serving the aerospace and defense industry.
Mike also plays an important role at SDL as a customer advocate by providing input and guidance to SDL’s S1000D product strategy providing input and guidance to SDLs S1000D product strategy.
SDL Group
Recognized Leader in Global Information ManagementPublicly traded company with $250m+ annual revenues$Over 2000 employees in 50 offices across 32 countriesAward-winning and profitable
ith l t fi i l t bilitwith long term financial stability 1000+ deployments of enterprise technologies80% of the global translation80% of the global translation supply chain use SDL software
SDL St t d C t t T h l iSDL Structured Content Technologies SDL is a leader in the design, creation, delivery and support of technical data systems in the aerospace and
defense community SDL offers award winning component content management, CSDB, PS and PDF Publishing and
IETM/IETP generation and delivery technologies as well as professional services, including system design, g y g p g y gproject management, implementation planning and execution, XML data and workflow modeling, custom programming and system integration.
A sampling of companies and defense organizations who rely on SDL Technologies are US Navy, US Air Force, Northrop Grumman, Raytheon, Boeing, Gulfstream, Pratt & Whitney, and many more.
S1000D Trends
• Strong desire for Vendor Neutrality
• Opportunity for Cost Savings • Significant budgetary pressure to reduce sustainment costs
Business reduce sustainment costs
• Government Data Acquisition Strategy: S1000D deliverables more frequently mandated in contracts
Drivers
• Multi-format, multi-device delivery ready
• Configuration Management• Interactive Electronic Technical Manuals (IETM’s)
• Proven interoperability between d l ti
Technical Drivers vendor solutionsDrivers
V St A ti St d d• Very Strong, Active Standards Community
• Government Spending is Down!
• Technical data management services becoming more competitive
• Tools are readily available to
Market Drivers
achieve the benefits of S1000D
Next Generation Content Delivery Platform
NAVSEA Viewer 1.0
Saab Aerotech – Gripen 39 IETP
S1000D OverviewS1000D Overview
Mike Cook, S1000D Business Analyst
S1000D Overview Slides
S1000D basics History Terminology Important activities Support files
How do you get there? The Larger context Challenges of adoption Challenges of adoption Best of Breed S1000D Implementations The myth of the end-to-end solution Th b t f b d l ti The best of breed solution The CSDB matters Why publishing matters
S1000D History
The S1000D specification is used to produce technical publications. It is co-owned by the following groups:
European Association of Aerospace Industries (ASD) Aerospace Industries Association (AIA)
Ai T t A i ti (ATA) Air Transport Association (ATA)
The S1000D specification is available from: www.S1000D.org
An outgrowth of the ATA 100 and ATA iSpec 2200
Anyone with experience in ATA 100 or ATA iSpec 2200 has someAnyone with experience in ATA 100 or ATA iSpec 2200 has some degree of familiarity with S1000D
S1000D supports air, land, or sea systems – and can be adapted to pp , , y psupport others. It can support any product requiring publications for maintenance, operation, and configuration of parts and supplies.
History - Why was S1000D created?
European Issues (ASD)• No standard existed to support more than the aviation industry• ATA 100 and ATA iSpec 2200 are considered to be a good start,
but do not incorporate many capabilities needed for other product or industry types
• Partners and customers have different requirements languages• Partners and customers have different requirements, languages, and viewing technologies – no single standard supports all these needs
US DoD Issues (AIA)US DoD Issues (AIA)• Too many different specifications across the services• Millions spent every year on publication maintenance or
conversion to support updates to each of the various standardsconversion to support updates to each of the various standards• Interoperability and data exchange is problematic between the
services and partners – no common method• Data re-use is inconsistent or impossible between publications (noData re use is inconsistent or impossible between publications (no
prescribed recycle paradigm)
History - Why was S1000D created?
Civil Platform Support Issues (ATA)• Aircraft manufacturers and airline customers may not be using the
same documentation standards. When aircraft manufacturers provide maintenance data to customers it must be transformed into whatever specification the customer is using.
• Aircraft manufacturers and customers want to move from Document Centric Publications to Information Centric Publications
• Data re-use is becoming more important as new technology influences how new products are maintained and how the information to support these activities is presented to technicians
• Aircraft manufacturers and customers want to exchange data gusing a formal supported format
S1000D Terminology – Abbreviations
DMC – Data Module CodePMC – Publication Module CodeICN – Information Control NumberDMRL – Data Module Requirements ListCSL – CSDB Status ListCSL – CSDB Status ListDDN – Data Dispatch NoteSNS – Standard Numbering System DC – Disassembly CodeIC – Information Code (aka infocode)CSDB Common Source Data BaseCSDB – Common Source Data Base BREX DM – Business Rules Exchange Data ModuleLOAP – List Of Applicable PublicationsLOEDM – List Of Effective Data ModulesIETP – Integrated Electronic Technical Publication
S1000D Terminology – Data Modules
The smallest self contained information unit within a technical publication. The equivalent of a “topic” or the most granular piece of information about a task or descriptive “How to” of a system.Data modules are created using “schemas” Schemas are used asData modules are created using schemas . Schemas are used as the framework for an “information set”. The various core schemas are:
• Procedural – proced.xsdD i ti d i t d
Data module file<dmodule>• Descriptive - descript.xsd
• Process – process.xsd• Crew – crew.xsd• Fault Isolation – fault.xsd• Illustrated Parts Data – ipd.xsd
Metadata about the data module’s content<identAndStatusSection>
Content – procedure, process, Illustrated Parts Data ipd.xsd• Schedule – schedul.xsd (yes the “e” is missing on purpose)• Technical Information Repository – techrep.xsd• Wiring Data - wrngdata.xsd• Container – container.xsd
p , p ,how to, etc - all based on the information code and schema of the data module<content>
• Learning – learning.xsd• Checklist – checklist.xsd• Business Rules – BREX – brex.xsd• Publication Module – pm.xsd• Applicability Cross reference Table appliccrossreftable xsd• Applicability Cross-reference Table - appliccrossreftable.xsd• Product Cross-reference Table – prdcrossreftable.xsd• Conditions Cross-reference Table – condcrossreftable.xsd• SCORM Content Package – scormcontentpackage.xsd
S1000D Important activities
Adopting S1000D usually consists of the following pieces• Make Business Rule decisions - identifying how various features
of the specification will be used for the given project• Create or flesh out a Standard Numbering System (SNS)• Add information code variants (if needed)Add information code variants (if needed)• Create a Data Module Requirements List (DMRL) (optional)• Implement a Content Management System - referred to as a
Common Source Data Base (CSDB)Common Source Data Base (CSDB)• Author content - using XML, graphics, and multimedia• Assemble Publication Modules• Publish – digital distribution or paper
• Publishing for digital distribution may include selecting an Interactive Electronic Technical Publication (IETP) viewer, creation of a website, or hosting an FTP site for distribution of raw XML data modules directly to customerssite for distribution of raw XML data modules directly to customers
S1000D Support file - DMRL
Data Module Requirements List Used to define and create the data modules for the Product (optional) Data modules are usually defined by the SMEs and authors and can be inserted
into a DMRL. The DMRL can be used to create skeleton XML files.
CSDB Empty Data ModulesDMRL file
DMRL can produce
S1000D Support file – Publication Module
CSDB - Project D t M d l
Publication Module Aircraft Maintenance
Manual (AMM) Data ModulesManual (AMM)
Publication Module Publication Module System Description
Section (SDS)
Crew door latch – Description of functionDMC-PROD1-A-52-11-05-00A-042A-A
=
System Description SectionPMC-PROD1-AAAAA-04001-01
=
S1000D Support file – Data Dispatch Note
S1000D provides a method to transfer data modules using a data interchange method – also known as a transfer package The transfer package must have a Data Dispatch Note (DDN) and at least one data module. Other S1000D files can also be included, for example: Illustrations and multimedia files Publication Modules a CSDB Status List (CSL)( )
CSDB files (DMC, ICN, etc) Transfer Package
Export CSDB content (files)
The Larger Context
S1000D enables collaboration of content, interchange of files, and content reuse Collaboration:
• Contracts are generally written to indicate the use of a specific issue of the specificationA D t M d l R i t Li t (DMRL) ll d t d l t b d fi d• A Data Module Requirements List (DMRL) allows data modules to be defined before authoring occurs. This is part of the business rules decision making process and allows multiple manufacturers to participate in the definition process
• Data Dispatch Note (DDN) files are used as part of the file transfer process to help create transfer packages (also known as revision packages). Content migrated from the CSDB for delivery to partner companies and for delivery to digital only recipients uses a simple method which is easily implemented.
• If S1000D is used by multiple organizations, the data created in each CSDB can be imported and exported between partners with relative ease
Content Reuse:• Content is authored at the data module level and is referenced by publication
modules. Reusing the data module in another publication is as easy as creating a reference to the data module within the publication module.
S1000D: How Do You Get There?S 000 o o ou Get e e
Crossing the road to adoption
S1000D: Challenges of Adoption
What is Needed Details Impediments to successDeep knowledge of the • Knowledge of terminology,
understanding of S000DLearning curve
specification understanding of S000D concepts and coding rules
Defining the business rules so as to manage
• Learning to write to the datamodule paradigm
• New workflow methods to
Psychology of change, new methods, identifying
changes to the authoring environment
New workflow methods to support authoring, review, editing, and publishing cycle
what needs to change in an existing environment
Technical know-how • Knowing how to work with XML,publishing basics and IETP
Human resources, access t i ti i f tipublishing basics, and IETP
experience• Experience with a CMS
to existing information on the spec, etc
Technology infrastructure • Authoring Tools• CSDB
Flexibility, support, programming/macro• Publishing Engine
• APIs to Integrate with Other systems (LSAR/Parts/Wiring)
programming/macrolanguage capabilities, compliance to spec
File/data exchange • Subcontractors, OEMs, and Seamless data exchangeFile/data exchange between partners
, ,Service organizations must all adopt S1000D
Seamless data exchange between organizations
Best of Breed S1000D Implementation
PublishingProduct Lifecycle Management
Technical Content Development
Logistics Management
P d t
Client Applications
P t d tProduct information
PLM digital content
Part data
CSDBIETP
LSAR
Each of these applications representpp pcomplex processes and specific
expertise. No single vendor has the expertise to do all of it well.
Authoring is not Content Management
Some vendors try to simplify the requirements around S1000D by focusing on authoring toolsAuthoring is important, but does not address the major requirements associated with S1000D: DMRL creation DMRL creation DMC and ICN creation and management Publication module creation and management Data interchange using a DDN Data interchange using a DDN Multi-channel publishing outputs (PDF, IETP)
These tasks are performed by the IT department and ll i i t i i t ti ith th CSDBgenerally require intensive interaction with the CSDB
Find a good XML Editor for authoring and a good CSDB for the management of S1000D content—focus on built-in gfunctionality to handle the major requirements listed above
Why Publishing Matters
The publications your company creates can be the difference between life and death for users of your products! Publishing your content determines how internal and external customers use your contente te a custo e s use you co te tS1000D IETPs should provide state-of-the-art functionality: Run-time applicability filtering Support for CGM, TIFF, SVG, Flash, 3D images, wire tracing, animations,
simulations, virtual task training, digital photographs, and more Locator graphics (graphical navigation); Graphic-to-graphic, graphic-to-
text text to text and text to graphic linking capabilitiestext, text-to-text, and text-to-graphic linking capabilities Customizable “skins” and styles; open architecture Support for Process Data Modules and links to external applications R i i hi hli ht d i t l d t f ti lit Revision highlights and incremental update functionality Annotations and built-in problem reporting Audit trails and forms capabilities
S1000D Best Practices for Deployment
1 2 3 4Primary Responsibility
SDL W k hSDL W k h I l t tiI l t ti
Months
S t fi ti S t fi ti SDL Workshop(out-of-the-box)SDL Workshop
(out-of-the-box)Implementation
WorkshopImplementation
WorkshopSDL
Adoption, content reuse,Adoption, content reuse, Client Client
System configuration and deployment
System configuration and deployment
L S1000DL S1000D
Style sheetsfinalized
Style sheetsfinalized
Adoption, content reuse,and change managementAdoption, content reuse,and change management
CustomerBusiness Rule decisions (document and apply to BREX DM)Business Rule decisions (document and apply to BREX DM)
Setup and Setup and
Client sign offClient
sign offLearn S1000DLearn S1000D
LiveRelease!LiveRelease!
Install Configured SDL Install Configured SDL IT / Admin Setup and Configure Server
Setup and Configure Server
SDL or Consultant S1000D S1000D
Content Creation and ConversionContent Creation and Conversion
Install Configured SDL Server
Install Configured SDL Server
IETM StylesIETM StylesS1000D
Author TrainingS1000D
Author Training
Best Practices with Multimedia and Hot Spotting in S1000D
Michael Davis, Principal Business Analyst and S1000D SpecialistS1000D Specialist
Objectives
Hot-Spotting Techniques Graphic to Text p Text To Graphic Raster Graphic Ri ht H i h ( 3D ) Right Hemisphere ( 3D )
Locator Graphics using Flash or Right Hemisphere How to Link from the locator graphic directly to a Data Module How to Link from the locator graphic directly to a Data Module How to synchronize Live Content TOC after making selection on
Locator Graphic
XREF C tiXREF Creation Internal xrefs External refs Pub refs
Objectives Continued
Cover Applicability Creation and Maintenance Data Module Applicability and Content Applicability
• XML tagging including attributes ACT, CCT, and PCT Files
• Explanation of ACT, CCT, and PCT work + demonstration
New SDLTools for applicability creation• System assisted assertion statement building• System assisted creation and maintenance of Content ApplicSystem assisted creation and maintenance of Content Applic
Cover Multimedia/Figure Tagging and Attributes 3d Files – Light Weight 3d Models Vector Graphics – SVG and CGM Animation – Right Hemisphere, Flash, MPEG, MP4 Raster Graphics and Raster Image Maps Raster Graphics and Raster Image Maps Sound - MP3
Hot Spotting
Graphic to text linking capabilities for immediate retrieval of part/item information from an illustration Graphic Hotspots link directly to illustrated parts catalog or
task/procedure.
Hot Spotting – Creation of Hotspot
• Explanation Markup<hotspot
Hotspot id in the graphicHotspot name in the graphic
papplicationStructureIdent="hot000“ applicationStructureName="0“hotspotTitle="BICYCLE"
ID you assign to indentify hot spothotspotType="CALLOUT"id="fig-0001-gra-0001-hot-0000" objectDescr="BICYCLE" visibility="visible">
</hotspot>
Hot Spotting – Graphic to Text
ExplanationFill in id attribute on elements supported
Markup<para id="p-0">A bicycle Test</para>pp
by the following list of elements that support this functionality.
• For this example we are using internalref
p p y p
<hotspot applicationStructureIdent="hot000"
li ti St t N "0"applicationStructureName="0" hotspotTitle="BICYCLE" hotspotType="CALLOUT"
id="fig-0001-gra-0001-hot-0000" objectDescr="BICYCLE" visibility="visible">
<internalRef internalRefId="p-0" internalRefTargetType="para"Internalref markup inside hotspot points
to already id’d <para> element
internalRefTargetType para xlink:actuate="onRequest"
xlink:show="replace" xlink:type="simple"></internalRef>
</hotspot>
Hot Spotting – Graphic to Text
Hot Spots – Graphic to Text Graphic to text linking capabilities for retrieval of part/item p g p p
information from an illustration Allows immediate highlight of graphic callout or graphic object
Hot Spotting – Text to Graphic
Hot Spots –Text to graphic Text to graphic linking allows editors to create highlighted parts or g p g g g p
hotspots within a graphic in a simple manner Allows immediate highlight of graphic callout or graphic object
Hot Spotting – Text to Graphic
ExplanationHotspot has been created and the id has
Markup<hotspot p
been assigned at time of creationp
applicationStructureIdent="hot000" applicationStructureName="0" hotspotTitle="BICYCLE" hotspotType="CALLOUT"p yp
id="fig-0001-gra-0001-hot-0000" objectDescr="BICYCLE" visibility="visible">
</h t t>
Create internalref markup which points back to the hotspot using the hotspot id.
</hotspot><internalRef internalRefId="fig-0001-gra-
0001-hot-0009"internalRefTargetType="hotspot"internalRefTargetType hotspot
xlink:actuate="onRequest"xlink:href="#fig-0001-gra-0001-hot-0009"
xlink:show="replace"xlink:type="simple">Frame</internalRef>
Hot Spotting
Hot Spots – Graphic to Graphic Simple Linking to and from graphic to graphicp g g p g p
Hot Spotting – Graphic to Graphic
ExplanationHotspot has been created and the id has
Markup<hotspot p
been assigned at time of creationp
applicationStructureIdent="AUTOID_7900"applicationStructureName="hottographic"hotspotTitle="Graphic to Graphic"
h t tT "CALLOUT" id " 001">hotspotType="CALLOUT" id="gra-001">
<internalRef internalRefId="fig-0005" internalRefTargetType="figure"
Create internalref markup which points back to the figure using the fig id
internalRefTargetType figuretargetTitle="Derailler Pivot"></internalRef></hotspot>
Raster Graphics and Image Maps
Provides authors ability to utilize simple images and create hotspots without custom tools Image repository may contain images or photos that were not
derived from 3d
Raster Graphics and Image Maps
<figure>
<title>ICN-S92-A-702100-A-78286-00001-A-01-1_EN</title>
f C S
Object Coordinates are X and Y Placement
<graphic id="turbine1” infoEntityIdent="ICN-S92-A-702100-A-78286-00001-A-01-1_EN">
<hotspot applicationStructureIdent="h001" hotspotType="CALLOUT” objectCoordinates="228,60,326,143">
<internalRef internalRefId="hot001” internalRefTargetType="para"></internalRef>
Positions
</internalRef>
</hotspot>
<hotspot applicationStructureIdent="h002" hotspotType="CALLOUT” objectCoordinates="111,157,177,234">p pp p yp j , , ,
<internalRef internalRefId="hot2” internalRefTargetType="other">
</internalRef>
/h t t</hotspot>
</graphic>
</figure>
Benefits of 3D Graphics in S1000D Deliverables
Tells a Better Story Animations , Materials, Metadata, Interactive Vi A l R d M d C S ti M View any Angle, Render Modes, Cross-Section, Measure
Reduces Repair Time & Costs Simplifies complex tasks & processes Easier to understand & comprehend Higher retention of information from interactive 3D content
Reduces Localization Costs Better graphical content delivered = less text written & translated!
Enables Change Management Allows easy updating of content when changes occur in Engineering Auto updating if connected to original Engineering data source.
3D Support with Right Hemisphere
Deep View control embedded with LiveContent IETP Viewer Integration between Right Hemisphere Deep View and Live g g p p
Content IETP allows Steps to be called out from pub to graphic
Right Hemisphere
LiveContent/Right Hemisphere Integration allows text exchange between DMC and 3d Graphic Tasks and Procedures Animations driven from within 3d model or IETP
Step position
3D Support with Right Hemisphere
Great For IPD Single graphic can cover entire parts list for IPDg g p p
Locator Graphic
LiveContent Flash Integration provides use of interactive Locator graphics allowing users to easily drill down through a graphic and find the system, procedure, or task
Locator Graphic
LiveContent example of user Mouse Over Flash API using javascript calls to interact with Table of Contents
Locator Graphic
LiveContent example of a mouse click on the system or subsystem being researched will display a detail view of that system and opens the TOC (Table of Contents pane on the left) to the appropriate document unit
Applicability Creation and Maintenance
Applicability is one of the most confusing parts of S1000D Employing it correctly is very difficult Reduction of errors during maintenance due to concise interactive
illustrations and multimediaillustrations and multimedia In countries where English is not the primary language technicians
can follow intuitive interactive illustrations and rely less upon the written word increasing technician effectivenesswritten word increasing technician effectiveness
Cutting Costs Intelligent Interactive graphics and media objects reduce the g g j
amount of technical authoring narrative needed for support of complex tasks and procedures
Reduction in narrative text leads to fewer written words increasing gauthor productivity while reducing the cost of localization
Applicability in Action
Updated Contenta S1000D Arbortext Plug-in with Applicability Assistant Create Applic without having to
handcode!! Assert Statement Builder Update ACT, CCT, and PCT
tables from Plug-in Access saved applic settings at Access saved applic settings at
any time Apply settings from within Editor Real Time Preview of Applic
settings.
Applicability in Action – Modified Menu
New Plug-in Choices Manage Applicabilityg pp y
• Allows the user to create and modify applic
Assign Applicability• Allows users to assign pre-
created applic statements
Applicability in Action – Manage Applic
New Applic Screen Initial Screen as you enter from y
menu New Button allows you to create
new applicability statements M dif ll t dif Modify allows user to modify
existing statement XML Preview actually shows the
current tagging
Applicability in Action – Build Applic
Applicability Plug-in Editor can select from all pre-p
configured applics or build a new applic
Editor can create “And” or “Or” conditionsconditions
New or Old Applic statements are easily modifiable
Applicability in Action – Updated XML
XML is updated When editor presses insert xml p
button the newly created/modified XML is inserted into the checked-out data module.
Author has just built complex Author has just built complex assert tagging.
Why Use Multimedia in S1000D
Supporting the Technician in the field A picture is worth a thousand wordsp Reduction of errors during maintenance due to concise interactive
illustrations and multimedia In countries where English is not the primary language technicians In countries where English is not the primary language technicians
can follow intuitive interactive illustrations and rely less upon the written word increasing technician effectiveness
Cutting CostsCutting Costs Intelligent Interactive graphics and media objects reduce the
amount of technical authoring narrative needed for support of complex tasks and procedures
Reduction in narrative text leads to fewer written words increasing author productivity while reducing the cost of localization
Multimedia Authoring and Publishing
Tool Requirements Ability to easily create Hot Spotted Graphics and Videosy y p p Utilization of 3d Technology
• Interactive callouts• Step Driven Animation• Step Driven Animation• Zoom, Rotate, Explode on demand • Ability to change views ( shaded, wireframe,
API i iti l• API is critical Viewers and Sound Players
• Defined as part of Project• Cost and Distribution Rights are critical
S1000D Multimedia Practices
Multimedia in terms of S1000D Objects used to support presentation of Textual Data and must be j pp p
considered secondary and not used in place of verified text Recommended that all multimedia objects are built in individual
parts. A portion of a media object that carries out a specific pa ts po t o o a ed a object t at ca es out a spec cfunction, eg sounds, images, action codes or video sections, can be used alone or combined with other parts
Indication that the media object is loading and it’s progress mustIndication that the media object is loading and it s progress must be visible to the user
Original material must be maintained in it’s native form for reusabilityreusability
Audio
Audio can be a sound track, audible effect, or pure narrative heard to support, warn, and clarify procedure or diagnoses steps and actions Natural Sounds to clarify result of actions
• Bearing working well versus bearing making a sqeaking noise
Audio that will enhance video, adding information required in performing the desired actions
User controlled audio narration from validated S1000D DM’s to enhance user understanding
Aural warnings and audible alarms • Flight deck• Procedural crew
Audio Tagging Example
<multimedia id="med-001">
<multimediaObject id="medobj-001” infoEntityIdent="ICN-S1000DBIKE-AAA-D000000-0-U8025-00600-A-04-01"multimediaType="audio" showPluginControls="show" xlink:actuate="onLoad"
“Sxlink:show="replace" xlink:title=“S1000D Rocks - Audio Test">
</multimediaObject>
</multimedia>
<para>Since it can be boring to tag xml all day we give you a multimedia example featuring
<internalRef internalRefId="medobj-001" internalRefTargetType="multimediaobject"targetTitle="Blue Oyster Cult Test" xlink:href="medobj-001">
</internalRef>
</para>
Video
Video – Definition Video in S1000D Issue 4.0.1 means real life moving images of
• Equipment actions• Procedural steps• Captured live events
Generally linked not embedded within other media objects
S1000D in ActionS1000D in Action
Mike Davis, Principal Business Analyst and S1000D Specialist
What we’re going to demonstrate
Deliver Electronically
PublishManage and Automate
Author
Publishing Output
Type 2 Interactive Electronic Technical Manuals
LiveContent P bli hi
CCM/CSDB
LiveContent
Publishing Server
XML Professional
Publisher
Contenta S1000D
ORACLE
Editorial W kfl
Check in/outXML DB
ArbortextWorkflow
Type 1 Paper/PDF Technical Manuals
Data Module(s)
XSL-FO
Arbortext Editor
RoundtableRoundtable
Moderator: Lou Iuppa
Panelists: Mike Cook, Mike Davis and YOU!
Webinars, Workshops and Wrap UpWrap Up
Lou Iuppa, VP Business Development
Where can I go from here?
SDL – “Your Source for S1000D Information” SDL S1000D Resources Page (handout) SDL S1000D Resources Page (handout)
• http://www.sdl.com/S1000DResources SDL’s Educational S1000D Recorded Webinars Series/Archive
SDL S1000D S ifi i Ed i S i SDL S1000D Specification Education Series Ask an S1000D Expert™ Tour Upcoming Events – Webinars, Conferences, Tours p g
• http://www.sdl.com/en/xml/events/• Webinar Series: S1000D Applicability Boot Camp
– Part 3: The CCT Data Module – November 9Part 3: The CCT Data Module November 9 On-Site S1000D Workshop
SDL S1000D Online Webinar Recordings
5 Part SeriesPart 1 – S1000D Alphabet Soup: Introduction to S1000D Concepts
Part 2 S1000D Content WorkflowPart 2 – S1000D Content Workflow
Part 3 – S1000D Applicability
Part 4 - S1000D Interactive Electronic Register and View ALL the Recorded
Technical Publications (IETP)
Part 5 - S1000D and Multimedia
ALL the Recorded Events!
http://www.sdl.com/en/xml/resources/resources-by-topic/topic-s1000d.asp
SDL S1000D Specification Education Series
Introduction to S1000D S1000D – An In-Depth Explorationp pAuthoring and Editing for S1000DChange Management (Editing/QA Cycle/Workflow)Front Matter – An Exploration of the PossibilitiesApplicability – An In-Depth Exploration of its Inner WorkingsWorkingsCommon Source Data Base (CSDB) – What It Is, What It Can Do, What You Need to KnowProject Startup for S1000D
Industry Conferences, Groups
Industry Conferences S1000D User Forum S1000D User Forum
• http://www.ataebiz.org/forum
AIA Techpubs Conference, Clearwater, FL – each May
S d U GSpecs and User Groups Download the S1000D Spec – for a little light reading!
• http://public s1000d org/Downloads/Pages/S1000DDownloads aspxhttp://public.s1000d.org/Downloads/Pages/S1000DDownloads.aspx
S1000DPC™ User's Group • http://www.s1000dpc.com/
LinkedIn “S1000D Users” Group LinkedIn – S1000D Users Group
S1000D Workshop
Objectives Gain a high level
understanding of the S1000Dunderstanding of the S1000D specification
Experience the project planning process
Create S1000D content Manage content in a CSDB Publish an interactive
electronic technical manual (IETM)
Lay foundation for business case
Prerequisites Team has XML authoring skillsg Executive sponsor identified,
and available for opening and close of workshop
Wrap Up
Evaluation FormLiteratureLiteratureSurvival ToolBuddiesBuddies
Contact Us!