s1000d compliant technical illustrations

Guest Presenter David Manock – President

S1000D Component

2D Technical Graphics

Copyright Vizualsite LLC 2015

Overview

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

and composite vector/raster picture definition since 1987.

2D Technical Illustrations/Graphicsand the S1000D Specification


Introduction

The topic can be spilt into 3 main sections:

• Authoring• Illustration Rules

• Identifying• Information Control Number

• CGM (Computer Graphics Metafile)• Meta-data

• CGM Profile

• Big thank you to Larson Software Technology, the CGM Experts, for their assistance with this section


http://www.cgmlarson.com/

Authoring - S1000D Specification

• 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

• 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


Authoring – Mode of Presentation

• 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


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?


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


Authoring - 3D

• 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 verified and authoritative

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

• The 3D graphics must contain appropriate warning's and cautions when parts are removed

• 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


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 • Aligned to the project and the equipment


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 - 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 measured against

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

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

ISO/IEC 8632-1 (1999-12-15) CGM

Model Profile Edition 2

WebCGM Profile Edition 2.1

S1000D Profile




CGM - Properties

• Interoperability• 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 - Properties 2

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

graphical objects including ellipses, circles, bezier curves to be preserved

• Graphics have to communicate a technical message, usually in black and white

• 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


CGM – Structure

• The CGM file should only containgraphical objects

• However a file can contain industry specific Metadata

• Exceptions include Object ID’s andhotspot regions

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


CGM Editing

Technology• The software tools to enable generation and revision of

graphics is a key production requirement

• The tools require ease of useand compliance to CGM profiles

• Generation & Revision• Auto-Trol TI

• CorelDraw Technical Suite X6

• PTC Arbortext IsoDraw (CGM Mode)

• VizEx Edit (Native CGM)

• Cortona2d Editor Pro

• Leonardo S1000D


http://www.auto-trol.com/tech-illustrator-overview




http://www.coreldraw.com/us/product/technical-communication-software/?sso_test=true

http://www.ptc.com/product/arbortext/author/isodraw

http://www.cgmlarson.com/VizEx_Edit_CGM.shtml

http://www.cortona3d.com/cortona2d-editorpro

http://www.vizualsite.com/products/technical-illustration/leonardo-s1000d

CGM – Viewing

• Deployment of CGM files on the web currently relies on plug-in technology

• 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


Poll

What file formats does your organization currently use in the graphics production process?

CGM (Computer Graphics Metafile) SVG (Scalable Vector Graphic) EPS (Encapsulated Postscript File) AI (Adobe Illustrator) Other


CGM – Additional Resources

• NIST• National Institute of Standards and Technology

• ISO/IEC 8632-1:1999• ISO (International Organization for Standardization)

• W3C • WebCGM Profile

• WebCGM DOM

• Linkedin• CGM Open

• S1000D Users


http://www.itl.nist.gov/div897/ctg/graphics/cgm_std.htm

http://www.iso.org/iso/home/store/catalogue_tc/catalogue_detail.htm?csnumber=32378



http://www.w3.org/TR/2010/REC-webcgm21-20100301/WebCGM21-DOM.html

http://www.w3.org/TR/2010/REC-webcgm21-20100301/WebCGM21-DOM.html

https://www.linkedin.com/groups?home=&gid=6792279&trk=my_groups-tile-grp

https://www.linkedin.com/groups?home=&gid=58182&trk=my_groups-tile-grp

Summary and Conclusions

Take Away: Graphics are a significant component of an S1000D project

• Authoring • Follow the S1000D illustration rules and your graphic representation will be

consistent

• 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 vector graphics in the specification

• Choose software that is capable of creating compliant CGM’s


s1000d compliant technical illustrations

Education