S1000D Sample Data Users Guide
S1000D Sample Data Users Guide
to
Redstone Arsenal
AL 35898-7466
15 September 2011
W31P4Q-08-A-
Contract Number: 0025
Task Order Number: 0001
Table of contents Page
References ..................................................................................................................................... 2
1 General information........................................................................................................ 3
1.1 Gun data set contents ..................................................................................................... 3
1.1.1 XML Files ......................................................................................................................... 3
1.1.1.1 Data modules .................................................................................................................. 3
1.1.1.2 Data module lists ............................................................................................................ 3
1.1.1.3 Publication modules........................................................................................................ 4
1.1.2 Other files........................................................................................................................ 4
1.2 Reporting errors and recommending improvements. .................................................... 4
2 Acquire the Gun data set ................................................................................................ 4
2.1 Viewing the XML ............................................................................................................. 4
2.2 Locating the source data module from a PDF location ................................................... 5
3 Checking the XML against the BREX file.......................................................................... 6
4 Publishing the XML.......................................................................................................... 7
4.1 Generating a complete publication: ............................................................................... 7
4.2 Generating formatted output one DM at a time ............................................................ 9
5 Common Source Data Base (CSDB) Software and Tools ............................................... 10
5.1 Working with data in EMS‐NG ...................................................................................... 10
5.1.1 Workflow....................................................................................................................... 11
6 File list ........................................................................................................................... 13
References
Table 1 References
Document No. Title
Each DM contains two distinct sections: 1) the identification and status section and 2) the content
section. Depending on the type of DM, the content section’s structure will vary greatly, but the
identification and status section structure is always identical.
One of these DM types is the Business Rules Exchange (BREX) file. This DM is not included as a part of
the publication content that is typically distributed to end users (but is included in the DMRL (refer to
1.1.1.2)). The BREX file is an XML file that contains all project Business Rules (BRs) which are
considered “computer‐verifiable” and identify all project‐defined values, if any, which are also
necessary for publishing. Individual DM compliance with these BRs can be checked using the BREX file
(e.g., the use of required or prohibited elements). Narrative BRs are not computer‐verifiable (e.g., page
size). The BREX file is included in the folder named “Supporting Information.”
A Data Module Requirements List (DMRL) and a Common Source Data Base (CSDB) Status List (CSL) are
examples of a DML. The Gun data set contains a DMRL, which is an XML file. This DMRL lists every DM
that is a part of the Gun data set. The Gun data set also includes a CSL, which is in an Excel file
(spreadsheet format). Both of these files are located in the “Supporting Information” folder.
A Publication Module (PM) contains references to all DMs, PMs, and external publications (e.g., PDFs)
which are intended to be part of the publication output. Each of the included references must be listed
in the PM in the order it should be presented to the user. In other words, each reference (DM, PM, or
external publication) is published in the order it is listed in the PM. Since additional nested PMs may be
referenced, this highest‐level PM is often referred to as the “Parent” PM.
The Gun data set includes two PMs. “PMC‐S1000DGUN‐91005‐MM301‐00_001‐00_EN‐US.xml,” which
is the main publication. Additionally, “PMC‐S1000DGUN‐91005‐OPI01‐00_001‐00_EN‐US.xml” is
included, but contains no content. This additional PM was used for testing purposes with a Common
Source DataBase (CSDB) tool (refer to 5.1 for more information). Its existence is necessary for the
Publication Module references (element <pmRef>) within several of the included Gun data modules.
There are other files included in the Gun data set which are not DMs or even XML files. These are
graphics files and their file names begin with “ICN‐." An Information Control Number (ICN) is applied to
each symbol, illustration, photograph, or multimedia object within each publication. Each of the Gun
ICN files may be viewed individually in a graphic viewer. These graphics are referenced within the DMs
to be displayed in the necessary location (e.g., within a step or paragraph). Additional files include style
sheets, which are used to generate a page‐based publication. These files all end in “xsl.”
An additional folder, titled “Supporting Information,” in the Gun Zip contains the remainder of the
project deliverables, including:
a. Content selection matrices
b. Project business rules (in accordance with (IAW) the Data Item Description (DID):
DI‐TMSS‐81784, Army S1000D Project Business Rules)
Refer to 6 for a complete list of the files in the PhunGun.zip file.
Any errors or recommendations for improvement should be reported to(Insert approriate e‐mail
address).
a. The style sheets (files ending with XSL) are included with the Gun data located in the same
folder as the XML files.
Note: These XSL files are based off of the LOGSA‐provided style sheets. These
files have been tweaked for the Gun project.
b. If using Arbortext, proceed to step c; if using Antenna House, proceed to step d.
c. Start Arbortext (Epic) Editor.
1) Open the folder (using Windows Explorer or other file manager) containing the Gun data
set and the S1000D/MIL‐STD‐3031A style sheets.
2) Select the Gun PM (filename: PMC‐S1000DGUN‐11005‐MM301‐00_001‐00_EN‐US.xml)
and drag it to the Arbortext window. Alternatively, access the file from the Menu by
selecting File > Open, and navigate to the location of the Gun PM.
3) If there is no available Internet connection, a popup window similar to FIGURE 1 is
displayed. Select the “Open in free‐form mode without Schema/DTD” to view the raw
XML.
Note: The file cannot be validated when the Schema is not available.
Follow the steps as noted under either Arbortext or Antenna House substituting the desired DM
instead of the PM.
The Gun data was used for basic testing within EMS‐NG. This allowed testing of the import feature in
EMS‐NG.
To import the Gun data into EMS‐NG, all related XML and graphic files were compressed into a single
archive (Zip file).
There are many options for creating a structure within EMS‐NG. The following include just one
possibility:
a. Create a “publication” called “S1000DGUN.”
b. Create a folder called “Upload.”
c. Select the “Upload” folder and then select “Upload file.”
d. Browse to locate and select the Zip file. Be sure to check the box marked “Unpack archive.”
Once the file upload has finished, archived files are automatically extracted. The XML files are
automatically validated and automatically registered in the CSDB, if no errors are detected. The
graphic files are also registered automatically.
Note: At the time this document was written, there were some permission issues
with file extraction from archives. Although the upload would complete,
the extraction would fail. This was reported and is likely already corrected.
5.1.1 Workflow
From “home” menu, create a Workflow Definition named “Authoring.”
Establish a workflow definition as shown in Table 5.
5.1.1.2 Roles
Change roles after all states have been entered. Define groups for Authoring, Graphics, and QA.
Note: By using groups, the workflow remains the same. Group participants may
be modified as needed.
ERROR=>Graphics Needed,
Needs User Group: LOGSA (Vendor :
Authoring Submit SKIP=>Graphics Needed,
Action LOGSA) Authoring Group
OK=>Graphics Needed,
ERROR=>Editor QA,
Needs User Group: LOGSA (Vendor :
Edit Number2 Submit SKIP=>Editor QA,
Action LOGSA) Authoring Group
OK=>Editor QA,
ERROR=>Edit Number2,
XML Syntax Auto-run Auto SKIP=>Finished,
OK=>XML Schema,
ERROR=>Edit Number2,
XML Schema Auto-run Auto SKIP=>Finished,
OK=>XML Link,
ERROR=>Edit Number2,
XML Link Auto-run Auto SKIP=>Finished,
OK=>QA Checks,
ERROR=>Finished,
Complete Auto-run None
OK=>Finished,
Needs User
Finished
Action
6 File list
Table 6 contains a list of all the files that are included in the Gun data set.
Supporting
21 files
Information
Graphics 23 files
Contents 49 files
1. FO‐3031‐A00‐S1000DGUN‐APPLIC_001‐
00_EN‐US.xsl
2. FO‐3031‐A00‐S1000DGUN‐
ATTRIBUTES_001‐00_EN‐US.xsl
3. FO‐3031‐A00‐S1000DGUN‐CHECKLIST_001‐
00_EN‐US.xsl
4. FO‐3031‐A00‐S1000DGUN‐COMMON_001‐
00_EN‐US.xsl
5. FO‐3031‐A00‐S1000DGUN‐CONTENT_001‐
00_EN‐US.xsl
6. FO‐3031‐A00‐S1000DGUN‐CREW_001‐
00_EN‐US.xsl
7. FO‐3031‐A00‐S1000DGUN‐
DESCRIPTIVE_001‐00_EN‐US.xsl
8. FO‐3031‐A00‐S1000DGUN‐DMODULE_001‐
00_EN‐US.xsl
9. FO‐3031‐A00‐S1000DGUN‐DOCBOOK‐FO‐
RTF_001‐00_EN‐US.xsl
10. FO‐3031‐A00‐S1000DGUN‐DOCBOOK‐
FORMAL_001‐00_EN‐US.xsl
11. FO‐3031‐A00‐S1000DGUN‐DOCBOOK‐
PI_001‐00_EN‐US.xsl
12. FO‐3031‐A00‐S1000DGUN‐DOCBOOK‐
TABLE_001‐00_EN‐US.xsl
13. FO‐3031‐A00‐S1000DGUN‐FAULT_001‐
00_EN‐US.xsl
14. FO‐3031‐A00‐S1000DGUN‐FIGURE_001‐
00_EN‐US.xsl
15. FO‐3031‐A00‐S1000DGUN‐IDSTATUS_001‐
00_EN‐US.xsl
16. FO‐3031‐A00‐S1000DGUN‐INLINE_001‐
00_EN‐US.xsl