S1000D Illustrations White Paper

Co-Authors Don Larson – CEO, Larson Software Technology

David Manock – President, Vizualsite LLC

[email protected], [email protected]

Abstract The creation and delivery of illustrations is a significant component of an

S1000D project. There are several factors that require consideration when

creating and maintaining illustrations…

COMPLIANT S1000D ILLUSTRATIONS

Table of Contents _________________________________________________

S1000D Compliant Technical Illustrations _______________________________ 1

HISTORY OF S1000D ____________________________________________________ 2

THE PRINCIPAL CONCEPTS OF S1000D ______________________________________ 2

INFORMATION CREATION _________________________________________________ 4

S1000D COMPLIANT ILLUSTRATIONS _______________________________________ 4

S1000D ILLUSTRATION PROCESS __________________________________________ 5

THE PURPOSE AND USE OF HOTSPOTS ______________________________________ 7

THE DELIVERY OF S1000D ILLUSTRATIONS __________________________________ 8

THE IMPORTANCE OF S1000D _____________________________________________ 8

Optimize the S1000D technical graphics process using Larson CGM Products ___ 9

CORE BENEFITS ________________________________________________________ 9

The Benefits of the Larson CGM Products __________________________________ 10

Features of the Larson CGM Products _________________________________ 11

VIZEX TRANSFORM_____________________________________________________ 11

Transform DWG and DXF files ___________________________________________ 11

Transform PDF files ___________________________________________________ 12

Transform Image files _________________________________________________ 13

Automatically create intelligent CGM graphics ______________________________ 13

VIZEX EDIT ___________________________________________________________ 14

Product Features _____________________________________________________ 14

VIZEX VIEW __________________________________________________________ 15

VizEx View Plugin for Chrome, Internet Explorer and Firefox browsers ___________ 15

VizEx View C++ _____________________________________________________ 16

VizEx View iOS ______________________________________________________ 16

VizEx Office _________________________________________________________ 16

Summary _______________________________________________________ 17

Glossary ________________________________________________________ 18

References ______________________________________________________ 19

Company Information _____________________________________________ 20

LARSON SOFTWARE TECHNOLOGY

Page 1 Compliant S1000D Illustrations

S1000D Compliant Technical Illustrations

The S1000D specification controls the creation and delivery of technical publications.

Although the specification applies to all publication elements, this document focuses

particularly on its impact on 2D technical illustrations.

If you work in the military or commercial

aerospace sectors, you're probably familiar with

the S1000D specification. The specification was

used mainly in Europe until the United States

DoD (Department of Defense) raised the profile

of the specification. The adoption of the

specification by major programs, for example,

C-17 Globemaster has solidified its position.

In Europe, the S1000D story is lengthier with defense ministries and prime defense

contractors using the specification successfully for many years on various projects,

including Eurofighter Typhoon. There are several reasons for the success of S1000D, with

two being particularly important. The first was the emergence of multi-country military

projects, where one specification enables interoperability and benefits from the resulting

cost savings. The second was the

mandating of S1000D by the defense

ministries in Europe, for example, the

UK Ministry of Defense.

The impact, financially and

organizationally, of implementing

S1000D has vastly improved over the

years. Today, the software solutions

are cost effective and usually off the

shelf and people with expertise easier

to find.

Figure 1. C-17 Globemaster

Figure 2. Eurofighter Typhoon



HISTORY OF S1000D

The S1000D specification emerged in the early 1980s, with the purpose of developing a

global standard for technical documentation, similar in philosophy to the commercial

aerospace specification ATA100.

The majority of early adoptions of S1000D were on military aerospace projects. The main

reason for this was the bias of the specification towards air vehicle and ground support

equipment. The situation changed when S1000D encompassed land and marine

requirements.

The governance for the specification

is provided by ASD (Aerospace and

Defense Industries Association of

Europe). The involvement of the USA

required additional transatlantic

governance of S1000D; this was

provided by the AIA (Aerospace

Industries Association). More

recently the ATA (Air Transport

Association) made the decision to

become involved in S1000D. The

result, commercial aerospace

requirements were integrated into

the current version of the

specification, 4.1. This initiative was

an ironic twist, considering that one

of the prime reasons for developing

S1000D was in response to the

