<?xml version="1.0" encoding="iso-8859-1"?>

<!--
ADOBE SYSTEMS INCORPORATED
Copyright 2006 © 2006 Adobe Systems Incorporated
All Rights Reserved

NOTICE:  Adobe permits you to use, modify, and distribute this file in accordance with the 
terms of the Adobe license agreement accompanying it.  If you have received this file from a 
source other than Adobe, then your use, modification, or distribution of it requires the prior 
written permission of Adobe.
-->

<!DOCTYPE dmodule [
<!NOTATION CGM PUBLIC "-//USA-DOD//NOTATION Computer Graphics Metafile//EN" "">
<!ENTITY S1000DUG005 SYSTEM "S1000DUG005.png" NDATA PNG>
<!ENTITY S1000DUG006 SYSTEM "S1000DUG006.png" NDATA PNG>
<!ENTITY S1000DUG007 SYSTEM "S1000DUG007.png" NDATA PNG>
]>
 <dmodule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="C:\S1000D221\app221\221schema\descriptSchema.xsd" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:fm="http://www.itp-x.co.uk/xslt" xmlns:dc="http://www.purl.org/dc/elements/1.1/" xmlns:dm="http://www.s1000d.org/dm">
<rdf:Description>
<dc:Title>The S1000D specification-Introduction</dc:Title>
<dc:Creator>00001</dc:Creator>
<dc:Subject>The S1000D specification-Introduction</dc:Subject>
<dc:Publisher>00001</dc:Publisher>
<dc:Contributor>00001</dc:Contributor>
<dc:Date>2006-08-31</dc:Date>
<dc:Type>text</dc:Type>
<dc:Format>text/xml</dc:Format>
<dc:Identifier>ITPX-A-00-00-00-00A-041A-A_001-00</dc:Identifier>
<dc:Rights>01</dc:Rights>
</rdf:Description>
<idstatus>
<dmaddres>
<dmc>
<avee>
<modelic>ITPX</modelic>
<sdc>A</sdc>
<chapnum>00</chapnum>
<section>0</section>
<subsect>0</subsect>
<subject>05</subject>
<discode>00</discode>
<discodev>A</discodev>
<incode>041</incode>
<incodev>A</incodev>
<itemloc>A</itemloc>
</avee>
</dmc>
<dmtitle>
<techname>The S1000D specification</techname>
<infoname>Introduction</infoname>
</dmtitle>
<issno inwork="00" type="new" issno="001"/>
<issdate month="08" day="31" year="2006"/>
</dmaddres>
<status>
<security class="01"/>
<datarest>
<instruct>
<distrib>To be made available to all Adobe FrameMaker
7.2 Application Pack for S1000D users.</distrib>
<expcont>Export of this data module to all countries that are the
residence of organizations that are users of S1000D is permitted.
Storage of this data module is to be at the discretion of the organization.</expcont>
<handling>There are no specific handling instructions for this data
module.</handling>
<destruct>Users may destroy this data module in accordance with
their own local procedures.</destruct>
<disclose>There are no dissemination limitations that apply to this
data module.</disclose>
</instruct>
<inform>
<copyright>
<para>2006 Adobe Systems Incorporated. All rights reserved.  </para>
</copyright>
<datacond>NOTICE:  Adobe permits you to use, modify, and distribute
this file in accordance with the 
terms of the Adobe license agreement accompanying it.  If you have
received this file from a 
source other than Adobe, then your use, modification, or distribution
of it requires the prior 
written permission of Adobe.</datacond>
</inform>
</datarest>
<rpc rpcname="Adobe">00001</rpc>
<orig origname="Adobe">00001</orig>
<applic/>
<brexref>
<refdm xlink:actuate="onRequest" xlink:type="simple" xlink:show="replace">
<avee>
<modelic>ITPX</modelic>
<sdc>A</sdc>
<chapnum>00</chapnum>
<section>0</section>
<subsect>0</subsect>
<subject>00</subject>
<discode>00</discode>
<discodev>A</discodev>
<incode>022</incode>
<incodev>A</incodev>
<itemloc>D</itemloc>
</avee>
<issno type="new" issno="001"/>
</refdm>
</brexref>
<qa>
<firstver type="tabtop"/>
</qa>
<skill skill="sk02"/>
</status>
</idstatus>
<content>
<descript>
<para0 id="i1011547">
<title>An introduction to S1000D</title>
<para>ASD S1000D is an international standard. Although it was first
used by the European military aerospace industry, it has now been
adopted by countries and industries around the world. </para>
<para>The S1000D specification is unusual because it specifies the
requirements for a project&#8217;s complete publication lifecycle. All
stages of the publication lifecycle are accounted for, including
initial project planning, business rules, management methods, configuration,
writing rules, illustration rules, production methods, quality assurance,
data storage, publishing, commenting, and revision cycles. </para>
<para>At the heart of any S1000D project you will find the Common
Source DataBase, or CSDB. At its most basic, the CSDB is a repository
for all of the components of a publication. It&#8217;s more likely, however,
that the CSDB will be used to manage the entire project, including:<randlist prefix="pf02">
<item>Project set-up</item>
<item>Production workflow</item>
<item>Quality assurance processes</item>
<item>Lifecycle management and revision control</item>
<item>Content storage for data modules and graphics</item>
<item>Publication management for IETP or IETM and paper documents.</item>
</randlist>
</para>
<subpara1>
<title>Modular publications</title>
<para>One of the S1000D specification&#8217;s key features is the data
module. A data module is an easy&#8211;to&#8211;manage document designed for
reuse. A typical data module provides a small amount of content about
a specific topic in a clearly defined context.</para>
</subpara1>
<subpara1>
<title>Data module types</title>
<para>S1000D is a standard for data interchange, and ensures that
all data follows a common set of rules, thereby reducing the lifecycle
costs for a project. S1000D defines a fixed set of data module types,
which are:</para>
<table colsep="0" frame="topbot" rowsep="0" tocentry="1">
<tgroup colsep="0" cols="2" rowsep="0" tgstyle="S1000D" charoff="50" align="left">
<thead>
<row rowsep="1">
<entry colname="1" valign="top" morerows="0" rotate="0">Data Module Type</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">Purpose</entry>
</row>
</thead>
<tbody>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>Business Rules Exchange</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>The BREX data module propagates the allowed
customizations throughout a project. It is a configuration file
that is not intended to be viewed by the end user. See Using BREX for
more detail.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>Crew</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>Provides structure for operational checklist
procedures and related descriptive information. Typical use: aircrew
flight reference cards and flight manuals.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>Description</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>A general purpose data module for descriptive
text. Also very useful for legacy data due to its flexible structure.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>Fault</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>Dedicated structure for Fault Isolation
procedures that may be represented as graphical fault isolation
charts by some display systems.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>Illustrated Parts Data</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>The basic building block for an Illustrated
Parts Catalogue where each data module includes a labeled parts
illustration with a corresponding parts list. These data modules
are often generated by an ASD 2000M&#8211;compliant initial provisioning
database system.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>Procedural</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>Step-based procedural data. Includes
Preliminary requirements, Maintenance function, and Close-up procedures.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>Process</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>The Process data module is used by integrated
systems to dynamically deliver maintenance information that is dependant
on the status of the equipment. The majority of the content of a
Process data module is a type of scripting language for data module
delivery.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>Schedule</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>A data module type that is used for maintenance
planning information.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>Wiring Data </para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>The Wiring data module is used to store
wiring data information including wire, harness, equipment, and
standard parts data. This data could then be used to generate wiring
and schematic diagrams.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>Wiring Data Description</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>Each relevant element in a wiring data
module requires a project&#8211;specific wiring element field description.
This data module type, therefore, provides an interface between
a company&#8217;s wiring data production system and the wiring data module.</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</subpara1>
<subpara1>
<title>Managing data modules</title>
<para>A typical S1000D project makes use of thousands of data modules
and graphics, or CSDB objects. Many of these CSDB objects are specific
to the project, but some will be reused from other projects. So
how do you manage all of this potentially fragmented, modular information?</para>
<para>S1000D&#8217;s answer is to provide every CSDB object with a unique,
but meaningful, identification code. For a data module this is called
the Data Module Code, or DMC. (For example, the code for an illustration
is the Illustration Control Number, or ICN. </para>
<para>The data module code has two forms AVEE and the deprecated
AGE. The structure of a DMC and its meaning are shown below.</para>
<figure>
<title>The data module code structure</title>
<graphic reprowid="3.798in" reprohgt="4.569in" xlink:type="simple" boardno="S1000DUG005"/>
</figure>
<table colsep="0" frame="topbot" rowsep="0" tocentry="1">
<tgroup colsep="0" cols="2" rowsep="0" tgstyle="S1000D" charoff="50" align="left">
<thead>
<row rowsep="1">
<entry colname="1" valign="top" morerows="0" rotate="0">DMC ELEMENT</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">Description</entry>
</row>
</thead>
<tbody>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>modelic - Model Identification Code</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>A globally unique code for each project.
These codes are allocated by NAMSA. An up-to-date list of allocated
codes can be found at: www.namsa.nato.int/s2000m/s2000m_moi_e.htm
andwww.namsa.nato.int/s2000m/s2000m_moi14_e.htm</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>sdc - System Difference Code</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>Identifies alternative systems that share
identical SNS codes. This happens when, for example, subsystems supplied
by different manufacturers perform an identical role.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>chapnum - SNS Chapter Number</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>First part of the Standard Numbering
System. Provides system&#8211;level breakdown of a product&#8217;s structure.
The use of &#8220;chapter&#8221; does not imply a page based publication breakdown.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>section and subsect - SNS Section Number</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>Second part of the Standard Numbering
System. Provides subsystem level breakdown of a product&#8217;s structure. </para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>subject - SNS Subject Number</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>Third part of the Standard Numbering
System. Provides sub&#8211;subsystem level breakdown of a product&#8217;s structure.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>discode - Disassembly Code</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>For most types of data module, this element
extends the possible system breakdown level. For the IPD data module,
it holds the Figure number for the current SNS breakdown.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>discodev - Disassembly Code Variant</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>Introduces a variant of the Disassembly
code or IPD figure.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para id="i1012622">incode - Information
Code</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>Identifies the purpose of the data module
using a three digit code. Some examples are:</para>
<randlist prefix="pf02">
<item>041&#8212;Description of how it is made</item>
<item>520&#8212;Remove procedures</item>
<item>941&#8212;Illustrated Parts Data</item>
</randlist>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>incodev - Information Code Variant</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>Typically a way to define an alternative
procedure that achieves the same results for a given incode.</para>
</entry>
</row>
<row rowsep="0">
<entry colname="1" valign="top" morerows="0" rotate="0">
<para>itemloc - Item Location Code</para>
</entry>
<entry colname="2" valign="top" morerows="0" rotate="0">
<para>Where the procedure is done (for example,
"on the main equipment,&#8221; or "on the workbench").</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
<para id="i1004805">The DMC is used as the data module&#8217;s identifier
for linking between data modules using the &#8220;refdm&#8221; element. The
DMC is also used as the basis for the data module&#8217;s file name (for
example, DMC-AE-A-04-10-0301-00A-022A-A_001-02.XML.</para>
<para>The Illustration Control Number is used as the entity name
in a data module and the file name (for example, ICN-AE-A-321005-0-U8025-00503-A-02-1.CGM).
See the S1000D specification, chapter 4.4, for more information
about the ICN.</para>
</subpara1>
<subpara1>
<title>The structure of a data module</title>
<figure>
<title>All data modules contain two
main sections, the idstatus and the content.</title>
<graphic reprowid="1.465in" reprohgt="1.173in" xlink:type="simple" boardno="S1000DUG006"/>
</figure>
<para>The idstatus, or Identification and Status section, contains
a comprehensive set of metadata elements that are used by the CSDB
to manage the data module. The idstatus is not normally displayed
to the user of the publication, and is often not editable by the
author. The structure view below shows the idstatus elements. See
the S1000D specification, chapter 3.9.5.1., for a complete explanation
of the idstatus section. </para>
<figure>
<title> The structure of the idstatus
section</title>
<graphic reprowid="2.694in" reprohgt="6.850in" xlink:type="simple" boardno="S1000DUG007"/>
</figure>
<para>While the available element structure of the idstatus is identical
for all data modules, the content section varies for each type of
data module.</para>
<para>The content section is the part of the data module that the
publication&#8217;s user sees in the IETP or printed manual.</para>
</subpara1>
<subpara1>
<title>An S1000D project</title>
<para>Creating and managing a modular publication is unlike working
on a traditional document, but the specification has guidance here
as well. </para>
<para>Before a single data module is written or a legacy page converted,
some important steps must be taken:<seqlist>
<item>Define the project,
and obtain a Model Identification Code.</item>
<item>Select the relevant Standard Numbering System for the equipment
type, (for example, General surface vehicle, Navigation system,
or even your project&#8217;s own unique SNS).</item>
<item>Create the Data Module Requirements List. A DMRL is a list
of all data modules that will be needed for the project. This stage
should not be underestimated; it is a significant amount of work.
However it is a vital part of the project setup. Once complete,
the DMRL will aid resource planning and project costing. It will
identify potential reuse cases. It also makes it possible to define
refdm element links to data modules that do not yet exist.</item>
<item>If the project involves legacy conversion, the Illustration
Control Numbers should be created while compiling the DMRL.</item>
<item>Create the project business rules and the BREX data module.</item>
</seqlist>
</para>
</subpara1>
<subpara1>
<title>The publication module</title>
<para>S1000D gives instructions for page based and electronic publication.
Both methods are controlled by the publication module, a structured
list of references to data modules. </para>
</subpara1>
<subpara1>
<title>Further information</title>
<para>This introduction can only give an overview of the S1000D
specification. For more information, see the S1000D website at <?FM MARKER [Hypertext] message URL http://www.s1000d.org?>www.s1000d.org,
where the complete specification is available for download in Adobe
PDF format. You will also find most issues of the DTDs and XML schemas
if you want to extend the application pack to support additional
data module types or previous issues.</para>
</subpara1>
</para0>
</descript>
</content>
</dmodule>
