Compliant S1000D Illustrations NEW

A Larson Informational WebinarCompliant S1000D Illustrations - NEW

Thursday 8th September 2016

David Manock – President – Vizualsite [email protected]

www.vizualsite.com

Presenter:

www.cgmlarson.comCopyright Larson Software Technology (c) 2016

Don Larson – CEO – Larson Software [email protected] www.cgmlarson.com

Introduction:

http://www.vizualsite.com/

http://www.cgmlarson.com/

http://www.vizualsite.com/

Webinar - Housekeeping

• All attendees will be muted for the duration of the Webinar• If you experience problems when joining the webinar please

use the questions function to communicate• VOIP is the recommended audio option• Questions during the webinar can be posted• Questions will be answered at the webinar in the Q&A session• Please vote in the interactive Poll,

it is easy and private• The results will be live!



Interactive Polls


• At appropriate times during the webinar we will conduct a interactive Poll

• The results will immediately follow the vote!• Questions:

1. Does your organization currently create illustrations for an S1000D project?

2. Does your organization originate 3D graphical data for your manuals?3. What graphic types does your organization currently use in the

publishing process?4. Does your S1000D project hotspot the CGM graphics? Engage



Larson Software Technology

• Based in Houston, Texas• Founded in 1984, Graphics and CGM Experts for 30 years• Develop powerful, innovative CGM graphics software,

based on open standards• Promoting CGM Usage, VizEx Reader a free CGM and

TIFF viewer• Member of the CGM Open Foundation• Larson technology simplifies the graphics workflow for

Geologists, Geophysicists, Technical Publications Professionals and Engineers.


Overview


• 2D CGM: Computer Graphics Metafile • an ISO (International Organization for Standardization) standard for

vector and composite vector/raster picture definition since 1987. • 3D computer graphics

• utilize a three-dimensional representation of geometric data, stored in a computer for the purposes of performing calculations and rendering 3D images.

2D and 3D Technical Illustrations/Graphicsand the S1000D Specification

Part of Larson’s build up to the 2016 S100D User ForumFurther Details: www.s1000d.org

Seville, Spain


Introduction


We have split the webinar into 4 main sections: Based on Specification - Issue 4.1

• Identifying Data• Information Control Number

• Authoring 2D Illustrations• Illustration Rules

• CGM (Computer Graphics Metafile)• Meta-data• CGM Profile

• Authoring 3D Content• Interactive 3D



Poll #1



Authoring 2D S1000D Illustrations



• Chapter 3.9.2 - Authoring - Illustration rules and multimedia• Chap 3.9.2.1 Illustration rules and multimedia - Illustrations, General• Chap 3.9.2.2 Illustration rules and multimedia - Navigation and configuration• Chap 3.9.2.3 Illustration rules and multimedia - Use of color and photographs• Chap 3.9.2.4 Illustration rules and multimedia - Multimedia, General• Chap 3.9.2.5 Illustration rules and multimedia - Interactive 3D content• Chap 3.9.2.6 Illustration rules and multimedia - e-learning• Chap 7.3.3 CSDB objects – Multimedia• S2000M International specification S2000M for materiel management -

Integrated data processing for military equipment

Authoring – S1000D Specification



Authoring

• 3.9.2.1 – Illustration’s General



Authoring – Primary Rules of Illustration

• Illustrations must communicate to the user in a simple, clear and economical way

• Visually enhance the technical information required by the user to perform the intended task

• Prepared in accordance with the text and other information in data modules• The end user receives the maximum amount of information



• The advised presentation format for print is portrait orientation• Foldouts and landscape orientations are allowed as exceptions but require

defining in the project business rules

• The presentation of illustrations in an IETP/M (Interactive Electronic Technical Publication/Manual) is not governed by the same rules• However consideration must be given if the IETP has print capability• The ability to print becomes a bigger challenge if you include 3D data

Authoring – Mode of Presentation



Authoring – Illustration Rules Objectives

• Consistent illustration appearance• Line weights• Line styles• Annotations• Symbols• Perspective Projection – Isometric• Illustration/Page Size

• Clear and concise information• Extraneous data removed• Usually Monochrome• Use Color when clarity is required • BRDP-S1-00029 –

Use of color in the final deliverable?

Business Rules Decision point



Authoring – Color

• 3.9.2.3 - Use of color and photographs



Authoring – Use of Color

• The Specification defines the use of color• Specific color palette

• Provides very good examplesof using color in illustrationsand photographs

• The use of color on the exampleillustration denotes ahierarchical structure• Light Blue – parts on this illustration• Grey – Parts shown on subsequent illustrations,

see the detail arrows for navigation



Poll #2



Authoring – 3D ContentS1000D Interactive Content



Authoring – 3D Content

• 3.9.2.5 – Interactive 3D Content



Authoring – Interactive 3D Content

• The Chapter provides basic guidelines for the use of 3D interactive graphics

• The production of 3D content must be from a verified and authoritative source

• 3D information usage is recommended where procedures are complex and users will benefit from the visualization

• Currently there is no recommended file format for 3D delivery• The S1000D Model Based Enterprise (MBE) Task Team (TT) are

working to define more detailed guidelines for 3D content • Issue 4.2?



3D – Media types

• Definition: 3D images dynamically generated from engineering models or other production systems

• 3D data is usually going to be included in an IETP (Interactive Electronic Technical Publication)• If a 2D printed manual is required, how is the 3D data rendered

• When should you use 3D data?• Clarify complex maintenance assembly and disassembly procedures• Enable the viewing of hidden equipment information• When interactive information benefits the user• Use instead of textual information