ATA100 specification.

The ASD, AIA and ATA provide governance of the specification they do not develop or

maintain S1000D. Councils and working groups perform the task of writing and amending

the specification. Figure 3 provides an overview of the current organization. In summary,

the specification has an excellent history of development and use. Benefits include

interoperability, consistency, security, cost reduction, business processes, usability and

performance.

THE PRINCIPAL CONCEPTS OF S1000D

The S1000D specification is a substantial document, and the current version 4.1, contains

over 3,500 pages. The defining concept that separates S1000D from other documentation

processes is the Data Module (DM), a chunk of information utilized to support a particular

Figure 3. S1000D Organization



aspect the equipment. The DM structure is XML (Extensible Markup Language), and

information types define the content, for example, descriptive, procedural and fault

diagnostics. The content can assist with the maintenance of the equipment or the validity

of the information by defining project business rules. A comparable specification is DITA

(Darwin Information Typing Architecture), also based on XML and modular in construct.

DITA, however, does contain the guidance afforded by S1000D for constructing technical

documentation for the sophisticated equipment common in the military and aerospace

industries.

The S1000D specification abandons the linear structure of a traditional publication, the

concept of chapters, sections, and pages is no longer true. S1000D's modular structure

provides the opportunity to reuse, manage and deliver information efficiently. A unique DM

code identifies content and details of the assembly, disassembly sequence, and definition

of the data type. The code enables data to be easily identified and managed in a

repository, the Common Source DataBase (CSDB). The CSDB is used to manage the

majority of the project data including illustrations, usually archived in the CGM (Computer

Graphics Metafile) file format. Figure 4 provides an overview of the S1000D publication

process.

Figure 4. S1000D Publication Process



INFORMATION CREATION

The philosophy of S1000D specification is to base the creation of data on internationally

recognized standards. The first versions of the specification used SGML (Standard

Generalized Markup Language) to create DM's. The transition to XML (Extensible Markup

Language) was logical and CGM preserved as the 2D technical illustration format.

The specification provides the guidance you require to

implement the project, download from www.s1000d.org.

The S1000D organization also provides a sample project

based on a bicycle, included are sample DM’s and CGM’s,

XML schemas, and other information that will assist the

project.

The Data Module structure is divided into two distinct

parts:

1. The Identification and Status section contains mainly

meta-data. Primarily used for the management of the DM,

the section includes the DM code, revision, validation,

quality assurance details, manufacturer’s name and

security classification.

2. The Contents section contains the information required

to maintain the equipment. The information type

categories, descriptive, procedural, fault diagnosis,

illustrated parts data, etc. enable the appropriate

positioning of the content. The CGM illustrations are inserted into the appropriate part of

the contents section.

If you're new to S1000D, you will be required to originate and deliver compliant data.

Software Vendors provide a good choice of solutions enabling the implementation and

delivery of a successful project.

S1000D COMPLIANT ILLUSTRATIONS

The creation and delivery of illustrations is a significant component of an S1000D project.

There are several factors that require consideration when creating and maintaining

illustrations or repurposing data sourced from CAD (Computer Aided Design) systems. The

major factor is possessing the technology capable of generating and delivering compliant

CGM files. If you're using a general graphics package, CAD or visual mock-up systems

usually this is not possible. This software type is often not aware of the requirements of

the S1000D specification, and the result will be uncompliant CGM files.

Figure 5. Data Module Structure



The CGM file will usually be validated when delivered for compliance, and so it is crucial

that the file is in the correct format. The delivery of a non-compliant CGM file could result

in rejection of the data and as a result increased costs.

The specialized software required to generate

compliant files is not usually available in mass-market

tools. The functionality of the software is also a

consideration, for example; the ability to create and

manage illustrations containing hotspots.

The delivery of interactive manuals is now a major

consideration when creating technical illustrations. The

concept of "Intelligent Graphics" defines standardized

structured graphics, which could be used by

applications in an interactive way. The CGM format has

the capability to be intelligent, using meta-data, a

region of the graphic can be defined as a trigger for an

action to be performed when clicked. This clickable

area is also known as a graphical hotspot the

functionality is commonly used in IETM’s (Interactive

Electronic Technical Manual’s) for example when

identifying spare parts information.

