[Mirror from: Electronic Exchange - Encoding (Reference Guide for DTDs used by DOE for bibliographic exchange, etc.)]

Scientific and Technical Information Management

Reference Guide for the Department of Energy Technical Report Document Type Definition (DTD)

January 1996
U.S. DEPARTMENT OF ENERGY

Office of Science Education and Technical Information
Office of Scientific and Technical Information

Preface

The initiative to implement standards for the electronic exchange of scientific and technical information was promulgated within the Department of Energy (DOE) in August 1991 by the Office of Information Resources Management (IRM) Policy, Plans, and Oversight, when they announced an initiative to achieve electronic exchange of scientific and technical information (STI) within the Department. At that time the Department adopted the International Standards Organization (ISO) 8879, Information processing - Text and office systems - Standard Generalized Markup Language (SGML), as defined in the Federal Information Processing Standards (FIPS) Publication 152, as the DOE standard. The DOE Office of Scientific and Technical Information (OSTI), which coordinates STI management within the Department, was given responsibility to manage the transition.

The initiative assumes an open systems environment in which international standards play the predominant role for electronic exchange of STI. The vision of this initiative is the electronic creation, storage, transfer, retrieval, and exchange of full-text scientific and technical documents throughout the community.

In February 1993, The Electronic Exchange of Scientific and Technical Information: Strategic Plan was issued by the Department. The Strategic Plan was developed by a team of information managers, professionals, and computer scientists from DOE and contractor sites across the country. These stakeholders established the goal identified in the Strategic Plan to make electronic exchange of full-text DOE STI the norm by the year 2000.

OSTI has sponsored and worked closely with the DOE SGML Technical Working Group (STWG) since 1992. One of the activities to come from that group is the DOE Technical Reports Document Type Definition (DTD). This DTD was a Department-wide effort with participation by most of the major DOE sites.

Contents

Table of Contents

INTRODUCTION

The DOE Technical Reports Document Type Definition (DTD) is designed for markup of scientific and technical reports sent to the Office of Scientific and Technical Information (OSTI). It started life at Oak Ridge National Laboratory (ORNL). Their Technical Report DTD was used as a starting point for the Standard Generalized Markup Language (SGML) Technical Working Group (STWG) development of a Technical Report DTD for DOE-wide use. Ideas from other publicly available DTDs, such as the ISO 12083 DTD, were also incorporated in the DOE DTD.

The purpose of this guide is to document the elements and their use for the DOE Technical Reports DTD. It is made up of three sections identifying the conventions used to describe the elements, an element data dictionary, and a sample document. The latest copy of the DTD modules can be obtained using Mosaic or Netscape from the Electronic Exchange Initiative pages on the DOE WWW server at http://doe.www.gov/osti/eei/eeihome.html.

The DTD is documented in the form of this element data dictionary. Information about each element is presented in alphabetical order. The element data dictionary is itself an SGML DTD and document designed specifically for this application. The actual printed data dictionary portion of this document was printed using the InContext SGML editor.

The DOE Technical Report DTD parses properly with SGMLS, OmniMark, Intellitag, WordPerfect SGML Edition, and InContext. Be aware that some tweaking had to be done to the files to get successful parses. The DTD modules were merged into a single large file for several of the packages and the Forward corrections, additions, comments, and questions to:

     Department of Energy
     Office of Scientific and Technical Information
     ATTN: Robert Donohue
     P.O. Box 62
     Oak Ridge, Tennessee 37831

CONVENTIONS

This section describes the conventions used in the Element Data Dictionary. The data dictionary is arranged in alphabetical order. Parameter entities are documented first, followed by elements.

Each element entry starts with the element name in <>. This is the element name defined in the DTD. The entry for an element is made up of the following items:

Name:
A short (usually two or three word) description of this element.

Date:
The date this entry was modified in the data dictionary. The date is associated with the comment that follows it.

Comment:
A brief comment documenting the change to the data dictionary entry for this element. Multiple date/comment pairs are allowed.

Description:
A textual description of this element.

Content:
The content entry is made up of a list of items. Hierarchy describes the placement of the element within the DTD. Child elements identifies any required sub-elements for this element. And, Editorial text identifies any special formatting considerations.

DTD:
The module filename where the definition for this element resides is listed here.

Content Model:
The actual content model from the DTD is shown here. Parameter entity definitions are not expanded. Refer to the parameter entity for details about the content model. Future versions of this document may also list the expanded content model for parameter entities.

Attributes:
Each attribute defined for this element is identified. Parameter entity attributes are not expanded.

Example:
A short example of the usage of this element is provided.

ELEMENT DATA DICTIONARY

The Element Data Dictionary describes each of the elements and parameter entities in the DOE Technical Reports Document Type Definition. The listing is arranged in alphabetical order with the parameter entities listed first, followed by the elements.