| Comparing Styling in Layout-driven &, Content-driven Documents | Table of contents | Indexes | Most Frequently asked business questions about XML from current or prospective SGML users | |||
AECMA 1000D and IETP : Diverse approach to define IETP from Data-Modules; |
|
Michel Domeon |
| Head of Cals Technical Applications Department |
| Dassault-Aviation Military Customer Support Division Support Product Department 78 Quai Marcel Dassault - cedex 300 St Cloud France Cedex 92552 Phone: +33 1.47.11.31.39 Fax: +33 1.47.11.31.39 Email: michel.domeon@dassault-aviation.fr Web: www.dassault-aviation.fr |
Biographical notice: |
Michel Doméon |
Michel Doméon is currently working for DASSAULT-AVIATION and has been involved in both the military and civil technical documentation process, especially for information systems. |
From DCF (IBM) to XML through SGML and HTML, he has been in charge of studying and promoting these technologies within the company. |
Glasgow ![]() Malloy, Thomas MoDUK United Kingdom ![]() |
Thomas Malloy |
| Head of Policy |
| MoDUK Kentigern House Glasgow Scotland United Kingdom G2 8EX Phone: +44 141 224 2587 Fax: +44 141 224 2142 Email: tmalloy@gtnet.gov.uk |
Biographical notice: |
Thomas Malloy |
ABSTRACT: |
AECMA 1000D ![]() Data-Modules HTML, Hypertext Markup Language ![]() HyTime ![]() IETP ![]() SGML ![]() XML ![]() |
The first part of this paper describes the AECMA 1000D modular approach and the concept of data-modules and CSDB (Common Source DataBase) . With the following part describing several approaches for generating IETP (Interactive Electronic Technical Publication) derived from source data. |
AECMA Presentation |
|
What is AECMA? |
|
AECMA ![]() |
AECMA (European Association of Aerospace Constructors) is an association of European Aerospace Industries, which was founded in 1950 as a forum for Industry leaders. The association covers nine European nations and is recognised as being fully representative of the European aerospace industry.Its primary aim is to "Promote and represent European aerospace interests within the EEC and World-wide". |
| EDWG EPWG TPSMG |
The AECMA working group structure |
AECMA Organisation |
![]() |
AECMA S1000D |
|
What is AECMA S1000D? |
|
| CSDB |
AECMA S1000D is a specification for "Technical Publications utilising a Common Source Data Base". Documentation produced to AECMA S1000D will be in the form of units of information called Data Modules. All the Data Modules required to produce a technical publication are held in a CSDB . To facilitate ease of data management and transfer between IT systems the information is prepared using SGML . Each of the above will be covered more fully later in this paper. |
Why AECMA S1000D? |
|
What AECMA S1000D is not is another paper publications specification, database model or a definition for a computer software application. |
It however has some major benefits it is Non Proprietary, allows neutral delivery of Data and management of data also it uses the CALS philosophy of "create once use many" . |
AECMA S1000D status |
|
Work started on AECMA S1000D in 1983, with the present status being that the specification is at Change 7 |
Details of the DTDs can be found on the AECMA WEB site : www.aecma.org. |
Change 7 has introduced constructs for: |
AECMA S1000D structure |
|
Common Source Data Base(CSDB) |
|
Data Module |
|
Data Module Types |
|
There are several types of Data Module allowable within AECMA covering many types of information, below are some examples: |
Data Module Structure |
|
A Data Module consists of an Identification and Status section and a Contents section. These sections are further broken down into elements, with examples shown below; |
Identification and Status elements |
Content elements |
The DM structure is applicable to Air vehicles, engines and equipment but it is easily applied to other vehicles and associated equipment, with this being accomplished within many countries. |
| DMC |
Data Module Code (DMC) |
The DMC is a 17 character code, divided into eight groups as shown in example below : |
data module code structure |
![]() |
The Standard Numbering System (SNS), consists of 3 pairs of digits. |
The Information Code is a three numeric character code used to identify the type of information covered by a Data Module; |
This code also has a variant which indicates procedural variants that may need to be covered; |
Example: Information code 641A may denote anodising a component using a chemical bath and 641B is anodising using swab solution |
Support and training equipment DMC |
|
The data module code for support equipment is detailed below and is further detailed in S1000D |
data module code structure for AGE |
![]() |
| Simplified English |
AECMA S1000D Writing Rules |
AECMA S1000D Illustrations |
|
ATA, Air Transport Association ![]() CGM open initiative |
The specification details a chapter on the modes of presentation, types of illustrations, and there control using an Illustration control number. However the production of illustrations for an electronic environment is not covered, with AECMA keeping an eye on the ATA and CGM open initiative work being done in this area. The illustration formats allowed within the specification are the CALS graphic standards |
AECMA S1000D DTD |
|
The DTD has been developed with the following objectives: |
Theory of Operation |
|
The DTD consists of three parts, each part may contain one or more entity |
The 3 parts are: |
Paths through the DTD are controlled by incorporating the different entities required. |
There is one "main" entity for each type of Data Module structure. The DOCTYPE statement at the start of each Data Module specifies which "main" controlling entity should be used for that structure. |
Each "main" entity: |
AECMA 1000D also details the the formal public identifiers, parameter entities, elements and attribute lists allowable within the specification. |
AECMA 1000D - interchange of data modules |
|
To achieve an orderly and systematic digital interchange of DMs, it is necessary to work within a set of formal data interchange standards and procedures. |
The digital exchange of Data Modules is based on MIL STD 1840 (Automated Interchange of Technical Information.) |
| 1840 |
There are two aspects to the satisfactory delivery of DM: |
Mil Std 1840 defines how data will be packaged for transfer between parties and the standards to which that data shall be prepared. |
AECMA S1000D and Technical Publications |
|
Also described is the format of presentation for the paper publications. However our main thrust is the generation of IETP . |
AECMA S1000D and IETPs |
|
Publication modules |
|
Publication construction |
|
The building of the publication shall be independent to the end-user presentation software. This requires that the publication is built in two steps. |
Intermediate form |
|
The publication in intermediate form is implemented in a SGML/HyTime format known as a publication DTD, with illustrations in CGM, CCITT Gr4 or JPEG files. |
Intermediate form, step one |
![]() |
End user deliverable |
|
Building the end-user deliverable publication depends on the end-user software and hardware. |
End user deliverable, step two |
![]() |
Type of Publication |
|
The IETPs presently covered within the specification are : |
GUI, Graphical User Interface ![]() |
All the above IETP construct have one aspect in common this is the rules for the Graphical User Interface(GUI) , where AECMA specifies rules such as: |
This aspect is meant to lay down rules for "front ends" that will allow the same look and feel across IETP types thus creating standardisation and reducing learning time. |
IETP-L : linearly structured |
|
| IETPL |
Definition |
IETP process |
![]() |
An IETP-L must contain all relevant information necessary to allow the building of an end-user deliverable publication. |
The IETP-L is based on SGML standard for the text definitions. |
This IETP-L is defined through: |
SUBDOC ![]() |
For IETP-L the core of the IETP will refer to the SGML instances of data-modules. To manage the diverse types of DM that may be included, the use of entity management and SUBDOC structure will allow the parser to accept inside the IETP-L, the structure of all DM (eg PROCED, DESCRIPT, AIRCREW, IPD) These DM calls are implemented through the use of elements with an attribute of ENTITY type (general entity name attribute). All these entities are SGML documents with their own DTD. The entity type must be SUBDOC. |
The use of SUBDOC is shown in the specification, but implementation can be completed in a proprietory manner. |
Structure |
|
The IETP-L structure is divided into two parts:
|
Linking mechanism |
|
This IETP-L DTD is based on the SGML ENTITY management only and does not include HyTime links as in IETP-D publications. |
The core of the IETP-L uses the SUBDOC management to access the SGML instances of the referenced data-modules. |
Advantages and Disadvantages |
|
| Advantages | Disadvantages | |||||
| Easy to produce | Use of SUBDOC not generally supported | |||||
| No enhanced mechanism to understand | No enhanced links mechanism to use, Specifically for inter IETP links (need to add proprietary or HyTime links) | |||||
| Full respect of basic standards (neutral form garanteed) | Don't keep the modular aspect, by gathering all DM in one instance | |||||
| Not prepare for the future with web and XML delivery (don't keep the modular approach) | ||||||
IETP-D : Database oriented |
|
Definition |
|
| IETPD |
This chapter concerns the interactive electronic display of technical information specially authored into and maintained in a non-redundant relational or object-oriented hierarchical database. This source data is subsequently packaged (ie view-packaged) as a run-time database for interactive presentation. |
Structure |
|
The publication allows the end user to access to different entry points (TOC by zoning, TOC by chapter, glossary, LOI, etc). After selection of an entry point, the system links to a hub (LOEDMH) which contains all the DMH locations, and presents, to the end user, the structure of each DM which is already defined in this header. The user can only access information within the DM at this level (using ilinks), because the DMH contains the location of each portion of the elementary DM. |
Linking mechanism |
|
CLINK ![]() ILINK |
The linking mechanism is detailed in the following figure. The HyTime ilink (independent link) definition has been selected in preference to the clink (contextual link) definition. Both definitions are described in ISO 10744. |
Linking mechanism schematic |
![]() |
Advantages and Disadvantages |
|
| Advantages | Disadvantages | |||||
| keep the modular aspect, by only linking to DM instances | More complicated to understand and produce than IETP-L | |||||
| enhanced links mechanism (powerfull ilink architectural form) | Few HyTime engine available, and most of tools didn't support ilinks (replaced by clinks) | |||||
| Full respect of basic standards (neutral form garanteed) | Need the automatic building of Data module headers and HUB instance (LOEDMH) to reflect the cross references linking mechanism | |||||
| Prepare an XML delivery by keeping the modular approach | HyQ queries must be replaced by SDQL | |||||
IETP-H : Web HTML |
|
Definition |
|
| IETP-H |
This chapter details the general features which are required in order to deliver SGML-coded data modules as an IETP through HTML tagging on the WEB from a CSDB. |
Internet/Intranet IETP delivery process |
![]() |
Structure |
|
The hierarchical structure of technical documentation data for delivery on the WEB is based upon three levels: |
Upper level - LOAP |
|
Contains the list of all applicable publications and the way to address them either through textual or graphic link. |
Intermediate level - IETP |
|
An IETP is constructed for a specific subject and defines the links to the relevant base level data modules. |
The IETP contains an introduction, status, tables of contents and generated data allowing the end-user to access a relevant data module. Examples of generated data are: |
Base level - Data modules |
|
These DM conform to the AECMA-1000D DM DTD, with identification, status and content sections |
hierarchical levels presetation |
|
Hierarchical levels of technical documentation |
![]() |
URL ![]() |
The proposed structure is based on the fact that the URL (directories and filenames) can be automatically deduced from: |
In the proposed solution, the data modules are stored independently from the IETP, the organization is as given in following figure which illustrates a directory and filenaming method. |
Files and directories structure |
![]() |
Linking mechanism |
|
The URL structure is as follows: |
"protocol://host/path/filename" where:
|
The HTML structure also allows a specific file at a specific target to be opened. This requires an anchor using the "A" tag with a specific ID to be defined in the HTML file. To locate the link at this anchor, the character # with the anchor name must be added after the URL filename location. |
The following Table defines the various links available in S1000D structures, for referencing URL location. |
| Element | Context | Title | Type of link | URL example | ||
| dmcref | DM | Reference to DM | intra/inter IETP link | ../DM/YY-A-32/16-01-00A-520A-A.HTM | ||
| partno | DM | Part number | IPD link (Part number repository) | ../DM/YY-A-53-25-10-02A-999A-A.PNR | ||
| Table | DM | CALS table | ref table access | direct in file | ||
| Xref | DM | Cross references | (supply, support, tables, figures) DM internal link | #supportid1 | ||
| ICN | DM | Illustration control number | illustration access | ../IMAGES/CGM/0004A011.CGM | ||
| CSN | DM | Catalogue sequence number | IPD link (inside nomenclature) | ../DM/YY-A-53-25-10-02A-999A-A.HTM#CSN04 | ||
| DMC | LOEDM | DM reference | ../DM/YY-A-32-16-01/-00A-520A-A.HTM | |||
| DMC | LOI | DM reference | ../DM/YY-A-32-16-01/-00A-520A-A.HTM | |||
| DMC | LOSU | DM reference | ../DM/YY-A-32-16-01/-00A-520A-A.HTM | |||
| DMC | LOSE | DM reference | ../DM/YY-A-32-16-01/-00A-520A-A.HTM | |||
| DMC | TOC | DM reference | ../DM/YY-A-32-16-01/-00A-520A-A.HTM | |||
| RTX | DM-IPD | Refer to | link DM + CSN | ../DM/YY-A-53-25-10-02A-999A-A.HTM#CSN04 | ||
| CSN | REPNR | CSN link from part number repository | ../DM/YY-A-53-25-10-02A-999A-A.HTM#CSN04 | |||
| CSN | IPD | CSN item inside IPD (figure/text link) | ../DM/YY-A-53-25-10-02A-999A-A.HTM#CSN04 | |||
Advantages and Disadvantages |
|
| Advantages | Disadvantages | |||||
| Easy to understand | Need a convertion from SGML to HTML | |||||
| Easy to convert from SGML to HTML as Aecma 1000D DTD has powerfull DTD's | Structure loose | |||||
| keep the modular aspect, by only linking to DM instances | ||||||
| Dm structure well defined for WEB delivery | ||||||
| Enhanced links mechanism (powerfull url and href combination) | ||||||
| Respect of standards (neutral form garanteed) | ||||||
| Prepare an XML delivery by keeping the modular approach and url links | ||||||
| Cheap and powerfull browsers available | ||||||
| Easy browsing enhancement (lots of plugins, java(script) development) | ||||||
IETP-X XML oriented |
|
XML and AECMA 1000D |
|
the XML interest for AECMA community, the work in progress, the advantages of XML IETP will be define here |
Advantages and Disadvantages |
|
| Advantages | Disadvantages | |||||
| Easy to understand | Need the 2 last parts of XML standard to be widely adopted (links and style) | |||||
| No loose of structure (keep Aecma 1000D powerfull structure) | ||||||
| Respect the modular aspect, by only linking to DM instances | ||||||
| enhanced links mechanism with combination of WEB url and HyTime links | ||||||
| Respect of standards (neutral form garanteed) | ||||||
| No need of complex convertion from SGML source code | ||||||
| Cheap and powerfull browsers available | ||||||
| Easy browsing enhancement (lots of plugins, java(script) development) | ||||||
Conclusion |
|
The AECMA IETP modular approach, with Data Module concept as small unit of information, is well dedicated and well adapted to the web technologies. |
The achievement of an AECMA 1000D XML IETP will be addressed inside the AECMA spec to cover the gap left by the existing IETP structure and to gather the advantages of : The HyTime Linking mechanism already defined for IETP-D and The URL linking mechanism for WEB delivery, very adequate with the Spec 1000D modular approach. |
With these IETP-X, new AECMA armament generation, the M.I.B mission will at least be achieved : 'allowing us to protect the EARTH from the scum of the universe : people who want to write and produce and deliver paper only' |
Acknowledgments |
| Comparing Styling in Layout-driven &, Content-driven Documents | Table of contents | Indexes | Most Frequently asked business questions about XML from current or prospective SGML users | |||