S1000D ILLUSTRATION PROCESS

The primary considerations when creating S1000D-compliant illustrations are coding, style

and format. The coding of the CGM file is a fundamental factor for an S1000D project, do

not underestimate its significance. The CGM file is capable of containing metadata, for

example hotspots, however, not the depth of elements available inside a DM. The result is

the Information Control Number (ICN) is responsible for identifying and managing the

illustration inside the CSDB. The ICN is up to 45 characters in length; the code contains

similar information contained in the Identification and Status section of a DM (for example,

security classification and issue number). Figure 7 identifies the structure of the code.

Figure 7. Information Control Number Coding

Figure 6. CGM file compliance



The S1000D specification states, “The purpose of illustrations is to amplify and clarify

written content”. The specification provides guidance on how to produce illustrations and

enable downstream print or electronic deployment. The following bullet points summarize

the main illustration requirements.

The illustration must provide maximum information for the end user, with particular

awareness of the output media.

Illustrated parts must be clearly identifiable and annotated appropriately.

Location arrows, leader lines and annotations must be clearly shown and free from

surrounding detail.

The use of 2D and 3D CAD data is allowed if it conveys the information

convincingly.

Illustrations should be realistic but a

sensible size; if critical areas are tiny,

enlarge the area and show in a detail

drawing.

If several identical parts are present, only

one has to be shown providing that the

position and orientation of the other parts

is clear.

Wiring or system diagrams, schematics or

other charts where symbols are used are

also acceptable as an illustration if they

provide for the proper identification of the

detail parts.

Illustrations are to be created and

delivered appropriately for their intended

output format. Illustrations destined for

print should normally be portrait;

landscape may be used on a foldout page

but this must be described in the business

rules for the project. If the illustrations are intended for an IETP, the format

restrictions do not apply. However, if the illustration has the ability to be printed, its

layout must be considered.

When the disassembly order or detail parts can be identified from the plan view of a

production drawing, that view must also be used in the illustration. A good example

is hose assemblies, control rods, clamps, instrument panels, circuit boards or

ground equipment.

Consider final illustration requirements and include in the project business rules.

Figure 8 shows an example of a technical illustration created in accordance with S1000D

guidelines. The detail drawing clearly depicts the location of the assembly on the vehicle.

Figure 8. S1000D Illustration



Showing the ICN on the illustration is optional, usually dependent on the project

requirements.

THE PURPOSE AND USE OF HOTSPOTS

Hotspots are responsive areas in illustrations, comparable to hyperlinks in a web page. The

term is used to describe a clickable area on an illustration, it usually provides a navigation

link to a different area of the illustration or text in the technical publication. The hotspots

are used in various contexts; it can provide a link to relevant text in an S1000D Data

Module (for example, a parts list). It can also provide a link to another area of the same

illustration and show an enlarged detail of the illustration. The responsive area can be a

callout annotation number or graphic element itself.

The benefit of hotspots to the user, they provide information in an intuitive environment.

As well as facilitating easy

identification of parts and

assemblies, they provide graphical

navigation not possible with

printed manuals.

The CGM technology enables the

inclusion of hotspots in

illustrations. The CGM file format

also allows you to include meta-

data, providing the ability to

describe a hotspot ‘region’ and a

target for the link known as a

‘viewcontext’.

To create hotspot information in a

CGM file, you require specialized

illustration tools developed

specifically for this purpose. Figure 9. Hotspots highlighted in CGM Viewer



THE DELIVERY OF S1000D ILLUSTRATIONS

The final task is to deliver the illustrations in a compliant CGM format. S1000D utilizes a

cascading profile, see

Figure 10, WebCGM

2.1 is a

recommendation of

the W3C organization.

The S1000D

specification specifies

a subset of the

complete WebCGM

profile.

The WebCGM format is developed and maintained by the CGM

Open Foundation, a non-profit organization, comprising of

representatives from software vendors, industry and government.

CGM is a stable and very reliable format, a key factor when

maintaining and delivering graphics on major programs.

THE IMPORTANCE OF S1000D

In summary, while S1000D is not applicable to every industry, however, aspects of its

methodology could benefit a company’s documentation process. The key benefit for a

company implementing the S1000D specification is the creation of data in a structured,

