Product Documentation - Technical Requirements

ISO/TC184/SC4/WG3/T14 IPO Technical Publication
Standing document H

1995-11-01

Page 4


THE ARCHITECTURAL FRAMEWORK

The goal of the architectural framework is to provide sharable data between the two environments without compromising either individual environment. This can only be achieved by providing a superset containing all of the concepts and functionality of both domains and where the data and operations are compatible and harmonized. The architecture must provide a functional and conceptual compatibility between the STEP constructs and the SGML constructs in order for interoperability to succeed between the two environments.

The architectural framework is shown in the following diagram as a set of flows between the SGML and the STEP environments.


Fig 3. The flow of information objects between STEP and SGML environments.

The architecture presumes two environments: the STEP-compliant and the SGML-compliant. These are shown separately in the architecture as this will be the predominant situation. However, the architecture does not in any way preclude combining the environments in other ways.

The following steps form the work and control flow patterns of the architecture.

  1. User works with an SGML-encoded document within an editing environment supporting SGML, HyTime, and perhaps other standards, e.g., DSSSL, SPDL, FONTS.
  2. The document may include HyTime references to data stored in the local repositories. This is the accepted manner of requesting or querying for data. The HyTime access queries could be aimed at data generated or stored in other repositories.
  3. The environment may have programs for generating data or support for one or more repositories for stored information that can be added to an instance of the product documentation being created or edited. Data, such as pictures, tables, spreadsheets, etc., may be retrieved from the repository and included in the product documentation. (NB. The above diagram does not show a way of storing new information into the STEP-compliant environment.)
  4. The user or an application task, in the SGML environment, initiates a request, encoded in HyTime, to fetch specific data from the STEP environment. (A request will be interpreted by a HyTime engine activated by the HyTime attribute embedded in the SGML document).

    The request may be for any entity that is stored and is addressable (either by a unique global address or by a search query) within the STEP-compliant repository, e.g., an SGML_STRING, a tool-number, the pressure of a pump, etc.

  5. The request is received by the application program in the STEP-environment and passed to the SDAI interface. (If not compatible with the SDAI, the request may be need to be translated by the application running on the proprietary system and the address will need to be transformed from a global to a local address.
  6. The application issues the appropriate SDAI statements (mapped through the AP schema) to fetch the requested data from the repository.
  7. The proprietary system (activated through the SDAI mapped instructions) fetches the specified product data and returns it to the application program.
  8. Product data is formatted to conform to SGML. This may entail converting real numbers to character data, truncating decimals, converting measurement units (inches to centimeters), etc.
  9. The SGML compatible data is returned to the point of embarkation, i.e., the query instance encoded in HyTime.

TECHNICAL ANNEX

OVERVIEW OF THE SGML “FAMILY”

The Standard Generalized Markup Language (SGML) specifies a standard way of defining document structures for the application of markup schemes based on generic coding, i.e., it provides rules for marking up text which enables the exchange of documents between different computer systems. SGML provides a consistent and precise manner of describing revisable documents for interchanging widely varying application data. It is an open-ended definition reflecting the diversity of information needs in industry, specifically trade and product definition data. SGML does not directly define any types of content data, and thus does not restrict the type of data contained in a document.

SGML is not a predefined set of tags that can be used to mark up documents. Neither is it a standardized template for producing particular types of documents. SGML is language for describing the component parts of a document that is to be transmitted from one computer to another. SGML is flexible enough to be able to describe any logically structured set of data, whether it be a form, memo, letter, report, book, encyclopaedia, dictionary or even a spreadsheet or database.

The SGML standard is based on the simple principle that documents are a combination of content and markup. Markup is represented by explicit start- and end-tags which indicate an element type, roughly the same as a STEP entity, a textual (or other) object such as a “title” or “paragraph”. Elements may also have associated attributes which refine, uniquely identify, or further qualify a particular instance of an element.

In an SGML representation of a document instance, markup and content are intermixed in one text stream. SGML parse software deconstructs the stream into a database, or builds a tree representation for editing software, or steps through the file as if it were a procedure in order to present it, e.g., print it out on paper.

SGML is a metalanguage. It is optimized for declaring structures that are meaningful for document information, SGML is built on the idea that a document text stream consists of three parts:

  1. 1. an SGML declaration, in which system defaults are established (character set, special or delimiter characters, use of optional SGML features, etc.)
  2. 2. a Document Type Definition (DTD) where sets of declarations establish the names of and relationships among element types, attributes and other constructs that are appropriate for a class of documents(where class might be aircraft maintenance manuals or parts lists or specifications).
  3. 3. the document instance: the stream in which the markup defined in the DTD is instantiated with the content.

The Separation of Form and Content

Whenever possible, SGML application developers have insisted on drawing a clear boundary between what a unit of text is and how it looks. Elements are marked up with tags indicating the element type. There are no element types corresponding to typographical commands, i.e., an element is a structural thing like a paragraph or a title, not a “bold”, “new page” or “Space down 3 lines” command.

The importance of this cannot be underestimated: Making this separation allows for the re-use without arbitrary limitation of all parts of an SGML document. This is a philosophy which has not always been practised within STEP, and the result is the inadvertent binding of information to one presentation and one opportunity for use. Inherent to T14's philosophy is the re-process ability of all content.

The DSSSL and HyTime Members of the SGML Family

SGML is closely related to two other international standards: The Document Style Semantics and Specification Language (DSSSL) and the Hypermedia/Time-based Structuring Language (HyTime). DSSSL provides two standardized processes, the first is the Transformation Process which defines a process for the conversion of SGML document types, i.e., from one DTD to another DTD. The second is the Formatting Process which defines a standardized process for attaching style semantics to elements of an SGML document.

HyTime is a standard application of SGML which provides semantics for multimedia constructs, such as hyperlinking, synchronizing, etc. One of the features of HyTime provides a method of encoding standard queries, which can be in the HyTime query language HyQ or in other query languages such as SQL. With HyTime it is possible to encode multimedia applications for transfer between dissimilar platforms.

THE STEP “FAMILY”

The ISO standard for Product Data Representation and Exchange (ISO 10303) aims are to provide the broadest possible range of industry with a neutral form for the capture and interchange of computerized models throughout the total life cycle of a product.

Contrary to SGML which allows for application defined tags to indicate the structure of data and leaves the semantics completely up to the interpretation of the application, STEP defines the structure and the semantics totally. A generic conceptual model provides a basis for the development of separate data models for specific application structures and semantics. The EXPRESS language is used to define application protocols (APs) using the generic concepts and their relationships.

The STEP architecture also includes an interchange file (Part 21) which is created by mapping from the generic resources using the appropriate AP.


Previous Page | Table of Contents