ENHANCING THE IETP USER EXPERIENCEMichael Davis – Principal Business Consultant

SDL Proprietary and ConfidentialSDL Proprietary and Confidential

Di IETP/IETM A hit t

Objectives

• Discuss IETP/IETM Architecture• Discuss and Demonstrate S1000D tagging techniques to improve

technician experience– Learn how to locate information quickly– Interact with CGM/Vector, Raster, and 3D graphics

Hotspot element explained and demonstrated– Hotspot element explained and demonstrated– Legend element explained and demonstrated

• XREF Creation– Internal xrefs– Pub RefsC t F S t• Custom Form Support– Learn and demonstrate how to create and execute a custom form within LiveContent

• E.G. – AFTO 22, Customer Satisfaction Form, Warranty Form

2

Objectives - Continued

• Hot-Spotting Techniques –Graphic to Text –Text To Graphic–Graphic to Graphic–Raster Graphic–Raster Graphic–Right Hemisphere ( 3D )

• Locator Graphics using Flash or Right Hemisphere–Explanation of Locator Graphic

• What is it?

• How does help my Technicians?• How does help my Technicians?

–How to Link from the locator graphic directly to a Data Module–How to synchronize Live Content TOC after making selection on

L t G hiLocator Graphic

3

IETP/IETM Viewer – Explanation

• What Does IETP/IETM stand for?– IETP – Interactive Electronic Technical Publication

IETM Interactive Electronic Technical Manual– IETM – Interactive Electronic Technical Manual

– What is an IETP • In Terms of S1000D an IETP is built up of front matter and a series of data modules and/or

publication modules organized into a single publication module representing a document Apublication modules organized into a single publication module representing a document. A publication module can contain references to Data Modules or already assembled publication modules allowing authors the ability to reuse content at both micro and macro levels. Different vendors and organizations have created IETP publishing tools that utilize various types of technology.

– How is an IETP created? • A publication module is created and then transformed into a web or machine deliverable

electronic publication.

H d IETP k?– How does an IETP work?• Once the publication module has been transformed into a Web or Machine deliverable, the

IETP executes on a server and delivers content via the web, or executes on a native device and presents front matter, a table of contents, and all of the technical information traditionally

t i d ithi l

4

contained within a paper manual.

What is LiveContent?

• LiveContent is SDL’s IETP which enables you to deliver intelligent content via the web or CD-ROM

P XML t t d t d t th h d li f t t– Preserves XML structure and metadata through delivery of content– Powerful Applicability engine, engineered to personalize a user’s content– Rendering on-the-fly to formats such as HTML, PDF, or others– Configurable search engine with advance search and targeted category

searches for data mining– Interactive Troubleshooting / Diagnostics Engine that can gather user input

and react intelligently– Intelligent graphics to help where needed– Gathers XML audit trails to learn about how users are consuming the data and

for compliance checking– Push out incremental updates to keep user’s data current and accurate– AND much more…

5

LiveContent Architecture

XQuery

• Content stays in native XML format until instant

XML

XQuery

XSLT(filtering) On many devices

until instant delivery—leverages your investment in XML, metadata and structure

Database / Repository Searching

XPath

• API allows other systems to integrate easily

APIXPath

Other toolkit / API functionality:

Integrate toolkit with,or provide data to,external servers

• Web interface can be configured and skinned to meet

t ti-Audit trail

-Capturing user input

-Incremental updates

external serversand services

your presentation requirements

-Much more

Access it all through a skinned web interface

CGM Hot Spot Info

• ID, Name, and Type of Hotspot are available within CGM viewers and can be part of the graphic or accompanying info

applicationSt ct eIdentapplicationStructureIdent

applicationStructureName

7

Hot Spotting – Creation of a hotspot

• Explanation • Markup<hotspot

Hotspot id in the graphic

Hotspot name in the graphicapplicationStructureIdent="hot000“

applicationStructureName="0“

hotspotTitle="BICYCLE"

ID you assign to indentify hot spot

hotspotTitle BICYCLE

hotspotType="CALLOUT"

id="fig-0001-gra-0001-hot-0000"

objectDescr="BICYCLE" visibility="visible">

</hotspot>

8

HotSpotting – Graphic to Text