neutral environment, ensuring data will always be accessible and easily managed

throughout its life-cycle.

The key benefit for the company’s clients is the provision of a user-friendly environment,

especially when information is delivered electronically. The delivery of illustrations is a key

part of the technical documentation process, providing major benefits to users both in

understanding and navigating the documentation. The generation of illustrations should

not be overlooked, especially in environments where rigorous specifications and regulatory

authorities are in place.

Figure 10. CGM Profiles



Optimize the S1000D technical illustration process using Larson CGM Products

The document has described the significance of creating compliant

S1000D technical illustrations and the challenges faced by organizations

implementing the strategy. The technology enabling the successful

delivery of the task is based on Larson CGM Products.

The Larson family of products provide the opportunity to transform common file formats to

S1000D compliant CGM files with VizEx Transform, edit files using VizEx Edit, and deploy

graphics using the VizEx View.

Figure 11. The Larson CGM family of products enable S1000D compliance

CORE BENEFITS

The benefits provided by Larson Products are visible both in technical graphics production

and deployment phases, Figure 11 provides the vision of the S1000D CGM Ecosystem,

simple, productive and excellent quality.



The Benefits of the Larson CGM Products

Larson VizEx Transform has the ability to convert files of

differing formats to S1000D compliant CGM files and add

value with an automatic hot spotting capability.

o The transformation of files is cost effective by

utilizing the batch processing functionality.

o CAD files can be transformed utilizing the DWG format, enabling the reuse of

engineering data within the organization.

o The reuse of vector graphics embedded inside PDF files and graphics created

in popular graphics programs e.g. Adobe Illustrator, CorelDraw etc.

o A fast and highly configurable automatic hot spotting capability, downstream

end users will benefit from interactive intelligent graphics.

Larson VizEx Edit provides sophisticated tools, maintain and create

graphics and hotspot information.

o Provides a simple to use interface and powerful graphics editing

options to maintain your S1000D CGM graphics. An intuitive

interface to add and maintain hotspot information.

o A cost effective way of performing graphics editing tasks in

comparison to expensive vertical technical illustration tools.

Larson VizEx View products provide a whole range of different options for deploying

S1000D CGM graphics, from plugins for web browsers through to Software

Development Kits for embedding a CGM viewer into an IETM (Interactive Electronic

Technical Manual).

o VizEx View products can also be used to display S1000D CGM files in popular

browsers such as Internet Explorer, Chrome and Firefox on Windows and

Linux.

o Larson also provides technology for iOS to enable CGM graphics viewing on

the iPad.

Larson customers receive many benefits by both implementing Larson VizEx products and

having the ability to generate and work with S1000D compliant graphics.



Features of the Larson CGM Products

In the previous section we outlined the benefits of the Larson CGM Products in this section

we focus on some of the major features. The product datasheets are also available on

request providing additional information on the individual products.

VizEx Transform

This is a truly unique application enabling the transformation of multiple graphical data

formats into CGM in one simple to use interface. The application also has the ability to add

hotspot information to the CGM graphics during the transformation process. This is

achieved in a batch process saving time and money.

Transform DWG and DXF files

Transform CAD files from the engineering department, successfully reuse existing data and

preserve graphical quality.

Supports "Model" and "Paper" space options.

The pen weight values are supported and mapped to the CGM file.

The option for arcs, ellipses, polylines, and scaling control.

Control individual layers by turning off selected layers. For example turn off title

block, extract desired text for specific languages.

Convert colors to monochrome

Figure 12. Transform multiple file formats



Figure 13. DWG & DXF settings

Transform PDF files

Transforming PDF files eliminates the requirement to re-author or redraw existing

illustrations. The same technology can also be used to convert from popular graphics

software that do not support CGM, for example Adobe Illustrator.

The ability to convert a multiple page PDF document into separate CGM files.

The option of scaling line widths.

The ability to choose individual pages of a PDF document to be converted.

Scale line widths

Figure 14. PDF transformation settings



Transform Image files

Common image formats such JPEG, PNG, TIFF and BMP are also transformed into the CGM

format. CGM is commonly thought of as a vector only format, but CGM V3 onwards

includes the support for raster files.

Supports Raster to Raster conversion.

Advanced features include color swapping, compression for monochrome images.