3D – Production of Interactive Content

• 3D data must be generated and produced from the original validated engineering models• Removed parts must remain in view throughout the maintenance procedure• Call-outs and navigation icons must not move during animation sequence• The removal of parts and use of tools must be rendered realistically• When moving parts or actions are animated:• Appropriate warnings and cautions must be displayed• They should also have the ability to be acknowledged by the user before proceeding• Option to use textual data to warn the user before the animation begins



3D – Use of Color

• Rules and techniques for applying color to 3D graphics• Refer to Chapter 3.9.2.3 for the rules on how to apply color• Red should be used to emphasize critical objects or information• Color rules do not apply to realistic rendered surfaces• 3D tools/heavy objects must have an amber surface• Hidden objects for removal must appear light blue• All color applied to 3D objects must add value to the users• All navigation symbols must be blue and remain static• Black line art with a light blue fill can be used to identify detail items

• Takeaway - There is a heavy dependency on the software when achieving the S1000D requirements for 3D data



Identifying 2D S1000D Illustrations



Identifying – S1000D Specification

• Chapter 4.4 – Information Management – Information Control Number



Identifying – Information Control Number

• Data Modules are all assigned a unique code similarly multimedia objects including illustrations require an ICN code

• BRDP-S1-00345 - Presentation of ICN within the illustration reproduction area:• Decide whether the ICN is presented within the illustration reproduction area• If the decision is to display the ICN it must be placed in the lower right hand

corner of the figure

• A multimedia object or Illustration can be used in multiple Data Modules without being recoded



Identifying – ICN Decision Points - CAGE

• What ICN Structure should I choose? (BRDP-S1-00344)• CAGE or MODELIC?

• CAGE based, less complex – 5 to 10 Characters

• This method will not identify the object with the project or equipment



Identifying – ICN Decision Points - MODELIC

• MODELIC based code more complex (Model Identification Code) • Aligned to the project and the equipment• Provides granularity



Demo CSDB(Common Source DataBase)



Poll #3



CGM (Computer Graphics Metafile)



CGM – S1000D Specification

• Chapter 7.3.2 CSDB Objects - Graphics



CGM – Introduction

• Computer Graphics Metafile (CGM)• 2D Open Graphics format• Not owned, non-proprietary

• Managed by the CGM Open Foundation• www.cgmopen.org

• The CGM format first appeared in the 1980‘s• The format was widely supported many graphics based applications

• WebCGM profile developed specifically for web delivery and adopted by the S1000D Specification www.s1000d.org• Requires plug-in technology in a web browser to view CGM files• W3C - http://www.w3.org/Graphics/WebCGM/


http://www.cgmopen.org/

http://www.s1000d.org/

http://www.w3.org/Graphics/WebCGM/


CGM – Introduction (Cont)



CGM – Profiles

• CGM Profiles provide the mechanism for complying to specific industry specifications, S1000D, ATA iSpec 2200, PIP• Profiles can be thought of as rules the graphic is validated against• http://www.w3.org/Graphics/WebCGM/

• Profiles can also cascade providing multiple levels of validity• e.g. in the scenario below S1000D


http://www.w3.org/Graphics/WebCGM/


CGM – Benefits 1

• Interoperability• Very good graphics data interchange capabilities are

fundamental when mitigating risks on S1000D and ATA iSpec 2200 projects

• Program costs can significantly increase if the data is not interoperable

• Interactivity• Graphical Hotspots provide user with enhanced

experience

• Usability and Reusability• Files have to be easy to edit and reuse



CGM – Benefits 2

• Graphical Attributes• Graphics with long life cycles require the ability to retain the structure of

graphical objects including ellipses, circles, bezier curves• Possible use CGM as an archive format

• Text Attributes• The text requirements are typically low for technical graphics

• Typefaces are usually are not diverse, predominantly Helvetica • The ability to constrain text size and formatting is important

• Metadata (inside the file)• Requirements are low, hotspot region and ID information• XML companion files can contain additional information



Poll #4



Demo VizEx Edit



CGM – Delivery (IETM)

• The CGM file should only containgraphical objects

• However a file can contain industry specific Metadata• Exceptions include Object ID’s and

hotspot regions

• All other non-graphical datashould be contained in a XML companion file



CGM – Viewing Technology

• Deployment of CGM files on the web uses plug-in technology and now an HTML5 option

• The publishing of CGM files in IETP/M (Interactive Electronic Technical Publication/Manual) is therefore dependent on a viewer

• The publishing of CGM files as part of a printed manual is dependent on various technologies• Print of individual CGM files is also possible from

the illustration and text editing solutions



Demo VizEx View HTML5



Summary and Conclusions

• Graphics are a significant component of an S1000D project • Authoring 2D and 3D

• Follow the S1000D illustration rules and your graphic representation will be consistent• Consider what software you will use to create and deliver the 3D files

• Identifying• Choose the appropriate ICN Structure• The MODELIC option should be mapped to the Data Module Code

• CGM • CGM is the correct and only choice for 2D vector graphics in the specification• Choose software that is capable of creating compliant CGM’s


Q&A




Closing Information

Thank you for attending

• Supporting Information• Compliant S1000D Illustrations – 2nd Edition• CGM Infographic

• Webinar Materials can be downloaded:• http://www.slideshare.net/DonLarson1

• Next Event: The 2016 S1000D User Forum • September 26th – 29th , Seville, Spain.


http://www.slideshare.net/DonLarson1

http://www.s1000duserforum2016.com/