• Explanation• (Text ID) Where the pointer shows up

• Markup<para id="p-0">A bicycle Test</para>

• Fill in id attribute on elements such as para’s, steps, etc with a unique id. The unique id is then used to identify the element you wish highlight when the

<hotspot applicationStructureIdent="hot000" applicationStructureName="0" hotspotTitle="BICYCLE"y g g

hotspot is selected

• (HotSpot ID) Unique Identifier for hotspot element.

hotspotTitle BICYCLE hotspotType="CALLOUT"

id="fig-0001-gra-0001-hot-0000" objectDescr="BICYCLE" i ibilit " i ibl "

• For this example we are using the <internalRef> element to point to the area of text we wish to show when the graphic

visibility="visible">

<internalRef internalRefId="p-0" internalRefTargetType="para" xlink:actuate="onRequest"text we wish to show when the graphic

hotspot is selected. The <internalRef> markup inside the <hotspot> element points to a <para> element with that id attribute value as defined in the “internalRefId”

xlink:actuate onRequest

xlink:show="replace" xlink:type="simple"></internalRef>

</hotspot>

9

value as defined in the internalRefId attribute.

</hotspot>

HotSpotting – Graphic to Text

• Hot Spots – Graphic to Text–Graphic to text linking capabilities for retrieval of part/item information

from an illustrationfrom an illustration

10

HotSpotting – Text to Graphic

• Explanation• Hotspot element is defined and its id

attribute value is assigned at time of

• Markup<hotspot

applicationStructureIdent="hot009" creation within the data module. applicationStructureName=“9"

hotspotTitle="BICYCLE" hotspotType="CALLOUT"

id="fig 0001 gra 0001 hot 0009"id= fig-0001-gra-0001-hot-0009 objectDescr="BICYCLE" visibility="visible">

</hotspot>

• Create markup for the <internalRef> element to point back to the hotspot using the hotspot id attribute (fig-0001-gra-0001-

<internalRef internalRefId="fig-0001-gra-0001-hot-0009"

internalRefTargetType="hotspot" hot-0009) and putting it in the “internalRefId” attribute. This <internalRef> can appear anywhere within the <content> section where it is allowed. Generally within

g yp pxlink:actuate="onRequest“xlink:href="#fig-0001-gra-0001-hot-0009" xlink:show="replace”xlink:type="simple">Frame</internalRef>

11

the <para> element, but it is available within many other elements too.

y

HotSpotting – Text to Graphic

• Hot Spots – When the user clicks “Frame” hotspot Number 9 on graphic lights up

9

12

HotSpotting – Graphic to Graphic

• Explanation• Hotspot is defined and an id is assigned at

time of creation Use the same attributes as

• Markup<hotspot

applicationStructureIdent="AUTOID_7900“li ti St t N "h tt hi "time of creation. Use the same attributes as

in “text to graphic” and “graphic to text”. However, in this case, we won’t be linking back to the hotspot since we want to link to the graphic instead

applicationStructureName="hottographic"

hotspotTitle="Graphic to Graphic" hotspotType="CALLOUT" id=“fig-0001-gra-0001-hot-0001">

the graphic instead.

• Create an <internalRef> element within the <hotspot> element block to point to the figure you want your hotspot to activate.

<internalRefinternalRefId="fig-0005" internalRefTargetType="figure“targetTitle="Derailler Pivot">

/i t lR fg y y p

Use the “internalRefId” attribute to point at the <figure> element with the same id you want to use. Note: this example points to a figure within

</internalRef></hotspot>

<figure id="fig-0005"><title>ICN-S1000DBIKE-AAA-DA51000-0-U8025-

00521 B 04 1 /titlp p g

the same data module. 00521-B-04-1</title>

<graphicinfoEntityIdent="ICN-S1000DBIKE-AAA-

DA51000-0-U8025-00521-B-04-1“/>

13

</figure>

HotSpotting – Graphic to Graphic

• Hot Spots – Graphic to Graphic–Simple Linking to and from graphic to graphicp g g p g p

14

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

15

Raster Graphic Markup Explained

• Explanation • Markup<figure id=“fig-0001”>

<title>ICN-S92-A-702100-A-78286-00001-A-01-1_EN</title><graphic