The DPI (dots per inch) resolution can be controlled.

Options for file compressions, image quality, grayscale, size (pixels, inches, metric),

Aspect Ratio, Gamma, and Rotation.

Automatically create intelligent CGM graphics

Larson’s VizEx Transform also automates the creation of hotspot information in CGM files

during the conversion process.

The ability to identify text based on characteristics including minimum and

maximum digits, minimum and maximum height. For more powerful text filtering

specify characteristics with regular expression (regex).

The tool also provides option to output hotspot information to a file in CSV format

so you can add or replace developed applications, which refer to databases, or add

screen tips text and actual URL links.

The Raster option allows you to take TIFF, JPEG, PNG, and CALS raster files and

automatically recognize callouts and then convert them to CGM Version 4 with

hotspots.

Figure 7. Hotspot settings



VizEx Edit

Provides a cost effective solution to edit and maintain your S1000D illustrations. Create

overlay hotspots, embed hyperlinks, and link all your drawings together with this

standards based graphics technology.

Figure 8. Maintain CGM files in VizEx Edit

Product Features

Enables the revision of CGM's, edit lines, fill colors, change fonts, reposition objects

and delete them.

Provides an Isometric grid, the preferred perspective projection of the S1000D

specification.

Allows the import of Adobe Illustrator, PDF, DWG, TIFF and other graphics formats,

additionally all versions of CGM.

Quickly and easily add hotspots and enter the associated metadata. Simply click

and drag a rectangle to indicate hotspot location, or select group of objects to

create a hotspot for the entire group.

The metadata "Tree View”, see Figure 9, enables the intuitive modification of

hotspot attributes like object id, name(s), embedded links. The clicking of the

hotspot while pressing Control-key also allows individual hotspot attributes to be

very quickly edited.

The document tabs feature permits several files to be opened in a single session

enabling quick and easy navigation between CGM files.

The split views feature enables multiple files to be viewed side by side for quick

comparison and revision.



The Auto Hotspot technology is also available as a fully integrated option for VizEx

Edit.

o Select the Auto Hotspot function and the file is scanned for all vector and

raster text.

o The text to be hot-spotted can be identified by the setting of parameters, for

example, alpha, numeric only, or a regex text filter.

o The CGM file is hot-spotted on screen, the attributes will be automatically

generated and be edited if required to obtain the required result.

Layout Tools: Align, Crop, Group, Un-Group, Flip, Rotate, Arrange, Crop,

Copy/Paste, Snap to Grid, Zoom

Mark-up Tools: Text, Bezier Curves, Circles, Ellipses, Rectangles, Polygons,

Transparency, Lines, Hotspot, True Type Fonts, Line and Fill Attributes

VizEx View

Deploy your S1000D graphics easily to your, customers, partners and suppliers with

Larson’s world leading CGM viewing technology. VizEx View comprises of various products

each designed to deliver quality CGM files the customer can rely on.

Figure 17. Deploy CGM files in VizEx View

VizEx View Plugin for Chrome, Internet Explorer and Firefox browsers

Larson provides technology for the support of CGM in all major internet browsers. The

support of CGM is comprehensive and easy to implement.

Full support for the WebCGM 2.0 DOM, a JavaScript API and event model for

programmatically interacting with graphical and non-graphical picture elements.



E.g. identifying a user click on a hotspot then changing the color of a line or text

element.

Supports hyperlinking and document navigation, picture structuring and layering,

and enabling of search and query of WebCGM content.

Support XML Companion File for externalization of non-graphical metadata for

easier metadata management e.g. link, screen tips.

Toolbar for added user interaction: scale, zoom, pan, show hotspots.

Menu right-click menu provides text search in addition to scale, zoom, pan, show

hotspots functions.

Supports Open-Type and True-Type fonts

OpenGL is utilized on Linux for fast and accurate graphics rendering.

Embed CGMs in HTML document, with either an OBJECT tag or via the JavaScript

API.

VizEx View C++

This product includes an easy to use C++ library for Windows and Linux developers

looking to support CGM in their application(s). The VizEx View C++ Library Software

Development Kit includes sample code, documentation and the object code library (.DLL

or .SO on Linux), both which you can utilize with your C++ applications.

VizEx View iOS

