README file for SGML subdirectory on SOLIS *********************************************************************** *********************************************************************** *********************************************************************** README file for SGML subdirectory on SOLIS This README file assumes that the reader has a working knowledge of both STEP and SGML. For more information in either of these or related areas, see documents in "References" section below. SGML DTDs for STEP: ------------------- As part of the Application Protocol Development Environment (APDE), NIST is developing SGML document type definitions (DTDs) for STEP (ISO 10303) documents. These DTDs are being written according to the Supplementary Directives for the Drafting and Presentation of STEP documents and thus will support the development of STEP documents which are consistent and structurally correct. The DTDs will also be used along with the corresponding tagged SGML documents to facilitate structure-based querying, browsing, and retrieval of STEP documents. Currently, a DTD for STEP Integrated Resources and a DTD for STEP Application Protocols have been developed at NIST. The DTD for STEP Application Protocols is still being validated in-house, however the DTD for STEP integrated resources is now available electronically through SOLIS. The DTD for STEP Integrated Resources is now being used to develop and convert documents into SGML. Thus far, STEP parts 43, 44, and 101 have all been converted to SGML using this DTD (see "SGML-tagged STEP parts" below. NIST plans to continue tagging the integrated resource parts of STEP and will provide them on SOLIS and in an information base which will contain STEP parts and other documents related to STEP. The DTD for STEP integrated resources is publically available and is intended for general use in the STEP community. Using this DTD, users may develop or convert a document into a STEP integrated resource or access existing SGML documents which conform to this DTD. SGML-tagged STEP parts ----------------------- Each Integrated Resource part subdirectory in the private ftp area and in the public area on SOLIS contains a subdirectory called sgml. The files in each sgml subdirectory comprise a NIST-developed SGML document instance which conforms to the DTD for STEP Integrated Resources. When the DTD for STEP Application Protocols has been successfully validated, SGML-tagged Application Protocols will also be stored on SOLIS along with the DTD for STEP Application Protocols. The files in the sgml subdirectories are broken up into a master SGML file and one or more other sub-files which contain the graphics or figures referred to in the master SGML file. The format of the sub-files are indicated by their filename extensions. The document instance in each sgml subdirectory was converted to SGML from the original format of the part as stored in the parent directory of the subdirectory. All document instances were successfully validated using psgml and sgmls. Using the DTD for Integrated Resources to Develop or Access a STEP Integrated Resource: ------------------------------------------------------------------ In order to use the DTD to develop or access an SGML STEP integrated resource, the user should be minimally equipped with a DTD parser which will parse the DTD and in some cases, produce a compiled version of the DTD to be used by an SGML-based application. The user will also require a document instance parser to validate the document instance against the corresponding DTD. Several commercial and public domain DTD parsers are available either as a stand-alone tool or as part of a stand-alone tool. (For more information on available DTD parsers, see "For more information" below.) This DTD has been validated using sgmls, a public domain DTD and SGML document instance parser. This DTD has also been validated with the Author/Editor DTD "rules builder" (mkrls) program. If you are using sgmls, psgml (an emacs mode for editing SGML documents), or Author/Editor to parse this DTD, the following special instructions apply: Using the DTD with sgmls or psgml: ---------------------------------- The following table describes the necessary modifications to the DTDs and the sgmls source code: File Description --------------------------------------------------------------------- In the DTD Add the following lines to the top of the file: sgmldecl.c Change first value after #define REFCAPSET from 35000 to 100000 to handle size of DTD. This first value corresponds with the TOTALCAP parameter in SGML. entity.h Change REFNAMELEN from 8 to 32 to handle legnth of element names. entity.h Change REFLITLEN from 240 to 800 to handle legnth of entity definitions. After making changes to the sgmls source code, run "make" in the directory in which the source code is located to generate a new sgmls executable. Using the DTD with Author/Editor mkrls program: ----------------------------------------------- Change the SGML declaration file (sgml.dec) as follows: Add parameter NAMELEN to QUANTITY SGMLREF section. Set NAMELEN to 32 to increase the permissible name lengths from 8 to 32. NIST-provided applications based on STEP DTDs: ---------------------------------------------- NIST will be providing SGML-aware applications which are based on the DTD for STEP Integrated Resources and the DTD for STEP Application Protocols. These applications will be provided minimally at initial operational capability in fiscal year 1995. These applications include the following: o STEP-customized editor o SGML translator (for translating documents into a publishable format) o Automatic SGML conversion tools for WordPerfect and LaTeX o Text database system For more information -------------------- For more information regarding the STEP DTDs and the tagged document instances, contact: Lisa Phillips National Institute of Standards and Technology Building 220, Room A354 Gaithersburg, Md 20899 USA telephone: 301-975-5021 fax: 301-869-9017 email: phillips@cme.nist.gov References ---------- Clark, Stephen N, Allison Barnard Feeney, and James E. Fowler, Specifications for an Application Protocol Development Environment, NISTIR 5248, National Institute of Standards and Technology, Gaithersburg, Md., August 1993. Goldfarb, Charles F., The SGML Handbook, Oxford University Press, New York, 1992. International Organization for Standardization, ISO 10303 Industrial Automation Systems and Integration - Product Data Representation and Exchange - Overview and Fundamental Principles, Draft International Standard, ISO TC184/SC4, 1992. Phillips, Lisa, A DTD for STEP Integrated Resources, ISO TC184/SC4 Editing Committee Version 1.0, N43, September 5, 1994. Phillips, Lisa and Joshua Lubell, An SGML Environment for STEP, NISTIR 5547, National Institute of Standards and Technology, Gaithersburg, Md., June, 1994. Shaw, Nigel, Supplementary Directives for the Drafting and Presentation of ISO 10303, Version 1.1, N40, July 10, 1993. Rinaudot, Gaylen, The STEP On-line Information Service. NISTIR 5511, National Institute of Standards and Technology, Gaithersburg, Md., October 1994. *********************************************************************** *********************************************************************** ***********************************************************************