S1000D Compliant Illustrations 2018 - Part 1

S1000D Compliant
Illustrations 2018 - Part 1
July 18th 2018
11am Eastern Time, USA
Presenter – David Manock
Larson Software Technology
Welcome to the Webinar
We will begin shortly
www.cgmlarson.com
Copyright Larson Software Technology (c) 2018

www.cgmlarson.com
Agenda
• Introduction
• Housekeeping
• Company Overview
• Slide Presentation and Demos
• Summary
• Q & A
• Closing Information

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
• Computer Audio is the recommended option
• We have some product data sheets available in the Handouts
section, drag and drop to download, at anytime
• Post questions during the webinar using the panel
• Questions will be answered following the main presentation
or by email
www.cgmlarson.com

www.cgmlarson.com
Larson Software Technology
• Based in Houston, Texas, USA
• Founded in 1984, graphic technology experts for 30 years
• We develop powerful, innovative graphics software and
toolkits, based on open standards
• Promoting CGM usage, by providing VizEx Reader a free
CGM and TIFF viewer
• Developer of the first HTML5 CGM viewer, no plug in!
• Member of the CGM Open Foundation
• Larson technology simplifies the graphics workflow for
Technical Publications Professionals, Engineers,
Geologists, and Geophysicists
• www.cgmlarson.com

Introduction S1000D Specification
www.cgmlarson.com
• The S1000D Specification was
introduced in the 1980’s
• The main concept was to hold
information in a modular form,
Data Modules
• The objective, a more flexible method of
managing and publishing technical documentation
• Today, S1000D is widely adopted and accepted globally as a standard
method of producing technical documentation
• Graphics and multimedia are critical S1000D components, they have
their own unique requirements

Introduction – S1000D Illustrations
www.cgmlarson.com
We have split the webinar into 3 main sections:
• Authoring
• Illustration Rules - Comparison 4.1 to 4.2
• Identifying
• Information Control Number
• Managing
• NEW in 4.2 - IMF (ICN Metadata File)

Authoring
www.cgmlarson.com

www.cgmlarson.com
• Chapter 3.9.2 - Authoring - Illustration rules and multimedia
• Introduction – New advice
• Chap 3.9.2.1 - Illustrations, General
• Chap 3.9.2.2 - Navigation and configuration – Part 2
• Chap 3.9.2.3 - Use of color and photographs
• Chap 3.9.2.4 - Multimedia, General – Part 2
• Chap 3.9.2.5 - Interactive 3D content
• Chap 3.9.2.6 - e-learning and SCORM
• Chap 3.9.2.7 - ICN Metadata File (IMF)
Authoring – S1000D Specification

www.cgmlarson.com
Authoring
• 3.9.2 – Introduction
• 2.1 now split into sections
• Guidance Legacy Illustrations
• Maintain commonality
• Rules developed for new programs
• Illustrations created using previous
specifications, their use is
discretionary
• Primary illustration rules and
principles must be fulfilled

www.cgmlarson.com
Authoring
• 3.9.2.1 – Illustration’s, General

www.cgmlarson.com
Authoring – Primary Rules of Illustration
• The Table Of Contents for this section has not changed
• However, some of the content has changed
• Illustrations must communicate 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 written text and other information
in data modules
• The end user receives the maximum amount of information

www.cgmlarson.com
• 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 – Mode of Presentation

www.cgmlarson.com
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?
4.14.2

www.cgmlarson.com
Authoring – Illustration Sizes
4.1
4.2
• Additional sentence relating to legacy illustrations and scaling

www.cgmlarson.com
Authoring – Illustration Line weights
4.1
• NEW - Line weight table, now classified as types
4.2

www.cgmlarson.com
Authoring – Text Style (1)
4.1
• Advice on text style expanded with more guidance

www.cgmlarson.com
Authoring – Text Style (2)
4.2 Business rule decision point BRDP-S1-00554 – Illustration annotations
written in upper or sentence case:

www.cgmlarson.com
Authoring – Symbols
4.2

www.cgmlarson.com
Authoring – Color
• 3.9.2.3 - Use of color and photographs

www.cgmlarson.com
Authoring – Use of Color (1)
• The Specification defines the use of color
• Specific color palette
• Provides very good examples of using color
in illustrations and photographs
• The use of color on the example
illustration denotes a hierarchical structure
• Light Blue – parts on this illustration
• Grey – Parts shown on subsequent illustrations,
see the detail arrows for navigation

www.cgmlarson.com
Authoring – Use of Color (2)
4.24.1

www.cgmlarson.com
Authoring – Use of Color in 3D Content
• General Guidance:
• The color of the 3D objects should adhere to the S1000D color palette
• Projects should define a color scheme for the whole program
• Projects should also define Devices, Viewers etc. capable of displaying data
• Also, consider the capabilities of the technology
• Use color consistently
• The color Red should only be used for a Warning
• Critical alerts
• The color Amber should only be used for a Caution
• I think this should have been yellow?
• The color rules do not apply to realistically rendered surfaces
• The specification encourages the use of a gradient color for the background
• Critical information situations can be supported with symbols, markings, wording etc.

www.cgmlarson.com
Authoring – 3D
• 3.9.2.5 – Interactive 3D Content