• Hotspot element contains objectCoordinates attribute which allows you to specify where the hotspot will

<graphic id=“gra-turbine1” infoEntityIdent="ICN-S92-A-702100-A-78286-00001-A-01-1_EN">

<hotspot id=“fig-0001-gra-turbine1-hot-0001”applicationStructureIdent="h001“hotspotType="CALLOUT” objectCoordinates="228 60 326 143">you to specify where the hotspot will

appear.objectCoordinates= 228,60,326,143 >

<internalRefinternalRefId="h001” internalRefTargetType="para“/>

</hotspot>

• <internalRef> element has the

<hotspot id=“fig-0001-gra-turbine1-hot-0002” applicationStructureIdent="h002" hotspotType="CALLOUT” objectCoordinates="111,157,177,234">

<internalRefinternalRefId="h002”• <internalRef> element has the

“internalRefId” attribute which points to the “applicationStructureIdent” attribute of the <hotspot>.

internalRefId="h002 internalRefTargetType="other“/>

</hotspot></graphic>

</figure>

16

Custom Form Support

Provides IETP authors/creators the ability to create custom data entry forms quickly and easily.Accessible from LiveContent Resource Manager Menu–Accessible from LiveContent Resource Manager Menu

–Add, Edit, and Delete are all standard functionality

17

Custom Form Support

Relieves field technicians from paperwork–Easily tracked by LiveContent Audit Trail support

18

Generic Forms - Simple Coding Rules<?xml version="1 0"?><?xml version= 1.0 ?><generic_form><idstatus>

<name>genform1</name><title>Customer Satisfaction Form</title><height>500px</height><height>500px</height><width>700px</width><scroll>1</scroll>

</idstatus><content>

l b l<label>Were you satitisfied with the bicycle, and with this electronic technical manual?</label><label>All fields marked with a * are required.</label><input type="text" id="first_name" label="First Name *" required="true"/><input type="text" id="middle_init" label="Middle Initial" size="1" maxlength="1"/><input type="text" id="last_name" label="Last Name *" required="true" size="48"/>

<input type="select" id="satisfied" label="Satisfied? *" required="true" ><option label="" value=""/><option label="Yes" value="yes"/><option label="No" value="no"/>

</input>

19

p<input type="textarea" size="60" height="10" id="comments" label="Your Comments" required="false" default="Please add your comments here."/>

</content></generic_form>

Benefits of 3D graphics in S1000D Electronic Deliverables

• Tells a Better Story– Animations , Materials, Metadata, Interactive– 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.

20

3D Support via Right Hemisphere Deep View

• Deep View control embedded with LiveContent IETP Viewer

– Integration between Right Hemisphere Deep View and Live Content IETP allows Steps to be called out from pub to graphicbe called out from pub to graphic

21

3D - Animations

• LiveContent/Right Hemisphere Integration allows text exchange between DMC and 3d Graphic

– Tasks and Procedures Animations driven from within 3d model or IETP Step positionTasks and Procedures Animations driven from within 3d model or IETP Step position

22

3D – IPD Support greatly simplified

• Great For IPD

– Single graphic can cover entire parts list for IPD

23

Locator Graphic – What is it and how does it enhance user experience?

• Locator graphics are intelligent/interactive graphical objects which allow users the option to visually drill down through a graphic and find the system, assembly, or part they wish to locate.

24

Locator Graphic – Continued

• LiveContent example of Mouse Over Flash API using javascript call to load the appropriate Data Module and refresh the Table of Contents

25

Upcoming Sessions

S1000D in Action Series

Session 1: How to Use the BREX Builder [recording]Session 1: How to Use the BREX Builder [recording]

Session 3: The Power of Applicability 4/25/2012

Session 4: Project Workflow Management 5/17/2012

Session 5: Building and Delivering Publications 6/28/2012 g g

Session 6: Enhancing the Clarity and Language Quality of Technical Documentation Not yet scheduled

Register at www.sdl.com/xml under Eventsg

Q & A

Got questions?

Thanks for joining us!

Copyright © 2008-2012 SDL plc. All rights reserved.. All company names, brand names, trademarks, service marks, images and logos are the property of their respective owners.

This presentation and its content are SDL confidential unless otherwise specified, and may not be copied, used or distributed except as authorised by SDL.