The distribution of technical documentation on tablet devices is becoming very important.

The ability deploy CGM files on iOS is now possible with this Larson product. VizEx View

iOS enables delivery of quality native CGM graphics including all the functionality you

would expect on other platforms.

VizEx Office

The View Office product (an add-in for Microsoft Office 2010 and later) seamlessly inserts

CGM Files into Microsoft PowerPoint and Word documents utilizing Larson's unique

technology. Insert all types of CGM technical graphics and easily reuse your single instance

archive.



Summary

The objective of the document is to describe the requirements when creating, managing

and deploying S1000D CGM graphics. As a world leading supplier of CGM technology,

Larson has the credentials, experience and products to enable your S1000D graphics

vision.

The S1000D technical graphic has comparable importance with its textual XML counterpart

the Data Module. They are both a crucial component of the S1000D technical

documentation process. As a result your graphics production is a significant component of

the overall process.

Larson believed in CGM and founded a company based on the format. The S1000D

community was also convinced and were quick to adopt the CGM open format. Larson is

the ideal partner when achieving and delivering your S1000D technical graphics goals.



Glossary

API Application Programming Interface

BMP Bitmap image file

C++ A general purpose computer programming language

CAD Computer Aided Design

CGM Computer Graphics Metafile

CSV Comma-Separated Values

DOM Document Object Model

DWG A binary file format developed by AutoDesk, used by many CAD

systems including AutoCAD as native file format.

Hotspot A graphical hotspot is a region where information about an

associated action is contained

HTML Hyper Text Markup Language

IETM Interactive Electronic Technical Manual

JavaScript A computer programming language, most commonly used as part of

web browsers

JPEG Joint Photographic Experts Group

PDF Portable Document Format

PNG Portable Network Graphic

Raster Graphics A dot based data structure representing an image made up of pixels

and viewable via a monitor, paper, or other display medium.

RIP Raster Image Processor

SDK Software Development Kit

TIFF Tagged Image File Format

Vector Graphics Points, lines, curves, shapes and polygons based on mathematical

expressions representing images in computer graphics.

XML Extensible Markup Language

http://en.wikipedia.org/wiki/Data_structure

http://en.wikipedia.org/wiki/Pixel

http://en.wikipedia.org/wiki/Computer_display

http://en.wikipedia.org/wiki/Paper

http://en.wikipedia.org/wiki/Point_(spatial)

http://en.wikipedia.org/wiki/Line_(mathematics)

http://en.wikipedia.org/wiki/Curve

http://en.wikipedia.org/wiki/Shape

http://en.wikipedia.org/wiki/Polygons

http://en.wikipedia.org/wiki/Image

http://en.wikipedia.org/wiki/Computer_graphics



References

S1000D is an international specification for the production of technical publications.

www.s1000d.org

Aerospace Industries Association (AIA), played a key role in developing S1000D

specification.along with Aerospace and Defence Industries Association of Europe (ASD)

www.aia-aerospace.org/

The ATA e-Business Program, where the global commercial aviation industry

collaborates to create standards for information exchange to support engineering,

maintenance, materiel management and flight operations.

www.ataebiz.org/specifications/

Airlines for America (A4A), formerly known as Air Transport Association of America,

Inc. (ATA), was the first and remains the only trade organization of the principal

U.S. airlines. https://publications.airlines.org/

The World Wide Web Consortium (W3C) is an international community that

develops open standards to ensure the long-term growth of the Web.

www.w3.org/Graphics/WebCGM/

Part of the U.S. Department of Commerce, NIST (National Institute of Standards

and Technology's) is one of the nation's oldest physical science laboratories.

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

CGM Open Foundation is non-profit international foundation, made up of developers

and users dedicated to open and interoperable standards for the exchange of

graphical information. www.cgmopen.org/

http://www.ataebiz.org/specifications/

https://publications.airlines.org/

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

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

http://www.cgmopen.org/



Company Information

Larson Software Technology

800 Wilcrest, Suite 210, Houston, TX 77042 USA

Tel (+1) 713-977-4177

Fax (+1) 713-977-4176

www.cgmlarson.com

http://www.cgmlarson.com/

S1000D Illustrations White Paper

Technology

Transcript of S1000D Illustrations White Paper