www.cgmlarson.com
Authoring – Interactive 3D Content
• The Chapter provides basic guidelines for the use of 3D interactive
graphics
• The production of 3D content must be produced from verified and
authoritative engineering information
• 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
• There is no updated guidance in Issue 4.2
• Personal Comment - The project should seriously consider specifying a 3D
file format – Project Business Rule

Identifying
www.cgmlarson.com

www.cgmlarson.com
Identifying – S1000D Specification
• Chapter 4.4 – Information Management –
Information Control Number

www.cgmlarson.com
Identifying – Information Control Number
• Data Modules are all assigned a unique code
• 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 and keep the same code

www.cgmlarson.com
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

www.cgmlarson.com
Identifying – ICN Decision Points - MODELIC
• MODELIC based code more complex
• Aligned to the project and the equipment
• Provides granularity

www.cgmlarson.com
DEMO
Example of S1000D Illustration

Managing
www.cgmlarson.com

www.cgmlarson.com
Managing – S1000D Specification
• NEW - Chapter 3.9.2.7 – Illustration Rules – ICN metadata file

www.cgmlarson.com
Managing – ICN Metadata File (IMF)
• What is an IMF?
• An XML file similar in structure to a Data Module
• External but linked to an ICN object
• You could call it an XML companion file
• The mechanism for managing illustrations and multimedia objects in a
CSDB
• The CSDB will need to support the new file type
• The IMF is linked to an illustration or multimedia object via the unique
ICN code
• The use of the IMF file appears to be optional
• No Business Rule Decision Points in the Chapter
• Caveat – This is not a new Data Module Document Type

www.cgmlarson.com
Managing – IMF Structure
• The file name is prefixed with IMF- and derived from the ICN
• Overall structure very simple
• ID and Status
• Content

www.cgmlarson.com
Managing – IMF Structure – ID & Status
• The ID and Status section is very similar to a Data Module
• The structure includes the Address and Status elements

www.cgmlarson.com
Managing – IMF Structure – Address
• The section includes the
ICN enabling the linking
to the graphic object
• It also includes the ability
to add keywords,
• Included to the help
searches in a CSDB

www.cgmlarson.com
Managing – IMF Structure – Status
• The Status section is mainly Boiler Plate content from the
associated Data module/s

www.cgmlarson.com
Managing – IMF Structure – Content
• The Content section contains the <icnVariation> element and can
have multiple instances
• The initial attribute is the file type notation e.g. .cgm

www.cgmlarson.com
Managing – IMF Structure – Object
• The IMF file can also be used to contain hotspot information for the
graphic
• The CGM viewer will need to support the IMF XML file to benefit
• In theory the viewer could also display the ID and Status information
• Example: Attribute <icnObjectTitle> would be the tooltip
• The <icnObect> attribute can contain hotspot coordinates for both
2D and 3D graphics

www.cgmlarson.com
Managing – IMF Structure – Miscellaneous
• The <icnObject> element
• Provides the ability to specify a object hierarchy
• The elements <internalRef> <dmRef> <catalogSeqNumberRef>
• Provide the standard linking approach
• Internal with the graphic, different viewpoint
• Link to a Data Module
• Link to a specific part in the IPD

www.cgmlarson.com
Managing – IMF Structure – Miscellaneous
• The <icnSourceFiles>
• Provides the ability to reference material important in the creation of data
• The <icnResourceFiles>
• Provides the ability to reference additional material

www.cgmlarson.com
Managing – Code Structure
• The IMF code structure is derived from the ICN
• The only difference, the Prefix is IMF
• In summary, the IMF can contain an extensive range of metadata
IMF

www.cgmlarson.com
DEMO
XML Companion File (XCF)
IMF file in Notepad++

www.cgmlarson.com
Summary
• The specification has not changed substantially with respect
illustration creation
• Changes mainly cosmetic and more guidance on using legacy material
• Additional guidance around the use of 3D data, especially color
• Surprisingly no 3D file format specified
• This could cause issues around interoperability
• Also, display of 3D could be challenge as there will be a multitude of viewers
• The introduction of the IMF will provide data management benefits
• On the flip side it will add preparation overhead
• No guidance from the specification if this is optional or a requirement
• Will probably be a project decision if to adopt IMF

Q&A
www.cgmlarson.com

www.cgmlarson.com
Closing Information
Thank you for attending
• Next Larson Webinar
• Compliant S1000D Illustrations - Part 2
• Wednesday August 15th 2018
• Focus on the illustration file formats, CGM and SVG
• Register:
https://attendee.gotowebinar.com/register/3084557118490822913
• Next Event
• 2018 S1000D User Forum, New Orleans, LA
• September 10th – 13th Registration Open
• Register:
https://www.aia-aerospace.org/event/2018-s1000d-user-forum/

S1000D Compliant Illustrations 2018 - Part 1

Recommended

Recommended

More Related Content

Similar to S1000D Compliant Illustrations 2018 - Part 1

Similar to S1000D Compliant Illustrations 2018 - Part 1 (20)

More from Larson Software Technology

More from Larson Software Technology (9)

Recently uploaded

Recently uploaded (20)

S1000D Compliant Illustrations 2018 - Part 1