<?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 S1000DUG022 SYSTEM "S1000DUG022.png" NDATA PNG>
<!ENTITY S1000DUG001 SYSTEM "S1000DUG001.png" NDATA PNG>
<!ENTITY S1000DUG002 SYSTEM "S1000DUG002.png" NDATA PNG>
<!ENTITY S1000DUG003 SYSTEM "S1000DUG003.png" NDATA PNG>
<!ENTITY S1000DUG004 SYSTEM "S1000DUG004.png" NDATA PNG>
<!ENTITY S1000DUG008 SYSTEM "S1000DUG008.png" NDATA PNG>
<!ENTITY S1000DUG009 SYSTEM "S1000DUG009.png" NDATA PNG>
<!ENTITY S1000DUG010 SYSTEM "S1000DUG010.png" NDATA PNG>
<!ENTITY S1000DUG011 SYSTEM "S1000DUG011.png" NDATA PNG>
<!ENTITY S1000DUG012 SYSTEM "S1000DUG012.png" NDATA PNG>
<!ENTITY S1000DUG013 SYSTEM "S1000DUG013.png" NDATA PNG>
<!ENTITY S1000DUG014 SYSTEM "S1000DUG014.png" NDATA PNG>
<!ENTITY S1000DUG015 SYSTEM "S1000DUG015.png" NDATA PNG>
<!ENTITY S1000DUG016 SYSTEM "S1000DUG016.png" NDATA PNG>
<!ENTITY S1000DUG017 SYSTEM "S1000DUG017.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>Adobe FrameMaker 7.2 Application Pack for S1000D-User Guide</dc:Title>
<dc:Creator>00001</dc:Creator>
<dc:Subject>Adobe FrameMaker 7.2 Application Pack for S1000D-User Guide</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>20</subject>
<discode>00</discode>
<discodev>A</discodev>
<incode>041</incode>
<incodev>A</incodev>
<itemloc>A</itemloc>
</avee>
</dmc>
<dmtitle>
<techname>Adobe FrameMaker 7.2 Application Pack for S1000D</techname>
<infoname>User Guide</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="i1002437">
<title>What you can do with the Adobe FrameMaker 7.2 Application Pack for S1000D</title>
<para>Depending upon the complexity and business rules of your S1000D project,
you may be able to use the S1000D Application Pack unchanged for all data modules.
A more likely scenario is that you&#8217;ll use the Adobe FrameMaker 7.2 Application Pack for S1000D as the
basis for further developments. Perhaps you need to create alternative
formatting for the existing data module types. Or, you may need
to add a currently unsupported data module type.</para>
<para>The following sections introduce the features of the S1000D Application Pack and
give examples of how to use them.</para>
<subpara1>
<title>Getting started</title>
<para>The Adobe FrameMaker 7.2 Application Pack for S1000D includes a small set of example data modules
in the Examples folder. Because all data modules share the same
root element name of &lt;dmodule&gt;, you must choose the correct structured
application.</para>
<figure>
<title> Choose a Structured Application</title>
<graphic reprowid="2.913in" reprohgt="1.184in" xlink:type="simple" boardno="S1000DUG022"/>
</figure>
<para>The data module type may be indicated by the DMC information
code, (see incode - Information Code. You&#8217;ll find a full list in
chapter 8.4 of the S1000D specification. Some examples are:<randlist prefix="pf02">
<item>040, 041, 042&#8212;use S1000D2.21Descriptive</item>
<item>121, 151, 330, 663&#8212;use S1000D2.21Procedural</item>
<item>022&#8212;use S1000D2.21BREX</item>
<item>941&#8212;use S1000D2.21IPD</item>
</randlist>
</para>
</subpara1>
</para0>
<para0 id="i1012607">
<title>
<?FM MARKER [Cross-Ref] 51149: Header: Using BREX?>Using BREX</title>
<para>Business Rules Exchange (BREX), the S1000D method for controlling
project configuration or customization, is fully integrated with
the Description, Procedural, and IPD applications.</para>
<para>Each data module includes a &lt;brexref&gt; element, which is
a reference to a BREX data module that includes project specific
settings. This data module code is used as part of the file name
by the XSLT transform stylesheet when it merges the information
into each data module. In the screenshot on the next page, the refdm
maps to a data module with the filename &#8220;DMC-AE-04-10-0301-00-A-022A-A.xml.&#8221;
The path to the BREX data module is defined for each XML application
in the Structured Application Definition Document.</para>
<figure>
<title> The &lt;brexref&gt; structure</title>
<graphic reprowid="3.986in" reprohgt="5.246in" xlink:type="simple" boardno="S1000DUG001"/>
</figure>
<subpara1>
<title>Setting up the BREX file</title>
<para>In this exercise, you will make a small change to the BREX
data module then, observe the effect it has on a data module that
references it.<seqlist>
<item>In FrameMaker, open the supplied BREX
data module &lt;$S1000Dpath&gt;/Examples/DMC-S1000DBIKE-AAA-00-00-00-0000-022A-D_001-00.xml.</item>
<item>In Structure rule 2.1, locate Object rule 2.1.2. This rule
lists the security settings that the project will use. </item>
</seqlist>
</para>
<figure>
<title> Context rules in the BREX data
module</title>
<graphic reprowid="3.694in" reprohgt="4.152in" xlink:type="simple" boardno="S1000DUG002"/>
</figure>
<note>
<para>The first element in each object rule is the object path which
uses an Xpath expression to identify the context for the rule. In
this case &#8216;security/@class&#8217; means that the object rule relates to
the class attribute on any security elements.</para>
</note>
<para>
<seqlist>
<item>Add a new &lt;objval&gt; element after [05] Top
secret.</item>
</seqlist>
</para>
<figure>
<title> &lt;objval&gt; attributes in the
structure view</title>
<graphic reprowid="3.725in" reprohgt="2.163in" xlink:type="simple" boardno="S1000DUG003"/>
</figure>
<para>
<seqlist>
<item>When prompted for attribute values, set valtype
to single and val1 to 51. Click Insert Element, and then type in
the meaning for the new &lt;objval&gt;, for example, Sensitive.</item>
</seqlist>
</para>
<note>
<para>The Val1 attribute stores the value that is saved to XML in
every data module. Without BREX integration the security level shown
in the header and footer would be a meaningless number. Also the job
of editing a data module would be much more difficult if you have
to remember that em64 is an emphasis setting of red text in a monospaced
font.</para>
<para>The value 51 is chosen because configurable attributes may
have values from 00 to 99 where 00 to 50 are reserved for S1000D specification
definition.</para>
</note>
<para>
<seqlist>
<item>Save and close the BREX data module.</item>
<item>Open any data module from the examples folder. Find and select
the &lt;security&gt; element. </item>
<item>Open the Attributes dialog box, then select class. Click the
Choices button to confirm that your new security setting is available
as an option.</item>
</seqlist>
</para>
<figure>
<title> BREX integration in the Attributes
dialog</title>
<graphic reprowid="4.048in" reprohgt="2.913in" xlink:type="simple" boardno="S1000DUG004"/>
</figure>
</subpara1>
<subpara1 id="i1003320">
<title>
<?FM MARKER [Cross-Ref] 25249: Header: Manual IPD compilation?>How BREX integration works</title>
<para>When a data module is opened, the XSLT transform uses the
xalan:write extension to output a MIF fragment that contains the
new attribute choices. Each structured template is a MIF file that uses
several include statements to pull in the generated MIF fragments.</para>
</subpara1>
</para0>
<para0>
<title>Manual IPD compilation</title>
<para>The IPD data module was designed to be generated as output
from a 2000M provisioning database. In reality, the IPD is often
compiled manually. With the FrameMaker S1000D Application Pack, you can work
either way. The formatting follows the S1000D requirements exacly,
while the transformed structure makes sense of a very confusing
source schema structure.</para>
<para>This section explains how the S1000D Application Pack helps users avoid
the hidden complexities of IPD compilation.</para>
<subpara1>
<title>IPD content structure</title>
<para>The IPD content section is arranged as shown below. </para>
<figure>
<title> IPD content structure</title>
<graphic reprowid="3.454in" reprohgt="5.329in" xlink:type="simple" boardno="S1000DUG008"/>
</figure>
<para>The &lt;ipc&gt; element contains the following descendants:<randlist prefix="pf02">
<item>A single &lt;figure&gt; element that may
include a single graphic or multiple sheets. See Figure transformation for
more information.</item>
<item>A single &lt;ipp&gt; element which stores information about the
Initial Provisioning Project.</item>
<item>A single &lt;fm:csna&gt; element. This is simply an anchor element
for the following &lt;csn&gt; table structures. Its purpose is to ensure
that the parts list starts at the top of the page following the
graphic.</item>
<item>One or more &lt;csn&gt; elements. The Catalogue Sequence Number
is the parent element of each line entry in the parts list. Each
&lt;csn&gt; contains the elements shown below.</item>
</randlist>
</para>
<figure>
<title> &lt;csn&gt; structure</title>
<graphic reprowid="2.069in" reprohgt="1.861in" xlink:type="simple" boardno="S1000DUG009"/>
</figure>
<para>
<randlist prefix="pf02">
<item>Each &lt;csn&gt; is a FrameMaker
table element, the child &lt;fm:csnbody&gt; is a table body element.</item>
<item>Each &lt;isn&gt; (or Item Sequence Number) is a FrameMaker table
row element. There must be at least one &lt;isn&gt; for each &lt;fm:csnbody&gt;.
The reason for having more than one &lt;isn&gt; is to show variant
parts data or, alternative parts that perform the same function.</item>
<item>Within the &lt;isn&gt;, seven generated FrameMaker table cell
elements contain the parts data elements.</item>
</randlist>
</para>
<figure>
<title> &lt;fm:csnbody&gt; structure</title>
<graphic reprowid="2.236in" reprohgt="3.329in" xlink:type="simple" boardno="S1000DUG010"/>
</figure>
<para>
<randlist prefix="pf02">
<item>&lt;fm:figitem&gt; Figure
number and item number cell. Contains the generated &lt;fm:prefix&gt;
element, which displays the figure number at the top of the parts
list as well as the item number from the &lt;csn&gt; element. When
an item is not illustrated, add a &lt;nil&gt; element as a child of &lt;fm:prefix&gt;.
Enter a single &#8220;-&#8221; as its content.</item>
</randlist>
</para>
<figure>
<title> &lt;fm:figitem&gt; structure</title>
<graphic reprowid="3.756in" reprohgt="1.830in" xlink:type="simple" boardno="S1000DUG011"/>
</figure>
<para>
<randlist prefix="pf02">
<item>&lt;fm:qna&gt; Quantity per
next higher assembly cell. Must contain a single &lt;qna&gt; element
that gives the quantity of this item in its parent assembly. For
the first or top level item this is normally &#8220;Ref.&#8221; Zero or more
&lt;uoi&gt; elements are used to define the Unit of Issue, (for example, EA
for &#8220;each,&#8221; mm for millimetres). Allowable codes are defined in
S2000M.</item>
</randlist>
</para>
<figure>
<title> &lt;fm:qna&gt; structure</title>
<graphic reprowid="2.538in" reprohgt="1.153in" xlink:type="simple" boardno="S1000DUG012"/>
</figure>
<para>
<randlist prefix="pf02">
<item>&lt;fm:ncage&gt; NATO Commercial
And Government Entity cell. Must contain a single &lt;mfc&gt; element.
The terms NCAGE and MFC (Manufacturer&#8217;s Code) are interchangeable.
This code is unique to the manufacturer of each part.</item>
</randlist>
</para>
<figure>
<title> &lt;fm:ncage&gt; structure</title>
<graphic reprowid="2.840in" reprohgt="0.965in" xlink:type="simple" boardno="S1000DUG013"/>
</figure>
<para>
<randlist prefix="pf02">
<item>&lt;fm:pnr&gt; Part Number
cell. A single mandatory &lt;pnr&gt; element holds the item&#8217;s part
number. An optional &lt;nsn&gt; element is used if the NATO Stock Number
is required.</item>
</randlist>
</para>
<figure>
<title> &lt;fm:pnr&gt; structure</title>
<graphic reprowid="3.444in" reprohgt="1.205in" xlink:type="simple" boardno="S1000DUG014"/>
</figure>
<para>
<randlist prefix="pf02">
<item>&lt;fm:nomen&gt; Nomenclature
cell. Holds all of the descriptive elements for an item. 
The relationship between parts is indicated by the indenture level
as defined by the ind attribute on the ancestor &lt;csn&gt; element.
Indenture is shown by the number of bullets preceding the &lt;dfp&gt;
element.

The asp attribute is used for formatting purposes. Its value is
copied from the optional &lt;asp&gt; element during import. When asp
=&#8221;1&#8221;, the preceding bullets are replaced with the same number of
asterisks, which shows that this is an attaching part. You may change
this value manually if required, but it will always use the values
from the &lt;asp&gt; element when imported from XML.</item>
<item>&lt;dfp&gt; or Description For Part element is mandatory and
must use the unique name that is allocated to the part. Because
of a potentially confusing section of the underlying IPD schema
structure, it is possible to use more than one &lt;dfp&gt; element.
However this is not recommended as it will have unwanted side effects
when saving XML.</item>
<item>&lt;dfl&gt; &#8211; Description For Location is optional, it is used
for a context specific description of the item.</item>
<item>&lt;asp&gt; &#8211; Attaching, Storage, or Shipping Part. The asp attribute
may have the value 1, 2, or 3. The value is copied to the asp attribute
on the &lt;fm:nomen&gt; element on import from XML.</item>
<item>For descriptions for other elements, see chapter 5.3.1.4 of
the S1000D specification.</item>
</randlist>
</para>
<figure>
<title> &lt;fm:nomen&gt; structure</title>
<graphic reprowid="3.715in" reprohgt="5.892in" xlink:type="simple" boardno="S1000DUG015"/>
</figure>
<para>
<randlist prefix="pf02">
<item>&lt;fm:mov&gt; Model Version,
Usable on Code cell. Contains optional elements &lt;uca&gt; (Usable on
Code for the Assembly) or &lt;uce&gt; (Usable on Code for the Equipment).
The optional, repeatable &lt;mov&gt; element displays the Model version
information for the current item. The &lt;smr&gt; (Source, Maintenance,
and Recoverability) element is required and repeatable. See the
S2000M specification for an explanation of its use.</item>
</randlist>
</para>
<figure>
<title> &lt;fm:mov&gt; structure</title>
<graphic reprowid="2.902in" reprohgt="1.548in" xlink:type="simple" boardno="S1000DUG016"/>
</figure>
<para>
<randlist prefix="pf02">
<item>&lt;fm:icy&gt; Interchangeability
cell, which can contain a single &lt;icy&gt; element. See the S2000M specification
for an explanation of its use.</item>
</randlist>
</para>
<figure>
<title> &lt;fm:icy&gt; structure</title>
<graphic reprowid="1.246in" reprohgt="0.965in" xlink:type="simple" boardno="S1000DUG017"/>
</figure>
</subpara1>
</para0>
<para0 id="i1007478">
<title>
<?FM MARKER [Cross-Ref] 65535: Header: Description and Procedural data modules?>Description and Procedural data modules</title>
<para>Description and Procedural data module types are more conventional
in their structure. The best way to learn how to use them is to
open any of the provided examples and see what can be done by trial
and error. The S1000D specification provides guidance for the usage
of all elements for these modules.</para>
</para0>
<para0 id="i1007491">
<title>
<?FM MARKER [Cross-Ref] 73292: Header: fm:display options?>fm:display options</title>
<para>All four S1000D applications may be configured to display
for edit or publish. The top level &lt;dmodule&gt; element includes
the &lt;fm:display&gt; attribute, which has values of either &#8220;edit&#8221;
or &#8220;publish.&#8221; The attribute&#8217;s setting affects the way some elements
are displayed. In Edit mode, the &lt;idstatus&gt; and &lt;fig-title&gt;
are visible. In Publish mode, these items are hidden. Elements are
hidden by their formatting, rather than by using conditional text,
so that the data module remains valid regardless of the &lt;fm:display&gt;
setting.</para>
<para>You can choose whether the data module opens in Edit or Publish
mode by setting the value of the &#8220;start.mode&#8221; stylesheet parameter
to &#8220;edit&#8221; or &#8220;publish&#8221; as required. The stylesheet parameters are
defined in the Structured Application Definition Document.</para>
</para0>
</descript>
</content>
</dmodule>
